2003-02-10 14:48:00 +00:00
|
|
|
<chapter id="intro"><title id="tintro">Introduction</title>
|
|
|
|
|
|
|
|
<sect1><title>What is the VideoLAN project ?</title>
|
|
|
|
|
|
|
|
<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
|
|
|
|
<ulink url="http://www.gnu.org/copyleft/gpl.html">GNU General Public
|
|
|
|
License</ulink> (GPL). VideoLAN is designed to stream MPEG videos on high
|
|
|
|
bandwidth networks.
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2003-04-28 14:58:42 +00:00
|
|
|
<para>The VideoLAN solution includes :</para>
|
2003-02-10 14:48:00 +00:00
|
|
|
|
|
|
|
<itemizedlist>
|
|
|
|
|
2003-04-28 14:58:42 +00:00
|
|
|
<listitem><para>the VideoLAN Server (VLS), 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>
|
2003-02-10 14:48:00 +00:00
|
|
|
|
|
|
|
<listitem><para>the VideoLAN Client (VLC), which can be used as a server
|
2003-04-28 14:58:42 +00:00
|
|
|
to stream MPEG-1, MPEG-2 and MPEG-4 files and DVDs on the network in
|
|
|
|
unicast or multicast ; or used as a client to receive, decode and
|
|
|
|
display MPEG streams under multiple operating systems.</para>
|
2003-02-10 14:48:00 +00:00
|
|
|
|
|
|
|
</itemizedlist>
|
|
|
|
|
2003-04-28 14:58:42 +00:00
|
|
|
<para>Here is an illustration of the complete VideoLAN solution :</para>
|
2003-02-10 14:48:00 +00:00
|
|
|
|
|
|
|
<figure><title>Global VideoLAN solution</title>
|
|
|
|
<mediaobject>
|
|
|
|
<imageobject>
|
|
|
|
<imagedata fileref="plan-videolan-640.&magic;" format="&magic;" scalefit="1" scale="60">
|
|
|
|
</imageobject>
|
|
|
|
</mediaobject>
|
|
|
|
</figure>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
More details about the project can be found on the
|
2003-04-28 14:58:42 +00:00
|
|
|
<ulink url="http://www.videolan.org/">VideoLAN Web site</ulink>.
|
2003-02-10 14:48:00 +00:00
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<sect2><title>VideoLAN software</title>
|
|
|
|
|
|
|
|
<simplesect><title>VideoLAN Client</title>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
The VideoLAN Client (VLC) works on many platforms : Linux, Windows, Mac
|
2003-04-28 14:58:42 +00:00
|
|
|
OS X, BeOS, *BSD, Solaris, Familiar Linux, Yopy/Linupy and QNX. It can
|
|
|
|
read :
|
2003-02-10 14:48:00 +00:00
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<itemizedlist>
|
|
|
|
|
2003-04-28 14:58:42 +00:00
|
|
|
<listitem><para>MPEG-1, MPEG-2 and MPEG-4 / DivX files from a hard disk
|
2003-02-10 14:48:00 +00:00
|
|
|
or a CD-ROM drive,</para>
|
|
|
|
|
|
|
|
<listitem><para>DVDs and VCDs,</para>
|
|
|
|
|
|
|
|
<listitem><para>from a satellite card,</para>
|
|
|
|
|
2003-04-28 14:58:42 +00:00
|
|
|
<listitem><para>MPEG-1, MPEG-2 and MPEG-4 streams from the
|
2003-02-10 14:48:00 +00:00
|
|
|
network sent by VLS or VLC's stream output.</para>
|
|
|
|
|
|
|
|
</itemizedlist>
|
|
|
|
|
|
|
|
<para>VLC can also be used as a server to stream :</para>
|
|
|
|
|
|
|
|
<itemizedlist>
|
|
|
|
|
2003-04-28 14:58:42 +00:00
|
|
|
<listitem><para>MPEG-1, MPEG-2 and MPEG-4 / DivX files,</para>
|
2003-02-10 14:48:00 +00:00
|
|
|
|
|
|
|
<listitem><para>and DVDs,</para>
|
|
|
|
|
|
|
|
</itemizedlist>
|
|
|
|
|
|
|
|
<para>to :</para>
|
|
|
|
|
|
|
|
<itemizedlist>
|
|
|
|
|
|
|
|
<listitem><para>one machine (i.e. to one IP address) : this is called
|
|
|
|
<emphasis>unicast</emphasis> ;</para>
|
|
|
|
|
|
|
|
<listitem><para>a dynamic group of machines that the clients can join or leave
|
|
|
|
(i.e. to a multicast IP address) : this is called
|
|
|
|
<emphasis>multicast</emphasis>.</para>
|
|
|
|
|
|
|
|
</itemizedlist>
|
|
|
|
|
|
|
|
<note><para>VLC doesn't work on Mac OS 9, and will
|
|
|
|
probably never do.</para></note>
|
|
|
|
|
|
|
|
<simplesect><title>VideoLAN Server</title>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
The VideoLAN Server (VLS) can stream :
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<itemizedlist>
|
|
|
|
|
2003-04-28 14:58:42 +00:00
|
|
|
<listitem><para>an MPEG-1, MPEG-2 or MPEG-4 files stored on a hard drive or on a
|
2003-02-10 14:48:00 +00:00
|
|
|
CD,</para>
|
|
|
|
|
|
|
|
<listitem><para>a DVD located in a local DVD drive or copied on a hard
|
|
|
|
disk,</para>
|
|
|
|
|
2003-04-28 14:58:42 +00:00
|
|
|
<listitem><para>a satellite card or a digital terrestial television
|
|
|
|
card,</para>
|
2003-02-10 14:48:00 +00:00
|
|
|
|
|
|
|
<listitem><para>an MPEG encoding card ;</para>
|
|
|
|
|
|
|
|
</itemizedlist>
|
|
|
|
|
|
|
|
<para>to :</para>
|
|
|
|
|
|
|
|
<itemizedlist>
|
|
|
|
|
|
|
|
<listitem><para>one machine (i.e. to one IP address) : this is called
|
|
|
|
<emphasis>unicast</emphasis> ;</para>
|
|
|
|
|
|
|
|
<listitem><para>a dynamic group of machines that the clients can join or leave
|
|
|
|
(i.e. to a multicast IP address) : this is called
|
|
|
|
<emphasis>multicast</emphasis>.</para>
|
|
|
|
|
|
|
|
</itemizedlist>
|
|
|
|
|
|
|
|
<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>
|
|
|
|
|
2003-04-28 14:58:42 +00:00
|
|
|
VLS works under Linux and Mac OS X.
|
2003-02-10 14:48:00 +00:00
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<sect1><title>How can I use VideoLAN ?</title>
|
|
|
|
|
|
|
|
<sect2><title>The documentation</title>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
The user documentation of the VideoLAN project is composed of four documents :
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<itemizedlist>
|
|
|
|
|
|
|
|
<listitem><para>the <ulink
|
|
|
|
url="http://www.videolan.org/doc/videolan-quickstart/">VideoLAN
|
|
|
|
Quickstart</ulink>. This document will give you a quick overview of
|
2003-04-28 14:58:42 +00:00
|
|
|
of VLC, VLC's stream output, the Video On Demand
|
|
|
|
solution and the channel information service system.</para>
|
2003-02-10 14:48:00 +00:00
|
|
|
|
|
|
|
<listitem><para>the <ulink
|
|
|
|
url="http://www.videolan.org/doc/videolan-howto/">VideoLAN
|
|
|
|
HOWTO</ulink>. This document is the complete guide of the VideoLAN
|
|
|
|
streaming solution.</para>
|
|
|
|
|
|
|
|
<listitem><para>the <ulink
|
|
|
|
url="http://www.videolan.org/doc/vlc-user-guide/">VLC user
|
|
|
|
guide</ulink>. This document is the complete guide for VLC.</para>
|
|
|
|
|
|
|
|
<listitem><para>the <ulink
|
|
|
|
url="http://www.videolan.org/doc/faq-vlc/faq/">VLC FAQ</ulink>. This
|
|
|
|
document contains Frequently Asked Questions of VLC users.</para>
|
|
|
|
|
|
|
|
|
|
|
|
</itemizedlist>
|
|
|
|
|
2003-04-28 14:58:42 +00:00
|
|
|
<para>The latest version of these documents can be found on the <ulink
|
|
|
|
url="http://www.videolan.org/doc/">documentation page</ulink>.</para>
|
2003-02-10 14:48:00 +00:00
|
|
|
|
|
|
|
<sect2><title>User support</title>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
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/ml/videolan">online archive of the
|
|
|
|
mailing-lists</ulink>. There are two English-speaking mailing-lists for
|
|
|
|
the users :
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<itemizedlist>
|
|
|
|
|
|
|
|
<listitem><para><emphasis>vlc@videolan.org</emphasis> for the questions
|
|
|
|
on VLC,</para>
|
|
|
|
|
|
|
|
<listitem><para><emphasis>streaming@videolan.org</emphasis> for the questions
|
2003-04-28 14:58:42 +00:00
|
|
|
on VLS, mini-SAP-server and the network.</para>
|
2003-02-10 14:48:00 +00:00
|
|
|
|
|
|
|
</itemizedlist>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
If you want to subscribe or unsubscribe to the mailing-lists,
|
|
|
|
please go to the <ulink url="http://www.videolan.org/support/lists.html">
|
|
|
|
mailing-list page</ulink>.
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>You can also talk with VideoLAN users and developers on IRC :
|
|
|
|
server <emphasis>irc.freenode.net</emphasis>, channel
|
|
|
|
<emphasis>#videolan</emphasis>.</para>
|
|
|
|
|
|
|
|
<para>If you find a bug, please follow the instructions on the <ulink
|
|
|
|
url="http://www.videolan.org/support/bug-reporting.html">bug reporting
|
|
|
|
page</ulink>.</para>
|
|
|
|
|
|
|
|
<sect1><title>Convention</title>
|
|
|
|
|
2003-04-28 14:58:42 +00:00
|
|
|
<simplesect><title>Windows users</title>
|
|
|
|
|
|
|
|
<para>Some features are currently only available using
|
|
|
|
the command line interface of VLC. To run such commands, use the Windows
|
|
|
|
command line tool.</para>
|
|
|
|
|
|
|
|
<simplesect><title>Unix users</title>
|
|
|
|
|
|
|
|
<para>Unix systems users : in this document, we adopt the following
|
|
|
|
conventions for the Unix commands :</para>
|
2003-02-10 14:48:00 +00:00
|
|
|
|
|
|
|
<itemizedlist>
|
|
|
|
|
|
|
|
<listitem><para>commands that should be typed as
|
|
|
|
<emphasis>root</emphasis> have a <command>#</command> prompt :</para>
|
|
|
|
|
|
|
|
<screen>
|
|
|
|
<prompt># </prompt><userinput>command_to_be_typed_as_root</userinput>
|
|
|
|
</screen>
|
|
|
|
|
|
|
|
<listitem><para>commands that should be typed as a regular user have a
|
|
|
|
<command>%</command> prompt :</para>
|
|
|
|
|
|
|
|
<screen>
|
|
|
|
<prompt>% </prompt><userinput>command_to_be_typed_as_regular_user</userinput>
|
|
|
|
</screen>
|
|
|
|
|
|
|
|
</itemizedlist>
|