Read Me

     //
  /////u  // //         craftware        ===============
   //    // //         utilities        	ViaVoip    
  // // // // // //                    ===============     
 // // //  yt ///    www.utillyty.eu
             //							
				Copyright (C) 2015 Attilio Pavone <tilly@utillyty.eu>

A portable peer to peer voice chat.

				Version 0.7, 24/03/2015
				

Release notes
=============
This is the #7 prototype: version 1.0 is near!
Added: 
	- sample size (bit depth) selector;
	- settings management and settings data file;
	- audio settings negotiation with peer;
	- push to talk;
	- protocol and datafile version management for future backward compatibility;
and many others.

Please note:
************
As this is still a prototype, breaking backward compatibility 
should not be considered an issue (and this version does breaks compatibility
with previous versions).
Backward compatibility will be a primary concern and will be granted 
as far as possible after the first stable release.
ViaVoip 1.0 will be out in a week or so, so please,
keep in touch and stay updated :)

Install
=======
You can get ViaVoip at http://sourceforge.net/projects/viavoip/.

--- Windows ---
Extract the archive and launch "ViaVoip.exe" (no setup required).

--- Linux ---
Extract the archive and launch "ViaVoip" (no setup required).

--- Android ---
In order to setup the apk it is necessary
1) check the options "Settings/Security/Unknown Sources";
2) open the downloads folder through a file manager
   (and not the "downloads" link), and tap on ViaVoip-0.5.apk
3) accept the security requirements (most of them are unused, but I should have 
   specified it in the app manifest, and this is to much work for a prototype!)


Usage
=====

--- Network ---

* As server:
  - in the "Connection" tab, "Service" section, select the local IP from the list 
    (NB: 127.0.0.1 is only for test purpose in the host machine and should not be used);
  - specify a local port (better if >= 1024, but not mandatory, depends on the host system);
  - click the start service button (the first on the top left) and wait for incoming call.
    NB: in order to receive incoming calls it could be necessary to set your router
      NAT (port forwarding) accordingly (both TCP and UDP protocol must be allowed
      on local port).
  - click the public IP discovery button, and tell it to your peer together 
    with local port
  - accept the incoming call
    NB: once connected the server is paused.
    
* As client (peer):
  - in the "Connection" tab, "Peer" section, put in the "Public IP" and "Public Port"
    the numbers that your peer told you based on the above paragraph.
  - click the call button and wait for your peer to accept.
  
Once connected "client" and "server" behave in the same way.
  
--- Audio ---

- To speak push the mic button in the, or use the 
  "push 2 talk" feature (push Control Key to activate audio);
- to hear your peer voice push the headphones button.

--- Chat ---

- Use the message button (<Alt> + 's' or <Enter> if "send on enter" is active) 
  to send a message;
- use the file button (<Alt> + 'f') to send a file;
- use the enter button to activate "send on enter" (default).

--- Settings ----

Settings are saved in the 'ViaVoip.data' file in the same directory of the program.
Besides the network and audio settings, this additional settings are possible
(use the settings button to modify):
- play ring/message sounds: to enable/disable notification sounds;
- audio settings negotiation: to enable/disable the exchange of your audio settings
  with your peer (this is selected by default).
  
  ****************************************************************************
  *
  *  PLEASE NOTE
  *                                                               
  *  For "audio settings negotiation" to work, 
  *  both peers must have the option active.
  *
  *  If one of the peers has "audio settings negotiation" disabled,
  *  due to the different sampling formats, you can hear horrible sounds,
  *  and even harm your speakers/headphones(/ears!), 
  *  so please, DON'T disable it unless you know exactly what you are doing!
  *	
  ***************************************************************************

PS: when peers connect you may notice some redundant "audio settings negotiation"
    notification in the bottom log: this is due to double check on connection
	initialization (peers audio cards could not support all the same configurations...)
    After connection is established only one message for configuration change is sent.

Licence
=======
GNU General Public License version 3 (see LICENSE.txt).


Developing
==========
- OS X/iOS: 
  Source, with minimal modifications, should build also to OS X and iOS, but
  I've no way to test it, so if you are interested to try, please contact me;