= Media Concept =

[[TracNav(Python_SIP/TOC)]]


== Media Objects ==

Media objects are objects that are capable to process media. In [http://www.pjsip.org/pjmedia/docs/html/index.htm PJMEDIA] terms, these objects re implemented as media ports (or [http://www.pjsip.org/pjmedia/docs/html/group__PJMEDIA__PORT.htm pjmedia_port]). 

There are several type of media objects supported in pjsua:
 * call, obviously, to transmit and receive media from remote person.
 * WAV file player to play WAV file
 * WAV file recorder to record audio to a WAV file
 * WAV playlist, to playback multiple WAV files sequentially.

More media objects may be added in the future.

== The Conference Bridge ==

In pjsua Python module and in [http://www.pjsip.org/pjsip/docs/html/group__PJSUA__LIB.htm PJSUA API] in general, all media objects are terminated in the central conference bridge so that they are easier to manipulate. When objects are plugged-in to the conference bridge, they will be given a ''slot number'' that identifies the objects in the bridge.

Each object provides different API to fetch the slot number associated with it:
 * for [http://www.pjsip.org/python/pjsua.htm#Call Call] object, the slot number is in the [http://www.pjsip.org/python/pjsua.htm#CallInfo CallInfo] structure, so it can be fetch with {{{call.info().conf_slot}}} (once the media is active of course).
 * for WAV file player, use [http://www.pjsip.org/python/pjsua.htm#Lib-player_get_slot lib.player_get_slot()]
 * for WAV playlist, use [http://www.pjsip.org/python/pjsua.htm#Lib-playlist_get_slot lib.playlist_get_slot()]
 * for WAV file recorder, use [http://www.pjsip.org/python/pjsua.htm#Lib-recorder_get_slot lib.recorder_get_slot()]


The conference bridge provides a simple but yet powerful API to manage audio routing between the audio objects. The principle is very simple, that is you connect audio source to audio destination, and the bridge will make the audio flows from the source to destination, and that's it. If more than one sources are transmitting to the same destination, then the audio will be mixed. If one source is transmitting to more than one destinations, the bridge will take care of duplicating the audio from the source to the multiple destinations.

Lets see a diagram of a conference bridge with several media objects.

[[Image(conference-bridge.jpg)]]

The diagram above shows the conference bridge with the following objects:
 * sound device, which by convention is always attached at slot number 0
 * a WAV file to be played back at slot 1
 * a WAV file for recording at slot 2
 * an active call to Alice at slot 3
 * an active call to Bob at slot 4

When a media object is plugged-in to the bridge, it will not be connected to anything, so media will not flow from/to the object. When no connections are made in the bridge (like the diagram above), then no media will be flowing in the bridge at all.

=== Sample: WAV File Playback ===

To playback the WAV file to the speaker, just connect the WAV playback object to the sound device, with the snippet below:

[[Image(conference-bridge-wav-playback.jpg)]]

The red line in the diagram above shows the media flow from the WAV playback object to the sound device.

Here's the code to connect the WAV playback object to the speaker:

 {{{
#!python
  lib.conf_connect(1, 0)
 }}}

The [http://www.pjsip.org/python/pjsua.htm#Lib-conf_connect conf_connect()] method takes two arguments: 
 * the first argument is the slot number of the source media object, in this case one (1) for the WAV file playback, and 
 * the second argument is the slot number of the destination media object, in this case zero for the sound device

Once you're done with the playback, just disconnect the connection to stop the playback:

 {{{
#!python
  lib.conf_disconnect(1, 0)
 }}}


=== Sample: Recording to WAV File ===

Or if you want to record the microphone to the WAV file, simply do this:

 {{{
#!python
  lib.conf_connect(0, 2)
 }}}

And the media will flow from the sound device to the WAV record file, as shown as brown line in the diagram below:

[[Image(conference-bridge-snd-rec.jpg)]]

As usual, to stop or pause recording, just disconnect the connection:

 {{{
#!python
  lib.conf_disconnect(0, 2)
 }}}

(Note that disconnecting the WAV recorder as above does not close the WAV file, and you can resume recording by connecting a source to the WAV recorder again. You cannot playback the recorded WAV file before you close it.)


=== Sample: Normal Call ===

For a normal call, we would want to establish bidirectional audio with the remote person (with Alice, in this case), which can be done easily by connecting the sound device and the call and vice versa:

 {{{
#!python

 # This will connect the sound device/mic to the call
 lib.conf_connect(0, 3)

 # And this will connect the call to the sound device/speaker
 lib.conf_connect(3, 0)
 }}}

Of course on a real application, you would replace the number "3" above with the slot number of the call, which you can get with {{{call.info().conf_slot}}}.

The diagram below shows the interconnection in the bridge now:

[[Image(conference-bridge-call.jpg)]]


=== Sample: Second Call ===

Suppose we want to talk with Alice and Bob at the same time. Since we already have bidirectional media connection with Alice, we just need to add  bidirectional connection with Bob using the code below.

 {{{
#!python

  lib.conf_connect(0, 4)
  lib.conf_connect(4, 0
 }}}

The interconnection diagram in the bridge will be like this, with the code above adds the blue lines below:

[[Image(conference-bridge-2-calls.jpg)]]

Now we can talk to Alice and Bob at the same time, and we will hear audio from either party. But at this stage, Alice and Bob can't talk or hear each other (i.e. we're not in full conference mode yet).

=== Sample: Conference Call ===

To make Alice and Bob talk to each other, just establish bidirectional media between them:

 {{{
#!python

 lib.conf_connect(3, 4)
 lib.conf_connect(4, 3)
 }}}

The snippet above will add the new connections as shown as black lines below:

[[Image(conference-bridge-conf-call.jpg)]]

Now the three parties (us, Alice, and Bob) will be able to talk to each other.

=== Sample: Recording the Conference ===

While doing the conference, it perfectly makes sense to want to record the conference to a WAV file, and all we need to do is to connect the microphone and both calls to the WAV recorder:

 {{{
#!python

 lib.conf_connect(0, 2)
 lib.conf_connect(3, 2)
 lib.conf_connect(4, 2)
 }}}

The connections in the conference bridge now will look like the diagram below, with the snippet above adds the brown lines in the diagram:

[[Image(conference-bridge-conf-call-record.jpg)]]

That looks like a pretty intricate connections indeed, but the good thing is we don't need to worry about it as all will be taken care of by the bridge. We only need to care about what the audio routings that we want to achieve.