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 #8 prototype!
Added: 
	- audio compression with opus codec
	- web helper service (this is a refactored version of the public-ip getter,
	  with added facilities i.e. version check; maybe in the next version I will
	  add some optional features, like 'register' and 'contacts').
	- history
	- audio 'over-clocking': to allow selecting unsupported sampling rates and
	  sizes (specifically: that supported by opus codec)
	- traffic counters
	- double buffering audio output
	- help documentation
and many others, besides some bug fixing.

Please note:
************
This is still a prototype, but version 1.0 is coming soon.
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" (a few dependencies may need to be
installed: work in progress to make the process easier).

--- Android ---
In order to setup the apk prototype 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!)
Please note:
************
The Android version is still an experimental porting, so many feature are not
properly working as I'm concentrating on the audio streaming.

Usage
=====

--- Line ---

* Receiver:
  - in the "Line" tab, "Receiver" section, select the local IP from the list 
    (NB: if present 127.0.0.1 is only for test purpose and should not be used);
  - specify a local port (better if >= 1024);
  - click the start-receiver button (on the top left) and wait for incoming call.
    NB: in order to receive incoming calls, it can be necessary configuring
        your router NAT to allow TCP and UDP stream to your local port.
  - let your peer to know your public IP and port (use your phone if necessary ;)
  - accept the incoming call
    NB: once connected the server is paused.
    
* As caller:
  - in the "Line" tab, "Call" section, put in the "Public IP" and "Public Port"
    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 ---

- Push the "mic" button to toggle the audio input state.
  If "push 2 talk" is checked the button need to be pressed while talking
  (you can use the <Ctrl> Key in your keyboard);
- Push the "headphones" button to toggle the audio output state.

--- 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 and SHOULD always be selected).
  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, and you don't
  set manually your audio settings accordingly, you can hear very bad sounds!


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