1 <!doctype linuxdoc system>
4 <title>VLC HOWTO</title>
5 <author>Originally written by Henri Fallon, maintained by Johan Bilien<tt><htmlurl url="mailto:jobi@videolan.org" name="<jobi@videolan.org>"></tt></author>
6 <date>v0.0.9, 16 april 2002</date>
9 This document describes how to use the vlc (VideoLAN client) to read DVDs and mpeg files, locally or from a network.
16 <heading>Introduction</heading>
19 <heading>What is VideoLAN ?</heading>
21 VideoLAN is a project of sudents of the École Centrale Paris which aims
22 at broadcasting video on the campus, and providing the students with an MPEG-2
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 systems. Recent additions allow to read .avi files,
26 and MPEG-4/DivX-encoded movies.
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/">.
35 <heading>What is the VideoLAN project ?</heading>
38 VideoLAN is a complete software solution for video streaming, developed
39 by students at the <htmlurl url="http://www.ecp.fr" name="Ecole Centrale
40 Paris"> and contributors from all over the world, under the <htmlurl
41 url="http://www.gnu.org/copyleft/gpl.html" name="General Public License
42 (GPL)">. It has been designed for streaming MPEG 1 and MPEG 2 videos on
43 local area networks (LAN), but it can be extended to metropolitan or
44 wide area networks (MAN, WAN), thanks to the multicast technology.
46 The VideoLAN solution includes a server, which can stream video from
47 various sources (file, DVD, satellite and MPEG 2 encoder), a client, which can
48 receive, decode and display MPEG 1 and MPEG 2 streams and, if necessary,
49 a channel server which tells automatically to the client the parameters
50 needed to receive the stream.
52 Here is an illustration of the complete VideoLAN solution :
56 DVD --->- Unicast/Broadcast/Multicast
58 File --->-- -------- / \ --------
59 |->-| Server |=====>====| LAN |---->-----| Client |
60 Satellite ->-- | (VLS) | \ / | (VLC) |
61 / -------- --- --------
71 More details about the project can be found on the
72 <htmlurl url="http://www.videolan.org" name="VideoLAN Web site">.
77 <heading>The documentation of the project</heading>
79 There are four main documents :
82 url="http://www.videolan.org/doc/videolan-quickstart/videolan-quickstart.html"
83 name="VideoLAN Quickstart">,
84 <item>the <htmlurl url="http://www.videolan.org/network/doc/videolan-howto.html"
85 name="VideoLAN HOWTO">,
86 <item>the <htmlurl url="http://www.videolan.org/vls/doc/vls-guide.html"
87 name="VideoLAN Server user guide">,
88 <item>this VideoLAN Client Howto.
91 The up-to-date version of these documents can be found on the <htmlurl
92 url="http://www.videolan.org/doc" name="VideoLAN Web Site">.
95 <heading>Translated versions of this document</heading>
97 No translation is currently available.
101 The English version is maintained by Henri Fallon,
102 Johan Bilien, and the VideoLAN team. It can be found at:
103 <htmlurl url="http://www.videolan.org/doc/index.html"
104 name="http://www.videolan.org/doc/index.html">.
109 <heading>Requirements</heading>
111 <heading>Operating system</heading>
113 VLC works under the following systems :
117 <item> Linux (all distributions, including iPAQ Familiar Linux)
118 <item> Windows (all 32bit versions)
120 <item> FreeBSD, NetBSD, OpenBSD, BSD/OS
127 Please note that the Linux, Windows and MacOS X versions are generally the most
132 <heading>Software requirements</heading>
134 Depending on the outputs and inputs you are using, you may need
135 additional libraries. Please see <ref id="modules" name="description">.
138 For playing encrypted DVDs, you will need libdvdcss, which you can find
140 <htmlurl name="http://www.videolan.org/libdvdcss/download.html"
141 url="http://www.videolan.org/libdvdcss/download.html">.
145 <heading>Hardware requirements</heading>
147 The hardware power needed depends a lot of the type of stream.
148 For reading a DVD, a CPU working at around 450 MHz is required.
151 VLC can benefits from hardware acceleration from modern video cards
152 for YUV transformation and window rescaling. it also uses MMX, MMX EXT,
153 SSE, 3Dnow! optimizations if available.
160 <heading>Disclaimer</heading>
162 This documentation is given "as is", and any comment and improvement
168 In this HOWTO, we consider you already have a little knowledge
169 about Linux, and you know how to use a DVD. If not, good howtos
170 can be found on the <htmlurl url="http://www.tldp.org" name="Linux
171 Documentation Projet">.
177 <heading>Legal</heading>
180 Copyright (©) 2002 by the VideoLAN project.
182 Permission is granted to copy, distribute and/or modify this document
183 under the terms of the GNU Free Documentation License, Version
184 1.1 or any later version published by the Free Software Foundation ;
185 with no Invariant Sections, with no Front-Cover Texts, and with no
186 Back-Cover Texts. The text of the license can be found on <htmlurl
187 url="http://www.gnu.org/copyleft/fdl.html">.
194 <heading>Quick start</heading>
196 <p> This section will help you get, install and use vlc without giving you
201 <heading>Get and install vlc from binary packages</heading>
203 The first thing to do is to get an archive, on our web site
204 <htmlurl url="http://www.videolan.org/download.html" name="http://www.videolan.org/download.html">
208 <heading>Which package to chose ?</heading>
210 There are different packages because vlc has "plugins" which provide
211 features but also enlarge the executable and require external libraries.
214 SDL is a lib which allows you to have an accelerated video output.
215 You will need libsdl > 1.1.6
218 If you're using the enlightened sound daemon, you may want to try
222 Generally, when you don't know what a module name is, you don't
228 <heading>Debian package</heading>
232 dpkg -i vlc-x.x.x.deb
236 Depending on the package you have downloaded, you may have dependency
237 problems. You have to solve them, by installing the required libraries.
242 <heading>RPM package</heading>
244 Install vlc just as you would install any RPM package :
250 You may have to install external libraries to meet dependencies, depending on
251 the package you downloaded (gnome, gtk, esd, ...).
256 <heading>BeOS users</heading>
258 Double-click on the archive. It should open your favorite archive extracter.
259 You can then execute the vlc from there, or extract the archive to a
260 directory and run it from there.
265 <heading>Mac OS X users</heading>
267 Double-click on the archive, and copy the vlc file to your Applications
272 <heading>Windows users</heading>
274 Launch the installer by double-clicking on it, and follow the installation
275 instructions. Please note that in most cases you will need administrator
276 rights to install it under Windows NT, 2000 and XP.
282 <heading>Get libdvdcss</heading>
284 In order to read CSSsrambled DVDs, you will need libdvdcss.
286 packages for your distribution here : <htmlurl
287 name="http://www.videolan.org/libdvdcss/download.html"
288 url="http://www.videolan.org/libdvdcss/download.html">
291 For Windows, BeOS and Mac OS X users, libdvdcss is statically linked in the
292 Windows binary, so you don't have to install it.
297 <heading>Use the vlc for DVD reading</heading>
299 Launch the application simply by typing vlc in a terminal (or by
300 double-clicking on its icon in a graphical shell). You should see
301 the graphical interface appear.
305 For reading a DVD (or a VCD), click on the "Disc" button. The new window
306 you must then enter the path to your DVD or VCD drive :
309 <heading>Linux users</heading>
311 Usually, your dvd device is /dev/hd? (if you have an ide drive).
312 For instance, if you DVD player is master on the second IDE device,
316 It is very useful to create a symlink to this file, called /dev/dvd.
317 To do this, as root, type (if your dvd device is /dev/hdc for example) :
319 ln -s /dev/hdc /dev/dvd
321 Also make sure you have read AND write permission to the device
322 (otherwise dvd decryption won't work).
326 <heading>Windows users</heading>
328 The path to your DVD drive usually is D:\ or E:\. You may have a look
329 in "My Computer" and look to which letter your DVD drive is assigned.
333 <heading>BeOS users</heading>
335 Under BeOS, the dvd device looks like
336 "/dev/disk/ide/atapi/1/slave/0/raw" for example, if your dvd device is
337 slave on your first (not sure) ide device.
341 <heading>Other OS</heading>
347 <heading>Use the vlc for network streaming</heading>
349 This is the vlc original usage.
353 Launch the vlc as you would have for DVD reading. Then click on the
357 <heading>If using a VideoLAN Channel Server</heading>
359 The only thing you have to do is to check the "Channel server" box
360 and to enter the IP address and port
362 server. Ask your administrator if you don't have it. Then click on OK.
365 You will see a new "Channel" field in the interface. You may now
366 enter the selected channel and click on OK. After a few seconds,
367 if a program is being sent in this channel, you should see the program
371 If nothing appears and you are sure that a program is streamed in
372 this channel, you may try once again, because a problem of communication
373 with the channel server could have occurred (if you launched vlc from
374 a terminal, you should see "Network error: no answer from vlcs").
378 <heading>Without VideoLAN Channel Server</heading>
380 Simply clicking on the network button, then on ok should be
381 sufficient in most cases.
384 After clicking on OK, and if a program is being sent, you should see
385 a window open with your program.
391 <heading>The graphical interface</heading>
393 Please note that the gnome, gtk and win32 interfaces are currently the most
394 advanced. The following descriptions refer to them.
397 <heading>Opening a stream</heading>
399 For opening streams through the graphical interface, click on either
400 "File" for opening a file stored on your hard drive, "Disc" for
401 opening a DVD or a VCD, "Network" for reading a stream from a vls
402 or through http input, or "Satellite" for reading directly
403 from a satellite card.
406 <heading>Basic stream control</heading>
408 You have at your disposal all the classical control of a video player.
409 For example when playing local streams, you can do pauses, speed up or
410 slow down the stream ... Just use the corresponding buttons.
413 <heading>DVD and VCD navigation</heading>
415 When reading a DVD or a VCD, you can change chapter and title either
417 right-click menu or by using the dedicated bar that appears when reading
423 <heading>Programs, audio and subtitles</heading>
425 When reading a multiprogram stream, you can change the current program
426 by selecting it in the "View/Programs" submenu, or using the "right click"
427 menu from the video output window.
430 In DVDs, if different angles are availables, they will be treated as
434 At any time you can change the audio/subtitles channel using either the
435 "setting" menu from the interface or using the "right click" menu from
436 the video output window.
439 <heading>Preferences window</heading>
441 By choosing "Preferences" in the "Settings" menu, you will open
442 the preferences window. This window is generated dynamically according
443 to the modules that were compiled.
446 In every tab, you may click on "Save" to store your settings in your
447 ~/.videolan/vlcrc file.
450 <heading>Interface tab</heading>
452 In that tab, you can select which interface you would like to use on next
453 start. Click on the choosen interface, click on "Select" then on "Save".
457 <heading>Audio tab</heading>
459 In this tab, you can select the audio output you would like to use on
460 next start. You may also specify some other settings such as the output
461 level, the audio frequency, ...
465 <heading>Video tab</heading>
467 In this tab, you can select which video output will be used on next start,
468 and add a video filter module. You may also specify some video settings,
469 such as the window size or if you would like fullscreen display.
473 <heading>Input tab</heading>
475 In this tab, you can enter the input method with options (for example
476 <tt>udp:@239.255.255.42</tt>) that will be used on next start. You can
477 also add some settings, such as the channel server address ...
481 <heading>Decoders tab</heading>
483 In this tab, you can select which decoder you want to use for MPEG audio
488 <heading>CPU tab</heading>
490 In this tab, you may disable the use of some CPU extensions such as
495 <heading>Playlist tab</heading>
497 In this tab, you can select some playlist options, such as looping the
502 <heading>Miscellanous tab</heading>
504 In this tab, you can select which memcpy version you want to use. Some
505 of them uses MMX 3Dnow! extensions.
511 <heading>Command line options</heading>
513 Many options are only available through command line. They are detailed here.
516 <heading>Opening streams</heading>
518 The following commands start vlc and add a first element to the playlist.
521 <heading>Opening a file</heading>
523 Simply start vlc with <tt>vlc my_file.mpg</tt>.
526 You may tell vlc what input to use, for example add <tt>--input ts</tt>
527 when playing a ts MPEG, although vlc should be able to recognize the type
532 <heading>Opening a DVD or VCD</heading>
534 Simply start vlc with <tt>vlc dvd:DVDDRIVE</tt> or <tt> vlc vcd:CDROMDRIVE
535 </tt>, where DVDDRIVE/CDROMDRIVE is the complete
536 path to your dvd/cdrom drive.
539 You may add <tt>-t X -T Y</tt> to start directly from the Xth chapter, Yth
544 <heading>Start a network stream</heading>
546 To receive an UDP stream (being sent from a VLS), start vlc with
547 <tt> vlc udpstream:[@<bind address>[:<server port>]] </tt>.
550 Please note that bind address refers to the destination address, for
551 example your broadcast address. If the stream is being broadcasted,
552 <verb> vlc udpstream:</verb> should be sufficient. If the stream
553 is multicasted, you must specify the multicast address, for example
554 <verb> vlc udpstream:@239.255.255.42 </verb>
556 To receive a http stream, start vlc with <tt>vlc <your URL></tt>.
564 <heading>Modules selection</heading>
566 The vlc tries to select the most appropriate interface, input and output
567 modules, among the ones available on the system, according to
568 the stream he is given to read. However, you may wish to force
569 the use of a specific module with the following options:
571 <p> <verb>--intf <interface module></verb>
572 allows you to select the interface module </p>
574 <p> <verb>--vout <video output module></verb>
575 allows you to select the video output.</p>
577 <p> <verb>--aout <audio output module></verb>
578 allows you to select the audio output.</p>
580 <p> <verb>--filter <video filter module></verb>
581 allows you to add a video filter module.</p>
583 <p> <verb>--mpeg-adec <MPEG audio decoder module></verb>
584 allows you to select the audio MPEG decoder.</p>
586 <p> <verb>--ac3-adec <AC3 audio decoder module></verb>
587 allows you to select the audio AC3 decoder.</p>
591 <heading>Other options</heading>
593 <heading>Help options:</heading>
595 <p> <verb>--help</verb>
596 gives you all the available options.</p>
597 <p> <verb>--longhelp</verb>
598 gives you a more detailled version of the available options.</p>
599 <p> <verb>--version</verb>
600 gives you information about the current version.</p>
601 <p> <verb>--list</verb>
602 gives you the list of all available plugins.</p>
603 <p> <verb>-vvvv (X times)</verb>
604 set the level of warning messages.</p>
605 <p> <verb>--stats</verb>
606 gives statistic outputs.</p>
610 <heading>Audio options:</heading>
613 <p> <verb>--noaudio</verb>
614 disables the audio output</p>
615 <p> <verb>--mono</verb>
616 forces the vlc to treat the stream in mono audio.</p>
617 <p> <verb>--volume <integer></verb>
618 set the level of audio output.</p>
619 <p> <verb>--rate <integer></verb>
620 set the audio output frequency (Hz)</p>
621 <p> <verb>--desync <integer></verb>
622 compensates desynchronization of audio (ms)</p>
626 <heading>Video options:</heading>
628 <p> <verb>--novideo</verb>
629 disables the video output</p>
630 <p> <verb>--width <integer></verb>
631 <verb>--height <integer></verb>
632 set the video window dimensions.</p>
633 <p> <verb>--grayscale</verb>
634 turns video output into grayscale mode.</p>
635 <p> <verb>--fullscreen</verb>
636 set fullscreen video.</p>
637 <p> <verb>--nooverlay</verb>
638 disables hardware acceleration for the video output</p>
639 <p> <verb>--spumargin <integer></verb>
640 force subtitles position.</p>
644 <heading>Input options:</heading>
647 <p> <verb>--network-channel</verb>
648 Start with channel server enabled.</p>
649 <p> <verb>--channel-server <string></verb>
650 Specify the channel server address.</p>
651 <p> <verb>--channel-port <integer></verb>
652 Specify the channel server port.</p>
653 <p> <verb>--iface <string></verb>
654 Select the network interface to use.</p>
655 <p> <verb>--input-program <integer></verb>
656 Select the program to use (for streams with
657 several programs, as those coming from satellite).</p>
658 <p> <verb>--audio-type <integer></verb>
659 Select the audio channel to use.</p>
660 <p> <verb>--subtitle-channel <integer></verb>
661 Select the subtitle.</p>
662 <p> <verb>--audio_channel <integer></verb>
663 Select the channel number.</p>
664 <p> <verb>--dvd <string></verb>
665 Specify the default dvd device.</p>
666 <p> <verb>--vcd <string></verb>
667 Specify the default vcd device.</p>
668 <p> <verb>-4, --ipv4</verb>
670 <p> <verb>-6, --ipv6</verb>
675 <heading>CPU options</heading>
676 <p> <verb>--nommx</verb>
677 disable the use of mmx CPU extensions.</p>
678 <p> <verb>--no3dn</verb>
679 disable the use of 3D Now! CPU extensions.</p>
680 <p> <verb>--nommxext</verb>
681 disable the use of mmx ext CPU extensions.</p>
682 <p> <verb>--noaltivec</verb>
683 disable the use of AltiVec CPU extensions.</p>
694 <heading>Building the vlc from sources</heading>
696 You can choose either to take the latest release, or a CVS source. Note that
697 CVS snapshots may be broken, although we do our best to prevent this from
701 From here, you have to be a little experienced, even more if you want to use
705 <heading>Getting an archive</heading>
707 You have guessed it, the first thing to do is to get the source.
708 Until there, everyone should understand :)
711 <heading>Web site</heading>
713 Source packages can be found in the "tarballs" section of the download page :
714 <htmlurl url="http://www.videolan.org/download.html" name="http://www.videolan.org/dowload.html">.
717 CVS snapshots are available from the address :
718 <htmlurl url="http://www.videolan.org/packages/snapshots/"
719 name="http://www.videolan.org/packages/snapshots/">.
722 Then untar the archive :
724 tar xzf vlc-x-x-x.tar.gz
729 <heading>Directly from CVS</heading>
731 First log in as user anonymous with an empty password :
733 cvs -d :pserver:anonymous@anoncvs.videolan.org:/var/cvs/videolan login
735 Then retrieve the repository :
737 cvs -d :pserver:anonymous@anoncvs.videolan.org:/var/cvs/videolan -z3 checkout vlc
742 <heading>libdvdcss</heading>
744 To compile vlc with dvd support, you need to get and install libdvdcss.
747 It is available for download here :
748 <htmlurl url="http://www.videolan.org/libdvdcss/download.html"
749 name="http://www.videolan.org/libdvdcss/download.html">
751 Decompress the tarball in a directory of your choice and build it :
753 tar -xvzf libdvdcss-x.x.x.tar.gz
757 [as root] make install
760 You can also find binaries packages for many distributions.
764 <heading>Building the program</heading>
765 <p><label id="compile">
766 Go into the vlc directory and run the configure script :
770 If you want to enable options, you may add "--enable-option"
771 to the previous line.
772 For example, to build with the xvideo extension, and alsa support,
775 ./configure --enable-xvideo --enable-alsa
777 To get the list of the available options, and know if they are
785 Also have a look on the <ref id="modules" name="following modules
789 A very typical installation, on a XFree 4.1 system, recent video card, with
792 ./configure --enable-esd --enable-gnome
797 <heading>Plugins, builtins ...</heading>
799 The configure script should create a Makefile.opts file, which you can edit and modify.
800 Indeed you can chose to have features (as esd support, for example) built as plugins
801 or inside the program.
804 If you build a feature as a plugin, it can lead to a little loss of performance.
805 It you build it inside the code, it'll enlarge a bit the size of the executable.
808 When you're done with Makefile.opts (which also works if you leave it
814 It should compile without any error. If there are, please check you
815 have the required libraries
816 installed on your system, as the configure script can't check them all.
819 When you're done with it, as root, type :
823 if you wish to have vlc fully installed on your system. If you prefer
825 current directory, you may skip the "make install". You'll then have
827 directory and type "./vlc" instead of just typing vlc.
833 <heading>Modules description</heading>
836 Here is a description of nearly all the available modules for the
837 vlc. If you wish to compile one which is stated disabled by default,
838 you have to launch the configure script with
839 <verb> ./configure --enable-module_name </verb>. See <ref
840 name="compilation instructions" id="compile">.
842 <heading>Video outputs</heading>
844 <heading>x11</heading>
845 <p>default :enabled </p>
847 This is the basic x11 video output. It only requires a
848 working X11 server. You will need xlibs headers to compile it
849 (xlibs-dev package on Debian systems).
854 <heading>xvideo</heading>
855 <p>default : enabled</p>
857 It requires an xvideo compliant graphic card (it is the case for
858 nearly all the modern card). It uses hardware acceleration for
859 yuv transformation and for rescaling.
864 <heading>sdl</heading>
865 <p>default : enabled</p>
867 This video output uses sdl libraries. You need at least version 1.1.6 of
871 You may indicate the path to the sdl-config program with the
872 <verb> --with-sdl-config-path=PATH </verb> option given to the <verb>
873 configure</verb> script.
878 <heading>directx</heading>
879 <p>default: enabled on win32</p>
881 This video output uses Microsoft Direct X libraries. It is recommended
885 You may indicate the path to directx libraries and headers with
886 the <verb>--with-directx=PATH</verb> option.
890 <heading>fb</heading>
891 <p>default: enabled on Linux</p>
893 This is the frame buffer video output. It requires that your kernel
894 was compiled with frame buffer support.
899 <heading>glide</heading>
900 <p>default: disabled</p>
902 This video output uses Glide libraries (hardware acceleration for
906 You may indicate the path to the library with the
907 <verb>--with-glide=PATH</verb> compilation option.
912 <heading>mga</heading>
913 <p>default: disabled</p>
915 It provides hardware acceleration for Matrox cards on Linux.
920 <heading>ggi</heading>
921 <p>default: disabled</p>
925 <heading>aa</heading>
926 <p>default: disabled</p>
928 This video output uses the aalib library to display video
929 through ASCII art. It requires aalib headers (aalib1-dev under Debian)
935 <heading>Video filters modules</heading>
937 <heading>deinterlace</heading>
938 <p>default: enabled</p>
940 This filter deinterlaces video. It is useful with streams coming
941 from a satellite broadcast.
946 <heading>wall</heading>
947 <p>default: enabled</p>
949 This filter allows you to have the video cut in pieces in several
950 windows, which you can order as you wish. It can be used to generate
951 image walls with several sources. Start it with
952 <verb> --filter wall:XxY</verb> in order to have the video cut in X rows
957 <heading>distort</heading>
958 <p>default: enable</p>
960 This filter adds a distortion effect to the video. Who said it
966 <heading>transform</heading>
967 <p>default: enable</p>
969 This filter rotates the video window of 90 degrees.
974 <heading>invert</heading>
975 <p>default: enabled</p>
977 This filter inverses colors.
982 <heading>Sound outputs</heading>
984 <heading>dsp</heading>
985 <p>default: enabled on Linux</p>
987 This is the Linux /dev/dsp output. It requires that your kernel
988 was compiled with support for your sound card.
993 <heading>alsa</heading>
994 <p>default: disabled</p>
996 This is the sound output for Advanced Linux Sound Architecture.
997 It requires that you installed the alsa drivers and libraries.
1002 <heading>esd</heading>
1003 <p>default: disabled</p>
1005 This sound output has Enlightened Sound Daemon support
1006 (usually used with Gnome).
1007 You must have the daemon and its libraries installed.
1011 <heading>arts</heading>
1012 <p>default: disabled</p>
1014 This sound output has aRts (KDE's sound server) support.
1015 You must have the daemon and its libraries installed.
1020 <heading>waveout</heading>
1021 <p>default: enabled on win32</p>
1023 This is the Wave output, which is used by the win32 port.
1029 <heading>Input modules</heading>
1031 <heading>dvd</heading>
1032 <p>default: enabled</p>
1034 This is the DVD input module. It will need libdvdcss, which can
1035 be found <htmlurl url="http://www.videolan.org/libdvdcss/"
1036 name="http://www.videolan.org/libdvdcss/">.
1041 <heading>dvdread</heading>
1042 <p>default: disabled</p>
1044 This is an alternative to the previous one, it uses libdvdread
1045 (which also needs libdvdcss).
1049 <heading>vcd</heading>
1050 <p>default: enabled</p>
1052 This is the VideoCD input.
1056 <heading>http</heading>
1057 <p>default: enabled</p>
1059 This is the http input. You can use it for Video On Demand.
1063 <heading>satellite</heading>
1064 <p>default: disabled</p>
1066 This is an input module that allows to read directly from a
1067 Hauppauge WinTV Nova card under Linux. It requires drivers 0.9.4
1069 <htmlurl url="http://www.linuxtv.org/" name="linuxtv.org">.
1073 <heading>avi</heading>
1074 <p>default: enabled</p>
1076 This input module allows to read .avi files.
1083 <heading>Interface modules</heading>
1085 <heading>gtk</heading>
1086 <p>default: enabled</p>
1088 This is the GTK+ interface. It needs gtk libraries (libgtk1.2 package
1089 on Debian) and headers files if you are compiling it (libgtk1.2-dev
1090 package on Debian). Note that it can be used under Windows.
1094 <heading>gnome</heading>
1095 <p>default: disabled</p>
1097 This is the Gnome interface. It needs gnome libraries (libgnome32 under
1098 Debian) and headers (libgnome-dev) if you wish to compile it.
1102 <heading>intfwin</heading>
1103 <p>default: enabled on win32</p>
1105 This is the Windows native interface. It requires Borland C++ builder
1106 to compile. You may use <verb>--with-bc-builder=PATH</verb> option
1107 to specify the path to this application.
1112 <heading>qt</heading>
1113 <p>default: disabled</p>
1115 This is the QT libraries interface module. You will need the libraries
1116 (libqt2 package on Debian) and headers (libqt-dev) if you wish to
1121 <heading>kde</heading>
1122 <p>default: disabled</p>
1124 This is the KDE interface module. You will need the libraries
1125 (kdelib package on Debian) and headers (kde-devel) if you wish to
1131 <heading>rc</heading>
1132 <p>default: enable</p>
1134 This is the Remote Control interface module. With this one, vlc
1135 is controled by sending him commands, such as play, stop, ... so
1136 that you may control vlc through a script.
1141 <heading>ncurses</heading>
1142 <p>default: disabled</p>
1144 This is a text interface, using ncurses library. You will need
1145 ncurses headers if you want to compile it (libncurses5-dev on Debian).
1149 <heading>lirc</heading>
1150 <p>default: disabled</p>
1152 This interface module allows you to control vlc through a remote.
1153 A lircrc example is provided to help you configure it to your remote
1154 (see doc/lirc/example.lircrc).
1159 <heading>Codec modules</heading>
1160 <p> The following modules add codec support. </p>
1162 <heading>a52</heading>
1163 <p>default: disabled</p>
1165 This is a better AC3/A52 decoder than the built-in one, based on
1167 <htmlurl url="http://liba52.sf.net/" name="liba52">.
1171 <heading>ffmpeg</heading>
1172 <p>default: disabled</p>
1174 This is a free MPEG-4/DivX/OpenDivX codec :
1175 <htmlurl url="http://ffmpeg.sf.net/" name="ffmpeg">.
1181 <heading>OS support modules</heading>
1182 <p> The following modules add support or different OSs. </p>
1184 <heading>macosx</heading>
1185 <p>default: enabled on MacOS X</p>
1187 This is the MacOS X support module, including a native interface.
1192 <heading>qnx</heading>
1193 <p>default: enabled on qnx</p>
1195 This is the QNX RTOS support module.
1201 <heading>Specific use of the vlc</heading>
1203 <heading>Use the vlc as a viever and decoder for the Hauppauge WinTV
1206 <heading>What is required ?</heading>
1208 At the present time, the satellite input only works under Linux.
1209 It requires that drivers version 0.9.4 of the card, drivers
1210 that are being developped by the <htmlurl name="linuxtv.org"
1211 url="http://www.linuxtv.org/">.
1215 <heading>Building the vlc with satellite support</heading>
1217 Get the sources, either from our last .tar.gz release,
1218 or best from the cvs (see <ref name="cvs instructions"
1222 Move to the vlc directory, then launch
1224 ./configure --enable-satellite
1226 You may add other compilation options, see <ref
1227 name="compilation instructions" id="compile">.
1228 Then launch the compilation with
1232 You may install it with (as root)
1236 or run it from the current directory.
1240 <heading>Running it from the command line</heading>
1244 vlc satellite:<frequency(Hz)>,<polarization(0 for V,
1246 >FEC (1 for 1/2, 2 for 2/3 ...)>,<symbol rate (kbytes/sec)>
1248 You then have to select your program, either with the command line option
1250 --input_program <program_number (also called service ID)>
1252 or by choosing it in the view/programs menu.
1255 <heading>Running it from the GTK/Gnome interface</heading>
1257 Click on the "Sat" icon. In the opening box, you may enter
1258 your transponder settings, then click on "Ok".
1261 After a few seconds, the word satellite should appear under the command
1262 buttons. You may now choose your program from the View/Programs menu.
1267 <heading>Use the vlc to create image walls.</heading>
1269 The idea is to use several video sources, each one displaying a part
1270 of the whole image, to get a bigger result.
1273 Vlc and the VideoLAN solution can provide a good way to create
1274 such displays : a vls broadcasts a stream in several vlc each
1275 display a part of image.
1278 For this, you should use the wall filter : start vlc with
1280 vlc udp: --filter wall:<number of rows>x<number of columns>
1281 :<number of the part to diplay>
1288 <heading>Get more help</heading>
1290 First of all, it something seems to go wrong, read and try to
1291 understand the error messages. You can have detailed messages by
1292 choosing messages in the view menu, in GTK, Gnome and Win32 interfaces.
1295 There is a FAQ page on our website :
1296 <htmlurl url="http://www.videolan.org/doc/index.html" name="http://www.videolan.org/doc/index.html">.
1297 If you think one question should be in the FAQ, please contact
1298 <htmlurl url="mailto:videolan@videolan.org" name="videolan@videolan.org">
1301 Finally, there's a users mailing list (English-speaking). To subscribe, send a mail to
1302 <htmlurl url="mailto:listar@videlan.org" name="listar@videlan.org"> containing
1303 "subscribe vlc" as message body.
1306 </article></linuxdoc>