Changes between Version 32 and Version 33 of Documentation/VLC


Ignore:
Timestamp:
May 4, 2010, 2:15:45 PM (14 years ago)
Author:
Christoph Mayer
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Documentation/VLC

    v32 v33  
    1313
    1414=== Setting up / installing ===
    15 The ariba framework is currently only available on linux and therefor the plugin is linux-only at the moment.
    16 
    17 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.
     15The ariba framework is currently only available for Linux and therefor the plugin is linux-only at the moment.
     16
     17A quick and simple way for testing but also using 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 easily. Instructions how to compile the plugin will be provided in the Developers Guide below.
    1818
    1919For running the vlc-mcpo plugin a number of packages have to be installed:
    … …  
    323264bit linux: [ coming soon ]
    3333
    34 Unpack the archive to $HOME. (If you choose another location, you have to adjust the path in the running script.)
    35 
    36 Now you can link the running-script to $HOME/bin or /usr/bin via: [[BR]]
    37 cd $HOME/bin [[BR]]
     34Unpack the archive to {{{$HOME}}}. (If you choose another location, you have to adjust the path in the running script.)
     35
     36Now you can link the running-script to {{{$HOME/bin}}} or {{{/usr/bin}}} via: [[BR]]
     37{{{
     38cd $HOME/bin
    3839ln -s $HOME/vlc-mcpo/run.sh vlc-mcpo
     40}}}
    3941
    4042Or just run from where it is.
    4143
    42 (Note: If you just created the $HOME/bin folder, you have to start a new bash.)
     44(Note: If you just created the {{{$HOME/bin}}} folder, you have to start a new bash.)
    4345(Note: The following instructions assume you created one of links described above.)
    4446
    45 
    4647=== A first test: ===
     48
    4749Now it's time for a first simple test.
    4850
    49 Run two instanced of the modified vlc-players:[[BR]]
    50 ° LANG=en_US.UTF-8 vlc-mcpo & LANG=en_US.UTF-8 vlc-mcpo & [[BR]]
    51 (Note: "LANG=en_US.UTF-8" sets the language of these two vlc-instances on English for easier following the instructions below.)
    52 
     51Run two instances of the modified vlc-players:[[BR]]
     52{{{
     53LANG=en_US.UTF-8 vlc-mcpo & LANG=en_US.UTF-8 vlc-mcpo &
     54}}}
     55(Note: {{{LANG=en_US.UTF-8}}} sets the language of these two vlc-instances on English for easier following the instructions below.)
    5356
    5457Two vlc-windows should open, let's call them [S] and [R].
    5558
    56 ° On [R] please click: Media > Open Network Stream... [[BR]]
    57 ° 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]]
    58 ° The address field should now look like this: 1234:localhost:5000 [[BR]]
    59 ° Press »play«.
    60 
    61 ° Continuing on [S], click: Meda > Streaming... [[BR]]
    62 ° 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]]
    63 ° Press »Stream«. [[BR]]
    64 ° Press »Next«. [[BR]]
    65 ° Choose »MCPO« and press »Add«. [[BR]]
    66 ° Now you can see: Source: Port: 5000; Destination: Address: localhost, Port: 1234 [[BR]]
    67 ° Disable transcoding and press »Stream«. [[BR]]
    68 ° After a few seconds you should see the video in [R].
    69 
     59 * Server side [S]
     60  * On [R] please click: Media > Open Network Stream... [[BR]]
     61  * 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]]
     62  * The address field should now look like this: {{{1234:localhost:5000}}} [[BR]]
     63  * Press »play«.
     64 * Receiver side [R]
     65  * Continuing on [S], click: Meda > Streaming... [[BR]]
     66  * 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]]
     67  * Press »Stream«. [[BR]]
     68  * Press »Next«. [[BR]]
     69  * Choose »MCPO« and press »Add«. [[BR]]
     70  * Now you can see: Source: Port: 5000; Destination: Address: localhost, Port: 1234 [[BR]]
     71  * Disable transcoding and press »Stream«. [[BR]]
     72  * After a few seconds you should see the video in [R].
    7073
    7174=== Usage ===
    7275In this section we describe the parameters of the mcpo-vlc plugin and some usage scenarios which demonstrate the strength of the mcpo approach.
    7376
    74 Mcpo-vlc 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 can confuse a little in the beginning, as on most streaming protocols the role defines whether one instance is client or server.
    75 
     77Mcpo-vlc 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 can confuse a little in the beginning, as on most streaming protocols the role defines whether one instance is client or server.
    7678
    7779==== Parameters ====
    78 The mcpo-vlc plugin takes three connection parameters. source-port:destination-address:destination-port (e.g. 1234:localhost:5000)
    79 
    80 The ''source-port'' provides an entry point for other instances to the SpoVNet our instance is in (or will be in).
    81 To access this entry point ''destination address'' and ''destination port'' must be set on the ip-address (or domain name) and source-port of an instance in the targeted SpoVNet.
     80
     81The mcpo-vlc plugin takes three connection parameters. {{{source-port:destination-address:destination-port}}} (e.g. {{{1234:localhost:5000}}})
     82
     83The {{{source-port}}} provides an entry point for other instances to the SpoVNet our instance is in (or will be in).
     84To access this entry point {{{destination address}}} and {{{destination port}}} must be set on the IP address (or domain name) and {{{source-port}}} of an instance in the targeted SpoVNet.
    8285
    8386An instance which has not connected to such an entry point makes up a SpoVNet with only itself in it.
    8487
    85 
    8688==== Creating a SpoVNet ====
     89
    8790At first we need an initial SpoVNet, consisting of a single mcpo-vlc instance. This instance can either be server or client but must be accessible from (at least) the second instance. (Means, it mustn't be blocked by a firewall or NAT.) On the first instance we have to set the source-port. Destination-address and -port can be set but as long as there is no other instance listening there, setting this parameters has no effect.
    8891