intro.xml 10.5 KB
Newer Older
Clément Stenac's avatar
Clément Stenac committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
<?xml version="1.0" encoding="iso-8859-1" ?>
<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>

<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>
<figure><title>
Global VideoLAN solution
</title>

<mediaobject>
  <imageobject>
    <imagedata fileref="images/global-diagram.jpg" format="JPG" scalefit="1" scale="60" />
  </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>

</sect2>

<sect2><title>
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>
<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:
</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:
</para>

<itemizedlist>
<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
<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.
</para></note>

</simplesect>

<simplesect><title>VLS</title>

<para>
 VLS can stream:
</para>

<itemizedlist>

<listitem><para>
an MPEG-1, MPEG-2 or MPEG-4 files stored on a hard drive
or on a CD,
</para></listitem>

<listitem><para>
a DVD located in a local DVD drive or copied on a hard
disk,
</para></listitem>

<listitem><para>
a satellite card (DVB-S) or a digital terrestial
television card (DVB-T)
,</para></listitem>

<listitem><para>
an MPEG encoding card
 ;</para></listitem>

</itemizedlist>

<para>
to
:</para>

<itemizedlist>
<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
<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>

<para>
You can add a channel information service based on the SAP/SDP
standard to the VideoLAN solution. The mini-SAP-server sends announces
about the multicast programs on the network in IPv4 or IPv6, and VLCs
receive these annouces and automatically add the programs announced to
their playlist.
</para>

<para>
The mini-SAP-server works under Linux and Mac OS X.
</para>

</simplesect>
</sect2>
</sect1>

<sect1><title>
What is a codec ?
</title>

&codec-demux;

</sect1>

<sect1><title>
How can I use VideoLAN ?
</title>

<sect2><title>
Documentation
</title>

<para>
The user documentation of VideoLAN is made up of 4 documents:
</para>

<itemizedlist>

<listitem><para> the <emphasis>VideoLAN
HOWTO</emphasis>. This document is the complete guide of the VideoLAN
streaming solution. It will give you practical examples to set up your
streaming solution.

</para></listitem>

<listitem><para>
the <emphasis>VLC user guide</emphasis>. This document
is the complete guide for VLC.
</para></listitem>

<listitem><para>
the <emphasis>VLS user guide</emphasis>. This document
is the complete guide for VLS.
</para></listitem>

<listitem><para>
The <emphasis>VideoLAN FAQ</emphasis>.
This document contains Frequently Asked Questions about
VideoLAN.
</para></listitem>

</itemizedlist>

<para>

The latest version of these documents can be found on the <ulink
url="http://www.videolan.org/doc/">documentation page</ulink>

.</para>

</sect2>

<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/via/ml/videolan-en.html">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>

<listitem><para><emphasis>streaming@videolan.org</emphasis> 
 for the questions on VLS, mini-SAP-server
    and the network
.</para></listitem>

</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>

</sect2>
</sect1>

<sect1><title>
Command line usage
</title>

<itemizedlist>
<listitem><para>

VLC has many different graphical interfaces, that
are organized quite differently in order to be in harmony with the
guidelines of each operating system supported. Documenting the use
of each graphical interface is too long, and some features are only
available via the command line interface. Therefore we decided to
document only the command line interface, but in many cases it shoud
be easy to guess how to use the graphical interface for the same use
!

</para></listitem>

<listitem><para>
VLS has a command line and a telnet interface, but no
graphical interface !
</para></listitem>

</itemizedlist>

<para>

All the commands that show up in this document should be typed
inside a terminal.
.</para>

<sect2><title>
Open a terminal
</title>

<simplesect><title>Windows</title>

<para>
Click on <emphasis>Start</emphasis>,
<emphasis>Run</emphasis> and type:
</para>

<itemizedlist>

<listitem><para><command>cmd</command> <keycap>Enter</keycap>
(Windows 2000 / XP),</para></listitem>

<listitem><para><command>command</command> <keycap>Enter</keycap>
(Windows 95 / 98 / ME).</para></listitem>

</itemizedlist>

<para>
The terminal appears
</para>

<figure><title>Windows terminal</title>
<mediaobject>
  <imageobject>
    <imagedata fileref="images/terminal-windows.jpg" format="JPG" scalefit="1" scale="60" />
  </imageobject>
</mediaobject>
</figure>

<note><para>
Under Windows, you need to be in the directory where the
program is installed to run it.
</para></note>

</simplesect>

<simplesect><title>Linux / Unix</title>

<para>
Open a terminal
:</para>

<figure><title>Linux X terminal</title>
<mediaobject>
  <imageobject>
    <imagedata fileref="images/terminal-linux.jpg" format="JPG" scalefit="1" scale="60" />
  </imageobject>
</mediaobject>
</figure>

<para>
In the documentation, we adopt the following 
conventions for the Unix commands:
</para>

<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>

<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>

</listitem>

</itemizedlist>

</simplesect>

<simplesect><title>Mac OS X</title>

<para>

Go to <emphasis>Applications</emphasis>, open the
folder <emphasis>Utilities</emphasis> and double-click on
<emphasis>Terminal</emphasis>
:</para>

<figure><title>Mac OS X terminal</title>
<mediaobject>
  <imageobject>
    <imagedata fileref="images/terminal-macosx.jpg" format="JPG" scalefit="1" scale="60" />
  </imageobject>
</mediaobject>
</figure>

<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>

</simplesect>

<simplesect><title>BeOS</title>

<para>
In the deskbar, go to <emphasis>Application</emphasis> and then
<emphasis>Terminal</emphasis>:
</para>

<figure><title>BeOS terminal</title>
<mediaobject>
  <imageobject>
    <imagedata fileref="images/terminal-beos.jpg" format="JPG" scalefit="1" scale="60" />
  </imageobject>
</mediaobject>
</figure>

<note><para>
Under BeOS, you need to be in the directory where
the program is installed to run it, and start the command with
<command>./</command>
.</para></note>

</simplesect>
</sect2>
</sect1>

</chapter>