= Ariba VLC Plugin - Overlay-based Videostreaming using Ariba and MCPO Application Layer Multicast = 


NOTE! This text is currently under development. Please do not rely on completeness or even correctness of the following content.

== User Guide == 

=== What is the VLC-MCPO plugin? ===
The vlc-mcpo plugin is an (not yet) open source streaming module for the vlc-mediaplayer (http://www.videolan.org). It comes with a sender and a receiver module. And is able to handle any kind of stream, vlc can deal with.

The plugin uses the mcpo multicast protocol, which is part of the ariba framework.

Ariba provides a virtual overlay net. [...]

For more information about ariba or the SpoVNet project, please refer to: http://www.ariba-underlay.org/, http://www.spovnet.de/


=== Setting up / installing ===
The ariba framework is currently only available on linux and therefor the plugin is linux-only at the moment.

A quick and simple way for testing but also useing the plugin are the precompiled libraries. In this section we describe how to set up an ubuntu 10.04 for this purpose. This should be adoptable to other linux distributions in an easy manner. Instructions how to compile the plugin will be provided in the Developers Guide below.

For running the vlc-mcpo plugin a number of packages have to be installed:

sudo apt-get install vlc [[BR]]
sudo apt-get install libboost-system1.40.0 [[BR]]
sudo apt-get install libboost-thread1.40.0 [[BR]]
sudo apt-get install libboost-regex1.40.0 [[BR]]
sudo apt-get install liblog4cxx10 [[BR]]
sudo apt-get install libdb4.7

Please download the tar-ball containing the required libraries:
32bit linux: [ coming soon ]
64bit linux: [ coming soon ]

Unpack the archive to $HOME. (If you choose another location, you have to adjust the path in the running script.)

Now you can link the running-script to $HOME/bin or /usr/bin via: [[BR]]
cd $HOME/bin [[BR]]
ln -s $HOME/vlc-mcpo/run.sh vlc-mcpo

Or just run from where it is.

(Note: If you just created the $HOME/bin folder, you have to start a new bash.)
(Note: The following instructions assume you created one of links described above.)


=== A first test: ===
Now it's time for a first simple test.

Run two instanced of the modified vlc-players:[[BR]]
° LANG=en_US.UTF-8 vlc-mcpo & LANG=en_US.UTF-8 vlc-mcpo & [[BR]]
(Note: "LANG=en_US.UTF-8" sets the language of these two vlc-instances on English for easier following the instructions below.)


Two vlc-windows should open, let's call them [S] and [R].

° On [R] please click: Media > Open Network Stream... [[BR]]
° Then choose: Protocol: »MCPO« (Note: If you can only see protocols like: HTTP, HTTPS, UDP, etc but no MCPO then the plugin wasn't load into your vlc. Please refer to the trouble shooting section in this case.) [[BR]]
° The address field should now look like this: 1234:localhost:5000 [[BR]]
° Press »play«.

° Continuing on [S], click: Meda > Streaming... [[BR]]
° Add a video file. (For a first test we recommend the test-video [coming soon], or at least a video you're successfully able to stream via UDP. Just eliminate sources of error not connected to the vlc-mcpo plugin.) [[BR]]
° Press »Stream«. [[BR]]
° Press »Next«. [[BR]]
° Choose »MCPO« and press »Add«. [[BR]]
° Now you can see: Source: Port: 5000; Destination: Address: localhost, Port: 1234 [[BR]]
° Disable transcoding and press »Stream«. [[BR]]
° After a few seconds you should see the video in [R].


=== Usage ===
In this section we describe the parameters of the mcpo-vlc plugin and some usage scenarios which demonstrate the strength of the mcpo approach.

Vlc-mcpo uses a spontaneous virtual network (SpoVNet) for distributing the video content. Each SpoVNet have to consist of 0-1 senders and 0-N receivers. The connection procedure does not depend on the role (sender/receiver) one instance has. This could be a little bit confusion in the beginning, as on most streaming protocols the role defines whether one instance is client or server.

==== Creating a SpoVNet ====


==== Parameters ====
The vlc-mcpo plugin takes three connection parameters. source-port:destination-address:destination-port (e.g. 1234:localhost:5000)

The source-port provides an interface for other instances to connect to this instances.

[...]

==== Examples / Scenarios ====



=== Trouble shooting ===



== Developer Guide ==