. Url & mailing-lists corrections
[vlc.git] / doc / vlc-howto.sgml
1 <!doctype linuxdoc system>
2 <linuxdoc><article>
3 <titlepag>
4  <title>VLC HOWTO</title>
5  <author>by the Videolan Team<tt><htmlurl url="mailto:videolan@videolan.org" name="videolan@videolan.org"></tt></author>
6  <date>v0.0.9, 16 april 2002</date>
7
8  <abstract>
9   This document describes how to use the vlc (VideoLAN client) to read DVDs and mpeg files and DVDs.
10  </abstract>
11 </titlepag>
12
13 <toc>
14
15 <sect>
16  <heading>Introduction</heading>
17
18  <sect1>
19   <heading>What is VideoLAN ?</heading>
20   <p>
21    VideoLAN is a project of sudents of the École Centrale Paris which aims 
22    to broadcast video on the campus, and provide the students with a MPEG2 
23    software-only decoder. VideoLAN is an OpenSource project which will thus 
24    allow anyone to watch DVD movies under Linux, BeOS, MacOS X, Windows 
25    and most Unix 
26    systems
27   </p>
28   <p>
29     You may want to look at the port section on our website : 
30     <htmlurl url="http://www.videolan.org" name="http://www.videolan.org/">.
31   </p>
32  </sect1>
33  
34  <sect1>
35   <heading>What is the vlc</heading>
36   <p>
37    Vlc stands for VideoLAN client. It is the name of the program which is
38    capable of decoding MPEG streams, and displaying them onto your screen,
39    so you can watch you favourite movies, confortably sit in your armchair
40    :-).
41   </p>
42  </sect1>
43
44  <sect1>
45   <heading>Translated versions of this document</heading>
46   <p>
47     No translation is currently available.
48   </p>
49
50   <p>
51    The English version is maintained by Henri Fallon,
52    Johan Bilien, and the VideoLAN team. It can be found at:
53    <htmlurl url="http://www.videolan.org/doc/index.html"
54    name="http://www.videolan.org/doc/index.html">.
55   </p>
56  </sect1>
57
58  <sect1> 
59   <heading>Disclaimer</heading> 
60   <p> 
61    This documentation is given "as is", and any comment and improvement
62    are welcome. 
63   </p>
64
65   <p>
66    In this HOWTO, we consider you already have a little knowledge about
67    Linux, and you know how to use a DVD. If not, good howtos can be
68    found on the Linux Documentation Projet.
69   </p>
70  </sect1>
71
72  <sect1> 
73   <heading>Legal</heading> 
74   <p> 
75    Copyright (©) 2001 by the VideoLAN project. This document may be
76    distributed only subject to the terms and conditions set forth in
77    <htmlurl url="http://metalab.unc.edu/LDP/LDP-COPYRIGHT.html" 
78    name="the LDP license">.
79   </p> 
80  </sect1> 
81 </sect>
82
83 <sect>
84  <heading>Quick start</heading>
85   
86   <p> This section will help you get, install and use vlc without giving you
87   much details.
88   </p>
89
90  <sect1>
91   <heading>Get and install vlc from binary packages</heading>
92   <p>
93    The first thing to do is to get an archive, on our web site 
94    <htmlurl url="http://www.videolan.org/download.html" name="http://www.videolan.org/download.html">
95   </p>
96  
97   <sect2>
98    <heading>Which package to chose ?</heading>
99    <p>
100     There are different packages because vlc has "plugins" which provide 
101     features but also enlarge the executable and require external libs. 
102    </p>
103    <p>
104     SDL is a lib which allows you to have an accelerated video output.
105     You will need libsdl > 1.1.6
106    </p>
107    <p>
108     If you're using the enlightened sound daemon, you may want to try 
109     the esd-aware vlc.
110    </p>
111    <p>
112     Generally, when you don't know what a module name is, you don't 
113     need/use it :-)
114    </p>
115   </sect2>
116   
117   <sect2>
118    <heading>Debian package</heading>
119    <p>
120     Just use dpkg :
121     <verb>
122      dpkg -i vlc-x.x.x.deb
123     </verb>
124    </p>
125    <p>
126     Depending on the package you have downloaded, you may have dependency
127     problems. You have to solve them, by installing the required libs.
128    </p>
129   </sect2>
130    
131   <sect2>
132     <heading>RPM package</heading>
133    <p>
134     Install vlc just as you would install any rpm package : 
135     <verb>
136      rpm -i vlc-x.x.x.rpm
137     </verb>
138    </p>
139    <p>
140     You may have to install external libs to meet dependencies, depending on
141     the package you downloaded (gnome, gtk, esd, ...).
142    </p>
143   </sect2>
144
145   <sect2>
146    <heading>BeOS users</heading>
147    <p>
148     Double-click on the archive. It should open your favorite archive extracter.
149     You can then execute the vlc from there, or extract the archive to a 
150     diretory and run it from there.
151    </p>
152   </sect2>
153   
154   <sect2>
155    <heading>MacOS X users</heading>
156    <p>
157     To be completed
158    </p>
159   </sect2> 
160   <sect2>
161    <heading>Windows users</heading>
162    <p>
163     Decompress the archive with your favourite extracter in a directory of your
164     choice.
165    </p>
166   </sect2>
167  </sect1>
168  
169  <sect1>
170   <heading>Get libdvdcss</heading>
171   <p>
172    In order to read CSSsrambled DVDs, you will need libdvdcss. 
173    You can find binary
174    packages for your distribution here : <htmlurl 
175    name="http://www.videolan.org/libdvdcss/download/index.html" 
176    url="http://www.videolan.org/libdvdcss/download/index.html">
177   </p>
178  </sect1>
179  
180  <sect1>
181   <heading>Use the vlc for DVD reading</heading>
182   <p>
183   Launch the application simply by typing vlc in a terminal (or by 
184   double-clicking on its icon in a graphical shell). You should see
185   the graphical interface appear.
186   </p>
187
188   <p> 
189   For reading a DVD (or a VCD), click on the "Disc" button. The new window 
190   you must then enter the path to your DVD or VCD drive :
191
192    <sect2>
193     <heading>Linux users</heading>
194     <p>
195      Usually, you dvd device is /dev/hd? (if you have an ide drive).
196      For instance, if you DVD player is master on the second IDE device,
197      it will be /dev/hdc.
198     </p>
199     <p>
200      It is very useful to create a symlink to this file, called /dev/dvd. 
201      To do this, as root, type (if your dvd device is /dev/hdc for example) :
202      <verb>
203       ln -s /dev/hdc /dev/dvd
204      </verb>
205      Also make sure you have read AND write permission to the device 
206      (otherwise dvd decryption won't work).
207     </p>
208    </sect2>
209    <sect2>
210     <heading>Windows users</heading>
211     <p>
212      The path to your DVD drive usually is D: or E:. You may have a look
213      in "My Computer" and look to which letter your DVD drive is assigned.
214     </p>
215    </sect2>
216    <sect2>
217     <heading>BeOS users</heading>
218     <p>
219       Under BeOS, the dvd device looks like 
220       "/dev/disk/ide/atapi/1/slave/0/raw" for example, if your dvd device is 
221       slave on your first (not sure) ide device.
222     </p>
223    </sect2>
224    <sect2>
225     <heading>Other OS</heading>
226     <p>
227     To do ...
228     </p>
229    </sect2>
230   <sect1>
231    <heading>Use the vlc for network streaming</heading>
232    <p>
233     This is the vlc original usage. 
234    </p>
235    
236    <p>
237     Launch the vlc as you would have for DVD reading. Then click on the 
238     "Network" button. 
239     </p>
240     <sect2>
241      <heading>If using a VideoLAN Channel Server</heading>
242      <p>
243       The only thing you have to do is to check the "Channel server" box
244       and to enter the IP address and port 
245       of this channel
246       server. Ask your administrator if you don't have it. Then click on OK.
247      </p>
248      <p>
249       You will see a new "Channel" field in the interface. You may now
250       enter the selected channel and click on OK. After a few seconds,
251       if a program is being sent in this channel, you should see the program
252       start.
253      </p>
254      <p>
255       If nothing appears and you are sure that a program is broadcasted in
256       this channel, you may try once again, because a problem of communication
257       with the channel server could have occured (in you launched vlc from
258       a terminal, you should see "Network error: no answer from vlcs").
259      </p>
260     </sect2>
261     <sect2>
262      <heading>Without VideoLAN Channel Server</heading>
263      <p>
264       Simply choose clicking on the network button, then on ok should be 
265       sufficient in most cases.
266      </p>
267      <p>
268       After clicking on OK, and if a program is being sent, you should see
269       a window open with your program.
270      </p>
271     </sect2>
272 </sect>    
273     
274 <sect>
275  <heading>The graphical interface</heading>
276  <p>
277   Please note that the gnome, gtk and win32 interfaces are currently the most
278   advanced. The following descriptions refer to them.
279  </p>
280  <sect1>
281   <heading>Opening a stream</heading>
282   <p>
283    For opening streams through the graphical interface, click on either
284    "File" for opening a file stored on your hard drive, "Disc" for 
285    opening a DVD or a VCD, "Network" for reading a stream from a vls 
286    or through http input, or "Satellite" for reading directly 
287    from a satellite card.
288   </p>
289  <sect1>
290   <heading>Basic stream control</heading>
291   <p>
292    You have at your disposal all the classical control of a video player.
293    For example when playing local streams, you can do pauses, speed up or
294    slow down the stream ... Just use the corresponding buttons.
295   </p>
296  <sect1>
297   <heading>DVD and VCD navigation</heading>
298   <p>
299    When reading a DVD or a VCD, you can change chapter and title either 
300    by using the 
301    right-click menu or by using the dedicated bar that appears when reading
302    from a disc.
303   </p>
304  </sect1>
305  
306  <sect1>
307   <heading>Programs, audio and subtitles</heading>
308   <p>
309    When reading a multiprogram stream, you can change the current program
310    by selecting it in the "View/Programs" submenu, or using the "right click"
311    menu from the video output window.
312   </p>
313   <p>
314    In DVDs, if different angles are availables, they will be treated as
315    different programs.
316   </p>
317   <p>
318    At any time you can change the audio/subtitles channel using either the 
319    "setting" menu from the interface or using the "right click" menu from
320    the video output window.
321   </p>
322  <sect1>
323   <heading>Preferences window</heading>
324   <p>
325    By choosing "Preferences" in the "Settings" menu, you will open 
326    the preferences window. This window is generated dynamically according
327    to the modules that were compiled.
328   </p>
329   <p>
330    In every tab, you may click on "Save" to store your settings in your
331    ~/.videolan/vlrrc file.
332   </p>
333   <sect2>
334    <heading>Interface tab</heading>
335    <p>
336     In that tab, you can select which interface you would like to use on next
337     start. Click on the choosen interface, click on "Select" then on "Save".
338    </p>
339   </sect2>
340   <sect2>
341    <heading>Audio tab</heading>
342    <p>
343     In this tab, you can select the audio output you would like to use on 
344     next start. You may also specify some other settings such as the output
345     level, the audio frequency, ...
346    </p>
347   </sect2>
348   <sect2>
349    <heading>Video tab</heading>
350    <p>
351     In this tab, you can select which video output will be used on next start,
352     and add a video filter module. You may also specify some video settings,
353     such as the window size or if you would like fullscreen display.
354    </p>
355   </sect2>
356   <sect2>
357    <heading>Input tab</heading>
358    <p>
359     In this tab, you can enter the input method with options (for example
360     <tt>udp:@239.255.255.42</tt>) that will be used on next start. You can 
361     also add some settings, such as the channel server address ...
362    </p>
363   </sect2>
364   <sect2>
365    <heading>Decoders tab</heading>
366    <p>
367     In this tab, you can select which decoder you want to use for MPEG audio
368     and AC3 streams.
369    </p>
370   </sect2>
371   <sect2>
372    <heading>CPU tab</heading>
373    <p>
374     In this tab, you may disable the use of some CPU extensions such as 
375     MMX or SSE.
376    </p>
377   </sect2>
378   <sect2>
379    <heading>Playlist tab</heading>
380    <p>
381     In this tab, you can select some playlist options, such as looping the
382     playlist.
383    </p>
384   </sect2>
385   <sect2>
386    <heading>Miscellanous tab</heading>
387    <p>
388     In this tab, you can select which memcpy version you want to use. Some 
389     of them uses MMX 3Dnow! extensions.
390    </p>
391   </sect2>  
392  </sect1>
393 </sect>
394 <sect>
395  <heading>Command line options</heading>
396  <p>
397  Many options are only available through command line. They are detailled here.
398  </p>
399  <sect1>
400   <heading>Opening streams</heading>
401   <p> 
402   The following commands start vlc and add a first element to the playlist.
403   </p>
404   <sect2>
405    <heading>Opening a file</heading>
406    <p>
407     Simply start vlc with <tt>vlc my_file.mpg</tt>. 
408    </p>
409    <p>
410     You may tell vlc what input to use, for example add <tt>--input ts</tt>
411     when playing a ts MPEG, although vlc should be able to recognize the type
412     of MPEG.
413    </p>
414   </sect2>
415   <sect2>
416    <heading>Opening a DVD or VCD</heading>
417    <p>
418     Simply start vlc with <tt>vlc dvd:DVDDRIVE</tt> or <tt> vlc vcd:CDROMDRIVE
419     </tt>, where DVDDRIVE/CDROMDRIVE is the complete
420     path to your dvd/cdrom drive.
421    </p>
422    <p>
423     You may add <tt>-t X -T Y</tt> to start directly from the Xth chapter, Yth
424     title.
425    </p>
426   </sect2>
427   <sect2>
428   <heading>Start a network stream</heading>
429    <p>
430     To receive an UDP stream (being sent from a VLS), start vlc with 
431     <tt> vlc udpstream:[@&lt;bind address&gt;[:&lt;server port&gt;]] </tt>.
432    </p>
433    <p>
434     Please note that bind address refers to the destination address, for 
435     example your broadcast address. If the stream is being broadcasted, 
436     <verb> vlc udpstream:</verb> should be sufficient. If the stream
437     is multicasted, you must specify the multicast address, for example 
438     <verb> vlc udpstream:@239.255.255.42  </verb>
439
440    
441    </p>
442   </sect2>
443  </sect1>
444  
445  <sect1>
446   <heading>Modules selection</heading>
447   <p>
448    The vlc tries to select the most appropriate interface, input and output
449    modules, among the ones available on the system, according to
450    the stream he is given to read. However, you may wish to force
451    the use of a specific module with the following options:
452    
453    <p> <verb>--intf &lt;interface module&gt;</verb>
454    allows you to select the interface module </p>
455
456    <p> <verb>--input &lt;input module&gt;</verb>
457    allows you to select the input module.</p>
458
459    <p> <verb>--vout &lt;video output module&gt;</verb>
460    allows you to select the video output.</p>
461
462    <p> <verb>--aout &lt;audio output module&gt;</verb>
463    allows you to select the audio output.</p>
464
465    <p> <verb>--filter &lt;video filter module&gt;</verb>
466    allows you to add a video filter module.</p>
467
468    <p> <verb>--mpeg_adec &lt;MPEG audio decoder module&gt;</verb>
469    allows you to select the audio MPEG decoder.</p>
470
471    <p> <verb>--ac3_adec &lt;AC3 audio decoder module&gt;</verb>
472    allows you to select the audio AC3 decoder.</p>
473   
474  </sect1>
475  <sect1>
476   <heading>Other options</heading>
477   <sect2>
478    <heading>Help options:</heading>
479    
480    <p> <verb>--help</verb>
481    gives you all the available options.</p>  
482    <p> <verb>--longhelp</verb>
483    gives you a more detailled version of the available options.</p>  
484    <p> <verb>--version</verb>
485    gives you information about the current version.</p>  
486    <p> <verb>--list</verb>
487    gives you the list of all available plugins.</p>
488    <p> <verb>--warning X or -vvvv (X times)</verb>
489    set the level of warning messages.</p>
490    <p> <verb>--stat</verb>
491    gives statistic outputs.</p>
492   </sect2>
493   
494   <sect2>
495    <heading>Audio options:</heading>
496    
497
498    <p> <verb>--noaudio</verb>
499    disables the audio output</p>
500    <p> <verb>--mono</verb>
501    forces the vlc to treat the stream in mono audio.</p>
502    <p> <verb>--volume &lt;integer&gt;</verb>
503    set the level of audio output.</p>
504    <p> <verb>--rate &lt;integer&gt;</verb>
505    set the audio output frequency (Hz)</p>
506    <p> <verb>--desync &lt;integer&gt;</verb>
507    compensates desynchronization of audio (ms)</p>
508   </sect2>
509
510   <sect2>
511    <heading>Video options:</heading>
512    
513    <p> <verb>--novideo</verb>
514    disables the video output</p>
515    <p> <verb>--width &lt;integer&gt;</verb>
516        <verb>--height &lt;integer&gt;</verb>
517    set the video window dimensions.</p>
518    <p> <verb>--grayscale</verb>
519    turns video output into grayscale mode.</p>
520    <p> <verb>--fullscreen</verb>
521    set fullscreen video.</p>
522    <p> <verb>--nooverlay</verb>
523    disables hardware acceleration for the video output</p>
524    <p> <verb>--spumargin &lt;integer&gt;</verb>
525    force subtitles position.</p>
526
527   </sect2>
528   <sect2>
529    <heading>Input options:</heading>
530
531
532    <p> <verb>--network-channel</verb>
533    Start with channel server enabled.</p>
534    <p> <verb>--channel_server &lt;string&gt;</verb>
535    Specify the channel server address.</p>
536    <p> <verb>--channel_port &lt;integer&gt;</verb>
537    Specify the channel server port.</p>
538    <p> <verb>--iface &lt;string&gt;</verb>
539    Select the network interface to use.</p>
540    <p> <verb>--input_program &lt;integer&gt;</verb>
541    Select the program to use (for streams with 
542    several programs, as those coming from satellite).</p>
543    <p> <verb>--input_audio &lt;integer&gt;</verb>
544    Select the audio channel to use.</p>
545    <p> <verb>--input_subtitle &lt;integer&gt;</verb>
546    Select the subtitle.</p>
547    <p> <verb>--input_channel &lt;integer&gt;</verb>
548    Select the channel number.</p>
549    <p> <verb>--dvd_device &lt;string&gt;</verb>
550    Specify the default dvd device.</p>
551    <p> <verb>--vcd_device &lt;string&gt;</verb>
552    Specify the default vcd device.</p>
553    <p> <verb>--ipv4</verb>
554    Force IPv4.</p>
555    <p> <verb>--ipv6</verb>
556    Force IPv6.</p>
557   </sect2>
558   
559   <sect2>
560    <heading>CPU options</heading>
561    <p> <verb>--nommx</verb>
562    disable the use of mmx CPU extensions.</p>
563    <p> <verb>--no3dn</verb>
564    disable the use of 3D Now! CPU extensions.</p>
565    <p> <verb>--nommxext</verb>
566    disable the use of mmx ext CPU extensions.</p>
567    <p> <verb>--noaltivec</verb>
568    disable the use of AltiVec CPU extensions.</p>
569   </sect2>
570  </sect1>
571  
572
573
574    
575
576  
577
578 <sect>
579  <heading>Building the vlc from sources</heading>
580  <p>
581   You can choose either to take the latest release, or a CVS source. Note that
582   CVS snapshots may be broken, although we do our best to prevent this from
583   happening.
584  </p>
585  <p>
586   From here, you have to be a little experienced, even more if you want to use
587   the cvs.
588  </p>
589  <sect1>
590   <heading>Getting an archive</heading>
591   <p>
592    You have guessed it, the first thing to do is to get the source.
593    Until there, everyone should understand :)
594   </p>
595   <sect2>
596    <heading>Web site</heading>
597    <p>
598     Source packages can be found in the "tarballs" section of the download page :
599     <htmlurl url="http://www.videolan.org/download.html" name="http://www.videolan.org/dowload.html">.
600    </p>
601    <p>
602     CVS snapshots are available from the address : 
603     <htmlurl url="http://www.videolan.org/packages/snapshots/" 
604     name="http://www.videolan.org/packages/snapshots/">.
605    </p>
606    <p>
607     Then untar the archive :
608     <verb>
609      tar xzf vlc-x-x-x.tar.gz
610     </verb>
611    </p>
612   </sect2>
613   <sect2>
614    <heading>Directly from CVS</heading>
615    <p> <label id="cvs">
616     Firs log in as suer anonymous with an empty password :
617     <verb>
618      cvs -d :pserver:anonymous@anoncvs.videolan.org:/var/cvs/videolan login
619     </verb>
620    Then retrieve the repository :
621    <verb>
622     cvs -d :pserver:anonymous@anoncvs.videolan.org:/var/cvs/videolan -z3 checkout vlc
623    </verb>
624    </p>
625   </sect2>
626   <sect2>
627    <heading>libdvdcss</heading>
628    <p>
629    To compile vlc with dvd support, you need to get and install libdvdcss.
630    </p>
631    <p>
632    It is available for download here : 
633    <htmlurl url="http://www.videolan.org/libdvdcss/download.html"
634    name="http://www.videolan.org/libdvdcss/download.html">
635
636    Decompress the tarball in a directory of your choice and build it :
637    <verb>
638     tar -xvzf libdvdcss-x.x.x.tar.gz
639     cd libdvdcss-x.x.x
640     ./configure
641     make
642     [as root] make install
643    </verb>
644
645    You can also find binaries packages for many distributions.
646  </sect1>
647  
648  <sect1>
649   <heading>Building the program</heading>
650   <p><label id="compile">
651    Go into the vlc directory and run the configure script :
652    <verb>
653     ./configure
654    </verb>
655     If you want to enable options, you may add "--enable-option" 
656     to the previous line.
657     For example, to build with the xvideo extension, and alsa support, 
658     you should type :
659     <verb>
660     ./configure --enable-xvideo --enable-alsa
661     </verb>
662    To get the list of the available options, and know if they are 
663    enabled by default,
664    you can try :
665    <verb>
666     ./configure --help
667    </verb>
668   </p>
669   <p>
670    Also have a look on the <ref id="modules" name="following modules 
671    descriptions">.
672   </p>
673   <p>
674    A very typical installation, on a XFree 4.1 system, recent video card, with 
675    gnome, is :
676    <verb>
677     ./configure --enable-esd --enable-gnome
678    </verb>
679   <p>
680  </sect1>
681  <sect1>
682   <heading>Plugins, builtins ...</heading>
683   <p>
684    The configure script should create a Makefile.opts file, which you can edit and modify.
685    Indeed you can chose to have features (as esd support, for example) built as plugins
686    or inside the program.
687   </p>
688   <p>
689    If you build a feature as a plugin, it can lead to a little loss of performance.
690    It you build it inside the code, it'll enlarge a bit the size of the executable.
691   </p>
692   <p>
693    When you're done with Makefile.opts (which also works if you leave it 
694    untouched), just 
695    type:
696     <verb>
697     make
698     </verb>
699    It should compile without any error. If there are, please check you 
700    have the required libs 
701    installed on your system, as the configure script can't check them all.
702   </p>
703   <p>
704    When you're done with it, as root, type :
705    <verb>
706     make install
707    </verb>
708   if you wish to have vlc fully installed on your system. If you prefer 
709   to keep in in the 
710   current directory, you may skip the "make install". You'll then have 
711   to cd into the vlc 
712   directory and type "./vlc" instead of just typing vlc.
713   </p>
714  </sect1>
715 </sect>
716
717 <sect>
718  <heading>Modules description</heading>
719  <p> 
720   <label id="modules">
721   Here is a description of nearly all the available modules for the 
722   vlc. If you wish to compile one which is stated disabled by default,
723   you have to launch the configure script with 
724   <verb> ./configure --enable-module_name </verb>. See <ref 
725   name="compilation instructions" id="compile">.
726  <sect1>
727   <heading>Video outputs</heading>
728   <sect2>
729    <heading>x11</heading>
730    <p>default :enabled </p>
731    <p>
732     This is the basic x11 video output. It only requires a 
733     working X11 server. You will need xlibs headers to compile it
734     (xlibs-dev packet on Debian systems).
735    </p>
736   </sect2>
737   
738   <sect2>
739    <heading>xvideo</heading>
740    <p>default : enabled</p>    
741    <p>
742     It requires an xvideo compliant graphic card (it is the case for 
743     nearly all the modern card). It uses hardware acceleration for 
744     yuv transformation and for rescaling.
745    </p>
746   </sect2>
747   
748   <sect2>
749    <heading>sdl</heading>
750    <p>default : enabled</p>
751    <p>
752     This video output uses sdl libraries. You need at least version 1.1.6 of
753     this libraries.
754    </p>
755    <p> 
756     You may indicate the path to the sdl-config program with the
757     <verb> --with-sdl-config-path=PATH </verb> option given to the <verb>
758     configure</verb> script.
759    </p>
760   </sect2>
761   
762   <sect2>
763    <heading>directx</heading>
764    <p>default: enabled on win32</p>
765    <p>
766     This video output uses Microsoft Direct X libraries. It is recommended 
767     for the win32 port.
768    </p>
769    <p>
770     You may indicate the path to directx libraries and headers with
771     the <verb>--with-directx=PATH</verb> option.
772   </sect2>
773   
774   <sect2>
775    <heading>fb</heading>
776    <p>default: enabled on Linux</p>
777    <p>
778     This is the frame buffer video output. It requires that your kernel 
779     was compiled with frame buffer support.
780    </p>
781   </sect2>
782   
783   <sect2>
784    <heading>glide</heading>
785    <p>default: disabled</p>
786    <p>
787    This video output uses Glide libraries (hardware acceleration for
788    3Dfx cards).
789    </p>
790    <p> 
791     You may indicate the path to the library with the 
792    <verb>--with-glide=PATH</verb> compilation option.
793    </p>
794   </sect2>
795   
796   <sect2>
797    <heading>mga</heading>
798    <p>default: disabled</p>
799    <p> 
800    It provides hardware acceleration for Matrox cards on Linux.
801    </p>
802   </sect2>
803
804   <sect2>
805    <heading>ggi</heading>
806    <p>default: disabled</p>
807   </sect2>
808   
809   <sect2>
810    <heading>aa</heading>
811    <p>default: disabled</p>
812    <p>
813     This video output uses the aalib library to display video
814     through ASCII art. It requires aalib headers (aalib1-dev under Debian)
815     to compile.
816    </p>
817   </sect2>
818  </sect1>
819  <sect1>
820   <heading>Video filters modules</heading>
821   <sect2>
822    <heading>deinterlace</heading>
823    <p>default: enabled</p>
824    <p>
825     This filter deinterlaces video. It is usefull with streams coming 
826     from a satellite broadcast.
827    </p>
828   </sect2>
829   
830   <sect2>
831    <heading>wall</heading>
832    <p>default: enabled</p>
833    <p>
834     This filter allows you to have the video cut in pieces in several 
835     windows, which you can order as you wish. It can be used to generate
836     image walls with several sources. Start it with 
837    <verb> --filter wall:XxY</verb> in order to have the video cut in X rows
838    and Y columns
839    </p>
840   </sect2>
841   <sect2>
842    <heading>distort</heading>
843    <p>default: enable</p>
844    <p>
845     This filter adds a distortion effect to the video. Who said it
846     was useless ;-) ?
847    </p>
848   </sect2>
849   
850   <sect2>
851    <heading>transform</heading>
852    <p>default: enable</p>
853    <p>
854     This filter rotates the video window of 90 degrees.
855    </p>
856   </sect2>
857   
858   <sect2>
859    <heading>invert</heading>
860    <p>default: enabled</p>
861    <p>
862     This filter inverses colors.
863    </p>
864   </sect2>
865  </sect1>
866  <sect1>
867   <heading>Sound outputs</heading>
868   <sect2>
869    <heading>dsp</heading>
870    <p>default: enabled on Linux</p>
871    <p>
872     This is the Linux /dev/dsp output. It requires that your kernel 
873     was compiled with support for your sound card.
874    </p>
875    </sect2>
876    
877    <sect2>
878     <heading>alsa</heading>
879     <p>default: disabled</p>
880     <p>
881      This is the sound output for Advanced Linux Sound Architecture. 
882      It requires that you installed the alsa drivers and libraries.
883     </p>
884    </sect2>
885    
886    <sect2>
887     <heading>esd</heading>
888     <p>default: disabled</p>
889     <p>
890      This sound output has Enlightened Sound Daemon support
891      (usually used with Gnome). 
892      You must have the daemon and its libraries installed.
893     </p>
894    </sect2>
895    <sect2>
896     <heading>arts</heading>
897     <p>default: disabled</p>
898     <p>
899      This sound output has aRts (KDE's sound server) support.
900      You must have the daemon and its libraries installed.
901     </p>
902    </sect2>
903    
904    <sect2>
905     <heading>waveout</heading>
906     <p>default: enabled on win32</p>
907     <p>
908      This is the Wave output, which is used by the win32 port.
909     </p>
910    </sect2>
911  </sect1>
912  
913  <sect1>
914   <heading>Input modules</heading>
915   <sect2>
916    <heading>dvd</heading>
917    <p>default: enabled</p>
918    <p>
919     This is the DVD input module. It will need libdvdcss, which can
920     be found <htmlurl url="http://www.videolan.org/libdvdcss/" 
921     name="http://www.videolan.org/libdvdcss/">.
922    </p>
923   </sect2>
924   
925   <sect2>
926    <heading>dvdread</heading>
927    <p>default: disabled</p>
928    <p>
929     This is an alternative to the previous one, it uses libdvdread 
930     (which also needs libdvdcss).
931    </p>
932   </sect2>
933   <sect2>
934    <heading>vcd</heading>
935    <p>default: enabled</p>
936    <p>
937     This is the VideoCD input. 
938    </p>
939   </sect2>
940   <sect2>
941    <heading>satellite</heading>
942    <p>default: disabled</p>
943    <p>
944     This is an input module that allows to read directly from a
945     Hauppauge WinTV Nova card under Linux. It requires drivers 0.9.4 
946     available from 
947    <htmlurl url="http://www.linuxtv.org/" name="linuxtv.org">.
948    </p>
949   </sect2>
950  </sect1>
951  
952  <sect1>
953   <heading>Interface modules</heading>
954   <sect2>
955    <heading>gtk</heading>
956    <p>default: enabled</p>
957    <p>
958     This is the GTK+ interface. It needs gtk libraries (libgtk1.2 package
959     on Debian) and headers files if you are compiling it (libgtk1.2-dev 
960     package on Debian). Note that it can be used under Windows.
961    </p>
962   </sect2>
963   <sect2>
964    <heading>gnome</heading>
965    <p>default: disabled</p>
966    <p>
967     This is the Gnome interface. It needs gnome libraries (libgnome32 under
968     Debian) and headers (libgnome-dev) if you wish to compile it.
969    </p>
970   </sect2>
971   <sect2>
972    <heading>intfwin</heading>
973    <p>default: enabled on win32</p>
974    <p>
975     This is the Windows native interface. It requires Borland C++ builder 
976     to compile. You may use <verb>--with-bc-builder=PATH</verb> option
977     to specify the path to this application.
978    </p>
979   </sect2>
980
981   <sect2>
982    <heading>qt</heading>
983    <p>default: disabled</p>
984    <p>
985     This is the QT libraries interface module. You will need the libraries
986     (libqt2 package on Debian) and headers (libqt-dev) if you wish to 
987     compile it.
988    </p>
989   </sect2>
990   <sect2>
991    <heading>kde</heading>
992    <p>default: disabled</p>
993    <p>
994     This is the KDE interface module.  You will need the libraries
995     (kdelib package on Debian) and headers (kde-devel) if you wish to 
996     compile it.
997    </p>
998   </sect2>
999
1000   <sect2>
1001    <heading>rc</heading>
1002    <p>default: enable</p>
1003    <p>
1004     This is the Remote Control interface module. With this one, vlc
1005     is controled by sending him commands, such as play, stop, ... so 
1006     that you may control vlc through a script.
1007    </p>
1008   </sect2>
1009
1010   <sect2>
1011    <heading>ncurses</heading>
1012    <p>default: disabled</p>
1013    <p>
1014     This is a text interface, using ncurses library. You will need
1015     ncurses headers if you want to compile it (libncurses5-dev on Debian).
1016    </p>
1017   </sect2>
1018   <sect2>
1019    <heading>lirc</heading>
1020    <p>default: disabled</p>
1021    <p>
1022     This interface module allows you to control vlc through a remote.
1023     A lircrc example is provided to help you configure it to your remote
1024     (see doc/lirc/example.lircrc).
1025    </p>
1026   </sect2>
1027  </sect1>
1028  <sect1>
1029   <heading>OS support modules</heading>
1030   <p> The following modules add support or different OSs. </p>
1031   <sect2>
1032    <heading>macosx</heading>
1033    <p>default: enabled on MacOS X</p>
1034    <p>
1035     This is the MacOS X support module, including a native interface.
1036    </p>
1037   </sect2>
1038   
1039   <sect2>
1040    <heading>qnx</heading>
1041    <p>default: enabled on qnx</p>
1042    <p>
1043     This is the QNX RTOS support module.
1044    </p>
1045   </sect2>
1046  </sect1>    
1047
1048 <sect>
1049  <heading>Specific use of the vlc</heading>
1050  <sect1>
1051   <heading>Use the vlc as a viever and decoder for the Hauppauge WinTV 
1052   Nova card</heading>
1053   <sect2>
1054    <heading>What is required ?</heading>
1055    <p>
1056     At the present time, the satellite input only works under Linux. 
1057     It requires that drivers version 0.9.4 of the card, drivers
1058     that are being developped by the <htmlurl name="linuxtv.org"
1059     url="http://www.linuxtv.org/">. 
1060    </p>
1061   </sect2>
1062   <sect2>
1063    <heading>Building the vlc with satellite support</heading>
1064    <p>
1065     Get the sources, either from our last .tar.gz release, 
1066     or best from the cvs (see <ref name="cvs instructions"
1067     id="cvs">).
1068    </p>
1069    <p>
1070     Move to the vlc directory, then launch
1071     <verb>
1072      ./configure --enable-satellite
1073     </verb>
1074     You may add other compilation options, see <ref 
1075     name="compilation instructions" id="compile">.
1076     Then launch the compilation with
1077     <verb>
1078      make
1079     </verb>
1080     You may install it with (as root)
1081     <verb>
1082      make install
1083     </verb>
1084     or run it from the current directory.
1085    </p>
1086   </sect2>
1087   <sect2>
1088    <heading>Running it from the command line</heading>
1089    <p>
1090    Run the vlc with 
1091     <verb>
1092      vlc satellite:&lt;frequency(Hz)&gt;,&lt;polarization(0 for V,
1093      1 for H)&lt;,
1094      &gt;FEC (1 for 1/2, 2 for 2/3 ...)&gt;,&lt;symbol rate (kbytes/sec)&gt;
1095     </verb>
1096     You then have to select your program, either with the command line option
1097     <verb>
1098      --input_program <program_number (also called service ID)>
1099     </verb>
1100     or by choosing it in the view/programs menu.
1101    </sect2>
1102    <sect2>
1103     <heading>Running it from the GTK/Gnome interface</heading>
1104     <p>
1105      Click on the "Sat" icon. In the opening box, you may enter 
1106      your transponder settings, then click on "Ok". 
1107     </p>
1108     <p>
1109      After a few seconds, the word satellite should appear under the command
1110      buttons. You may now choose your program from the View/Programs menu.
1111     </p>
1112    </sect2>
1113   </sect1>
1114   <sect1>
1115    <heading>Use the vlc to create image walls.</heading>
1116    <p>
1117     The idea is to use several video sources, each one displaying a part 
1118     of the whole image, to get a bigger result.
1119    </p>
1120    <p> 
1121     Vlc and the VideoLAN solution can provide a good way to create
1122     such displays : a vls broadcasts a stream in several vlc each
1123     display a part of image.
1124    </p>
1125    <p>
1126     For this, you should use the wall filter : start vlc with 
1127     <verb>
1128      vlc udp: --filter wall:&lt;number of rows&gt;x&lt;number of columns&gt;
1129      :&lt;number of the part to diplay&gt;
1130     </verb>
1131    </p>
1132   </sect1>
1133
1134 </sect>
1135 <sect>
1136   <heading>Get more help</heading>
1137   <p>
1138    First of all, it something seems to go wrong, read and try to 
1139    understand the error messages. If you are a confirmed user, you 
1140    may try the "-vvv" option which makes the vlc very verbose.
1141   </p>
1142   <p>
1143    There is a FAQ page on our website :
1144    <htmlurl url="http://www.videolan.org/doc/index.html" name="http://www.videolan.org/doc/index.html">.
1145    If you think one question should be in the FAQ, please contact
1146    <htmlurl url="mailto:videolan@videolan.org" name="videolan@videolan.org">
1147   </p>
1148   <p>
1149    Finally, there's a users mailing list (English speaking). To subscribe, send a mail to 
1150    <htmlurl url="mailto:listar@videlan.org" name="listar@videlan.org"> containing
1151    "subscribe vlc" as message body.
1152   </p>
1153 </sect>
1154 </article></linuxdoc>