ICEBERG v1 Documentation: VAT IAP

This document describes the specifics of the VAT IAP. For a general description of an IAP, refer iap.html.

The VAT IAP is an ICEBERG front-end (or proxy if you will) to the VAT audio conferencing tool.

The specifics of the VAT IAP are as follows:

• It has a Java Swing GUI. The GUI isn't great and there are probably better ways of doing it. But it is okay for basic functionality.
• It implements only outgoing DTMF since incoming DTMF makes no sense to the end user. (Note: ICEBERG-v1 does not implement DTMF. The Call-Agent has to modified to provide this functionality -- an additional message has to be defined to go from one call-agent to another. Then, DTMFListener.java has to be modified appropriately).
• It can operate with vat using one of two data formats: gsm or pcm-ul-8000. (These the two data formats supported by the APC -- of course, this list can be extended).
• It supports only a single session at a time. A functionality that would be trivial to add would be to notify the user of an incoming call (when a call is already in place) and allow the user to hang up the current call, and accept the incoming call.

The GUI

• Enter the callee's email address (Iceberg unique-id) and press "Connect" to establish a call.
• Press "Disconnect" to terminate call.
• On incoming call, press "accept call" within 15 seconds to accept the call.

The files

• Vat_Iap.java is the main file. It implements the UI_IF interface (see iap.html).
• ConnectListener.java implements outgoing call establishments.
• DisconnectListener.java implements outgoing call terminations.
• DTMFListener.java implements outgoing DTMF tones (not used in ICEBERG-v1).
• vat_iap_cs_class.java -- the call state associated with a session.
• vat_iap_call_state.java -- wrapper around vat_iap_cs_class -- to atomically check and change session state.

The operator iceberg1/APCpath/operators/VatOp.java implements the operator. The very similar operator iceberg1/APCpath/operators/VatPCMOp.java is used when the audio data format to be used at the IAP is the PCM codec and not the GSM codec. The operators simply exec's vat and waits on it. Note: vatrec is exec'ed instead of vat when the IAP gets the remote IP address as "127.0.0.1" or "0.0.0.0". This happens when the VAT IAP end only receives data and does not send any data (e.g., when listening to songs from the Jukebox). That is, the forward path does not involve any transcoding. The APC does not tell the IAP of the source IP address of the data in these cases. This is a limitation of the current implementation. The program "vatrec" is exec'ed in these cases since vat needs to be given a specific IP address from which to receive data (vat does a bind to a specific IP address -- at least in Linux, vatrec does not).

Running the IAP

The IAP should be run as follows:

java iceberg1.nvsme.Main demo1-vat-iap-bhaskar.cfg

An example configuration file is demo1-vat-iap-bhaskar.cfg. Be sure to check the "smSpec" and "uiCfgFile" parameters. Note: the "uiCfgFile" is not really a file -- its just a configuration string -- the name comes from the original implementation of the IPPhone IAP. The first string in the "uiCfgFile" parameter value gives the codec format to be used by VAT. And the second string gives the uniqueID of the user running the VAT IAP.

The codec format is one of "gsm" or "pcm-ul-8000". VAT is run with "gsm" format or PCM U-Law 8kHz when given those arguments, respectively.

I had to modify vat a wee-bit to make things work. The original vat strictly runs with RTP data on an even port, and RTCP control on the next odd port. This happens even when you give an odd port as a command-line argument. This restriction created problems when the APC chose ports that were odd. Modifying APC to work-around this seemed less appropriate because of two reasons: (a) it required too much change, and (b) it is a hack to get around a specific restriction. Hence I changed vat to allow operation with odd data ports as well. Here's the change I made to the "vat" TCL script (you can find this by typing "which vat"):

In procedure "AddressBlock instproc data-port", replace the "return [expr $p &~ 1]" with "return $p". Do the same in the procedure "AddressBlock/RTP instproc data-port" as well.