Commit 2fe6af00 authored by Felix Paul Kühne's avatar Felix Paul Kühne

* Redesigned the XML-layout and fixed mistakes in the output-layout

parent b480efd6
......@@ -6,8 +6,8 @@
Download the ZIP file from the <ulink
url="http://www.videolan.org/streaming/download-vls-windows.html">VLS
Windows download page</ulink>, unzip-it and run
<filename>setup.exe</filename>
.</para>
<filename>setup.exe</filename>.
</para>
</sect2>
......@@ -37,22 +37,22 @@ if you want to be able to stream DVDs
<listitem><para><emphasis>libdvb</emphasis>
if you want to be able to stream from a DVB card (a
satellite card or a digital terrestial TV card)
.</para></listitem>
satellite card or a digital terrestial TV card).
</para></listitem>
</itemizedlist>
<para>
Download the libraries from the <ulink
url="http://www.videolan.org/streaming/download-vls-sources.html">VLS
sources download page</ulink>
.</para>
sources download page</ulink>.
</para>
<para>
For each library, uncompress, configure
(unless for <emphasis>libdvb</emphasis> which doesn't have a
<emphasis>./configure</emphasis>), compile and install
:</para>
<emphasis>./configure</emphasis>), compile and install:
</para>
<screen>
<prompt>% </prompt><userinput>tar xvzf library.tar.gz</userinput>
......@@ -64,15 +64,15 @@ For each library, uncompress, configure
<para>
On GNU/Linux, check that the configuration file
<filename>/etc/ld.so.conf</filename> contains the following line
:</para>
<filename>/etc/ld.so.conf</filename> contains the following line:
</para>
<programlisting>
/usr/local/lib
</programlisting>
<para>
If the line is not present, add-it and then run
:</para>
If the line is not present, add-it and then run:
</para>
<screen>
<prompt># </prompt><userinput>ldconfig</userinput>
......@@ -97,8 +97,8 @@ Download the sources of the latest release : get
the file <filename>vls-version.tar.gz</filename> from the <ulink
url="http://www.videolan.org/streaming/download-vls-sources.html">VLS
sources download page</ulink>. Uncompress-it and generate
<emphasis>./configure</emphasis>
:</para>
<emphasis>./configure</emphasis>:
</para>
<screen>
<prompt>% </prompt><userinput>tar xvzf vls-version.tar.gz</userinput>
......@@ -114,8 +114,8 @@ To get the list of configuration options, do
</screen>
<para>
Then configure VLS
:</para>
Then configure VLS:
</para>
<itemizedlist>
......@@ -131,8 +131,8 @@ m
</listitem>
<listitem><para>
if you want a VLS with DVD support, do
:</para>
if you want a VLS with DVD support, do:
</para>
<screen>
<prompt>% </prompt><userinput>./configure</userinput>
......@@ -141,8 +141,8 @@ if you want a VLS with DVD support, do
</listitem>
<listitem><para>
if you want a VLS with DVB support, do
:</para>
if you want a VLS with DVB support, do:
</para>
<screen>
<prompt>% </prompt><userinput>./configure --enable-dvb --with-dvb=PATH_TO_DVB_DRIVERS --with-libdvb=PATH_TO_LIBDVB</userinput>
......@@ -153,8 +153,8 @@ if you want a VLS with DVB support, do
</itemizedlist>
<para>
Then, compile and install
:</para>
Then, compile and install:
</para>
<screen>
<prompt>% </prompt><userinput>make</userinput>
......@@ -163,8 +163,8 @@ Then, compile and install
<para>
You can also do a <command>make uninstall</command>,
<command>make clean</command> or <command>make distclean</command> as needed
.</para>
<command>make clean</command> or <command>make distclean</command> as needed.
</para>
</simplesect>
......
......@@ -10,8 +10,6 @@ What is the VideoLAN project ?
<sect2><title>
Overview
</title>
<para>VideoLAN is a complete software solution for video streaming, developed
by students of the <ulink url="http://www.ecp.fr">Ecole Centrale
Paris</ulink> and developers from all over the world, under the
......@@ -19,33 +17,21 @@ Paris</ulink> and developers from all over the world, under the
License</ulink> (GPL). VideoLAN is designed to stream MPEG videos on high
bandwidth networks.</para>
<para>The VideoLAN solution includes :</para>
<para>The VideoLAN solution includes:</para>
<itemizedlist>
<listitem><para>VLS (VideoLAN Server), which can stream MPEG-1, MPEG-2
and MPEG-4 files, DVDs, digital satellite channels, digital terrestial
television channels and live videos on the network in unicast or
multicast,</para></listitem>
<listitem><para>VLC (initially VideoLAN Client), which can be used as
a server to stream MPEG-1, MPEG-2 and MPEG-4 files, DVDs and live
videos on the network in unicast or multicast ; or used as a client
to receive, decode and display MPEG streams under multiple operating
systems.</para></listitem>
</itemizedlist>
<para>Here is an illustration of the complete VideoLAN solution :</para>
<para>Here is an illustration of the complete VideoLAN solution:</para>
<figure><title>
Global VideoLAN solution
</title>
......@@ -56,8 +42,6 @@ Global VideoLAN solution
</imageobject>
</mediaobject>
</figure>
<para>More details about the project can be found on the <ulink
url="http://www.videolan.org/">VideoLAN Web site</ulink>.</para>
......@@ -68,84 +52,52 @@ VideoLAN software
</title>
<simplesect><title>VLC</title>
<para>VLC works on many platforms : Linux, Windows, Mac OS X, BeOS,
*BSD, Solaris, Familiar Linux, Yopy/Linupy and QNX. It can read :</para>
<para>VLC works on many platforms: Linux, Windows, Mac OS X, BeOS,
*BSD, Solaris, Familiar Linux, Yopy/Linupy and QNX. It can read:</para>
<itemizedlist>
<listitem><para>MPEG-1, MPEG-2 and MPEG-4 / DivX files from a hard disk,
a CD-ROM drive, ...</para></listitem>
<listitem><para>DVDs and VCDs,</para></listitem>
<listitem><para>from a satellite card (DVB-S),</para></listitem>
<listitem><para>MPEG-1, MPEG-2 and MPEG-4 streams from the
network sent by VLS or VLC's stream output.</para></listitem>
</itemizedlist>
<para>
VLC can also be used as a server to stream :
VLC can also be used as a server to stream:
</para>
<itemizedlist>
<listitem><para>MPEG-1, MPEG-2 and MPEG-4 / DivX files,</para></listitem>
<listitem><para>DVDs,</para></listitem>
<listitem><para>from an MPEG encoding card,</para></listitem>
</itemizedlist>
<para>
to :
to:
</para>
<itemizedlist>
<listitem><para>one machine (i.e. to one IP address) : this is called
<listitem><para>one machine (i.e. to one IP address): this is called
<emphasis>unicast</emphasis>,</para></listitem>
<listitem><para>a dynamic group of machines that the clients can
join or leave (i.e. to a multicast IP address) : this is called
join or leave (i.e. to a multicast IP address): this is called
<emphasis>multicast</emphasis>,</para></listitem>
</itemizedlist>
<para>in IPv4 or IPv6
.</para>
<para>To get the complete list of VLC's possibilities
on each plateform supported, see the <ulink
url="http://www.videolan.org/vlc/features.html">VLC features
page</ulink>.</para>
<note><para>
VLC doesn't work on Mac OS 9, and will
probably never do.
......@@ -156,7 +108,7 @@ probably never do.
<simplesect><title>VLS</title>
<para>
VLS can stream :
VLS can stream:
</para>
<itemizedlist>
......@@ -187,38 +139,26 @@ to
:</para>
<itemizedlist>
<listitem><para>one machine (i.e. to one IP address) : this is called
<listitem><para>one machine (i.e. to one IP address): this is called
<emphasis>unicast</emphasis>,</para></listitem>
<listitem><para>a dynamic group of machines that the clients can
join or leave (i.e. to a multicast IP address) : this is called
join or leave (i.e. to a multicast IP address): this is called
<emphasis>multicast</emphasis>,</para></listitem>
</itemizedlist>
<para>
in IPv4 or IPv6
.</para>
<para>A Pentium 100 MHz with 32 MB of memory should be enough to send one
stream on the network. When streaming a lot of videos stored on a
hard drive, the actual limitation is not the processor but the hard
drive and the network connection.</para>
<para>VLS works under Linux and Windows. To get the complete
list of VLS's possibilities on each plateform supported, see the <ulink
url="http://www.videolan.org/streaming/features.html">streaming features
page</ulink>.</para>
</simplesect>
<simplesect><title>Mini-SAP-server</title>
......@@ -256,7 +196,7 @@ Documentation
</title>
<para>
The user documentation of VideoLAN is made up of 4 documents :
The user documentation of VideoLAN is made up of 4 documents:
</para>
<itemizedlist>
......@@ -305,7 +245,7 @@ If you have problems using VideoLAN, and if you don't find the
answer to your problems in the documentation, please look at the <ulink
url="http://www.via.ecp.fr/via/ml/videolan/index-en.html">online
archive of the mailing-lists</ulink>. There are two English-speaking
mailing-lists for the users :
mailing-lists for the users:
</para>
......@@ -331,7 +271,7 @@ mailing-list page</ulink>.
</para>
<para>
You can also talk with VideoLAN users and developers on IRC :
You can also talk with VideoLAN users and developers on IRC:
server <emphasis>irc.freenode.net</emphasis>, channel
<emphasis>#videolan</emphasis>
.</para>
......@@ -350,8 +290,6 @@ Command line usage
</title>
<itemizedlist>
<listitem><para>
VLC has many different graphical interfaces, that
......@@ -386,7 +324,7 @@ Open a terminal
<para>
Click on <emphasis>Start</emphasis>,
<emphasis>Run</emphasis> and type :
<emphasis>Run</emphasis> and type:
</para>
<itemizedlist>
......@@ -422,7 +360,7 @@ program is installed to run it.
<para>
Open a terminal
:</para>
:</para>
<figure><title>Linux X terminal</title>
<mediaobject>
......@@ -434,14 +372,14 @@ Open a terminal
<para>
In the documentation, we adopt the following
conventions for the Unix commands :
conventions for the Unix commands:
</para>
<itemizedlist>
<listitem><para>
commands that should be typed as
<emphasis>root</emphasis> have a <command>#</command> prompt :
<emphasis>root</emphasis> have a <command>#</command> prompt:
</para>
<screen>
......@@ -452,7 +390,7 @@ commands that should be typed as
<listitem><para>
commands that should be typed as a regular user have a
<command>%</command> prompt :
<command>%</command> prompt:
</para>
<screen>
......@@ -472,7 +410,7 @@ commands that should be typed as a regular user have a
Go to <emphasis>Applications</emphasis>, open the
folder <emphasis>Utilities</emphasis> and double-click on
<emphasis>Terminal</emphasis>
:</para>
:</para>
<figure><title>Mac OS X terminal</title>
<mediaobject>
......@@ -485,8 +423,8 @@ folder <emphasis>Utilities</emphasis> and double-click on
<note><para>
Under Mac OS X, you need to be in the directory where
the program is installed to run it, and start the command with
<command>./</command>
.</para></note>
<command>./</command>.
</para></note>
</simplesect>
......@@ -494,7 +432,7 @@ the program is installed to run it, and start the command with
<para>
In the deskbar, go to <emphasis>Application</emphasis> and then
<emphasis>Terminal</emphasis> :
<emphasis>Terminal</emphasis>:
</para>
<figure><title>BeOS terminal</title>
......
......@@ -3,8 +3,6 @@
<chapter id="sap"><title id="tsap">
Add a channel information service
</title>
<para>Typing multicast addresses is not very fun... that's why you need
a channel information service ! VideoLAN has implemented a channel
information service based on the SAP/SDP standard. The SAP announces
......@@ -13,14 +11,10 @@ address <emphasis>224.2.127.254</emphasis> reserved for this purpose).
On the client side, VLCs receive these annouces and automatically add
the programs announced to their playlist.</para>
<para>VLC can send the SAP announces associated with the programs
it is streaming. VLS can't do that, but an independant program, the
mini-SAP-server, can send the announces for the programs sent by
VLS.</para>
<sect1><title>
Send announces when streaming with VLC
</title>
......@@ -33,8 +27,6 @@ VLC's stream output, like this:
<screen>
<prompt>% </prompt><userinput>vlc -vvv input_stream --sout '#standard{access=udp,url=239.255.12.42,sap="Test Stream"}' --ttl 12</userinput>
</screen>
<para>where <filename>video1.xyz</filename> is the file you want
to stream, <emphasis>239.255.12.42</emphasis> is the multicast IP
address you want to stream on, <emphasis>Test Stream</emphasis> is
......@@ -42,8 +34,6 @@ the name that will be used for this program in the SAP announces and
<emphasis>12</emphasis> is the value of the TTL (Time To Live) of the
stream and of the SAP announces.</para>
<para>
To do the SAP announces in IPv6, just add the
<emphasis>sap_ipv=6</emphasis> option:
......@@ -59,8 +49,6 @@ To do the SAP announces in IPv6, just add the
Send announces for the programs streamed by VLS with the
mini-SAP-server
</title>
<note><para>
The mini-SAP-server is only available for Linux and Mac OSX.
</para></note>
......@@ -68,8 +56,6 @@ The mini-SAP-server is only available for Linux and Mac OSX.
<simplesect><title>
Install the mini-SAP-server
</title>
<para>
Download the latest version of the mini-SAP-server from the <ulink
url="http://www.videolan.org/streaming/">streaming download page</ulink>.
......@@ -91,8 +77,6 @@ Install-it:
<simplesect><title>
Configure the mini-SAP-server
</title>
<para>Edit the configuration file <filename>sap.cfg</filename> shipped
with the tarball. It should contain a global section with the Time To
Live (TTL) and the IP version (IPv4 or IPv6) used for the SAP announces
......@@ -101,8 +85,6 @@ parameter.</para>
<para>The Time To Live option indicates the maximum number of routers
that the SAP announce packets can cross before being dropped.</para>
</simplesect>
<simplesect><title>
......@@ -163,8 +145,6 @@ If the announces are sent in IPv6 :
</listitem>
</itemizedlist>
<para>Then open the playlist: you should see the names of the programs
announced in SAP. When you double-click on the name of a program,
VLC will subscribe to the multicast address and start to play the stream
......
......@@ -7,34 +7,34 @@ Description of the stream output
<para>
VLC's stream output allows VLC to be used as
a streaming server instead of a client ! It has very extended
capabilities
:</para>
capabilities:
</para>
<itemizedlist>
<listitem><para>
stream in unicast and multicast on an IPv4 or
IPv6 network everything that VLC is able to read, via UDP, RTP or
HTTP
;</para></listitem>
HTTP;
</para></listitem>
<listitem><para>
save the input stream to a file in AVI, PS, TS or
OGG format
;</para></listitem>
OGG format;
</para></listitem>
<listitem><para>
transcode an input stream, and then, send it, to the
network or to a file
.</para></listitem>
network or to a file.
</para></listitem>
</itemizedlist>
<para>
To know about the full possibilities of VLC's stream
output, see the <ulink url="http://www.videolan.org/streaming/features.html">
streaming features page</ulink>
.</para>
streaming features page</ulink>.
</para>
</sect2>
......@@ -46,61 +46,61 @@ Architecture and syntax
the stream output has a powerful architecture
that uses modules. Each module has capabilities, and you
can <emphasis>chain</emphasis> the modules to enhance the
possibilities
.</para>
possibilities.
</para>
<para>
Here is the list of the modules currently available
:</para>
Here is the list of the modules currently available:
</para>
<itemizedlist>
<listitem><para><emphasis>standard</emphasis>
"sends" the stream via an <emphasis>access
output</emphasis> module: for example, UDP, file, HTTP, ... You will
probably want to use this module at the end of your chains
.</para></listitem>
probably want to use this module at the end of your chains.
</para></listitem>
<listitem><para><emphasis>transcode</emphasis>
allows you to transcode the audio and the video
of the input stream "on the fly" (if your computer is powerful enough)
.</para></listitem>
of the input stream "on the fly" (if your computer is powerful enough).
</para></listitem>
<listitem><para><emphasis>duplicate</emphasis>
allows you to create a second chain, where the
stream will be handled in an independant way
.</para></listitem>
stream will be handled in an independant way.
</para></listitem>
<listitem><para><emphasis>display</emphasis>
allows you to display the input stream, as VLC
would normally do. Used with the <emphasis>duplicate</emphasis>
module, this allows you to view the stream as you send it
.</para></listitem>
module, this allows you to view the stream as you send it.
</para></listitem>
<listitem><para><emphasis>rtp</emphasis>
streams over RTP (one UDP port for each elementary stream)
.</para></listitem>
streams over RTP (one UDP port for each elementary stream).
</para></listitem>
<listitem><para><emphasis>es</emphasis>
allows you to make separate Elementary Streams (ES)
out of an input stream
.</para></listitem>
out of an input stream.
</para></listitem>
</itemizedlist>
<para>
Each of these modules may take options. Here is the
syntax that you must use
:</para>
syntax that you must use:
</para>
<screen>
<prompt>% </prompt><userinput>vlc input_stream --sout '#module1{option1=...,option2=...}:#module2{option1=...,option2=...}:...'</userinput>
</screen>
<para>
For example, to transcode a stream and send it, use
:</para>
For example, to transcode a stream and send it, use:
</para>
<screen>
<prompt>% </prompt><userinput>vlc input_stream --sout '#transcode{options}:#standard{options}'</userinput>
......@@ -115,20 +115,20 @@ Description of the modules
<sect3><title>standard (alias std)</title>
<para>
Sends a stream
.</para>
Sends a stream.
</para>
<para>
Options
:</para>
Options:
</para>
<itemizedlist>
<listitem><para><emphasis>access</emphasis>:
how to send:
<emphasis>file</emphasis>, <emphasis>udp</emphasis>,
<emphasis>rtp</emphasis>, <emphasis>http</emphasis>
.</para></listitem>
<emphasis>rtp</emphasis>, <emphasis>http</emphasis>.
</para></listitem>
<listitem><para><emphasis>mux</emphasis>:
which muxer (ie, which format) will be used. It can
......@@ -140,50 +140,50 @@ be one of
<emphasis>ps</emphasis>
(for MPEG2-PS format)
<emphasis>ts</emphasis>
(for MPEG2-TS format)
.</para></listitem>
(for MPEG2-TS format).
</para></listitem>
<listitem><para><emphasis>url</emphasis>:
if you use the
<emphasis>file</emphasis> access, it will be the location where to
store the stream; if you use another access, it will be the unicast or
multicast IP address where you want to stream
.</para></listitem>
multicast IP address where you want to stream.
</para></listitem>
<listitem><para><emphasis>sap</emphasis>:
if you use the <emphasis>udp</emphasis> or
<emphasis>rtp</emphasis> accesses, use this option to announce your
stream, using SAP/SDP. This option contains the name under which you
want to announce the program
.</para></listitem>
want to announce the program.
</para></listitem>
<listitem><para><emphasis>slp</emphasis>:
like sap, but use the SLP protocol. You need
to have libslp on your system
.</para></listitem>
to have libslp on your system.
</para></listitem>
<listitem><para><emphasis>sap_ipv</emphasis>:
if you use the <emphasis>sap</emphasis> option,
use this option to specify if you want to send the SAP announces in
IPv4 or IPv6. The value of this option is <emphasis>4</emphasis> or
<emphasis>6</emphasis>
.</para></listitem>
<emphasis>6</emphasis>.
</para></listitem>
</itemizedlist>
<note><para>
If you are streaming in multicast, you may want to
use the global option <command>--ttl 12</command> to set the TTL to a
value superior to 1
.</para></note>
value superior to 1.
</para></note>
</sect3>
<sect3><title>display</title>
<para>
Displays the stream
.</para>
Displays the stream.
</para>
<para>
Options:
......@@ -192,12 +192,12 @@ Options:
<itemizedlist>
<listitem><para><emphasis>noaudio</emphasis>:
Ignore audio
.</para></listitem>
Ignore audio.
</para></listitem>
<listitem><para><emphasis>novideo</emphasis>:
Ignore video
.</para></listitem>
Ignore video.
</para></listitem>
</itemizedlist>
......@@ -206,8 +206,8 @@ Ignore video
<sect3><title>duplicate</title>
<para>
Duplicates the stream to a new stream output chain
.</para>
Duplicates the stream to a new stream output chain.
</para>
<para>
Options:
......@@ -217,8 +217,8 @@ Options:
<listitem><para><emphasis>dst</emphasis>:
A new stream output chain of modules, as described
earlier
.</para></listitem>
earlier.
</para></listitem>
</itemizedlist>
......@@ -227,8 +227,8 @@ earlier
<sect3><title>transcode</title>
<para>
Changes the codec and/or bitrates for a stream
.</para>
Changes the codec and/or bitrates for a stream.