VideoLAN Wiki - User contributions [en]

VLC HowTo/Add a logo

2008-04-25T07:45:36Z

Tayssir: Troubleshooting bad-looking logo images

{{howto|add a logo on your video using the logo filter}}

= Idea =
This How To just explains how to use the logo filter in order to add a logo on your videos, like a TV.

== Local ==
vlc --sub-filter logo --logo-file ''logo.png'' ''video.avi''

== Stream ==
vlc --logo-file ''logo.png'' ''video.avi'' --sout "#transcode{vcodec=...,vb=...,sfilter=logo}:std{...}"

Make sure you do not specify --sub-filter logo, and that you specify a vcodec= value in the transcode part.

== Save the new video locally ==
vlc --logo-file ''logo.png'' ''video.avi'' --sout "#transcode{vcodec=...,vb=...,sfilter=logo}:std{access=file,dst=''new_video.avi'' }

== Dynamically change logo using [[Console | RC]], then send output to stream and local debugging display ==

vlc -I rc --logo-file nonexistent_dummy.png --sout "#transcode{vcodec=...,vb=...,sfilter=logo}:duplicate{dst=display,dst=std{...}}"

# Once the program has started
add ''video.avi''
# If using VLC 0.8.6 or older:
logo-file ''logo.png''
# If using VLC 0.9.0 or newer (see NEWS for details about the new syntax):
@logo logo-file ''logo.png''

This requires a <code>--logo-file</code>, but for some reason it won't work if you specify "<code>--sub-filter logo</code>". Nor does it apparently work if the <code>transcode</code> doesn't specify <code>[[Codec#Video_Codecs | vcodec=]]</code>.

A non-existent logo-file currently removes any logos from the video, and does not result in an error. Since you must specify one on the command-line, "<code>nonexistent_dummy.png</code>" was used.

= Troubleshooting =

== My text doesn't look right! It's sort of pixellated or has artifacts. ==

Sounds like a stretching or deinterlacing problem. One possible solution is to set your "<code>--aspect-ratio</code>" to the right setting. For instance, I got this when I ran VLC with "<code>-vvv</code>" (for verbose verbose verbose output):

[00000372] main video output debug: picture in 704x576 (0,0,704x576), chroma I420, ar 4:3, sar 12:11
[00000372] main video output debug: picture user 704x576 (0,0,704x576), chroma I420, ar 4:3, sar 12:11
[00000372] main video output debug: picture out 768x576 (0,0,768x576), chroma RV32, ar 4:3, sar 1:1

Here, the input was 704x576 resolution and VLC outputted it to 768x576. My text was added before this stretching occurred, and so the text looked awful. Forcing it back to the normal resolution using "<code>--aspect-ratio 11:9</code>" worked. (Because 704/576 = 11:9.)

User:Tayssir

2008-03-05T10:13:21Z

Tayssir:

Hi, I'm using VLC to record meetings of a pretty large city council. A moderator uses a GUI (written in Common Lisp) to record who is speaking and manage their political party speaking times. This information goes to a server and it asks VLC to overlay a speaker name and maybe a logo. The video goes out both streaming and to file.

This is all automated.

Right now I have a problem, since sometimes the video should cut to a logo, and the audio stopped. The video is no problem, but I'm not so hot at writing audio filters (because of insignificant C experience), so stopping the audio is a problem. With dionoea's kindly advice, I'm trying to solve this with with bridge-in (formerly part of Mosaic). Hope it interacts well with the stream filters I'm chaining together; the chain length is like 4 or 5.

User:Tayssir

2008-03-05T10:12:53Z

Tayssir: description of how I'm using VLC

Hi, I'm using VLC to record meetings of a pretty large city council. A moderator uses a GUI (written in Common Lisp) to record who is speaking and manage their political party speaking times. This information goes to a server and it asks VLC to overlay a speaker name and maybe a logo. The video goes out both streaming and to file.

This is all automated.

Right now I have a problem, since sometimes the video should cut to a logo, and the audio stopped. The video is no problem, but I'm not so hot at writing audio filters, so stopping the audio is a problem. With dionoea's kindly advice, I'm trying to solve this with with bridge-in (formerly part of Mosaic). Hope it interacts well with the stream filters I'm chaining together; the chain length is like 4 or 5.

Documentation:Streaming HowTo/Advanced Streaming Using the Command Line

2008-03-05T10:02:02Z

Tayssir: easier to read

{{RightMenu|documentation streaming howto toc}}



==Structure of stream output==

Stream output is the name of the feature of VLC that allows to output any stream read by VLC to a file or as a network stream instead of displaying it. Different kind of processing can be applied to the stream during this process (transcoding, re-scaling, filters, re-muxing...). Stream output includes different modules, each of them having different capabilities. You can ''chain'' modules to enhance the possibilities.

Here is the list of the modules currently available:

* '''standard''' allows to ''send'' the stream via an ''access output'' module: for example, UDP, file, HTTP, ... You will probably want to use this module at the end of your chains.

* '''transcode''' is used to transcode (decode and re-encode the stream using a different codec and/or bitrate) the audio and the video of the input stream. If the input or output access method doesn't allow pace control (network, capture devices), this done "on the fly", in real time. This can require quite a lot of CPU power, depending on the parameters set. Other streams, such as files and disks are transcoded as fast as the system allows it.

* '''duplicate''' allows you to create a second chain, where the stream will be handled in an independent way.

* '''display''' allows you to display the input stream, as VLC would normally do. Used with the ''duplicate'' module, this allows you to monitor the stream while processing it.

* '''rtp''' streams over RTP (one UDP port for each elementary stream). This module also allows RTSP support.

* '''es''' allows you to make separate Elementary Streams (ES) out of an input stream. This can be used to save audio and video streams to separate files, for instance.

* '''bridge-out''' TODO
* '''bridge-in''' TODO
* '''mosaic-bridge''' TODO

Each of these modules may take options. Here is the
syntax that you must use:

% '''vlc input_stream --sout "#module1{option1=parameter1{parameter-option1},option2=parameter2}:module2{option1=...,option2=...}:..."'''

'''NOTE:''' Some of the module options (option1 in the example) have to be set, others are optional. Option parameters (parameter-option1 in the example) are always optional. These option parameters are also often very advanced settings. If you don't understand their description, this certainly means that you don't need them.

You may also use the following syntax :

% '''vlc input_stream --sout-module1-option1=... --sout-module1-option2=... --sout-module2-option1=... --sout-module2-option2=... ...'''

For example, to transcode a stream and send it, use:

% '''vlc input_stream --sout '#transcode{options}:standard{options}' '''

==Description of the modules==

===standard (alias std)===

This module saves the stream to a file or sends it over a network, after having muxed it.

The available options are:

====access====

This option allows to set the medium used to save or send the stream. This is a compulsory option. Available options are:

* '''file''': saves the stream to a file.
Use the ''append'' option to append the stream to an existing file instead of replacing it:

standard{ ... ,'''access=file{append}''', ... }

* '''udp''': streams to a UDP unicast or multicast address.
Item options are:
** '''caching=<time in ms>''' to set the time VLC should buffer data before sending it;
** '''ttl=<ttl>''' to set the ttl of the sent udp packets;
** '''group=<amount of packets>''' to sent packets by burst instead of one by one;
** '''late=<time in ms>''' to drop packets that arrive too late at this stage of the chain;
** '''raw''' if you don't want to wait until the MTU is filled before sending the packet.

* '''http''': streams over HTTP.
Item options are:
** '''user=<user name>''' to enable HTTP basic authentication and set the user;
** '''pwd=<password>''' to set the basic authentication password;
** '''mime=<mime type>''' to set the mime type returned by the server.

* '''https''': streams over HTTP, using a secured SSL connection.
Item options are the same as for http and:
** '''cert=<path to certificate>'''to set the certificate to use;
** '''key=<path to key>''' to set the private key file the server should use for the SSL connection;
** '''ca=<path to certificate>''' to set the path to the root CA certificates to use for SSL;
** '''crl=<path to certificate>''' to set the revocation certificate to use for the SSL connection.

* '''mmsh''': streams using the Microsoft MMS protocol. This protocol is used as transport method by many Microsoft's softwares.
Note that only a small part of the MMS protocol is supported (MMS encapsulated in HTTP).
Item options are the same as for the http module.

* '''rtp''': streams over RTP. Please note that this is a legacy module. It doesn't allow RTSP and can only be used to stream TS streams. Please have a look at the '''rtp''' stream output module for a more compliant and complete RTP streamer.
Options are the same as for the ''udp'' setting.

====mux====
This option allows you to set the encapsulation method used for the resulting stream. This option has to be set.

Available options are:

* '''ts''': the MPEG2/TS muxer. This the standard muxer used to stream MPEG 2. This muxer can be used with any '''access''' method. Supported codecs are MPEG 1/2/4, MJPEG, H263, H264, I263, WMV 1/2 and theora for video, MPEG audio, AAC and a52 for the audio stream.
Item options are:
** '''pid-video=<pid>''' to set the PID of the video track;
** '''pid-audio=<pid>''' to set the PID of the audio track;
** '''pid-spu=<pid>''' to set the PID of the subtitle track;
** '''pid-pmt=<pid>''' to set the PID of the PMT (Program Map Table);
** '''tsid=<id>''' to set the ID of the resulting TS stream;
** '''shaping=<shaping delay in ms>''' to set the minimum interval during which the bitrate of the stream will remain constant, for variable bitrate streams;
** '''use-key-frames''' uses I frames as limits for the shaping intervals;
** '''pcr=<PCR interval in ms>''' allows to set at which interval Program Clock References will be sent;
** '''dts-delay=<delay in ms>''' allows to delay PTS (Presentation Time Stamps) from the DTS (Decoding Time Stamp) from the given time;
** '''crypt-audio''' allows to enable encryption of the audio track using the CSA algorithm;
** '''csa-ck=<key as a 16 character word>''' allows to set the key used for CSA encryption.

* '''ps''': the MPEG2/PS muxer. This the standard muxer for MPEG 2 files(.mpg). It can be used with the file and http output methods. Supported codecs are MPEG 1/2 and MJPEG for video, MPEG audio and a52 for audio streams.
The only available item option is:
** '''dst-delay=<delay in ms>''': It allows to delay PTS (Presentation Time Stamps) from the DTS (Decoding Time Stamp) from the given time.

* '''mpeg1''': the standard MPEG 1 muxer. This muxer should be used instead of ps with MPEG 1 video streams, when saved to a file or streamed over HTTP. Supported codecs are MPEG 1 and MPEG audio.
Items options are the same as for the PS muxer.

* '''ogg''': the ogg muxer. This is the muxer from the Xiph project. It can be used with the HTTP and file output methods. Supported codecs are MPEG 1/2/4, MJPEG WMV 1/2 and Theora, audio streams can be vorbis, flac, speex, a52 or MPEG audio.
There is no item option for this muxer.

* '''asf''': the Microsoft ASF muxer. This is the standard muxer used for streaming by Microsoft's softwares. Is also used as container for WMA audio files. This muxer can be used with the file and HTTP output methods. Supported codecs are MPEG 4, MJPEG, WMV 1/2 for video, MPEG audio, a52 for audio streams.
Item options are:
** '''title=<title>''';
** '''autor=<author>''';
** '''copyright=<copyright message>''';
** '''comment=<comments>''';
** '''rating=<rating>''' allow you to set what will be displayed in the according field of the stream comments.

* '''asfh''': this is a special version of the ASF muxer, that should be used for MMSH streaming. MMSH is the only supported output
method. Supported codecs are the same as for ASF.
Item options are the same as for ASF.

* '''avi''': the Microsoft AVI muxer. This is very common encapsulation format for MPEG 4 files. The only supported output method
is file. Supported codecs are MPEG 1/2/4, H263, H264 and I263 for video, MPEG audio and a52 for audio streams.
There is not item option for this muxer.
'''Note''': The avi muxer in VLC is known to produce corrupt files.

* '''mpjpeg''': the multipart jpeg muxer.
This encapsulation format is mostly used on surveillance video cameras with an integrated web-server. Such streams are usually embedded in web-pages and seen with standard Internet browsers, as they are seen as a succession of jpeg images. The only supported output method is HTTP. The only usable codec is MJPEG. No sound track can be muxed in such streams.
No item option is available for this muxer.

====dst====

This option allows to give informations about the location where the stream should actually be saved or sent.

Here is the meaning of the '''dst''' option depending on the parameter used for the '''access''' option.

* If the '''file''' output method is used, '''dst''' is the path where the file should be saved.
* If the '''udp''' or '''rtp''' output method is used, '''dst''' is the unicast or multicast destination address and, optionally, UDP port, in the form '''address:port'''.
* If the '''http''', '''https''' or '''mmsh''' output method is chosen, '''dst''' is the address, port and path of the local network interface on which the server should listen for requests. If no address is given, VLC will listen on all the network interfaces. These information have to be supplied using the '''address:port/path''' syntax.

====sap====

Use this option if you want VLC to send SAP (Session Announcement Protocol) announces. SAP is a service discovery protocol, that uses a special multicast address to send a list of available streams on a server.

This option can only be enabled with the '''udp''' output method.

====group====

This option allows to specify the name of an optional '''group''' of streams. A VLC used as a client will use this field to classify the stream.

This option uses a private extension of the SAP protocol. VLC will be the only client able to read this field.

This option can only be used if the '''sap''' option has been enabled.

====sap-ipv6====

Use this option if you want the SAP announces to be sent using the '''IPv6''' protocol instead of '''IPv4'''.

This option can only be used if the '''sap''' option has been enabled.

====slp====

SLP stands for ''Service Location Protocol''. It is an alternative to SAP for session announcement. Use this option if you want to send such announces.

====name====

Use this option to specify the name of the stream that will be sent in SAP and SLP announces.

This option can only be used if the '''sap''' or '''slp''' option has been enabled.

===display===

This module can be used to display the stream. This is particularly useful in a '''duplicate''' chain, in order to monitor a stream while it is being saved or streamed.

Available options are:

====novideo====

You can use this option to disable video in the displayed stream.

====noaudio====

You can use this option to disable audio in the displayed stream.

====delay====

You can use this option to introduce a delay in the display of the stream. Delay has to be given in ms.

===rtp===

This module can be used to send a stream using the ''RTP (Real Time Protocol)'' protocol (see RFC 3550).

Although use of ''RTSP'' is possible using this module, it won't allow you to make Video On demand. Please have a look at the description of the VLM module for that.

The different available options are:

====dst====

This option allow to give the destination UDP address. This can be the address of a host or a multicast group. This option has to be given, unless the ''sdp=rtsp://''option is given (see below). In the latter case, the stream will be sent to the host doing the
''RTSP'' request.

====port====

This option allows to set the UDP port used to send the first ''elementary stream''. This port has to be even. Other streams will be streamed using even ports directly above this one.

====port-video====

This option allows to set the UDP port used to send the first video ''elementary stream''. This port has to be even.

====port-audio====

This option allows to set the UDP port used to send the first audio ''elementary stream''. This port has to be even.

====sdp====

This option allows to set the way the SDP (Session Description Protocol) file corresponding the the stream should be made available.
Options are:

* '''file://<path to the file>''', to export the SDP as a local file.
* '''http://<local interface IP:port/path>''', to make the file available using the integrated HTTP server of VLC.
'''Note''': The '''local interface IP''' argument is optional. If not given, VLC will listen on all available interfaces.
* '''rtsp://<local interface IP:port/path>'', to make the SDP file available using the ''RTSP'' protocol (see RFC 2326).
'''Note''': The ''local interface IP'' argument is optional. If not given, VLC will listen on all available interfaces.
* '''sap''', to export the SDP using the SAP (Session Announcement Protocol, see RFC 2974).

====ttl====

This option can be used to set the ''TTL'' (Time to Live) of the sent UDP packets.

====mux====

This option allows to set the encapsulation method used to send the stream. See '''mux''' options of the '''standard''' module for a description of the available method. Only '''ts''' and '''raw''' (no encpasulation) are possible values for ''RTP'' streams. Default is RAW.

====name====

This option can be used to set the name that will be displayed on the client receiving the stream.

====description====

This option can be used to give an additional description of the stream.

====url====

This option allows to give the address of a website with additional informations about the stream.

====email====

This options allows to give a contact e-mail address.

===es===

The '''es''' module can be used to separate the different ''elementary streams'' from a stream, and save each of them in a different file or send it to a separate destination.

The available parameters are:

====access-video====

Use this option to set the medium used to save or send the video ''elementary streams''. Possible values and item options are the same as for the '''access''' option of the '''standard''' module (see above).

====access-audio====

Use this option to set the medium used to save or send the audio ''elementary streams''. Possible values and item options are the same than for the '''access''' option of the '''standard''' module (see above).

====access====

This option can be used instead of both '''access-video''' and '''access-audio''' options, when they share the same setting.

====mux-video====

Use this option to set the encapsulation method used for the video ''elementary streams''. Possible values and item
options are the same as for the '''mux''' option of the '''standard''' module (see above).

====mux-audio====

Use this option to set the encapsulation method used for the audio ''elementary streams''. Possible values and item options are the same than for the '''mux''' option of the '''standard''' module (see above).

====mux====

This option can be used instead of both '''mux-video''' and '''mux-audio''' options, when they share the same setting.

====dst-video====

Use this option to set the location where the video ''elementary streams'' should be saved, sent, or made available. The exact meaning of this option depends on the value of the '''access-video''' option and is the same as for the '''url''' option of the '''standard''' module (see above).

'''Note''': If you use the ''%n'' string in the url field, VLC will replace it by the number of the audio or video track
considered. The ''%c'' string will be replaced by the name (FOURCC) of the codec of the track. ''%a'' prints the access output used and ''%m'' the muxer used.

====dst-audio====

Use this option to set the location where the audio ''elementary streams'' should be saved, sent, or made available. The exact meaning of this option depends on the value of the '''access-audio''' option and is the same as for the '''url''' option of the '''standard''' module (see above).

'''Note''': If you use the ''%n'' string in the url field, VLC will replace it by the number of the audio or video track considered. The ''%c'' string will be replaced by the name (FOURCC) of the codec of the track. ''%a'' prints the access output used and ''%m'' the muxer used.

====dst====

This option can be used instead of both '''dst-video''' and '''dst-audio''' options, when they share the same setting.

===transcode===

You can use this module to transcode a stream, i.e. to change its codecs or the encoding bitrates. Some additional processing can be done during this process, such as re-scaling, deinterlacing, resampling, etc.

'''Note''': Depending on the bitrate of the original stream and of the options chosen, transcoding can be a very CPU intensive task. As a consequence, streaming of a real time transcoded stream can lead to dropped frames or a jerky image and sound in some cases, when running out of resources.

Available options are:

====vcodec====

This options allows to specify the codec the video tracks of the input stream should be transcoded to.

List of available codecs can be found on the [http://www.videolan.org/streaming/features.html streaming features page].

====vb====

This option allows to set the bitrate of the transcoded video stream, in kbit/s.

====venc====

This allows to set the encoder to use to encode the videos stream. Available options are:
* '''ffmpeg''': this is the libavcodec encoding module. It handles a large variety of different codecs (the list can be found on the [http://www.videolan.org/streaming/features.html streaming features page].
Item options are:
** '''keyint=<number of frames>''' allows to set the maximal amount of frames between 2 key frames;
** '''hurry-up''' allows the encoder to decrease the quality of the stream if the CPU can't keep up with the encoding rate;
** '''interlace''' allows to improve the quality of the encoding of interlaced streams;
** '''noise-reduction=<noise reduction factor>''' enables a noise reduction algorithm (will decrease required bitrate at the cost of details in the image);
** '''vt=<bitrate tolerance in kbit/s>''' allows to set a tolerance for the bitrate of the output video stream;
** '''bframes=<amount of frames>''' allows to set the amount of B frames between 2 key frames;
** '''qmin=<quantizer>''' allows to set the minimum quantizer scale;
** '''qmax=<quantizer>''' allows to set the maximum quantizer scale;
** '''qscale=<quantizer scale>''' allows to specify a fixed quantizer scale for VBR encodings;
** '''i-quant-factor=<quantization factor>''' allows to set the quantization factor of I frames, compared to P frames;
** '''hq=<quality>''' allows to choose the quality level for the encoding of the motion vectors (arguments are simple, rd or bits, default is simple *FIXME*);
** '''strict=<level of compliance>''' allows to force a stricter standard compliance (possible values are -1, 0 and 1, default is 0);
** '''strict-rc''' enables a strict rate control algorithm;
** '''rc-buffer-size=<size of the buffer in bits>''' allows to choose the size of the buffer used for rate control (bigger means more efficient rate control);
** '''rc-buffer-aggressivity=<float representing the aggressiveness>''' allows to set the rate control buffer aggressiveness *FIXME*;
** '''pre-me''' allows to enable pre motion estimation;
** '''mpeg4-matrix''' enable use of the MPEG4 quantization matrix with MPEG2 streams, improving quality while keeping compatibility with MPEG2 decoders;
** '''trellis''' enables trelli quantization (better quality, but slower processing).

* '''theora''': The Xiph.org theora encoder. The module is used to produce theora streams. Theora is a free patent and royalties free video codec.
The only available item option is:
** '''quality=<quality level>'''. This option allows to create a VBR stream, overriding '''vb''' setting. the quality level must be an integer between 1 and 10. Higher is better.

* '''x264'''. x264 is a free open-source h264 encoder. h264 (or MPEG4-AVC) is a quite recent high quality video codec.
Item options are:
** '''keyint=<number of frames>''' allows to set the maximal amount of frames between 2 key frames;
** '''idrint=<number of frames>''' allows to set the maximal amount of frames between 2 IDR frames;
** '''bframes=<amount of frames>''' allows to set the amount of B frames between an I and a P frame;
** '''qp=<quantizer parameter>''' allows to specify a fixed quantizer (between 1 and 51);
** '''qp-max=<quantizer parameter>''' allows to set the maximum value for the quantizer;
** '''qp-min=<quantizer parameter>''' allows to set the minimum value for the quantizer;
** '''cabac''' enables the CABAC (Context-Adaptive Binary Arithmetic Coding) algorithm (slower, but enhances quality);
** '''loopfilter''' enables deblocking loop filter;
** '''analyse''' enables the analyze mode;
** '''frameref=<amount of frames>''' allows to set the number of previous frames used as predictors;
** '''scenecut=<sensibility>''' allows to control how aggressively the encoder should insert extra I-frame, on scene change.

====fps====

This options allows to set the framerate of the transcoded video, in frame per second. reducing the framerate of a video can help
decreasing its bitrate.

====deinterlace====

This option allows to enable deinterlacing of interlaced video streams before encoding.

====croptop====

This option allows to crop the upper part of the source video while transcoding. The argument is the number of lines the video should be cropped.

====cropbottom====

This option allows to crop the lower part of the source video. The argument is the Y coordinate of the first line to be cropped.

====cropleft====

This option allows to crop the left part of the source video while transcoding. The argument is the number of columns the video should be cropped.

====cropright====

This option allows to crop the right part of the source video. The argument is the X coordinate of the first column to be cropped.

====scale====

This option allows the give the ratio from which the video should be rescaled while being transcoded. This option can be particularly useful to help reduce the bitrate of a stream.

====width====

This options allows to give the width of the transcoded video in pixels.

====height====

This options allows to give the height of the transcoded video, in pixels.

====acodec====

This options allows to specify the codec the audio tracks of the input stream should be transcoded to.

List of available codecs can be found on the [http://www.videolan.org/streaming/features.html streaming features page].

====ab====

This option allows to set the bitrate of the transcoded audio stream, in kbit/s.

====aenc====

This allows to set the encoder to use to encode the audio stream.
Available options are:

* '''ffmpeg''': this is the libavcodec encoding module. It handles a large variety of different codecs (the list can be found on the [http://www.videolan.org/streaming/features.html streaming features page]).
* '''vorbis'''. This module uses the vorbis encoder from the Xiph.org project. Vorbis is a free, open, license-free lossy audio codec.
Item options are:
** '''quality=<quality level>''' allows to use VBR (variable bitrate) encoding instead of the default CBR (constant bitrate), and
to set the quality level (between 1 and 10, higher is better);
** '''max-bitrate=<bitrate in kbit/s>''' allows to set the maximum bitrate, for vbr encoding;
** '''min-bitrate=<bitrate in kbit/s>''' allows to set the minimum bitrate, for vbr encoding;
** '''cbr''' allows to force cbr encoding.
* '''speex'''. This module uses the speex encoder from the Xiph.org project. Speex is a lossy audio codec, best fit for very low bitrates (around 10 kbit/s) and particularly video conference.

====samplerate====

This option allows to set the samplerate of the transcoded audio stream, in Hz. Reducing the samplerate is be a way to lower the bitrate of the resulting audio stream.

====channels====

This option allows to set the number of channels of the resulting audio stream. This is useful for codecs that don't have support for more than 2 channels, of to lower the bitrate of an audio stream.

====scodec====

This options allows to specify subtitle format the subtitles tracks of the input stream should be converted to.

List of available codecs can be found on the [http://www.videolan.org/streaming/features.html streaming features page].

====senc====

This allows to set the converter to use to encode the subtitle stream.

The only subtitle encoder we have at this time is '''dvbsub'''.

====soverlay====

This option allows rendering subtitles directly on the video, while transcoding it. Do not confuse this option with senc/scodec that transcode the subtitles and stream them.

====sfilter====

This option allows to render some images generated by a so called ''subpicture filter'' (e.g. a logo, a text string,
etc) on top of the video.

List of available ''subpicture filters'' can be found on the [http://www.videolan.org/streaming/features.html streaming features
page] (FIXME?). The Item options of this modules can be found using the following command line:
% '''vlc -p --advanced <module name>'''

====threads====

This options allows to set the amount of threads that should be used to encode the streams. Increasing this number to the amount of processors on the computer, (or twice this number on Intel P4 HT processors) should improve transcoding performance.

====audio-sync====

When this option is enabled, VLC will drop/duplicate video frames to synchronize the video track on the audio track.

===duplicate===

This module can be used to duplicate the stream, and so process it through several different chains.

Available options are:

====dst====

This options allows to give the chain through which the duplicated stream should be processed.

'''Note''': '''dst''' options have to be used in the same duplicate block to actually duplicate the stream.
Any of the stream output module described earlier can be used as parameter of this option.

====select====

This options can be used to duplicate only a part ''elementary streams'' of a complete stream.
Several criteria can be given, by separating each of them with a comma.
For criteria that need a parameter, such as '''es''' and '''program''', you can also specify a range, using the syntax '''criteria=num_start-num_end'''.

Available parameters are:

* '''program=''': duplicate only ''elementary streams'' belonging to the selected program (or SID). This option only works with MPEG2/TS streams.
* '''noprogram=''': do not duplicate ''elementary streams'' belonging to the selected program (or PID). This option only works with MPEG2/TS streams.
* '''es=''': duplicate only the ''elementary stream'' with the selected id.
* '''noes=''': do not duplicate the ''elementary stream'' with the selected id.
* '''video''': duplicate only video ''elementary streams''.
* '''novideo''': do not duplicate video ''elementary streams''.
* '''audio''': duplicate only audio ''elementary streams''.
* '''noaudio''': do not duplicate audio ''elementary streams''.
* '''spu''': duplicate only subtitle ''elementary streams''.
* '''nospu''': do not duplicate subtitle ''elementary streams''.

Example:
#duplicate{dst=std{...},select="program=100-200,novideo"}
This ''duplicate'' chain will only output the non video ''elementary streams'' belonging to the programs which PID are between 100 and 200.

=== Miscellaneous ===

Here are a few additional global options:

* '''--sout-all''', '''--no-sout-all''': Enable streaming of all ES (default disabled). By default VLC will only stream one audio ES and one video ES (the first ones). If you enable sout-all, all ES (audio, video and SPU) will be streamed.
* '''--sout-keep''', '''--no-sout-keep''': Keep sout open (default disabled) : use the same sout instance across the various playlist items, if possible.
* '''--no-sout-audio''': This options allows to disable audio in the outputted stream.
* '''--no-sout-video''': This options allows to disable video in the outputted stream.

=== Simplified Syntax ===

The stream output also offers a simplified syntax, with which you can only you use the '''standard''' module's main options:
% '''vlc input_stream --sout access/mux:url'''
where '''access''', '''mux''' and '''url''' are as defined in the options of the '''standard''' module.

== Examples ==

To understand fully the complex syntax of VLC's stream output, please look at the examples in the next section.

{{Documentation}}

Documentation:Streaming HowTo/Advanced Streaming Using the Command Line

2008-03-05T09:58:56Z

Tayssir: How the append option works with access=file

{{RightMenu|documentation streaming howto toc}}



==Structure of stream output==

Stream output is the name of the feature of VLC that allows to output any stream read by VLC to a file or as a network stream instead of displaying it. Different kind of processing can be applied to the stream during this process (transcoding, re-scaling, filters, re-muxing...). Stream output includes different modules, each of them having different capabilities. You can ''chain'' modules to enhance the possibilities.

Here is the list of the modules currently available:

* '''standard''' allows to ''send'' the stream via an ''access output'' module: for example, UDP, file, HTTP, ... You will probably want to use this module at the end of your chains.

* '''transcode''' is used to transcode (decode and re-encode the stream using a different codec and/or bitrate) the audio and the video of the input stream. If the input or output access method doesn't allow pace control (network, capture devices), this done "on the fly", in real time. This can require quite a lot of CPU power, depending on the parameters set. Other streams, such as files and disks are transcoded as fast as the system allows it.

* '''duplicate''' allows you to create a second chain, where the stream will be handled in an independent way.

* '''display''' allows you to display the input stream, as VLC would normally do. Used with the ''duplicate'' module, this allows you to monitor the stream while processing it.

* '''rtp''' streams over RTP (one UDP port for each elementary stream). This module also allows RTSP support.

* '''es''' allows you to make separate Elementary Streams (ES) out of an input stream. This can be used to save audio and video streams to separate files, for instance.

* '''bridge-out''' TODO
* '''bridge-in''' TODO
* '''mosaic-bridge''' TODO

Each of these modules may take options. Here is the
syntax that you must use:

% '''vlc input_stream --sout "#module1{option1=parameter1{parameter-option1},option2=parameter2}:module2{option1=...,option2=...}:..."'''

'''NOTE:''' Some of the module options (option1 in the example) have to be set, others are optional. Option parameters (parameter-option1 in the example) are always optional. These option parameters are also often very advanced settings. If you don't understand their description, this certainly means that you don't need them.

You may also use the following syntax :

% '''vlc input_stream --sout-module1-option1=... --sout-module1-option2=... --sout-module2-option1=... --sout-module2-option2=... ...'''

For example, to transcode a stream and send it, use:

% '''vlc input_stream --sout '#transcode{options}:standard{options}' '''

==Description of the modules==

===standard (alias std)===

This module saves the stream to a file or sends it over a network, after having muxed it.

The available options are:

====access====

This option allows to set the medium used to save or send the stream. This is a compulsory option. Available options are:

* '''file''': saves the stream to a file.
Use the ''append'' option to append the stream to an existing file instead of replacing it:

<pre>standard{ ... ,access=file{append}, ... }</pre>

* '''udp''': streams to a UDP unicast or multicast address.
Item options are:
** '''caching=<time in ms>''' to set the time VLC should buffer data before sending it;
** '''ttl=<ttl>''' to set the ttl of the sent udp packets;
** '''group=<amount of packets>''' to sent packets by burst instead of one by one;
** '''late=<time in ms>''' to drop packets that arrive too late at this stage of the chain;
** '''raw''' if you don't want to wait until the MTU is filled before sending the packet.

* '''http''': streams over HTTP.
Item options are:
** '''user=<user name>''' to enable HTTP basic authentication and set the user;
** '''pwd=<password>''' to set the basic authentication password;
** '''mime=<mime type>''' to set the mime type returned by the server.

* '''https''': streams over HTTP, using a secured SSL connection.
Item options are the same as for http and:
** '''cert=<path to certificate>'''to set the certificate to use;
** '''key=<path to key>''' to set the private key file the server should use for the SSL connection;
** '''ca=<path to certificate>''' to set the path to the root CA certificates to use for SSL;
** '''crl=<path to certificate>''' to set the revocation certificate to use for the SSL connection.

* '''mmsh''': streams using the Microsoft MMS protocol. This protocol is used as transport method by many Microsoft's softwares.
Note that only a small part of the MMS protocol is supported (MMS encapsulated in HTTP).
Item options are the same as for the http module.

* '''rtp''': streams over RTP. Please note that this is a legacy module. It doesn't allow RTSP and can only be used to stream TS streams. Please have a look at the '''rtp''' stream output module for a more compliant and complete RTP streamer.
Options are the same as for the ''udp'' setting.

====mux====
This option allows you to set the encapsulation method used for the resulting stream. This option has to be set.

Available options are:

* '''ts''': the MPEG2/TS muxer. This the standard muxer used to stream MPEG 2. This muxer can be used with any '''access''' method. Supported codecs are MPEG 1/2/4, MJPEG, H263, H264, I263, WMV 1/2 and theora for video, MPEG audio, AAC and a52 for the audio stream.
Item options are:
** '''pid-video=<pid>''' to set the PID of the video track;
** '''pid-audio=<pid>''' to set the PID of the audio track;
** '''pid-spu=<pid>''' to set the PID of the subtitle track;
** '''pid-pmt=<pid>''' to set the PID of the PMT (Program Map Table);
** '''tsid=<id>''' to set the ID of the resulting TS stream;
** '''shaping=<shaping delay in ms>''' to set the minimum interval during which the bitrate of the stream will remain constant, for variable bitrate streams;
** '''use-key-frames''' uses I frames as limits for the shaping intervals;
** '''pcr=<PCR interval in ms>''' allows to set at which interval Program Clock References will be sent;
** '''dts-delay=<delay in ms>''' allows to delay PTS (Presentation Time Stamps) from the DTS (Decoding Time Stamp) from the given time;
** '''crypt-audio''' allows to enable encryption of the audio track using the CSA algorithm;
** '''csa-ck=<key as a 16 character word>''' allows to set the key used for CSA encryption.

* '''ps''': the MPEG2/PS muxer. This the standard muxer for MPEG 2 files(.mpg). It can be used with the file and http output methods. Supported codecs are MPEG 1/2 and MJPEG for video, MPEG audio and a52 for audio streams.
The only available item option is:
** '''dst-delay=<delay in ms>''': It allows to delay PTS (Presentation Time Stamps) from the DTS (Decoding Time Stamp) from the given time.

* '''mpeg1''': the standard MPEG 1 muxer. This muxer should be used instead of ps with MPEG 1 video streams, when saved to a file or streamed over HTTP. Supported codecs are MPEG 1 and MPEG audio.
Items options are the same as for the PS muxer.

* '''ogg''': the ogg muxer. This is the muxer from the Xiph project. It can be used with the HTTP and file output methods. Supported codecs are MPEG 1/2/4, MJPEG WMV 1/2 and Theora, audio streams can be vorbis, flac, speex, a52 or MPEG audio.
There is no item option for this muxer.

* '''asf''': the Microsoft ASF muxer. This is the standard muxer used for streaming by Microsoft's softwares. Is also used as container for WMA audio files. This muxer can be used with the file and HTTP output methods. Supported codecs are MPEG 4, MJPEG, WMV 1/2 for video, MPEG audio, a52 for audio streams.
Item options are:
** '''title=<title>''';
** '''autor=<author>''';
** '''copyright=<copyright message>''';
** '''comment=<comments>''';
** '''rating=<rating>''' allow you to set what will be displayed in the according field of the stream comments.

* '''asfh''': this is a special version of the ASF muxer, that should be used for MMSH streaming. MMSH is the only supported output
method. Supported codecs are the same as for ASF.
Item options are the same as for ASF.

* '''avi''': the Microsoft AVI muxer. This is very common encapsulation format for MPEG 4 files. The only supported output method
is file. Supported codecs are MPEG 1/2/4, H263, H264 and I263 for video, MPEG audio and a52 for audio streams.
There is not item option for this muxer.
'''Note''': The avi muxer in VLC is known to produce corrupt files.

* '''mpjpeg''': the multipart jpeg muxer.
This encapsulation format is mostly used on surveillance video cameras with an integrated web-server. Such streams are usually embedded in web-pages and seen with standard Internet browsers, as they are seen as a succession of jpeg images. The only supported output method is HTTP. The only usable codec is MJPEG. No sound track can be muxed in such streams.
No item option is available for this muxer.

====dst====

This option allows to give informations about the location where the stream should actually be saved or sent.

Here is the meaning of the '''dst''' option depending on the parameter used for the '''access''' option.

* If the '''file''' output method is used, '''dst''' is the path where the file should be saved.
* If the '''udp''' or '''rtp''' output method is used, '''dst''' is the unicast or multicast destination address and, optionally, UDP port, in the form '''address:port'''.
* If the '''http''', '''https''' or '''mmsh''' output method is chosen, '''dst''' is the address, port and path of the local network interface on which the server should listen for requests. If no address is given, VLC will listen on all the network interfaces. These information have to be supplied using the '''address:port/path''' syntax.

====sap====

Use this option if you want VLC to send SAP (Session Announcement Protocol) announces. SAP is a service discovery protocol, that uses a special multicast address to send a list of available streams on a server.

This option can only be enabled with the '''udp''' output method.

====group====

This option allows to specify the name of an optional '''group''' of streams. A VLC used as a client will use this field to classify the stream.

This option uses a private extension of the SAP protocol. VLC will be the only client able to read this field.

This option can only be used if the '''sap''' option has been enabled.

====sap-ipv6====

Use this option if you want the SAP announces to be sent using the '''IPv6''' protocol instead of '''IPv4'''.

This option can only be used if the '''sap''' option has been enabled.

====slp====

SLP stands for ''Service Location Protocol''. It is an alternative to SAP for session announcement. Use this option if you want to send such announces.

====name====

Use this option to specify the name of the stream that will be sent in SAP and SLP announces.

This option can only be used if the '''sap''' or '''slp''' option has been enabled.

===display===

This module can be used to display the stream. This is particularly useful in a '''duplicate''' chain, in order to monitor a stream while it is being saved or streamed.

Available options are:

====novideo====

You can use this option to disable video in the displayed stream.

====noaudio====

You can use this option to disable audio in the displayed stream.

====delay====

You can use this option to introduce a delay in the display of the stream. Delay has to be given in ms.

===rtp===

This module can be used to send a stream using the ''RTP (Real Time Protocol)'' protocol (see RFC 3550).

Although use of ''RTSP'' is possible using this module, it won't allow you to make Video On demand. Please have a look at the description of the VLM module for that.

The different available options are:

====dst====

This option allow to give the destination UDP address. This can be the address of a host or a multicast group. This option has to be given, unless the ''sdp=rtsp://''option is given (see below). In the latter case, the stream will be sent to the host doing the
''RTSP'' request.

====port====

This option allows to set the UDP port used to send the first ''elementary stream''. This port has to be even. Other streams will be streamed using even ports directly above this one.

====port-video====

This option allows to set the UDP port used to send the first video ''elementary stream''. This port has to be even.

====port-audio====

This option allows to set the UDP port used to send the first audio ''elementary stream''. This port has to be even.

====sdp====

This option allows to set the way the SDP (Session Description Protocol) file corresponding the the stream should be made available.
Options are:

* '''file://<path to the file>''', to export the SDP as a local file.
* '''http://<local interface IP:port/path>''', to make the file available using the integrated HTTP server of VLC.
'''Note''': The '''local interface IP''' argument is optional. If not given, VLC will listen on all available interfaces.
* '''rtsp://<local interface IP:port/path>'', to make the SDP file available using the ''RTSP'' protocol (see RFC 2326).
'''Note''': The ''local interface IP'' argument is optional. If not given, VLC will listen on all available interfaces.
* '''sap''', to export the SDP using the SAP (Session Announcement Protocol, see RFC 2974).

====ttl====

This option can be used to set the ''TTL'' (Time to Live) of the sent UDP packets.

====mux====

This option allows to set the encapsulation method used to send the stream. See '''mux''' options of the '''standard''' module for a description of the available method. Only '''ts''' and '''raw''' (no encpasulation) are possible values for ''RTP'' streams. Default is RAW.

====name====

This option can be used to set the name that will be displayed on the client receiving the stream.

====description====

This option can be used to give an additional description of the stream.

====url====

This option allows to give the address of a website with additional informations about the stream.

====email====

This options allows to give a contact e-mail address.

===es===

The '''es''' module can be used to separate the different ''elementary streams'' from a stream, and save each of them in a different file or send it to a separate destination.

The available parameters are:

====access-video====

Use this option to set the medium used to save or send the video ''elementary streams''. Possible values and item options are the same as for the '''access''' option of the '''standard''' module (see above).

====access-audio====

Use this option to set the medium used to save or send the audio ''elementary streams''. Possible values and item options are the same than for the '''access''' option of the '''standard''' module (see above).

====access====

This option can be used instead of both '''access-video''' and '''access-audio''' options, when they share the same setting.

====mux-video====

Use this option to set the encapsulation method used for the video ''elementary streams''. Possible values and item
options are the same as for the '''mux''' option of the '''standard''' module (see above).

====mux-audio====

Use this option to set the encapsulation method used for the audio ''elementary streams''. Possible values and item options are the same than for the '''mux''' option of the '''standard''' module (see above).

====mux====

This option can be used instead of both '''mux-video''' and '''mux-audio''' options, when they share the same setting.

====dst-video====

Use this option to set the location where the video ''elementary streams'' should be saved, sent, or made available. The exact meaning of this option depends on the value of the '''access-video''' option and is the same as for the '''url''' option of the '''standard''' module (see above).

'''Note''': If you use the ''%n'' string in the url field, VLC will replace it by the number of the audio or video track
considered. The ''%c'' string will be replaced by the name (FOURCC) of the codec of the track. ''%a'' prints the access output used and ''%m'' the muxer used.

====dst-audio====

Use this option to set the location where the audio ''elementary streams'' should be saved, sent, or made available. The exact meaning of this option depends on the value of the '''access-audio''' option and is the same as for the '''url''' option of the '''standard''' module (see above).

'''Note''': If you use the ''%n'' string in the url field, VLC will replace it by the number of the audio or video track considered. The ''%c'' string will be replaced by the name (FOURCC) of the codec of the track. ''%a'' prints the access output used and ''%m'' the muxer used.

====dst====

This option can be used instead of both '''dst-video''' and '''dst-audio''' options, when they share the same setting.

===transcode===

You can use this module to transcode a stream, i.e. to change its codecs or the encoding bitrates. Some additional processing can be done during this process, such as re-scaling, deinterlacing, resampling, etc.

'''Note''': Depending on the bitrate of the original stream and of the options chosen, transcoding can be a very CPU intensive task. As a consequence, streaming of a real time transcoded stream can lead to dropped frames or a jerky image and sound in some cases, when running out of resources.

Available options are:

====vcodec====

This options allows to specify the codec the video tracks of the input stream should be transcoded to.

List of available codecs can be found on the [http://www.videolan.org/streaming/features.html streaming features page].

====vb====

This option allows to set the bitrate of the transcoded video stream, in kbit/s.

====venc====

This allows to set the encoder to use to encode the videos stream. Available options are:
* '''ffmpeg''': this is the libavcodec encoding module. It handles a large variety of different codecs (the list can be found on the [http://www.videolan.org/streaming/features.html streaming features page].
Item options are:
** '''keyint=<number of frames>''' allows to set the maximal amount of frames between 2 key frames;
** '''hurry-up''' allows the encoder to decrease the quality of the stream if the CPU can't keep up with the encoding rate;
** '''interlace''' allows to improve the quality of the encoding of interlaced streams;
** '''noise-reduction=<noise reduction factor>''' enables a noise reduction algorithm (will decrease required bitrate at the cost of details in the image);
** '''vt=<bitrate tolerance in kbit/s>''' allows to set a tolerance for the bitrate of the output video stream;
** '''bframes=<amount of frames>''' allows to set the amount of B frames between 2 key frames;
** '''qmin=<quantizer>''' allows to set the minimum quantizer scale;
** '''qmax=<quantizer>''' allows to set the maximum quantizer scale;
** '''qscale=<quantizer scale>''' allows to specify a fixed quantizer scale for VBR encodings;
** '''i-quant-factor=<quantization factor>''' allows to set the quantization factor of I frames, compared to P frames;
** '''hq=<quality>''' allows to choose the quality level for the encoding of the motion vectors (arguments are simple, rd or bits, default is simple *FIXME*);
** '''strict=<level of compliance>''' allows to force a stricter standard compliance (possible values are -1, 0 and 1, default is 0);
** '''strict-rc''' enables a strict rate control algorithm;
** '''rc-buffer-size=<size of the buffer in bits>''' allows to choose the size of the buffer used for rate control (bigger means more efficient rate control);
** '''rc-buffer-aggressivity=<float representing the aggressiveness>''' allows to set the rate control buffer aggressiveness *FIXME*;
** '''pre-me''' allows to enable pre motion estimation;
** '''mpeg4-matrix''' enable use of the MPEG4 quantization matrix with MPEG2 streams, improving quality while keeping compatibility with MPEG2 decoders;
** '''trellis''' enables trelli quantization (better quality, but slower processing).

* '''theora''': The Xiph.org theora encoder. The module is used to produce theora streams. Theora is a free patent and royalties free video codec.
The only available item option is:
** '''quality=<quality level>'''. This option allows to create a VBR stream, overriding '''vb''' setting. the quality level must be an integer between 1 and 10. Higher is better.

* '''x264'''. x264 is a free open-source h264 encoder. h264 (or MPEG4-AVC) is a quite recent high quality video codec.
Item options are:
** '''keyint=<number of frames>''' allows to set the maximal amount of frames between 2 key frames;
** '''idrint=<number of frames>''' allows to set the maximal amount of frames between 2 IDR frames;
** '''bframes=<amount of frames>''' allows to set the amount of B frames between an I and a P frame;
** '''qp=<quantizer parameter>''' allows to specify a fixed quantizer (between 1 and 51);
** '''qp-max=<quantizer parameter>''' allows to set the maximum value for the quantizer;
** '''qp-min=<quantizer parameter>''' allows to set the minimum value for the quantizer;
** '''cabac''' enables the CABAC (Context-Adaptive Binary Arithmetic Coding) algorithm (slower, but enhances quality);
** '''loopfilter''' enables deblocking loop filter;
** '''analyse''' enables the analyze mode;
** '''frameref=<amount of frames>''' allows to set the number of previous frames used as predictors;
** '''scenecut=<sensibility>''' allows to control how aggressively the encoder should insert extra I-frame, on scene change.

====fps====

This options allows to set the framerate of the transcoded video, in frame per second. reducing the framerate of a video can help
decreasing its bitrate.

====deinterlace====

This option allows to enable deinterlacing of interlaced video streams before encoding.

====croptop====

This option allows to crop the upper part of the source video while transcoding. The argument is the number of lines the video should be cropped.

====cropbottom====

This option allows to crop the lower part of the source video. The argument is the Y coordinate of the first line to be cropped.

====cropleft====

This option allows to crop the left part of the source video while transcoding. The argument is the number of columns the video should be cropped.

====cropright====

This option allows to crop the right part of the source video. The argument is the X coordinate of the first column to be cropped.

====scale====

This option allows the give the ratio from which the video should be rescaled while being transcoded. This option can be particularly useful to help reduce the bitrate of a stream.

====width====

This options allows to give the width of the transcoded video in pixels.

====height====

This options allows to give the height of the transcoded video, in pixels.

====acodec====

This options allows to specify the codec the audio tracks of the input stream should be transcoded to.

List of available codecs can be found on the [http://www.videolan.org/streaming/features.html streaming features page].

====ab====

This option allows to set the bitrate of the transcoded audio stream, in kbit/s.

====aenc====

This allows to set the encoder to use to encode the audio stream.
Available options are:

* '''ffmpeg''': this is the libavcodec encoding module. It handles a large variety of different codecs (the list can be found on the [http://www.videolan.org/streaming/features.html streaming features page]).
* '''vorbis'''. This module uses the vorbis encoder from the Xiph.org project. Vorbis is a free, open, license-free lossy audio codec.
Item options are:
** '''quality=<quality level>''' allows to use VBR (variable bitrate) encoding instead of the default CBR (constant bitrate), and
to set the quality level (between 1 and 10, higher is better);
** '''max-bitrate=<bitrate in kbit/s>''' allows to set the maximum bitrate, for vbr encoding;
** '''min-bitrate=<bitrate in kbit/s>''' allows to set the minimum bitrate, for vbr encoding;
** '''cbr''' allows to force cbr encoding.
* '''speex'''. This module uses the speex encoder from the Xiph.org project. Speex is a lossy audio codec, best fit for very low bitrates (around 10 kbit/s) and particularly video conference.

====samplerate====

This option allows to set the samplerate of the transcoded audio stream, in Hz. Reducing the samplerate is be a way to lower the bitrate of the resulting audio stream.

====channels====

This option allows to set the number of channels of the resulting audio stream. This is useful for codecs that don't have support for more than 2 channels, of to lower the bitrate of an audio stream.

====scodec====

This options allows to specify subtitle format the subtitles tracks of the input stream should be converted to.

List of available codecs can be found on the [http://www.videolan.org/streaming/features.html streaming features page].

====senc====

This allows to set the converter to use to encode the subtitle stream.

The only subtitle encoder we have at this time is '''dvbsub'''.

====soverlay====

This option allows rendering subtitles directly on the video, while transcoding it. Do not confuse this option with senc/scodec that transcode the subtitles and stream them.

====sfilter====

This option allows to render some images generated by a so called ''subpicture filter'' (e.g. a logo, a text string,
etc) on top of the video.

List of available ''subpicture filters'' can be found on the [http://www.videolan.org/streaming/features.html streaming features
page] (FIXME?). The Item options of this modules can be found using the following command line:
% '''vlc -p --advanced <module name>'''

====threads====

This options allows to set the amount of threads that should be used to encode the streams. Increasing this number to the amount of processors on the computer, (or twice this number on Intel P4 HT processors) should improve transcoding performance.

====audio-sync====

When this option is enabled, VLC will drop/duplicate video frames to synchronize the video track on the audio track.

===duplicate===

This module can be used to duplicate the stream, and so process it through several different chains.

Available options are:

====dst====

This options allows to give the chain through which the duplicated stream should be processed.

'''Note''': '''dst''' options have to be used in the same duplicate block to actually duplicate the stream.
Any of the stream output module described earlier can be used as parameter of this option.

====select====

This options can be used to duplicate only a part ''elementary streams'' of a complete stream.
Several criteria can be given, by separating each of them with a comma.
For criteria that need a parameter, such as '''es''' and '''program''', you can also specify a range, using the syntax '''criteria=num_start-num_end'''.

Available parameters are:

* '''program=''': duplicate only ''elementary streams'' belonging to the selected program (or SID). This option only works with MPEG2/TS streams.
* '''noprogram=''': do not duplicate ''elementary streams'' belonging to the selected program (or PID). This option only works with MPEG2/TS streams.
* '''es=''': duplicate only the ''elementary stream'' with the selected id.
* '''noes=''': do not duplicate the ''elementary stream'' with the selected id.
* '''video''': duplicate only video ''elementary streams''.
* '''novideo''': do not duplicate video ''elementary streams''.
* '''audio''': duplicate only audio ''elementary streams''.
* '''noaudio''': do not duplicate audio ''elementary streams''.
* '''spu''': duplicate only subtitle ''elementary streams''.
* '''nospu''': do not duplicate subtitle ''elementary streams''.

Example:
#duplicate{dst=std{...},select="program=100-200,novideo"}
This ''duplicate'' chain will only output the non video ''elementary streams'' belonging to the programs which PID are between 100 and 200.

=== Miscellaneous ===

Here are a few additional global options:

* '''--sout-all''', '''--no-sout-all''': Enable streaming of all ES (default disabled). By default VLC will only stream one audio ES and one video ES (the first ones). If you enable sout-all, all ES (audio, video and SPU) will be streamed.
* '''--sout-keep''', '''--no-sout-keep''': Keep sout open (default disabled) : use the same sout instance across the various playlist items, if possible.
* '''--no-sout-audio''': This options allows to disable audio in the outputted stream.
* '''--no-sout-video''': This options allows to disable video in the outputted stream.

=== Simplified Syntax ===

The stream output also offers a simplified syntax, with which you can only you use the '''standard''' module's main options:
% '''vlc input_stream --sout access/mux:url'''
where '''access''', '''mux''' and '''url''' are as defined in the options of the '''standard''' module.

== Examples ==

To understand fully the complex syntax of VLC's stream output, please look at the examples in the next section.

{{Documentation}}

Console

2008-02-26T16:18:57Z

Tayssir: Using netcat to communcate with telnet interface.

VLC has three terminal [[interface]] modules. These are ''rc'', ''telnet'' and ''ncurses''.
:''See also [[Command line]]''

== rc interface ==

The '''rc''' module is a interactive command line interface. It allows you to type commands to make vlc do things. To start it, run vlc --intf rc. This is the default interface if no gui environment is available. To get started type "help" followed by enter. Starting with VLC 0.8.0 you can access this interface through a network with a telnet-client by using the --rc-host localhost:port option.

== ncurses interface ==

The '''ncurses''' module is something like a text-mode gui, built with the well-known ncurses library. Linux users should be familiar with this kind of interface. This interface is not built by default, you need to add --enable-ncurses to the configure call. To start vlc with this interface run vlc --intf ncurses.

== telnet interface ==

The '''telnet''' interface will allow you to use the telnet command to connect to vlc remotely from the network. It is comparable to the rc interface, but less advanced. It can be launched by running vlc like: vlc --intf telnet. Starting with the VLC 0.7.x-series, you can control VLC's VLM-module with this interface to manage multiple simultaneous streams. Notice that you should use the rc-interface if you don't need this feature.

to launch vlc with telnet interface:
$vlc -I telnet --telnet-password test

The telnet interface is essentially over a "raw tcp socket." To interact with the instance at the command line (assuming the telnet interface's address is <code>10.0.0.100:4212</code>):

$netcat 10.0.0.100 4212

[[Category:Interfaces]]

Media resource locator

2008-02-14T13:16:45Z

Tayssir: more explanation

A '''media resource locator''' ('''MRL''') is a string of characters used to identify a multimedia resource or part of a multimedia resource. A MRL may be used to identify inputs or outputs to {{VLC}}.

The MRL syntax is:
<PRE>
[[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]
</PRE>

{| class="wikitable"
! MRL section
! Description
! Possible values
|-
| access
| How to obtain the media data
|
cdda: CD Digital Audio 
dir: Filesystem-based directory 
dv: Digital Video/FireWire 
file: Filesystem-based file 
ftp: FTP 
gnomevfs: GnomeVFS 
http: HTTP 
mms: Microsoft Media Server 
pvr: PVR 
rtp: RTP 
rtsp: RTSP 
smb: Server Message Block 
tcp: TCP 
udp: UDP 
vcdx: Video CD
|-
| demux
| The format of the source data
|
a52sys/Raw A/52 demuxer 
aiff/AIFF demuxer 
asf/ASF v1.0 demuxer 
au/AU demuxer 
avi/AVI demuxer 
demuxdump/File dumpper 
dtssys/Raw DTS demuxer 
flac/FLAC demuxer 
h264/H264 video demuxer 
m3u/Playlist metademux 
m4a/MPEG-4 audio demuxer 
m4v/MPEG-4 video demuxer 
mjpeg/M-JPEG camera demuxer 
mp4/MP4 stream demuxer 
mpga/MPEG audio / MP3 demuxer 
mpgv/MPEG-I/II video demuxer 
nsc/Windows Media NSC metademux 
nsv/NullSoft demuxer 
nuv/Nuv demuxer 
ogg/OGG demuxer 
playlist/B4S playlist import 
playlist/DVB playlist import 
playlist/M3U playlist import 
playlist/New winamp 5.2 shoutcast import 
playlist/PLS playlist import 
playlist/Playlist 
playlist/Podcast parser 
playlist/XSPF playlist import 
ps/MPEG-PS demuxer 
ps/MPEG-PS demuxer 
pva/PVA demuxer 
rawdv/DV (Digital Video) demuxer 
real/Real demuxer 
sgimb/Kasenna MediaBase parser 
subtitle/Text subtitles parser 
tta/TTA demuxer 
ty/TY Stream audio/video demux 
vobsub/Vobsub subtitles parser 
voc/VOC demuxer 
wav/WAV demuxer 
xa/XA demuxer
|-
| URL
| The [http://en.wikipedia.org/wiki/Uniform_Resource_Identifier URI] of the source
| See http://www.w3.org/TR/uri-clarification/
|-
| title
| Which title to select for input
| Positive integer
|-
| chapter
| Which chapter to select for input
| Positive integer
|-
| option
| Options to apply only to the specified MRL
| See [[VLC command-line help]] for a full list
|}

== Exception ==
An exception to these rules appears to be with UDP/RTP streams, where it may look like:

<pre>
udp://@:portnumber

# Example:
# udp://@:1234
#
# Apparently the @ has a meaning like localhost, though
# udp://localhost:1234
# doesn't seem to work in this circumstance, for some reason.
</pre>

[[Category:Glossary]]

Media resource locator

2008-02-14T12:34:46Z

Tayssir: UDP/RTP exception to the MRL syntax

A '''media resource locator''' ('''MRL''') is a string of characters used to identify a multimedia resource or part of a multimedia resource. A MRL may be used to identify inputs or outputs to {{VLC}}.

The MRL syntax is:
<PRE>
[[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]
</PRE>

{| class="wikitable"
! MRL section
! Description
! Possible values
|-
| access
| How to obtain the media data
|
cdda: CD Digital Audio 
dir: Filesystem-based directory 
dv: Digital Video/FireWire 
file: Filesystem-based file 
ftp: FTP 
gnomevfs: GnomeVFS 
http: HTTP 
mms: Microsoft Media Server 
pvr: PVR 
rtp: RTP 
rtsp: RTSP 
smb: Server Message Block 
tcp: TCP 
udp: UDP 
vcdx: Video CD
|-
| demux
| The format of the source data
|
a52sys/Raw A/52 demuxer 
aiff/AIFF demuxer 
asf/ASF v1.0 demuxer 
au/AU demuxer 
avi/AVI demuxer 
demuxdump/File dumpper 
dtssys/Raw DTS demuxer 
flac/FLAC demuxer 
h264/H264 video demuxer 
m3u/Playlist metademux 
m4a/MPEG-4 audio demuxer 
m4v/MPEG-4 video demuxer 
mjpeg/M-JPEG camera demuxer 
mp4/MP4 stream demuxer 
mpga/MPEG audio / MP3 demuxer 
mpgv/MPEG-I/II video demuxer 
nsc/Windows Media NSC metademux 
nsv/NullSoft demuxer 
nuv/Nuv demuxer 
ogg/OGG demuxer 
playlist/B4S playlist import 
playlist/DVB playlist import 
playlist/M3U playlist import 
playlist/New winamp 5.2 shoutcast import 
playlist/PLS playlist import 
playlist/Playlist 
playlist/Podcast parser 
playlist/XSPF playlist import 
ps/MPEG-PS demuxer 
ps/MPEG-PS demuxer 
pva/PVA demuxer 
rawdv/DV (Digital Video) demuxer 
real/Real demuxer 
sgimb/Kasenna MediaBase parser 
subtitle/Text subtitles parser 
tta/TTA demuxer 
ty/TY Stream audio/video demux 
vobsub/Vobsub subtitles parser 
voc/VOC demuxer 
wav/WAV demuxer 
xa/XA demuxer
|-
| URL
| The [http://en.wikipedia.org/wiki/Uniform_Resource_Identifier URI] of the source
| See http://www.w3.org/TR/uri-clarification/
|-
| title
| Which title to select for input
| Positive integer
|-
| chapter
| Which chapter to select for input
| Positive integer
|-
| option
| Options to apply only to the specified MRL
| See [[VLC command-line help]] for a full list
|}

== Exception ==
An exception to these rules appears to be with UDP/RTP streams, where it may look like:

<pre>
udp://@:portnumber
# example: udp://@:1234
</pre>

[[Category:Glossary]]

VLC command-line help

2008-02-14T12:07:30Z

Tayssir:

:''See also [[Command line]], [[Console|Console interfaces]]''
As you may have noticed, running the command
vlc --help
on some [[command prompt]]s is not very useful due to to the non-scrollable pop-up window that opened.

If you look for help, on a particular module, use
vlc -p module --advanced

Undocumented option:
-vvv "Verbose verbose verbose". Verbose output

Here's the output of ''vlc --longhelp --advanced --help-verbose'' of the development version 0.9.0-svn-20070112-0001 (12 jan. 2007) in Windows.

<nowiki>
Usage: vlc.exe [options] [stream] ...
You can specify multiple streams on the commandline. They will be enqueued in the playlist.
The first item specified will be played first.

Options-styles:
--option A global option that is set for the duration of the program.
-option A single letter version of a global --option.
:option An option that only applies to the stream directly before it
and that overrides previous settings.

Stream MRL syntax:
[[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]

Many of the global --options can also be used as MRL specific :options.
Multiple :option=value pairs can be specified.

URL syntax:
[file://]filename Plain media file
http://ip:port/file HTTP URL
ftp://ip:port/file FTP URL
mms://ip:port/file MMS URL
screen:// Screen capture
[dvd://][device][@raw_device] DVD device
[vcd://][device] VCD device
[cdda://][device] Audio CD device
udp:[[<source address>]@[<bind address>][:<bind port>]]
UDP stream sent by a streaming server
vlc:pause:<seconds> Special item to pause the playlist for a certain time
vlc:quit Special item to quit VLC

Audio
--audio, --no-audio Enable audio (default enabled)
You can completely disable the audio output.
The audio decoding stage will not take place,
thus saving some processing power. (default
enabled)
--volume=<integer> Default audio volume
You can set the default audio output volume
here, in a range from 0 to 1024.
--volume-step=<integer> Audio output volume step
The step size of the volume is adjustable
using this option, in a range from 0 to 1024.
--aout-rate=<integer> Audio output frequency (Hz)
You can force the audio output frequency
here. Common values are -1 (default), 48000,
44100, 32000, 22050, 16000, 11025, 8000.
--hq-resampling, --no-hq-resampling
High quality audio resampling (default
enabled)
This uses a high quality audio resampling
algorithm. High quality audio resampling can
be processor intensive so you can disable it
and a cheaper resampling algorithm will be
used instead. (default enabled)
--spdif, --no-spdif Use S/PDIF when available (default disabled)
S/PDIF can be used by default when your
hardware supports it as well as the audio
stream being played. (default disabled)
--force-dolby-surround={0 (Auto), 1 (On), 2 (Off)}
Force detection of Dolby Surround
Use this when you know your stream is (or is
not) encoded with Dolby Surround but fails to
be detected as such. Even if the stream is
not actually encoded with Dolby Surround,
turning on this option might enhance your
experience, especially when combined with the
Headphone Channel Mixer.
--audio-desync=<integer> Audio desynchronization compensation
This delays the audio output. The delay must
be given in milliseconds.This can be handy if
you notice a lag between the video and the
audio.
--aout=<string> Audio output module
This is the audio output method used by VLC.
The default behavior is to automatically
select the best method available.
--audio-filter=<string> Audio filters
This adds audio post processing filters, to
modify the sound rendering.
--audio-visual=<string> Audio visualizations
This adds visualization modules (spectrum
analyzer, etc.).

Video
--video, --no-video Enable video (default enabled)
You can completely disable the video output.
The video decoding stage will not take place,
thus saving some processing power. (default
enabled)
--grayscale, --no-grayscale
Grayscale video output (default disabled)
Output video in grayscale. As the color
information aren't decoded, this can save
some processing power. (default disabled)
-f, --fullscreen, --no-fullscreen
Fullscreen video output (default disabled)
Start video in fullscreen mode (default
disabled)
--embedded-video, --no-embedded-video
Embedded video (default enabled)
Embed the video output in the main interface.
(default enabled)
--drop-late-frames, --no-drop-late-frames
Drop late frames (default enabled)
This drops frames that are late (arrive to
the video output after their intended display
date). (default enabled)
--skip-frames, --no-skip-frames
Skip frames (default enabled)
This option enables framedropping on MPEG2
stream. Framedropping occurs when your
computer is not powerful enough (default
enabled)
--quiet-synchro, --no-quiet-synchro
Quiet synchro (default disabled)
This avoids flooding the message log with
debug output from the video output
synchronization mechanism. (default disabled)
--overlay, --no-overlay Overlay video output (default enabled)
Overlay is the hardware acceleration
capability of your video card (ability to
render video directly). VLC will try to use
it by default. (default enabled)
--video-on-top, --no-video-on-top
Always on top (default disabled)
Always place the video window on top of other
windows. (default disabled)
--disable-screensaver, --no-disable-screensaver
Disable screensaver (default enabled)
Disable the screensaver during video
playback. (default enabled)
--snapshot-path=<string> Video snapshot directory (or filename)
Directory where the video snapshots will be
stored.
--snapshot-prefix=<string> Video snapshot file prefix
Video snapshot file prefix
--snapshot-format={png,jpg}
Video snapshot format
Image format which will be used to store the
video snapshots
--snapshot-preview, --no-snapshot-preview
Display video snapshot preview (default
enabled)
Display the snapshot preview in the screen's
top-left corner. (default enabled)
--snapshot-sequential, --no-snapshot-sequential
Use sequential numbers instead of timestamps
(default disabled)
Use sequential numbers instead of timestamps
for snapshot numbering (default disabled)
--width=<integer> Video width
You can enforce the video width. By default
(-1) VLC will adapt to the video
characteristics.
--height=<integer> Video height
You can enforce the video height. By default
(-1) VLC will adapt to the video
characteristics.
--video-x=<integer> Video X coordinate
You can enforce the position of the top left
corner of the video window (X coordinate).
--video-y=<integer> Video Y coordinate
You can enforce the position of the top left
corner of the video window (Y coordinate).
--crop=<string> Video cropping
This forces the cropping of the source video.
Accepted formats are x:y (4:3, 16:9, etc.)
expressing the global image aspect.
--custom-crop-ratios=<string>
Custom crop ratios list
Comma seperated list of crop ratios which
will be added in the interface's crop ratios
list.
--aspect-ratio=<string> Source aspect ratio
This forces the source aspect ratio. For
instance, some DVDs claim to be 16:9 while
they are actually 4:3. This can also be used
as a hint for VLC when a movie does not have
aspect ratio information. Accepted formats
are x:y (4:3, 16:9, etc.) expressing the
global image aspect, or a float value (1.25,
1.3333, etc.) expressing pixel squareness.
--monitor-par=<string> Monitor pixel aspect ratio
This forces the monitor aspect ratio. Most
monitors have square pixels (1:1). If you
have a 16:9 screen, you might need to change
this to 4:3 in order to keep proportions.
--custom-aspect-ratios=<string>
Custom aspect ratios list
Comma seperated list of aspect ratios which
will be added in the interface's aspect ratio
list.
--hdtv-fix, --no-hdtv-fix Fix HDTV height (default enabled)
This allows proper handling of HDTV-1080
video format even if broken encoder
incorrectly sets height to 1088 lines. You
should only disable this option if your video
has a non-standard format requiring all 1088
lines. (default enabled)
--video-deco, --no-video-deco
Window decorations (default enabled)
VLC can avoid creating window caption,
frames, etc... around the video, giving a
"minimal" window. (default enabled)
--video-title=<string> Video title
Custom title for the video window (in case
the video is not embedded in the interface).
--align={0 (Center), 1 (Left), 2 (Right), 4 (Top), 8 (Bottom), 5 (Top-Left), 6 (Top-Right), 9 (Bottom-Left), 10 (Bottom-Right)}
Video alignment
Enforce the alignment of the video in its
window. By default (0) it will be centered
(0=center, 1=left, 2=right, 4=top, 8=bottom,
you can also use combinations of these
values, like 6=4+2 meaning top-right).
--zoom=<float> Zoom video
You can zoom the video by the specified
factor.
-V, --vout=<string> Video output module
This is the the video output method used by
VLC. The default behavior is to automatically
select the best method available.
--video-filter=<string> Video filter module
This adds post-processing filters to enhance
the picture quality, for instance
deinterlacing, or distortthe video.
--vout-filter=<string> (null)

Subpictures
--spu, --no-spu Enable sub-pictures (default enabled)
You can completely disable the sub-picture
processing. (default enabled)
--osd, --no-osd On Screen Display (default enabled)
VLC can display messages on the video. This
is called OSD (On Screen Display). (default
enabled)
--text-renderer=<string> Text rendering module
VLC normally uses Freetype for rendering, but
this allows you to use svg for instance.
--sub-file=<string> Use subtitle file
Load this subtitle file. To be used when
autodetect cannot detect your subtitle file.
--sub-autodetect-file, --no-sub-autodetect-file
Autodetect subtitle files (default enabled)
Automatically detect a subtitle file, if no
subtitle filename is specified (based on the
filename of the movie). (default enabled)
--sub-autodetect-fuzzy=<integer>
Subtitle autodetection fuzziness
This determines how fuzzy subtitle and movie
filename matching will be. Options are:
0 =
no subtitles autodetected
1 = any subtitle
file
2 = any subtitle file containing the
movie name
3 = subtitle file matching the
movie name with additional chars
4 = subtitle
file matching the movie name exactly
--sub-autodetect-path=<string>
Subtitle autodetection paths
Look for a subtitle file in those paths too,
if your subtitle file was not found in the
current directory.
--sub-margin=<integer> Force subtitle position
You can use this option to place the
subtitles under the movie, instead of over
the movie. Try several positions.
--sub-filter=<string> Subpictures filter module
This adds so-called "subpicture filters".
These filters overlay some images or text
over the video (like a logo, arbitraty
text...).
--france, --no-france France (default disabled)
If you live in France, it is not allowed to
workaround any Digital Restrictions
Management measure. (default disabled)
--program=<integer> Program
Choose the program to select by giving its
Service ID. Only use this option if you want
to read a multi-program stream (like DVB
streams for example).
--programs=<string> Programs
Choose the programs to select by giving a
comma-separated list of Service IDs (SIDs).
Only use this option if you want to read a
multi-program stream (like DVB streams for
example).
--audio-track=<integer> Audio track
Stream number of the audio track to use (from
0 to n).
--sub-track=<integer> Subtitles track
Stream number of the subtitle track to use
(from 0 to n).
--audio-language=<string> Audio language
Language of the audio track you want to use
(comma separated, two or three letter country
code).
--sub-language=<string> Subtitle language
Language of the subtitle track you want to
use (comma separated, two or tree letter
country code).
--audio-track-id=<integer> Audio track ID
Stream ID of the audio track to use.
--sub-track-id=<integer> Subtitles track ID
Stream ID of the subtitle track to use.
--input-repeat=<integer> Input repetitions
Number of time the same input will be repeated
--start-time=<integer> Start time
The stream will start at this position (in
seconds).
--stop-time=<integer> Stop time
The stream will stop at this position (in
seconds).
--input-list=<string> Input list
You can give a comma-separated list of inputs
that will be concatenated together after the
normal one.
--input-slave=<string> Input slave (experimental)
This allows you to play from several inputs
at the same time. This feature is
experimental, not all formats are supported.
Use a '#' separated list of inputs.
--bookmarks=<string> Bookmarks list for a stream
You can manually give a list of bookmarks for
a stream in the form "{name=bookmark-name,time
=optional-time-offset,bytes=optional-byte-offs
et},{...}"
--dvd=<string> DVD device
This is the default DVD drive (or file) to
use. Don't forget the colon after the drive
letter (eg. D:)
--vcd=<string> VCD device
This is the default VCD device to use.
--cd-audio=<string> Audio CD device
This is the default Audio CD device to use.
--server-port=<integer> UDP port
This is the default port used for UDP
streams. Default is 1234.
--mtu=<integer> MTU of the network interface
This is the maximum packet size that can be
transmitted over the network interface. On
Ethernet it is usually 1500 bytes.
-6, --ipv6, --no-ipv6 Force IPv6 (default disabled)
IPv6 will be used by default for all
connections. (default disabled)
-4, --ipv4, --no-ipv4 Force IPv4 (default disabled)
IPv4 will be used by default for all
connections. (default disabled)
--ipv4-timeout=<integer> TCP connection timeout
Default TCP connection timeout (in
milliseconds).
--socks=<string> SOCKS server
SOCKS proxy server to use. This must be of
the form address:port. It will be used for
all TCP connections
--socks-user=<string> SOCKS user name
User name to be used for connection to the
SOCKS proxy.
--socks-pwd=<string> SOCKS password
Password to be used for connection to the
SOCKS proxy.
--meta-title=<string> Title metadata
Allows you to specify a "title" metadata for
an input.
--meta-author=<string> Author metadata
Allows you to specify an "author" metadata
for an input.
--meta-artist=<string> Artist metadata
Allows you to specify an "artist" metadata
for an input.
--meta-genre=<string> Genre metadata
Allows you to specify a "genre" metadata for
an input.
--meta-copyright=<string> Copyright metadata
Allows you to specify a "copyright" metadata
for an input.
--meta-description=<string>
Description metadata
Allows you to specify a "description"
metadata for an input.
--meta-date=<string> Date metadata
Allows you to specify a "date" metadata for
an input.
--meta-url=<string> URL metadata
Allows you to specify a "url" metadata for an
input.
--cr-average=<integer> Clock reference average counter
When using the PVR input (or a very irregular
source), you should set this to 10000.
--clock-synchro={-1 (Default), 0 (Disable), 1 (Enable)}
Clock synchronisation
It is possible to disable the input clock
synchronisation for real-time sources. Use
this if you experience jerky playback of
network streams.
--network-synchronisation, --no-network-synchronisation
Network synchronisation (default disabled)
This allows you to remotely synchronise
clocks for server and client. The detailed
settings are available in Advanced / Network
Sync. (default disabled)

Decoders
--codec=<string> Preferred decoders list
List of codecs that VLC will use in priority.
For instance, 'dummy,a52' will try the dummy
and a52 codecs before trying the other ones.
Only advanced users should alter this option
as it can break playback of all your streams.
--encoder=<string> Preferred encoders list
This allows you to select a list of encoders
that VLC will use in priority.

Input
--access=<string> Access module
This allows you to force an access module.
You can use it if the correct access is not
automatically detected. You should not set
this as a global option unless you really
know what you are doing.
--access-filter=<string> Access filter module
Access filters are used to modify the stream
that is being read. This is used for instance
for timeshifting.
--demux=<string> Demux module
Demultiplexers are used to separate the
"elementary" streams (like audio and video
streams). You can use it if the correct
demuxer is not automatically detected. You
should not set this as a global option unless
you really know what you are doing.

Stream output
--sout=<string> Default stream output chain
You can enter here a default stream output
chain. Refer to the documentation to learn
how to build such chains.Warning: this chain
will be enabled for all streams.
--sout-display, --no-sout-display
Display while streaming (default disabled)
Play locally the stream while streaming it.
(default disabled)
--sout-keep, --no-sout-keep
Keep stream output open (default disabled)
This allows you to keep an unique stream
output instance across multiple playlist item
(automatically insert the gather stream
output if not specified) (default disabled)
--sout-all, --no-sout-all Enable streaming of all ES (default disabled)
Stream all elementary streams (video, audio
and subtitles) (default disabled)
--sout-audio, --no-sout-audio
Enable audio stream output (default enabled)
Choose whether the audio stream should be
redirected to the stream output facility when
this last one is enabled. (default enabled)
--sout-video, --no-sout-video
Enable video stream output (default enabled)
Choose whether the video stream should be
redirected to the stream output facility when
this last one is enabled. (default enabled)
--sout-spu, --no-sout-spu Enable SPU stream output (default enabled)
Choose whether the SPU streams should be
redirected to the stream output facility when
this last one is enabled. (default enabled)
--vlm-conf=<string> VLM configuration file
Read a VLM configuration file as soon as VLM
is started.
--mux=<string> Mux module
This is a legacy entry to let you configure
mux modules
--access_output=<string> Access output module
This is a legacy entry to let you configure
access output modules
--ttl=<integer> Hop limit (TTL)
This is the hop limit (also known as
"Time-To-Live" or TTL) of the multicast
packets sent by the stream output (-1 = use
operating system built-in default).
--miface=<string> Multicast output interface
Default multicast interface. This overrides
the routing table.
--miface-addr=<string> IPv4 multicast output interface address
IPv4 adress for the default multicast
interface. This overrides the routing table.
--dscp=<integer> DiffServ Code Point
Differentiated Services Code Point for
outgoing UDP streams (or IPv4 Type Of
Service, or IPv6 Traffic Class). This is used
for network Quality of Service.
--packetizer=<string> Preferred packetizer list
This allows you to select the order in which
VLC will choose its packetizers.
--sap-flow-control, --no-sap-flow-control
Control SAP flow (default disabled)
If this option is enabled, the flow on the
SAP multicast address will be controlled.
This is needed if you want to make
announcements on the MBone. (default disabled)
--sap-interval=<integer> SAP announcement interval
When the SAP flow control is disabled, this
lets you set the fixed interval between SAP
announcements.

CPU
--fpu, --no-fpu Enable FPU support (default enabled)
If your processor has a floating point
calculation unit, VLC can take advantage of
it. (default enabled)
--mmx, --no-mmx Enable CPU MMX support (default enabled)
If your processor supports the MMX
instructions set, VLC can take advantage of
them. (default enabled)
--3dn, --no-3dn Enable CPU 3D Now! support (default enabled)
If your processor supports the 3D Now!
instructions set, VLC can take advantage of
them. (default enabled)
--mmxext, --no-mmxext Enable CPU MMX EXT support (default enabled)
If your processor supports the MMX EXT
instructions set, VLC can take advantage of
them. (default enabled)
--sse, --no-sse Enable CPU SSE support (default enabled)
If your processor supports the SSE
instructions set, VLC can take advantage of
them. (default enabled)
--sse2, --no-sse2 Enable CPU SSE2 support (default enabled)
If your processor supports the SSE2
instructions set, VLC can take advantage of
them. (default enabled)

Miscellaneous
-A, --memcpy=<string> Memory copy module
You can select which memory copy module you
want to use. By default VLC will select the
fastest one supported by your hardware.
--plugins-cache, --no-plugins-cache
Use a plugins cache (default enabled)
Use a plugins cache which will greatly
improve the startup time of VLC. (default
enabled)
--plugin-path=<string> Modules search path
Additional path for VLC to look for its
modules.
--minimize-threads, --no-minimize-threads
Minimize number of threads (default disabled)
This option minimizes the number of threads
needed to run VLC. (default disabled)
--one-instance, --no-one-instance
Allow only one running instance (default
disabled)
Allowing only one running instance of VLC can
sometimes be useful, for example if you
associated VLC with some media types and you
don't want a new instance of VLC to be opened
each time you double-click on a file in the
explorer. This option will allow you to play
the file with the already running instance or
enqueue it. (default disabled)
--started-from-file, --no-started-from-file
VLC is started from file association (default
disabled)
Tell VLC that it is being launched due to a
file association in the OS (default disabled)
--one-instance-when-started-from-file, --no-one-instance-when-started-from-file
One instance when started from file (default
enabled)
Allow only one running instance when started
from file. (default enabled)
--playlist-enqueue, --no-playlist-enqueue
Enqueue items to playlist when in one
instance mode (default disabled)
When using the one instance only option,
enqueue items to playlist and keep playing
current item. (default disabled)
--high-priority, --no-high-priority
Increase the priority of the process (default
disabled)
Increasing the priority of the process will
very likely improve your playing experience
as it allows VLC not to be disturbed by other
applications that could otherwise take too
much processor time. However be advised that
in certain circumstances (bugs) VLC could
take all the processor time and render the
whole system unresponsive which might require
a reboot of your machine. (default disabled)
--fast-mutex, --no-fast-mutex
Fast mutex on NT/2K/XP (developers only)
(default disabled)
On Windows NT/2K/XP we use a slow mutex
implementation but which allows us to
correctly implement condition variables. You
can also use the faster Win9x implementation
but you might experience problems with it.
(default disabled)
--win9x-cv-method=<integer>
Condition variables implementation for Win9x
(developers only)
On Windows 9x/Me you can use a fast but
incorrect condition variables implementation
(more precisely there is a possibility for a
race condition to happen). However it is
possible to use slower alternatives which are
more robust. Currently you can choose between
implementation 0 (which is the fastest but
slightly incorrect), 1 (default) and 2.

Playlist
-Z, --random, --no-random Play files randomly forever (default disabled)
VLC will randomly play files in the playlist
until interrupted. (default disabled)
-L, --loop, --no-loop Repeat all (default disabled)
VLC will keep playing the playlist
indefinitely. (default disabled)
-R, --repeat, --no-repeat Repeat current item (default disabled)
VLC will keep playing the current playlist
item. (default disabled)
--play-and-exit, --no-play-and-exit
Play and exit (default disabled)
Exit if there are no more items in the
playlist. (default disabled)
--play-and-stop, --no-play-and-stop
Play and stop (default disabled)
Stop the playlist after each played playlist
item. (default disabled)
--media-library, --no-media-library
Use media library (default enabled)
The media library is automatically saved and
reloaded each time you start VLC. (default
enabled)
--playlist-tree={0 (Default), 1 (Always), 2 (Never)}
Use playlist tree
The playlist can use a tree to categorize
some items, like the contents of a directory.
"Default" means that the tree will only be
used when really needed.
--open=<string> Default stream
This stream will always be opened at VLC
startup.
--auto-preparse, --no-auto-preparse
Automatically preparse files (default enabled)
Automatically preparse files added to the
playlist (to retrieve some metadata).
(default enabled)
--album-art={0 (Manual download only), 1 (When track starts playing), 2 (As soon as track is added)}
Album art policy
Choose how album art will be downloaded.
-S, --services-discovery=<string>
Services discovery modules
Specifies the services discovery modules to
load, separated by semi-colons. Typical
values are sap, hal, ...
-v, --verbose=<integer> Verbosity (0,1,2)
This is the verbosity level (0=only errors
and standard messages, 1=warnings, 2=debug).
-q, --quiet, --no-quiet Be quiet (default disabled)
Turn off all warning and information
messages. (default disabled)
--file-logging, --no-file-logging
Log to file (default disabled)
Log all VLC messages to a text file. (default
disabled)
--language={auto,en,en_GB,ca,cs,da,de,es,fr,gl,he,hu,it,ja,ka,ko,ms,nl,oc,pt_BR,ro,ru,sk,sl,sv,tr,zh_CN,zh_TW}
Language
You can manually select a language for the
interface. The system language is
auto-detected if "auto" is specified here.
--color, --no-color Color messages (default disabled)
This enables colorization of the messages
sent to the console Your terminal needs Linux
color support for this to work. (default
disabled)
--advanced, --no-advanced Show advanced options (default enabled)
When this is enabled, the preferences and/or
interfaces will show all available options,
including those that most users should never
touch. (default enabled)
--interact, --no-interact Interface interaction (default disabled)
When this is enabled, the interface will show
a dialog box each time some user input is
required. (default disabled)
--show-intf, --no-show-intf
Show interface with mouse (default disabled)
When this is enabled, the interface is shown
when you move the mouse to the edge of the
screen in fullscreen mode. (default disabled)
--stats, --no-stats Collect statistics (default enabled)
Collect miscellaneous statistics. (default
enabled)
-I, --intf=<string> Interface module
This is the main interface used by VLC. The
default behavior is to automatically select
the best module available.
--extraintf=<string> Extra interface modules
You can select "additional interfaces" for
VLC. They will be launched in the background
in addition to the default interface. Use a
comma separated list of interface modules.
(common values are "rc" (remote control),
"http", "gestures" ...)
--control=<string> Control interfaces
You can select control interfaces for VLC.

Hot keys
--key-fullscreen=<integer> Fullscreen
Select the hotkey to use to swap fullscreen
state.
--key-play-pause=<integer> Play/Pause
Select the hotkey to use to swap paused state.
--key-pause=<integer> Pause only
Select the hotkey to use to pause.
--key-play=<integer> Play only
Select the hotkey to use to play.
--key-faster=<integer> Faster
Select the hotkey to use for fast forward
playback.
--key-slower=<integer> Slower
Select the hotkey to use for slow motion
playback.
--key-next=<integer> Next
Select the hotkey to use to skip to the next
item in the playlist.
--key-prev=<integer> Previous
Select the hotkey to use to skip to the
previous item in the playlist.
--key-stop=<integer> Stop
Select the hotkey to stop playback.
--key-position=<integer> Position
Select the hotkey to display the position.
--key-jump-extrashort=<integer>
Very short backwards jump
Select the hotkey to make a very short
backwards jump.
--key-jump+extrashort=<integer>
Very short forward jump
Select the hotkey to make a very short
forward jump.
--key-jump-short=<integer> Short backwards jump
Select the hotkey to make a short backwards
jump.
--key-jump+short=<integer> Short forward jump
Select the hotkey to make a short forward
jump.
--key-jump-medium=<integer>
Medium backwards jump
Select the hotkey to make a medium backwards
jump.
--key-jump+medium=<integer>
Medium forward jump
Select the hotkey to make a medium forward
jump.
--key-jump-long=<integer> Long backwards jump
Select the hotkey to make a long backwards
jump.
--key-jump+long=<integer> Long forward jump
Select the hotkey to make a long forward jump.
--key-nav-activate=<integer>
Activate
Select the key to activate selected item in
DVD menus.
--key-nav-up=<integer> Navigate up
Select the key to move the selector up in DVD
menus.
--key-nav-down=<integer> Navigate down
Select the key to move the selector down in
DVD menus.
--key-nav-left=<integer> Navigate left
Select the key to move the selector left in
DVD menus.
--key-nav-right=<integer> Navigate right
Select the key to move the selector right in
DVD menus.
--key-disc-menu=<integer> Go to the DVD menu
Select the key to take you to the DVD menu
--key-title-prev=<integer> Select previous DVD title
Select the key to choose the previous title
from the DVD
--key-title-next=<integer> Select next DVD title
Select the key to choose the next title from
the DVD
--key-chapter-prev=<integer>
Select prev DVD chapter
Select the key to choose the previous chapter
from the DVD
--key-chapter-next=<integer>
Select next DVD chapter
Select the key to choose the next chapter
from the DVD
--key-quit=<integer> Quit
Select the hotkey to quit the application.
--key-vol-up=<integer> Volume up
Select the key to increase audio volume.
--key-vol-down=<integer> Volume down
Select the key to decrease audio volume.
--key-vol-mute=<integer> Mute
Select the key to mute audio.
--key-subdelay-up=<integer>
Subtitle delay up
Select the key to increase the subtitle delay.
--key-subdelay-down=<integer>
Subtitle delay down
Select the key to decrease the subtitle delay.
--key-audiodelay-up=<integer>
Audio delay up
Select the key to increase the audio delay.
--key-audiodelay-down=<integer>
Audio delay down
Select the key to decrease the audio delay.
--key-audio-track=<integer>
Cycle audio track
Cycle through the available audio
tracks(languages).
--key-subtitle-track=<integer>
Cycle subtitle track
Cycle through the available subtitle tracks.
--key-aspect-ratio=<integer>
Cycle source aspect ratio
Cycle through a predefined list of source
aspect ratios.
--key-crop=<integer> Cycle video crop
Cycle through a predefined list of crop
formats.
--key-deinterlace=<integer>
Cycle deinterlace modes
Cycle through deinterlace modes.
--key-intf-show=<integer> Show interface
Raise the interface above all other windows.
--key-intf-hide=<integer> Hide interface
Lower the interface below all other windows.
--key-snapshot=<integer> Take video snapshot
Takes a video snapshot and writes it to disk.
--key-history-back=<integer>
Go back in browsing history
Select the key to go back (to the previous
media item) in the browsing history.
--key-history-forward=<integer>
Go forward in browsing history
Select the key to go forward (to the next
media item) in the browsing history.
--key-record=<integer> Record
Record access filter start/stop.
--key-dump=<integer> Dump
Media dump access filter trigger.
--key-zoom=<integer> Zoom
Zoom
--key-unzoom=<integer> Un-Zoom
Un-Zoom
--key-crop-top=<integer> Crop one pixel from the top of the video
Crop one pixel from the top of the video
--key-uncrop-top=<integer> Uncrop one pixel from the top of the video
Uncrop one pixel from the top of the video
--key-crop-left=<integer> Crop one pixel from the left of the video
Crop one pixel from the left of the video
--key-uncrop-left=<integer>
Uncrop one pixel from the left of the video
Uncrop one pixel from the left of the video
--key-crop-bottom=<integer>
Crop one pixel from the bottom of the video
Crop one pixel from the bottom of the video
--key-uncrop-bottom=<integer>
Uncrop one pixel from the bottom of the video
Uncrop one pixel from the bottom of the video
--key-crop-right=<integer> Crop one pixel from the right of the video
Crop one pixel from the right of the video
--key-uncrop-right=<integer>
Uncrop one pixel from the right of the video
Uncrop one pixel from the right of the video
--extrashort-jump-size=<integer>
Very short jump length
Very short jump length, in seconds.
--short-jump-size=<integer>
Short jump length
Short jump length, in seconds.
--medium-jump-size=<integer>
Medium jump length
Medium jump length, in seconds.
--long-jump-size=<integer> Long jump length
Long jump length, in seconds.
--key-set-bookmark1=<integer>
Set playlist bookmark 1
Select the key to set this playlist bookmark.
--key-set-bookmark2=<integer>
Set playlist bookmark 2
Select the key to set this playlist bookmark.
--key-set-bookmark3=<integer>
Set playlist bookmark 3
Select the key to set this playlist bookmark.
--key-set-bookmark4=<integer>
Set playlist bookmark 4
Select the key to set this playlist bookmark.
--key-set-bookmark5=<integer>
Set playlist bookmark 5
Select the key to set this playlist bookmark.
--key-set-bookmark6=<integer>
Set playlist bookmark 6
Select the key to set this playlist bookmark.
--key-set-bookmark7=<integer>
Set playlist bookmark 7
Select the key to set this playlist bookmark.
--key-set-bookmark8=<integer>
Set playlist bookmark 8
Select the key to set this playlist bookmark.
--key-set-bookmark9=<integer>
Set playlist bookmark 9
Select the key to set this playlist bookmark.
--key-set-bookmark10=<integer>
Set playlist bookmark 10
Select the key to set this playlist bookmark.
--key-play-bookmark1=<integer>
Play playlist bookmark 1
Select the key to play this bookmark.
--key-play-bookmark2=<integer>
Play playlist bookmark 2
Select the key to play this bookmark.
--key-play-bookmark3=<integer>
Play playlist bookmark 3
Select the key to play this bookmark.
--key-play-bookmark4=<integer>
Play playlist bookmark 4
Select the key to play this bookmark.
--key-play-bookmark5=<integer>
Play playlist bookmark 5
Select the key to play this bookmark.
--key-play-bookmark6=<integer>
Play playlist bookmark 6
Select the key to play this bookmark.
--key-play-bookmark7=<integer>
Play playlist bookmark 7
Select the key to play this bookmark.
--key-play-bookmark8=<integer>
Play playlist bookmark 8
Select the key to play this bookmark.
--key-play-bookmark9=<integer>
Play playlist bookmark 9
Select the key to play this bookmark.
--key-play-bookmark10=<integer>
Play playlist bookmark 10
Select the key to play this bookmark.
--bookmark1=<string> Playlist bookmark 1
This allows you to define playlist bookmarks.
--bookmark2=<string> Playlist bookmark 2
This allows you to define playlist bookmarks.
--bookmark3=<string> Playlist bookmark 3
This allows you to define playlist bookmarks.
--bookmark4=<string> Playlist bookmark 4
This allows you to define playlist bookmarks.
--bookmark5=<string> Playlist bookmark 5
This allows you to define playlist bookmarks.
--bookmark6=<string> Playlist bookmark 6
This allows you to define playlist bookmarks.
--bookmark7=<string> Playlist bookmark 7
This allows you to define playlist bookmarks.
--bookmark8=<string> Playlist bookmark 8
This allows you to define playlist bookmarks.
--bookmark9=<string> Playlist bookmark 9
This allows you to define playlist bookmarks.
--bookmark10=<string> Playlist bookmark 10
This allows you to define playlist bookmarks.

Help options
-h, --help print help for VLC (can be combined with
--advanced)
-H, --longhelp print help for VLC and all its modules (can
be combined with --advanced)
--advanced print help for the advanced options
--help-verbose ask for extra verbosity when displaying help
-l, --list print a list of available modules
-p, --module=<string> print help on a specific module (can be
combined with --advanced)
--save-config save the current command line options in the
config
--reset-config reset the current config to the default values
--config=<string> use alternate config file
--reset-plugins-cache resets the current plugins cache
--version print version information

ATSC A/52 (AC-3) audio decoder
--a52-dynrng, --no-a52-dynrng
A/52 dynamic range compression (default
enabled)
Dynamic range compression makes the loud
sounds softer, and the soft sounds louder, so
you can more easily listen to the stream in a
noisy environment without disturbing anyone.
If you disable the dynamic range compression
the playback will be more adapted to a movie
theater or a listening room. (default enabled)
--a52-upmix, --no-a52-upmix
Enable internal upmixing (default disabled)
Enable the internal upmixing algorithm (not
recommended). (default disabled)

Standard filesystem directory input
--recursive={none,collapse,expand}
Subdirectory behavior
Select whether subdirectories must be
expanded.
none: subdirectories do not appear
in the playlist.
collapse: subdirectories
appear but are expanded on first
play.
expand: all subdirectories are
expanded.

--ignore-filetypes=<string>
Ignored extensions
Files with these extensions will not be added
to playlist when opening a directory.
This is
useful if you add directories that contain
playlist files for instance. Use a
comma-separated list of extensions.

Fake input
--fake-caching=<integer> Caching value in ms
Caching value for fake streams. This value
should be set in milliseconds.
--fake-fps=<float> Framerate
Number of frames per second (eg. 24, 25,
29.97, 30).
--fake-id=<integer> ID
Set the ID of the fake elementary stream for
use in #duplicate{} constructs (default 0).
--fake-duration=<integer> Duration in ms
Duration of the fake streaming before faking
an end-of-file (default is 0, meaning that
the stream is unlimited).

File input
--file-caching=<integer> Caching value in ms
Caching value for files. This value should be
set in milliseconds.

Dump
--dump-force, --no-dump-force
Force use of dump module (default disabled)
Activate the dump module even for media with
fast seeking. (default disabled)
--dump-margin=<integer> Maximum size of temporary file (Mb)
The dump module will abort dumping of the
media if more than this much megabyte were
performed.

Record
--record-path=<string> Record directory
Directory where the record will be stored.

Timeshift
--timeshift-granularity=<integer>
Timeshift granularity
This is the size of the temporary files that
will be used to store the timeshifted streams.
--timeshift-dir=<string> Timeshift directory
Directory used to store the timeshift
temporary files.
--timeshift-force, --no-timeshift-force
Force use of the timeshift module (default
disabled)
Force use of the timeshift module even if the
access declares that it can control pace or
pause. (default disabled)

FTP input
--ftp-caching=<integer> Caching value in ms
Caching value for FTP streams. This value
should be set in milliseconds.
--ftp-user=<string> FTP user name
User name that will be used for the
connection.
--ftp-pwd=<string> FTP password
Password that will be used for the connection.
--ftp-account=<string> FTP account
Account that will be used for the connection.

HTTP input
--http-proxy=<string> HTTP proxy
HTTP proxy to be usesd It must be of the form
http://[user[:pass]@]myproxy.mydomain:myport/
; if empty, the http_proxy environment
variable will be tried.
--http-caching=<integer> Caching value in ms
Caching value for HTTP streams. This value
should be set in milliseconds.
--http-user-agent=<string> HTTP user agent
User agent that will be used for the
connection.
--http-reconnect, --no-http-reconnect
Auto re-connect (default disabled)
Automatically try to reconnect to the stream
in case of a sudden disconnect. (default
disabled)
--http-continuous, --no-http-continuous
Continuous stream (default disabled)
Read a file that is being constantly updated
(for example, a JPG file on a server).You
should not globally enable this option as it
will break all other types of HTTP streams.
(default disabled)

Microsoft Media Server (MMS) input
--mms-caching=<integer> Caching value in ms
Caching value for MMS streams. This value
should be set in milliseconds.
--mms-all, --no-mms-all Force selection of all streams (default
disabled)
MMS streams can contain several elementary
streams, with different bitrates. You can
choose to select all of them. (default
disabled)
--mms-maxbitrate=<integer> Maximum bitrate
Select the stream with the maximum bitrate
under that limit.

File stream output
--sout-file-append, --no-sout-file-append
Append to file (default disabled)
Append to file if it exists instead of
replacing it. (default disabled)

HTTP stream output
--sout-http-user=<string> Username
User name that will be requested to access
the stream.
--sout-http-pwd=<string> Password
Password that will be requested to access the
stream.
--sout-http-mime=<string> Mime
MIME returned by the server (autodetected if
not specified.
--sout-http-cert=<string> Certificate file
Path to the x509 PEM certificate file that
will be used for HTTPS.
--sout-http-key=<string> Private key file
Path to the x509 PEM private key file that
will be used for HTTPS. Leave empty if you
don't have one.
--sout-http-ca=<string> Root CA file
Path to the x509 PEM trusted root CA
certificates (certificate authority) file
that will be used for HTTPS. Leave empty if
you don't have one.
--sout-http-crl=<string> CRL file
Path to the x509 PEM Certificates Revocation
List file that will be used for SSL. Leave
empty if you don't have one.
--sout-http-bonjour, --no-sout-http-bonjour
Advertise with Bonjour (default disabled)
Advertise the stream with the Bonjour
protocol. (default disabled)

IceCAST output
--sout-shout-name=<string> Stream name
Name to give to this stream/channel on the
shoutcast/icecast server.
--sout-shout-description=<string>
Stream description
Description of the stream content or
information about your channel.
--sout-shout-mp3, --no-sout-shout-mp3
Stream MP3 (default disabled)
You normally have to feed the shoutcast
module with Ogg streams. It is also possible
to stream MP3 instead, so you can forward MP3
streams to the shoutcast/icecast server.
(default disabled)
--sout-shout-genre=<string>
Genre description
Genre of the content.
--sout-shout-url=<string> URL description
URL with information about the stream or your
channel.
--sout-shout-bitrate=<string>
Bitrate
Bitrate information of the transcoded stream.
--sout-shout-samplerate=<string>
Samplerate
Samplerate information of the transcoded
stream.
--sout-shout-channels=<string>
Number of channels
Number of channels information of the
transcoded stream.
--sout-shout-quality=<string>
Ogg Vorbis Quality
Ogg Vorbis Quality information of the
transcoded stream.
--sout-shout-public, --no-sout-shout-public
Stream public (default disabled)
Make the server publicly available on the
'Yellow Pages' (directory listing of streams)
on the icecast/shoutcast website. Requires
the bitrate information specified for
shoutcast. Requires Ogg streaming for
icecast. (default disabled)

UDP stream output
--sout-udp-caching=<integer>
Caching value (ms)
Default caching value for outbound UDP
streams. This value should be set in
milliseconds.
--sout-udp-group=<integer> Group packets
Packets can be sent one by one at the right
time or by groups. You can choose the number
of packets that will be sent at a time. It
helps reducing the scheduling load on
heavily-loaded systems.
--sout-udp-raw, --no-sout-udp-raw
Raw write (default disabled)
Packets will be sent directly, without trying
to fill the MTU (ie, without trying to make
the biggest possible packets in order to
improve streaming). (default disabled)

Real RTSP
--realrtsp-caching=<integer>
Caching value (ms)
Caching value for RTSP streams. This value
should be set in milliseconds.

SMB input
--smb-caching=<integer> Caching value in ms
Caching value for SMB streams. This value
should be set in milliseconds.
--smb-user=<string> SMB user name
User name that will be used for the
connection.
--smb-pwd=<string> SMB password
Password that will be used for the connection.
--smb-domain=<string> SMB domain
Domain/Workgroup that will be used for the
connection.

TCP input
--tcp-caching=<integer> Caching value in ms
Caching value for TCP streams. This value
should be set in milliseconds.

UDP/RTP input
--udp-caching=<integer> Caching value in ms
Caching value for UDP streams. This value
should be set in milliseconds.
--rtp-late=<integer> RTP reordering timeout in ms
VLC reorders RTP packets. The input will wait
for late packets at most the time specified
here (in milliseconds).
--udp-auto-mtu, --no-udp-auto-mtu
Autodetection of MTU (default enabled)
Automatically detect the line's MTU. This
will increase the size if truncated packets
are found (default enabled)

Image properties filter
--contrast=<float> Image contrast (0-2)
Set the image contrast, between 0 and 2.
Defaults to 1.
--brightness=<float> Image brightness (0-2)
Set the image brightness, between 0 and 2.
Defaults to 1.
--hue=<integer> Image hue (0-360)
Set the image hue, between 0 and 360.
Defaults to 0.
--saturation=<float> Image saturation (0-3)
Set the image saturation, between 0 and 3.
Defaults to 1.
--gamma=<float> Image gamma (0-10)
Set the image gamma, between 0.01 and 10.
Defaults to 1.
--brightness-threshold, --no-brightness-threshold
Brightness threshold (default disabled)
When this mode is enabled, pixels will be
shown as black or white. The threshold value
will be the brighness defined below. (default
disabled)

DirectX audio output
--directx-audio-device=<integer>
Output device
DirectX device number: 0 default device, 1..N
device by number(Note that the default device
appears as 0 AND another number).
--directx-audio-float32, --no-directx-audio-float32
Use float32 output (default disabled)
The option allows you to enable or disable
the high-quality float32 audio output mode
(which is not well supported by some
soundcards). (default disabled)

File audio output
--audiofile-format={u8,s8,u16,s16,u16_le,s16_le,u16_be,s16_be,fixed32,float32,spdif}
Output format
One of "u8", "s8", "u16", "s16", "u16_le",
"s16_le", "u16_be", "s16_be", "fixed32",
"float32" or "spdif"
--audiofile-channels=<integer>
Number of output channels
By default, all the channels of the incoming
will be saved but you can restrict the number
of channels here.
--audiofile-file=<string> Output file
File to which the audio samples will be
written to.
--audiofile-wav, --no-audiofile-wav
Add WAVE header (default enabled)
Instead of writing a raw file, you can add a
WAV header to the file. (default enabled)

Audioscrobbler submission Plugin
--lastfm-username=<string> Username
The username of your last.fm account
--lastfm-password=<string> Password
The password of your last.fm account

AVI demuxer
--avi-interleaved, --no-avi-interleaved
Force interleaved method (default disabled)
Force interleaved method. (default disabled)
--avi-index={0 (Ask), 1 (Always fix), 2 (Never fix)}
Force index creation
Recreate a index for the AVI file. Use this
if your AVI file is damaged or incomplete
(not seekable).

Audio CD input
--cdda-caching=<integer> Caching value in ms
Default caching value for Audio CDs. This
value should be set in milliseconds.
--cdda-track=<integer> (null)
--cdda-first-sector=<integer>
(null)
--cdda-last-sector=<integer>
(null)
--cddb-server=<string> CDDB Server
Address of the CDDB server to use.
--cddb-port=<integer> CDDB port
CDDB Server port to use.

Clone video filter
--clone-count=<integer> Number of clones
Number of video windows in which to clone the
video.
--clone-vout-list=<string> Video output modules
You can use specific video output modules for
the clones. Use a comma-separated list of
modules.

Color threshold filter
--colorthres-color={16711680 (Red), 16711935 (Fuchsia), 16776960 (Yellow), 65280 (Lime), 255 (Blue), 65535 (Aqua)}
Color
Colors similar to this will be kept, others
will be grayscaled. This must be an
hexadecimal (like HTML colors). The first two
chars are for red, then green, then blue.
#000000 = black, #FF0000 = red, #00FF00 =
green, #FFFF00 = yellow (red + green),
#FFFFFF = white
--colorthres-saturationthres=<integer>
saturaton threshold
--colorthres-similaritythres=<integer>
similarity threshold

Crop video filter
--crop-geometry=<string> Crop geometry (pixels)
Set the geometry of the zone to crop. This is
set as <width> x <height> + <left offset> +
<top offset>.
--autocrop, --no-autocrop Automatic cropping (default disabled)
Automatically detect black borders and crop
them. (default disabled)
--autocrop-ratio-max=<integer>
Ratio max (x 1000)
Maximum image ratio. The crop plugin will
never automatically crop to a higher ratio
(ie, to a more "flat" image). The value is
x1000: 1333 means 4/3.
--crop-ratio=<integer> Manual ratio
Force a ratio (0 for automatic). Value is
x1000: 1333 means 4/3.
--autocrop-time=<integer> Number of images for change
The number of consecutive images with the
same detected ratio (different from the
previously detected ratio) to consider that
ratio chnged and trigger recrop.
--autocrop-diff=<integer> Number of lines for change
The minimum difference in the number of
detected black lines to consider that ratio
changed and trigger recrop.
--autocrop-non-black-pixels=<integer>
Number of non black pixels
The maximum of non-black pixels in a line to
consider that the line is black.
--autocrop-skip-percent=<integer>
Skip percentage (%)
Percentage of the line to consider while
checking for black lines. This allows to skip
logos in black borders and crop them anyway.
--autocrop-luminance-threshold=<integer>
Luminance threshold
Maximum luminance to consider a pixel as
black (0-255).

Deinterlacing video filter
--deinterlace-mode={discard,blend,mean,bob,linear,x}
Deinterlace mode
Deinterlace method to use for local playback.
--sout-deinterlace-mode={discard,blend,mean,bob,linear,x}
Streaming deinterlace mode
Deinterlace method to use for streaming.

File dumpper
--demuxdump-file=<string> Dump filename
Name of the file to which the raw stream will
be dumped.
--demuxdump-append, --no-demuxdump-append
Append to existing file (default disabled)
If the file already exists, it will not be
overwritten. (default disabled)

Dummy interface function
--dummy-quiet, --no-dummy-quiet
Do not open a DOS command box interface
(default disabled)
By default the dummy interface plugin will
start a DOS command box. Enabling the quiet
mode will not bring this command box but can
also be pretty annoying when you want to stop
VLC and no video window is open. (default
disabled)
--dummy-save-es, --no-dummy-save-es
Save raw codec data (default disabled)
Save the raw codec data if you have
selected/forced the dummy decoder in the main
options. (default disabled)
--dummy-chroma=<string> Dummy image chroma format
Force the dummy video output to create images
using a specific chroma format instead of
trying to improve performances by using the
most efficient one.

DVB subtitles decoder
--dvbsub-position={0 (Center), 1 (Left), 2 (Right), 4 (Top), 8 (Bottom), 5 (Top-Left), 6 (Top-Right), 9 (Bottom-Left), 10 (Bottom-Right)}
Subpicture position
You can enforce the subpicture position on
the video (0=center, 1=left, 2=right, 4=top,
8=bottom, you can also use combinations of
these values, e.g. 6=top-right).
--dvbsub-x=<integer> Decoding X coordinate
X coordinate of the rendered subtitle
--dvbsub-y=<integer> Decoding Y coordinate
Y coordinate of the rendered subtitle
--sout-dvbsub-x=<integer> Encoding X coordinate
X coordinate of the encoded subtitle
--sout-dvbsub-y=<integer> Encoding Y coordinate
Y coordinate of the encoded subtitle

DVDnav Input
--dvdnav-angle=<integer> DVD angle
Default DVD angle.
--dvdnav-caching=<integer> Caching value in ms
Caching value for DVDs. This value should be
set in milliseconds.
--dvdnav-menu, --no-dvdnav-menu
Start directly in menu (default enabled)
Start the DVD directly in the main menu. This
will try to skip all the useless warning
introductions. (default enabled)

DVDRead Input (DVD without menu support)
--dvdread-angle=<integer> DVD angle
Default DVD angle.
--dvdread-caching=<integer>
Caching value in ms
Caching value for DVDs. This value should be
set in milliseconds.
--dvdread-css-method={title,disc,key}
Method used by libdvdcss for decryption
Set the method used by libdvdcss for key
decryption.
title: decrypted title key is
guessed from the encrypted sectors of the
stream. Thus it should work with a file as
well as the DVD device. But it sometimes
takes much time to decrypt a title key and
may even fail. With this method, the key is
only checked at the beginning of each title,
so it won't work if the key changes in the
middle of a title.
disc: the disc key is
first cracked, then all title keys can be
decrypted instantly, which allows us to check
them often.
key: the same as "disc" if you
don't have a file with player keys at
compilation time. If you do, the decryption
of the disc key will be faster with this
method. It is the one that was used by
libcss.
The default method is: key.

Equalizer with 10 bands
--equalizer-preset={flat,classical,club,dance,fullbass,fullbasstreble,fulltreble,headphones,largehall,live,party,pop,reggae,rock,ska,soft,softrock,techno}
Equalizer preset
Preset to use for the equalizer.
--equalizer-bands=<string> Bands gain
Don't use presets, but manually specified
bands. You need to provide 10 values between
-20dB and 20dB, separated by spaces, e.g. "0
2 4 2 0 -2 -4 -2 0"
--equalizer-2pass, --no-equalizer-2pass
Two pass (default disabled)
Filter the audio twice. This provides a more
intense effect. (default disabled)
--equalizer-preamp=<float> Global gain
Set the global gain in dB (-20 ... 20).

Extract RGB component video filter
--extract-component={16711680 (Red), 65280 (Green), 255 (Blue)}
RGB component to extract
RGB component to extract. 0 for Red, 1 for
Green and 2 for Blue.

Fake video decoder
--fake-file=<string> Image file
Path of the image file for fake input.
--fake-width=<integer> Video width
Output video width.
--fake-height=<integer> Video height
Output video height.
--fake-keep-ar, --no-fake-keep-ar
Keep aspect ratio (default disabled)
Consider width and height as maximum values.
(default disabled)
--fake-aspect-ratio=<string>
Background aspect ratio
Aspect ratio of the image file (4:3, 16:9).
Default is square pixels.
--fake-deinterlace, --no-fake-deinterlace
Deinterlace video (default disabled)
Deinterlace the image after loading it.
(default disabled)
--fake-deinterlace-module={deinterlace,ffmpeg-deinterlace}
Deinterlace module
Deinterlace module to use.

FFmpeg audio/video decoder/encoder ((MS)MPEG4,SVQ1,H263,WMV,WMA)
--ffmpeg-dr, --no-ffmpeg-dr
Direct rendering (default enabled)
Direct rendering (default enabled)
--ffmpeg-error-resilience=<integer>
Error resilience
Ffmpeg can do error resilience.
However, with
a buggy encoder (such as the ISO MPEG-4
encoder from M$) this can produce a lot of
errors.
Valid values range from 0 to 4 (0
disables all errors resilience).
--ffmpeg-workaround-bugs=<integer>
Workaround bugs
Try to fix some bugs:
1 autodetect
2 old
msmpeg4
4 xvid interlaced
8 ump4
16 no
padding
32 ac vlc
64 Qpel chroma.
This must
be the sum of the values. For example, to fix
"ac vlc" and "ump4", enter 40.
--ffmpeg-hurry-up, --no-ffmpeg-hurry-up
Hurry up (default disabled)
The decoder can partially decode or skip
frame(s) when there is not enough time. It's
useful with low CPU power but it can produce
distorted pictures. (default disabled)
--ffmpeg-vismv=<integer> Visualize motion vectors
You can overlay the motion vectors (arrows
showing how the images move) on the image.
This value is a mask, based on these
values:
1 - visualize forward predicted MVs
of P frames
2 - visualize forward predicted
MVs of B frames
4 - visualize backward
predicted MVs of B frames
To visualize all
vectors, the value should be 7.
--ffmpeg-lowres=<integer> Low resolution decoding
Only decode a low resolution version of the
video. This requires less processing power
--ffmpeg-skiploopfilter={0 (None), 1 (Non-ref), 2 (Bidir), 3 (Non-key), 4 (All)}
Skip the loop filter for H.264 decoding
Skipping the loop filter (aka deblocking)
usually has a detrimental effect on quality.
However it provides a big speedup for high
definition streams.
--ffmpeg-pp-q=<integer> Post processing quality
Quality of post processing. Valid range is 0
to 6
Higher levels require considerable more
CPU power, but produce better looking
pictures.
--ffmpeg-pp-name=<string> FFmpeg post processing filter chains
<filterName>[:<option>[:<option>...]][[,|/][-]
<filterName>[:<option>...]]...
long form
example:
vdeblock:autoq/hdeblock:autoq/linblen
ddeint default,-vdeblock
short form
example:
vb:a/hb:a/lb de,-vb
more examples:
tn
:64:128:256
Filters
Options
short long name short long
option Description
* *
a autoq cpu power dependant
enabler
c chrom
chrominance filtring enabled

y nochrom
chrominance filtring disabled
hb hdeblock
(2 Threshold) horizontal
deblocking filter
1. difference
factor: default=64, higher -> more
deblocking
2. flatness threshold:
default=40, lower -> more deblocking

the h & v deblocking filters
share these
so u cant
set different thresholds for h / v
vb
vdeblock (2 Threshold)
vertical deblocking filter
h1 x1hdeblock
Experimental h
deblock filter 1
v1 x1vdeblock
Experimental v deblock
filter 1
dr dering
Deringing filter
al autolevels
automatic
brightness / contrast

f fullyrange stretch luminance to
(0..255)
lb linblenddeint
linear blend deinterlacer
li
linipoldeint
linear interpolating deinterlace
ci
cubicipoldeint cubic
interpolating deinterlacer
md mediandeint
median
deinterlacer
fd ffmpegdeint
ffmpeg deinterlacer
de
default
hb:a,vb:a,dr:a,al
fa fast
h1:a,v1:a,dr:a,al
tn
tmpnoise (3 Thresholds)
Temporal Noise Reducer

1. <= 2. <= 3. larger -> stronger
filtering
fq forceQuant <quantizer>
Force quantizer

--ffmpeg-debug=<integer> Debug mask
Set ffmpeg debug mask
--sout-ffmpeg-hq={rd,bits,simple}
Quality level
Quality level for the encoding of motions
vectors (this can slow down the encoding very
much).
--sout-ffmpeg-keyint=<integer>
Ratio of key frames
Number of frames that will be coded for one
key frame.
--sout-ffmpeg-bframes=<integer>
Ratio of B frames
Number of B frames that will be coded between
two reference frames.
--sout-ffmpeg-hurry-up, --no-sout-ffmpeg-hurry-up
Hurry up (default disabled)
The encoder can make on-the-fly quality
tradeoffs if your CPU can't keep up with the
encoding rate. It will disable trellis
quantization, then the rate distortion of
motion vectors (hq), and raise the noise
reduction threshold to ease the encoder's
task. (default disabled)
--sout-ffmpeg-interlace, --no-sout-ffmpeg-interlace
Interlaced encoding (default disabled)
Enable dedicated algorithms for interlaced
frames. (default disabled)
--sout-ffmpeg-interlace-me, --no-sout-ffmpeg-interlace-me
Interlaced motion estimation (default enabled)
Enable interlaced motion estimation
algorithms. This requires more CPU. (default
enabled)
--sout-ffmpeg-vt=<integer> Video bitrate tolerance
Video bitrate tolerance in kbit/s.
--sout-ffmpeg-pre-me, --no-sout-ffmpeg-pre-me
Pre-motion estimation (default disabled)
Enable the pre-motion estimation algorithm.
(default disabled)
--sout-ffmpeg-strict-rc, --no-sout-ffmpeg-strict-rc
Strict rate control (default disabled)
Enable the strict rate control algorithm.
(default disabled)
--sout-ffmpeg-rc-buffer-size=<integer>
Rate control buffer size
Rate control buffer size (in kbytes). A
bigger buffer will allow for better rate
control, but will cause a delay in the stream.
--sout-ffmpeg-rc-buffer-aggressivity=<float>
Rate control buffer aggressiveness
Rate control buffer aggressiveness.
--sout-ffmpeg-i-quant-factor=<float>
I quantization factor
Quantization factor of I frames, compared
with P frames (for instance 1.0 => same
qscale for I and P frames).
--sout-ffmpeg-noise-reduction=<integer>
Noise reduction
Enable a simple noise reduction algorithm to
lower the encoding length and bitrate, at the
expense of lower quality frames.
--sout-ffmpeg-mpeg4-matrix, --no-sout-ffmpeg-mpeg4-matrix
MPEG4 quantization matrix (default disabled)
Use the MPEG4 quantization matrix for MPEG2
encoding. This generally yields a better
looking picture, while still retaining the
compatibility with standard MPEG2 decoders.
(default disabled)
--sout-ffmpeg-qmin=<integer>
Minimum video quantizer scale
Minimum video quantizer scale.
--sout-ffmpeg-qmax=<integer>
Maximum video quantizer scale
Maximum video quantizer scale.
--sout-ffmpeg-trellis, --no-sout-ffmpeg-trellis
Trellis quantization (default disabled)
Enable trellis quantization (rate distortion
for block coefficients). (default disabled)
--sout-ffmpeg-qscale=<float>
Fixed quantizer scale
A fixed video quantizer scale for VBR
encoding (accepted values: 0.01 to 255.0).
--sout-ffmpeg-strict=<integer>
Strict standard compliance
Force a strict standard compliance when
encoding (accepted values: -1, 0, 1).
--sout-ffmpeg-lumi-masking=<float>
Luminance masking
Raise the quantizer for very bright
macroblocks (default: 0.0).
--sout-ffmpeg-dark-masking=<float>
Darkness masking
Raise the quantizer for very dark macroblocks
(default: 0.0).
--sout-ffmpeg-p-masking=<float>
Motion masking
Raise the quantizer for macroblocks with a
high temporal complexity (default: 0.0).
--sout-ffmpeg-border-masking=<float>
Border masking
Raise the quantizer for macroblocks at the
border of the frame (default: 0.0).
--sout-ffmpeg-luma-elim-threshold=<integer>
Luminance elimination
Eliminates luminance blocks when the PSNR
isn't much changed (default: 0.0). The H264
specification recommends -4.
--sout-ffmpeg-chroma-elim-threshold=<integer>
Chrominance elimination
Eliminates chrominance blocks when the PSNR
isn't much changed (default: 0.0). The H264
specification recommends 7.

Freetype2 font renderer
--freetype-font=<string> Font
Filename for the font you want to use
--freetype-fontsize=<integer>
Font size in pixels
This is the default size of the fonts that
will be rendered on the video. If set to
something different than 0 this option will
override the relative font size.
--freetype-opacity=<integer>
Opacity
The opacity (inverse of transparency) of the
text that will be rendered on the video. 0 =
transparent, 255 = totally opaque.
--freetype-color={0 (Black), 8421504 (Gray), 12632256 (Silver), 16777215 (White), 8388608 (Maroon), 16711680 (Red), 16711935 (Fuchsia), 16776960 (Yellow), 8421376 (Olive), 32768 (Green), 32896 (Teal), 65280 (Lime), 8388736 (Purple), 128 (Navy), 255 (Blue), 65535 (Aqua)}
Text default color
The color of the text that will be rendered
on the video. This must be an hexadecimal
(like HTML colors). The first two chars are
for red, then green, then blue. #000000 =
black, #FF0000 = red, #00FF00 = green,
#FFFF00 = yellow (red + green), #FFFFFF =
white
--freetype-rel-fontsize={20 (Smaller), 18 (Small), 16 (Normal), 12 (Large), 6 (Larger)}
Relative font size
This is the relative default size of the
fonts that will be rendered on the video. If
absolute font size is set, relative size will
be overriden.
--freetype-effect={1 (Background), 2 (Outline), 3 (Fat Outline)}
Font Effect
It is possible to apply effects to the
rendered text to improve its readability.
--freetype-yuvp, --no-freetype-yuvp
Use YUVP renderer (default disabled)
This renders the font using "paletized YUV".
This option is only needed if you want to
encode into DVB subtitles (default disabled)

Mouse gestures control interface
--gestures-threshold=<integer>
Motion threshold (10-100)
Amount of movement required for a mouse
gesture to be recorded.
--gestures-button={left,middle,right}
Trigger button
Trigger button for mouse gestures.

GnuTLS TLS encryption layer
--tls-check-cert, --no-tls-check-cert
Check TLS/SSL server certificate validity
(default enabled)
This ensures that the server certificate is
valid (i.e. signed by an approved
Certification Authority). (default enabled)
--tls-check-hostname, --no-tls-check-hostname
Check TLS/SSL server hostname in certificate
(default enabled)
This ensures that the server hostname in
certificate matches the requested host name.
(default enabled)
--gnutls-dh-bits=<integer> Diffie-Hellman prime bits
This allows you to modify the Diffie-Hellman
prime's number of bits, used for TLS or
SSL-based server-side encryption. This is
generally not needed.
--gnutls-cache-expiration=<integer>
Expiration time for resumed TLS sessions
It is possible to cache the resumed TLS
sessions. This is the expiration time of the
sessions stored in this cache, in seconds.
--gnutls-cache-size=<integer>
Number of resumed TLS sessions
This is the maximum number of resumed TLS
sessions that the cache will hold.

Goom effect
--goom-width=<integer> Goom display width
This allows you to set the resolution of the
Goom display (bigger resolution will be
prettier but more CPU intensive).
--goom-height=<integer> Goom display height
This allows you to set the resolution of the
Goom display (bigger resolution will be
prettier but more CPU intensive).
--goom-speed=<integer> Goom animation speed
This allows you to set the animation speed
(between 1 and 10, defaults to 6).

Gradient video filter
--gradient-mode={gradient,edge,hough}
Distort mode
Distort mode, one of "gradient", "edge" and
"hough".
--gradient-type=<integer> Gradient image type
Gradient image type (0 or 1). 0 will turn the
image to white while 1 will keep colors.
--gradient-cartoon, --no-gradient-cartoon
Apply cartoon effect (default enabled)
Apply cartoon effect. It is only used by
"gradient" and "edge". (default enabled)

Growl Notification Plugin
--growl-server=<string> Growl server
This is the host to which Growl notifications
will be sent. By default, notifications are
sent locally.
--growl-password=<string> Growl password
Growl password on the server.
--growl-port=<integer> Growl UDP port
Growl UDP port on the server.

H264 video demuxer
--h264-fps=<float> Frames per Second
Desired frame rate for the H264 stream.

Headphone virtual spatialization effect
--headphone-dim=<integer> Characteristic dimension
Distance between front left speaker and
listener in meters.
--headphone-compensate, --no-headphone-compensate
Compensate delay (default disabled)
The delay which is introduced by the physical
algorithm may sometimes be disturbing for the
synchronization between lips-movement and
speech. In case, turn this on to compensate.
(default disabled)
--headphone-dolby, --no-headphone-dolby
No decoding of Dolby Surround (default
disabled)
Dolby Surround encoded streams won't be
decoded before being processed by this
filter. Enabling this setting is not
recommended. (default disabled)

HTTP remote control interface
--http-host=<string> Host address
Address and port the HTTP interface will
listen on. It defaults to all network
interfaces (0.0.0.0). If you want the HTTP
interface to be available only on the local
machine, enter 127.0.0.1
--http-src=<string> Source directory
Source directory
--http-charset=<string> Charset
Charset declared in Content-Type header
(default UTF-8).
--http-handlers=<string> Handlers
List of handler extensions and executable
paths (for instance: php=/usr/bin/php,pl=/usr/
bin/perl).
--http-intf-cert=<string> Certificate file
HTTP interface x509 PEM certificate file
(enables SSL).
--http-intf-key=<string> Private key file
HTTP interface x509 PEM private key file.
--http-intf-ca=<string> Root CA file
HTTP interface x509 PEM trusted root CA
certificates file.
--http-intf-crl=<string> CRL file
HTTP interace Certificates Revocation List
file.

Image video output
--image-out-format={png,jpeg}
Image format
Format of the output images (png or jpg).
--image-width=<integer> Image width
You can enforce the image width. By default
(-1) VLC will adapt to the video
characteristics.
--image-height=<integer> Image height
You can enforce the image height. By default
(-1) VLC will adapt to the video
characteristics.
--image-out-ratio=<integer>
Recording ratio
Ratio of images to record. 3 means that one
image out of three is recorded.
--image-out-prefix=<string>
Filename prefix
Prefix of the output images filenames. Output
filenames will have the "prefixNUMBER.format"
form.
--image-out-replace, --no-image-out-replace
Always write to the same file (default
disabled)
Always write to the same file instead of
creating one file per image. In this case,
the number is not appended to the filename.
(default disabled)

RTP/RTSP/SDP demuxer (using Live555)
--rtsp-tcp, --no-rtsp-tcp Use RTP over RTSP (TCP) (default disabled)
Use RTP over RTSP (TCP) (default disabled)
--rtp-client-port=<integer>
Client port
Port to use for the RTP source of the session
--rtsp-http, --no-rtsp-http
Tunnel RTSP and RTP over HTTP (default
disabled)
Tunnel RTSP and RTP over HTTP (default
disabled)
--rtsp-http-port=<integer> HTTP tunnel port
Port to use for tunneling the RTSP/RTP over
HTTP.
--rtsp-caching=<integer> Caching value (ms)
Allows you to modify the default caching
value for RTSP streams. This value should be
set in millisecond units.
--rtsp-kasenna, --no-rtsp-kasenna
Kasenna RTSP dialect (default disabled)
Kasenna servers use an old and unstandard
dialect of RTSP. When you set this parameter,
VLC will try this dialect for communication.
In this mode you cannot connect to normal
RTSP servers. (default disabled)
--rtsp-user=<string> RTSP user name
Allows you to modify the user name that will
be used for authenticating the connection.
--rtsp-pwd=<string> RTSP password
Allows you to modify the password that will
be used for the connection.

File logging
--logfile=<string> Log filename
Specify the log filename.
--logmode={text,html} Log format
Specify the log format. Available choices are
"text" (default) and "html".
--rrd-file=<string> RRD output file
Output data for RRDTool in this file.

Logo video filter
--logo-file=<string> Logo filenames
Full path of the image files to use. Format
is <image>[,<delay in ms>[,<alpha>]][;<image>[
,<delay>[,<alpha>]]][;...]. If you only have
one file, simply enter its filename.
--logo-x=<integer> X coordinate
X coordinate of the logo. You can move the
logo by left-clicking it.
--logo-y=<integer> Y coordinate
Y coordinate of the logo. You can move the
logo by left-clicking it.
--logo-delay=<integer> Logo individual image time in ms
Individual image display time of 0 - 60000 ms.
--logo-repeat=<integer> Logo animation # of loops
Number of loops for the logo animation.-1 =
continuous, 0 = disabled
--logo-transparency=<integer>
Transparency of the logo
Logo transparency value (from 0 for full
transparency to 255 for full opacity).
--logo-position={0 (Center), 1 (Left), 2 (Right), 4 (Top), 8 (Bottom), 5 (Top-Left), 6 (Top-Right), 9 (Bottom-Left), 10 (Bottom-Right)}
Logo position
Enforce the logo position on the video
(0=center, 1=left, 2=right, 4=top, 8=bottom,
you can also use combinations of these
values, eg 6 = top-right).

Marquee display
--marq-marquee=<string> Text
Marquee text to display. (Available format
strings: Time related: %Y = year, %m = month,
%d = day, %H = hour, %M = minute, %S =
second, ... Meta data related: $a = artist,
$b = album, $c = copyright, $d = description,
$e = encoded by, $g = genre, $l = language,
$n = track num, $p = now playing, $r =
rating, $s = subtitles language, $t = title,
$u = url, $A = date, $B = audio bitrate (in
kb/s), $C = chapter,$D = duration, $F = full
name with path, $I = title, $L = time left,
$N = name, $O = audio language, $P = position
(in %), $R = rate, $S = audio sample rate (in
kHz), $T = time, $U = publisher, $V = volume,
$_ = new line)
--marq-x=<integer> X offset
X offset, from the left screen edge.
--marq-y=<integer> Y offset
Y offset, down from the top.
--marq-position=<integer> Marquee position
You can enforce the marquee position on the
video (0=center, 1=left, 2=right, 4=top,
8=bottom, you can also use combinations of
these values, eg 6 = top-right).
--marq-opacity=<integer> Opacity
Opacity (inverse of transparency) of
overlayed text. 0 = transparent, 255 =
totally opaque.
--marq-color={-268435456 (Default), 0 (Black), 8421504 (Gray), 12632256 (Silver), 16777215 (White), 8388608 (Maroon), 16711680 (Red), 16711935 (Fuchsia), 16776960 (Yellow), 8421376 (Olive), 32768 (Green), 32896 (Teal), 65280 (Lime), 8388736 (Purple), 128 (Navy), 255 (Blue), 65535 (Aqua)}
Color
Color of the text that will be rendered on
the video. This must be an hexadecimal (like
HTML colors). The first two chars are for
red, then green, then blue. #000000 = black,
#FF0000 = red, #00FF00 = green, #FFFF00 =
yellow (red + green), #FFFFFF = white
--marq-size=<integer> Font size, pixels
Font size, in pixels. Default is -1 (use
default font size).
--marq-timeout=<integer> Timeout
Number of milliseconds the marquee must
remain displayed. Default value is 0 (remains
forever).

M-JPEG camera demuxer
--mjpeg-fps=<float> Frames per Second
This is the desired frame rate when playing
MJPEG from a file. Use 0 (this is the default
value) for a live stream (from a camera).

Matroska stream demuxer
--mkv-use-ordered-chapters, --no-mkv-use-ordered-chapters
Ordered chapters (default enabled)
Play ordered chapters as specified in the
segment. (default enabled)
--mkv-use-chapter-codec, --no-mkv-use-chapter-codec
Chapter codecs (default enabled)
Use chapter codecs found in the segment.
(default enabled)
--mkv-preload-local-dir, --no-mkv-preload-local-dir
Preload Directory (default enabled)
Preload matroska files from the same family
in the same directory (not good for broken
files). (default enabled)
--mkv-seek-percent, --no-mkv-seek-percent
Seek based on percent not time (default
disabled)
Seek based on percent not time. (default
disabled)
--mkv-use-dummy, --no-mkv-use-dummy
Dummy Elements (default disabled)
Read and discard unknown EBML elements (not
good for broken files). (default disabled)

MOD demuxer (libmodplug)
--mod-noisereduction, --no-mod-noisereduction
Noise reduction (default enabled)
Enable noise reduction algorithm (default
enabled)
--mod-reverb, --no-mod-reverb
Reverb (default disabled)
Enable reverberation (default disabled)
--mod-reverb-level=<integer>
Reverberation level
Reverberation level (from 0 to 100, default
value is 0).
--mod-reverb-delay=<integer>
Reverberation delay
Reverberation delay, in ms. Usual values are
from to 40 to 200ms.
--mod-megabass, --no-mod-megabass
Mega bass (default disabled)
Enable megabass mode (default disabled)
--mod-megabass-level=<integer>
Mega bass level
Megabass mode level (from 0 to 100, default
value is 0).
--mod-megabass-range=<integer>
Mega bass cutoff
Megabass mode cutoff frequency, in Hz.This is
the maximum frequency for which the megabass
effect applies. Valid values are from 10 to
100 Hz
--mod-surround, --no-mod-surround
Surround (default disabled)
Surround (default disabled)
--mod-surround-level=<integer>
Surround level
Surround effect level (from 0 to 100, default
value is 0).
--mod-surround-delay=<integer>
Surround delay (ms)
Surround delay, in ms. Usual values are from
5 to 40 ms

Audio filter for stereo to mono conversion
--sout-mono-downmix, --no-sout-mono-downmix
Use downmix algorithme. (default disabled)
This option selects a stereo to mono downmix
algorithm that is used in the headphone
channel mixer. Itgives the effect of standing
in a room full of speakers. (default disabled)
--sout-mono-channel={0 (Left), 1 (Right), 2 (Left rear), 4 (Right rear), 8 (Center), 5 (Left front)}
Select channel to keep
This option silences all other channels
except the selected channel. Choose one from
(0=left, 1=right 2=rear left, 3=rear right,
4=center, 5=left front)

Mosaic video sub filter
--mosaic-alpha=<integer> Transparency
Transparency of the mosaic foreground
pictures. 0 means transparent, 255 opaque
(default).
--mosaic-height=<integer> Height
Total height of the mosaic, in pixels.
--mosaic-width=<integer> Width
Total width of the mosaic, in pixels.
--mosaic-align={0 (Center), 1 (Left), 2 (Right), 4 (Top), 8 (Bottom), 5 (Top-Left), 6 (Top-Right), 9 (Bottom-Left), 10 (Bottom-Right)}
Mosaic alignment
You can enforce the mosaic alignment on the
video (0=center, 1=left, 2=right, 4=top,
8=bottom, you can also use combinations of
these values, eg 6 = top-right).
--mosaic-xoffset=<integer> Top left corner X coordinate
X Coordinate of the top-left corner of the
mosaic.
--mosaic-yoffset=<integer> Top left corner Y coordinate
Y Coordinate of the top-left corner of the
mosaic.
--mosaic-borderw=<integer> Border width
Width in pixels of the border between
miniatures.
--mosaic-borderh=<integer> Border height
Height in pixels of the border between
miniatures.
--mosaic-position={0 (auto), 1 (fixed), 2 (offsets)}
Positioning method
Positioning method for the mosaic. auto:
automatically choose the best number of rows
and columns. fixed: use the user-defined
number of rows and columns. offsets: use the
user-defined offsets for each image.
--mosaic-rows=<integer> Number of rows
Number of image rows in the mosaic (only used
if positionning method is set to "fixed".
--mosaic-cols=<integer> Number of columns
Number of image columns in the mosaic (only
used if positionning method is set to "fixed".
--mosaic-keep-aspect-ratio, --no-mosaic-keep-aspect-ratio
Keep aspect ratio (default disabled)
Keep the original aspect ratio when resizing
mosaic elements. (default disabled)
--mosaic-keep-picture, --no-mosaic-keep-picture
Keep original size (default disabled)
Keep the original size of mosaic elements.
(default disabled)
--mosaic-order=<string> Elements order
You can enforce the order of the elements on
the mosaic. You must give a comma-separated
list of picture ID(s).These IDs are assigned
in the "mosaic-bridge" module.
--mosaic-offsets=<string> Offsets in order
You can enforce the (x,y) offsets of the
elements on the mosaic (only used if
positioning method is set to "offsets"). You
must give a comma-separated list of
coordinates (eg: 10,10,150,10).
--mosaic-delay=<integer> Delay
Pictures coming from the mosaic elements will
be delayed according to this value (in
milliseconds). For high values you will need
to raise caching at input.
--mosaic-bs, --no-mosaic-bs
Bluescreen (default disabled)
This effect, also known as "greenscreen" or
"chroma key" blends the "blue parts" of the
foreground images of the mosaic on the
background (like wheather forecast
presenters). You can choose the "key" color
for blending (blue by default). (default
disabled)
--mosaic-bsu=<integer> Bluescreen U value
"U" value for the bluescreen key color (in
YUV values). From 0 to 255. Defaults to 120
for blue.
--mosaic-bsv=<integer> Bluescreen V value
"V" value for the bluescreen key color (in
YUV values). From 0 to 255. Defaults to 90
for blue.
--mosaic-bsut=<integer> Bluescreen U tolerance
Tolerance of the bluescreen blender on color
variations for the U plane. A value between
10 and 20 seems sensible.
--mosaic-bsvt=<integer> Bluescreen V tolerance
Tolerance of the bluescreen blender on color
variations for the V plane. A value between
10 and 20 seems sensible.

Motion blur filter
--blur-factor=<integer> Blur factor (1-127)
The degree of blurring from 1 to 127.

MusePack demuxer
--mpc-replaygain-type={0 (None), 1 (Title), 2 (Album)}
Replay Gain type
Musepack can have a title-specific replay
gain (volume control) or an album-specific
one. Choose which type you want to use

MSN Now-Playing
--msn-format=<string> MSN Title format string
Format of the string to send to MSN {0}
Artist, {1} Title, {2} Album. Defaults to
"Artist - Title" ({0} - {1}).

ASF muxer
--sout-asf-title=<string> Title
Title to put in ASF comments.
--sout-asf-author=<string> Author
Author to put in ASF comments.
--sout-asf-copyright=<string>
Copyright
Copyright string to put in ASF comments.
--sout-asf-comment=<string>
Comment
Comment to put in ASF comments.
--sout-asf-rating=<string> Rating
"Rating" to put in ASF comments.
--sout-asf-packet-size=<integer>
Packet Size
ASF packet size -- default is 4096 bytes

MP4/MOV muxer
--sout-mp4-faststart, --no-sout-mp4-faststart
Create "Fast Start" files (default enabled)
Create "Fast Start" files. "Fast Start" files
are optimized for downloads and allow the
user to start previewing the file while it is
downloading. (default enabled)

Multipart JPEG muxer
--sout-mpjpeg-separator=<string>
Multipart separator string
Multipart strings like MPJPEG use a specific
string to separate its content pieces. You
can select this string. Default is
--myboundary

PS muxer
--sout-ps-dts-delay=<integer>
DTS delay (ms)
Delay the DTS (decoding time stamps) and PTS
(presentation timestamps) of the data in the
stream, compared to the SCRs. This allows for
some buffering inside the client decoder.
--sout-ps-pes-max-size=<integer>
PES maximum size
Set the maximum allowed PES size when
producing the MPEG PS streams.

TS muxer (libdvbpsi)
--sout-ts-pid-video=<integer>
Video PID
Assign a fixed PID to the video stream. The
PCR PID will automatically be the video.
--sout-ts-pid-audio=<integer>
Audio PID
Assign a fixed PID to the audio stream.
--sout-ts-pid-spu=<integer>
SPU PID
Assign a fixed PID to the SPU.
--sout-ts-pid-pmt=<integer>
PMT PID
Assign a fixed PID to the PMT
--sout-ts-tsid=<integer> TS ID
Assign a fixed Transport Stream ID.
--sout-ts-netid=<integer> NET ID
Assign a fixed Network ID (for SDT table)
--sout-ts-program-pmt=<string>
PMT Program numbers
Assign a program number to each PMT. This
requires "Set PID to ID of ES" to be enabled.
--sout-ts-es-id-pid, --no-sout-ts-es-id-pid
Set PID to ID of ES (default disabled)
Sets PID to the ID if the incoming ES. This
is for use with --ts-es-id-pid, and allows to
have the same PIDs in the input and output
streams. (default disabled)
--sout-ts-muxpmt=<string> Mux PMT (requires --sout-ts-es-id-pid)
Define the pids to add to each pmt. This
requires "Set PID to ID of ES" to be enabled.
--sout-ts-sdtdesc=<string> SDT Descriptors (requires --sout-ts-es-id-pid)
Defines the descriptors of each SDT.
Thisrequires "Set PID to ID of ES" to be
enabled.
--sout-ts-alignment, --no-sout-ts-alignment
Data alignment (default enabled)
Enforces alignment of all access units on PES
boundaries. Disabling this might save some
bandwidth but introduce incompatibilities.
(default enabled)
--sout-ts-shaping=<integer>
Shaping delay (ms)
Cut the stream in slices of the given
duration, and ensure a constant bitrate
between the two boundaries. This avoids
having huge bitrate peaks, especially for
reference frames.
--sout-ts-use-key-frames, --no-sout-ts-use-key-frames
Use keyframes (default disabled)
If enabled, and shaping is specified, the TS
muxer will place the boundaries at the end of
I pictures. In that case, the shaping
duration given by the user is a worse case
used when no reference frame is available.
This enhances the efficiency of the shaping
algorithm, since I frames are usually the
biggest frames in the stream. (default
disabled)
--sout-ts-pcr=<integer> PCR delay (ms)
Set at which interval PCRs (Program Clock
Reference) will be sent (in milliseconds).
This value should be below 100ms. (default is
70ms).
--sout-ts-bmin=<integer> Minimum B (deprecated)
This setting is deprecated and not used
anymore
--sout-ts-bmax=<integer> Maximum B (deprecated)
This setting is deprecated and not used
anymore
--sout-ts-dts-delay=<integer>
DTS delay (ms)
Delay the DTS (decoding time stamps) and PTS
(presentation timestamps) of the data in the
stream, compared to the PCRs. This allows for
some buffering inside the client decoder.
--sout-ts-crypt-audio, --no-sout-ts-crypt-audio
Crypt audio (default enabled)
Crypt audio using CSA (default enabled)
--sout-ts-crypt-video, --no-sout-ts-crypt-video
Crypt video (default enabled)
Crypt video using CSA (default enabled)
--sout-ts-csa-ck=<string> CSA Key
CSA encryption key. This must be a 16 char
string (8 hexadecimal bytes).
--sout-ts-csa-pkt=<integer>
Packet size in bytes to encrypt
Size of the TS packet to encrypt. The
encryption routines subtract the TS-header
from the value before encrypting.

Network synchronisation
--netsync-master, --no-netsync-master
Act as master (default disabled)
Should act as the master client for the
network synchronisation? (default disabled)
--netsync-master-ip=<string>
Master client ip address
IP address of the master client used for the
network synchronisation.

Volume normalizer
--norm-buff-size=<integer> Number of audio buffers
This is the number of audio buffers on which
the power measurement is made. A higher
number of buffers will increase the response
time of the filter to a spike but will make
it less sensitive to short variations.
--norm-max-level=<float> Max level
If the average power over the last N buffers
is higher than this value, the volume will be
normalized. This value is a positive floating
point number. A value between 0.5 and 10
seems sensible.

Windows Service interface
--ntservice-install, --no-ntservice-install
Install Windows Service (default disabled)
Install the Service and exit. (default
disabled)
--ntservice-uninstall, --no-ntservice-uninstall
Uninstall Windows Service (default disabled)
Uninstall the Service and exit. (default
disabled)
--ntservice-name=<string> Display name of the Service
Change the display name of the Service.
--ntservice-options=<string>
Configuration options
Configuration options that will be used by
the Service (eg. --foo=bar --no-foobar). It
should be specified at install time so the
Service is properly configured.
--ntservice-extraintf=<string>
Extra interface modules
Additional interfaces spawned by the Service.
It should be specified at install time so the
Service is properly configured. Use a comma
separated list of interface modules. (common
values are: logger, sap, rc, http)

OpenGL video output
--opengl-cube-speed=<float>
OpenGL cube rotation speed
Rotation speed of the OpenGL cube effect, if
enabled.
--opengl-accuracy=<integer>
OpenGL sampling accuracy
Select the accuracy of 3D object sampling(1 =
min and 10 = max)
--opengl-pov-x=<float> Point of view x-coordinate
Point of view (X coordinate) of the
cube/cylinder effect, if enabled.
--opengl-pov-y=<float> Point of view y-coordinate
Point of view (Y coordinate) of the
cube/cylinder effect, if enabled.
--opengl-pov-z=<float> Point of view z-coordinate
Point of view (Z coordinate) of the
cube/cylinder effect, if enabled.
--opengl-cylinder-radius=<float>
OpenGL Cylinder radius
Radius of the OpenGL cylinder effect, if
enabled
--opengl-effect={none,cube,transparent-cube,cylinder,torus,sphere,SQUAREXY,SQUARER,ASINXY,ASINR,SINEXY,SINER}
Effect
Several visual OpenGL effects are available.

On Screen Display menu
--osdmenu-x=<integer> X coordinate
You can move the OSD menu by left-clicking on
it.
--osdmenu-y=<integer> Y coordinate
You can move the OSD menu by left-clicking on
it.
--osdmenu-position={0 (Center), 1 (Left), 2 (Right), 4 (Top), 8 (Bottom), 5 (Top-Left), 6 (Top-Right), 9 (Bottom-Left), 10 (Bottom-Right)}
Menu position
You can enforce the OSD menu position on the
video (0=center, 1=left, 2=right, 4=top,
8=bottom, you can also use combinations of
these values, eg. 6 = top-right).
--osdmenu-file=<string> Configuration file
Configuration file for the OSD Menu
--osdmenu-file-path=<string>
Path to OSD menu images
Path to the OSD menu images. This will
override the path defined in the OSD
configuration file.
--osdmenu-timeout=<integer>
Menu timeout
OSD menu pictures get a default timeout of 15
seconds added to their remaining time. This
will ensure that they are at least the
specified time visible.
--osdmenu-update=<integer> Menu update interval
The default is to update the OSD menu picture
every 200 ms. Shorten the update time for
environments that experience transmissions
errors. Be careful with this option as
encoding OSD menu pictures is very computing
intensive. The range is 0 - 1000 ms.

MPEG-I/II video packetizer
--packetizer-mpegvideo-sync-iframe, --no-packetizer-mpegvideo-sync-iframe
Sync on Intra Frame (default disabled)
Normally the packetizer would sync on the
next full frame. This flags instructs the
packetizer to sync on the first Intra Frame
found. (default disabled)

Panoramix: wall with overlap video filter
--panoramix-cols=<integer> Number of columns
Select the number of horizontal video windows
in which to split the video
--panoramix-rows=<integer> Number of rows
Select the number of vertical video windows
in which to split the video
--offset-x, --no-offset-x Offset X offset (automatic compensation)
(default enabled)
Select if you want an automatic offset in
horizontal (in case of misalignment due to
autoratio control) (default enabled)
--bz-length=<integer> length of the overlapping area (in %)
Select in percent the length of the blended
zone
--bz-height=<integer> height of the overlapping area (in %)
Select in percent the height of the blended
zone (case of 2x2 wall)
--panoramix-attenuate, --no-panoramix-attenuate
Attenuation (default enabled)
Check this option if you want attenuate
blended zone by this plug-in (if option is
unchecked, attenuate is made by opengl)
(default enabled)
--bz-begin=<integer> Attenuation, begin (in %)
Select in percent the Lagrange coeff of the
beginning blended zone
--bz-middle=<integer> Attenuation, middle (in %)
Select in percent the Lagrange coeff of the
middle of blended zone
--bz-end=<integer> Attenuation, end (in %)
Select in percent the Lagrange coeff of the
end of blended zone
--bz-middle-pos=<integer> middle position (in %)
Select in percent (50 is center) the position
of the middle point (Lagrange) of blended zone
--bz-gamma-red=<float> Gamma (Red) correction
Select the gamma for the correction of
blended zone (Red or Y component)
--bz-gamma-green=<float> Gamma (Green) correction
Select the gamma for the correction of
blended zone (Green or U component)
--bz-gamma-blue=<float> Gamma (Blue) correction
Select the gamma for the correction of
blended zone (Blue or V component)
--bz-blackcrush-red=<integer>
Black Crush for Red
Select the Black Crush of blended zone (Red
or Y component)
--bz-blackcrush-green=<integer>
Black Crush for Green
Select the Black Crush of blended zone (Green
or U component)
--bz-blackcrush-blue=<integer>
Black Crush for Blue
Select the Black Crush of blended zone (Blue
or V component)
--bz-whitecrush-red=<integer>
White Crush for Red
Select the White Crush of blended zone (Red
or Y component)
--bz-whitecrush-green=<integer>
White Crush for Green
Select the White Crush of blended zone (Green
or U component)
--bz-whitecrush-blue=<integer>
White Crush for Blue
Select the White Crush of blended zone (Blue
or V component)
--bz-blacklevel-red=<integer>
Black Level for Red
Select the Black Level of blended zone (Red
or Y component)
--bz-blacklevel-green=<integer>
Black Level for Green
Select the Black Level of blended zone (Green
or U component)
--bz-blacklevel-blue=<integer>
Black Level for Blue
Select the Black Level of blended zone (Blue
or V component)
--bz-whitelevel-red=<integer>
White Level for Red
Select the White Level of blended zone (Red
or Y component)
--bz-whitelevel-green=<integer>
White Level for Green
Select the White Level of blended zone (Green
or U component)
--bz-whitelevel-blue=<integer>
White Level for Blue
Select the White Level of blended zone (Blue
or V component)
--wall-active=<string> Active windows
Comma separated list of active windows,
defaults to all

Parametric Equalizer
--param-eq-lowf=<float> Low freq (Hz)
--param-eq-lowgain=<float> Low freq gain (Db)
--param-eq-highf=<float> High freq (Hz)
--param-eq-highgain=<float>
High freq gain (Db)
--param-eq-f1=<float> Freq 1 (Hz)
--param-eq-gain1=<float> Freq 1 gain (Db)
--param-eq-q1=<float> Freq 1 Q
--param-eq-f2=<float> Freq 2 (Hz)
--param-eq-gain2=<float> Freq 2 gain (Db)
--param-eq-q2=<float> Freq 2 Q
--param-eq-f3=<float> Freq 3 (Hz)
--param-eq-gain3=<float> Freq 3 gain (Db)
--param-eq-q3=<float> Freq 3 Q

Playlist
--playlist-autostart, --no-playlist-autostart
Auto start (default enabled)
Automatically start playing the playlist
content once it's loaded.
(default enabled)
--parent-item=<integer> (null)
--shoutcast-show-adult, --no-shoutcast-show-adult
Show shoutcast adult content (default
disabled)
Show NC17 rated video streams when using
shoutcast video playlists. (default disabled)

Podcasts
--podcast-urls=<string> Podcast URLs list
Enter the list of podcasts to retrieve,
separated by '|' (pipe).

PORTAUDIO audio output
--portaudio-device=<integer>
Output device
Portaudio identifier for the output device

MPEG-PS demuxer
--ps-trust-timestamps, --no-ps-trust-timestamps
Trust MPEG timestamps (default enabled)
Normally we use the timestamps of the MPEG
files to calculate position and duration.
However sometimes this might not be usable.
Disable this option to calculate from the
bitrate instead. (default enabled)

Puzzle interactive game video filter
--puzzle-rows=<integer> Number of puzzle rows
Number of puzzle rows
--puzzle-cols=<integer> Number of puzzle columns
Number of puzzle columns
--puzzle-black-slot, --no-puzzle-black-slot
Make one tile a black slot (default disabled)
Make one slot black. Other tiles can only be
swapped with the black slot. (default
disabled)

Qt interface
--qt-always-video, --no-qt-always-video
FIXME (default disabled)
FIXME (default disabled)

Remote control interface
--rc-show-pos, --no-rc-show-pos
Show stream position (default disabled)
Show the current position in seconds within
the stream from time to time. (default
disabled)
--rc-fake-tty, --no-rc-fake-tty
Fake TTY (default disabled)
Force the rc module to use stdin as if it was
a TTY. (default disabled)
--rc-unix=<string> UNIX socket command input
Accept commands over a Unix socket rather
than stdin.
--rc-host=<string> TCP command input
Accept commands over a socket rather than
stdin. You can set the address and port the
interface will bind to.
--rc-quiet, --no-rc-quiet Do not open a DOS command box interface
(default disabled)
By default the rc interface plugin will start
a DOS command box. Enabling the quiet mode
will not bring this command box but can also
be pretty annoying when you want to stop VLC
and no video window is open. (default
disabled)

Rotate video filter
--rotate-angle=<integer> Angle in degrees
Angle in degrees (0 to 359)

RSS and Atom feed display
--rrs-urls=<string> Feed URLs
RSS/Atom feed '|' (pipe) seperated URLs.
--rrs-x=<integer> X offset
X offset, from the left screen edge.
--rrs-y=<integer> Y offset
Y offset, down from the top.
--rrs-position={0 (Center), 1 (Left), 2 (Right), 4 (Top), 8 (Bottom), 5 (Top-Left), 6 (Top-Right), 9 (Bottom-Left), 10 (Bottom-Right)}
Text position
You can enforce the text position on the
video (0=center, 1=left, 2=right, 4=top,
8=bottom; you can also use combinations of
these values, eg 6 = top-right).
--rrs-opacity=<integer> Opacity
Opacity (inverse of transparency) of overlay
text. 0 = transparent, 255 = totally opaque.
--rrs-color={-268435456 (Default), 0 (Black), 8421504 (Gray), 12632256 (Silver), 16777215 (White), 8388608 (Maroon), 16711680 (Red), 16711935 (Fuchsia), 16776960 (Yellow), 8421376 (Olive), 32768 (Green), 32896 (Teal), 65280 (Lime), 8388736 (Purple), 128 (Navy), 255 (Blue), 65535 (Aqua)}
Color
Color of the text that will be rendered on
the video. This must be an hexadecimal (like
HTML colors). The first two chars are for
red, then green, then blue. #000000 = black,
#FF0000 = red, #00FF00 = green, #FFFF00 =
yellow (red + green), #FFFFFF = white
--rrs-size=<integer> Font size, pixels
Font size, in pixels. Default is -1 (use
default font size).
--rrs-speed=<integer> Speed of feeds
Speed of the RSS/Atom feeds (bigger is
slower).
--rrs-length=<integer> Max length
Maximum number of characters displayed on the
screen.
--rrs-ttl=<integer> Refresh time
Number of seconds between each forced refresh
of the feeds. 0 means that the feeds are
never updated.
--rrs-images, --no-rrs-images
Feed images (default enabled)
Display feed images if available. (default
enabled)

SAP Announcements
--sap-addr=<string> SAP multicast address
The SAP module normally chooses itself the
right addresses to listen to. However, you
can specify a specific address.
--sap-ipv4, --no-sap-ipv4 IPv4 SAP (default enabled)
Listen to IPv4 announcements on the standard
address. (default enabled)
--sap-ipv6, --no-sap-ipv6 IPv6 SAP (default enabled)
Listen to IPv6 announcements on the standard
addresses. (default enabled)
--sap-timeout=<integer> SAP timeout (seconds)
Delay after which SAP items get deleted if no
new announcement is received.
--sap-parse, --no-sap-parse
Try to parse the announce (default enabled)
This enables actual parsing of the announces
by the SAP module. Otherwise, all
announcements are parsed by the "livedotcom"
(RTP/RTSP) module. (default enabled)
--sap-strict, --no-sap-strict
SAP Strict mode (default disabled)
When this is set, the SAP parser will discard
some non-compliant announcements. (default
disabled)
--sap-timeshift, --no-sap-timeshift
Allow timeshifting (default disabled)
This automatically enables timeshifting for
streams discovered through SAP announcements.
(default disabled)

Screen Input
--screen-caching=<integer> Caching value in ms
Caching value for screen capture. This value
should be set in milliseconds.
--screen-fps=<float> Frame rate
Desired frame rate for the capture.
--screen-fragment-size=<integer>
Capture fragment size
Optimize the capture by fragmenting the
screen in chunks of predefined height (16
might be a good value, and 0 means disabled).

Shoutcast radio listings

Show interface with mouse
--showintf-threshold=<integer>
Threshold
Height of the zone triggering the interface.

Bridge stream output
--sout-bridge-out-id=<integer>
ID
Integer identifier for this elementary
stream. This will be used to "find" this
stream later.
--sout-bridge-in-delay=<integer>
Delay
Pictures coming from the picture video
outputs will be delayed according to this
value (in milliseconds, should be >= 100 ms).
For high values, you will need to raise
caching values.
--sout-bridge-in-id-offset=<integer>
ID Offset
Offset to add to the stream IDs specified in
bridge_out to obtain the stream IDs bridge_in
will register.

Display stream output
--sout-display-audio, --no-sout-display-audio
Enable audio (default enabled)
Enable/disable audio rendering. (default
enabled)
--sout-display-video, --no-sout-display-video
Enable video (default enabled)
Enable/disable video rendering. (default
enabled)
--sout-display-delay=<integer>
Delay
Introduces a delay in the display of the
stream.

Elementary stream output
--sout-es-access=<string> Output access method
This is the default output access method that
will be used.
--sout-es-access-audio=<string>
Audio output access method
This is the output access method that will be
used for audio.
--sout-es-access-video=<string>
Video output access method
This is the output access method that will be
used for video.
--sout-es-mux=<string> Output muxer
This is the default muxer method that will be
used.
--sout-es-mux-audio=<string>
Audio output muxer
This is the muxer that will be used for audio.
--sout-es-mux-video=<string>
Video output muxer
This is the muxer that will be used for video.
--sout-es-dst=<string> Output URL
This is the default output URI.
--sout-es-dst-audio=<string>
Audio output URL
This is the output URI that will be used for
audio.
--sout-es-dst-video=<string>
Video output URL
This is the output URI that will be used for
video.

Mosaic bridge stream output
--sout-mosaic-bridge-id=<string>
ID
Specify an identifier string for this
subpicture
--sout-mosaic-bridge-width=<integer>
Video width
Output video width.
--sout-mosaic-bridge-height=<integer>
Video height
Output video height.
--sout-mosaic-bridge-sar=<string>
Sample aspect ratio
Sample aspect ratio of the destination (1:1,
3:4, 2:3).

RTP stream output
--sout-rtp-dst=<string> Destination
This is the output URL that will be used.
--sout-rtp-sdp=<string> SDP
This allows you to specify how the SDP
(Session Descriptor) for this RTP session
will be made available. You must use an url:
http://location to access the SDP via HTTP,
rtsp://location for RTSP access, and sap://
for the SDP to be announced via SAP.
--sout-rtp-mux=<string> Muxer
This allows you to specify the muxer used for
the streaming output. Default is to use no
muxer (standard RTP stream).
--sout-rtp-name=<string> Session name
This is the name of the session that will be
announced in the SDP (Session Descriptor).
--sout-rtp-description=<string>
Session description
This allows you to give a broader description
of the stream, that will be announced in the
SDP (Session Descriptor).
--sout-rtp-url=<string> Session URL
This allows you to give an URL with more
details about the stream (often the website
of the streaming organization), that will be
announced in the SDP (Session Descriptor).
--sout-rtp-email=<string> Session email
This allows you to give a contact mail
address for the stream, that will be
announced in the SDP (Session Descriptor).
--sout-rtp-port=<integer> Port
This allows you to specify the base port for
the RTP streaming.
--sout-rtp-port-audio=<integer>
Audio port
This allows you to specify the default audio
port for the RTP streaming.
--sout-rtp-port-video=<integer>
Video port
This allows you to specify the default video
port for the RTP streaming.
--sout-rtp-ttl=<integer> Hop limit (TTL)
This is the hop limit (also known as
"Time-To-Live" or TTL) of the multicast
packets sent by the stream output (0 = use
operating system built-in default).
--sout-rtp-mp4a-latm, --no-sout-rtp-mp4a-latm
MP4A LATM (default disabled)
This allows you to stream MPEG4 LATM audio
streams (see RFC3016). (default disabled)

Standard stream output
--sout-standard-access=<string>
Output access method
This is the output access method that will be
used.
--sout-standard-mux=<string>
Output muxer
This is the muxer that will be used.
--sout-standard-dst=<string>
Output destination
This is the destination (URL) that will be
used for the stream.
--sout-standard-sap, --no-sout-standard-sap
SAP announcing (default disabled)
Announce this session with SAP. (default
disabled)
--sout-standard-name=<string>
Session name
This allows you to specify a name for the
session, that will be announced if you choose
to use SAP.
--sout-standard-group=<string>
Session groupname
This allows you to specify a group for the
session, that will be announced if you choose
to use SAP.

Transcode stream output
--sout-transcode-venc=<string>
Video encoder
This is the video encoder module that will be
used (and its associated options).
--sout-transcode-vcodec=<string>
Destination video codec
This is the video codec that will be used.
--sout-transcode-vb=<integer>
Video bitrate
Target bitrate of the transcoded video stream.
--sout-transcode-scale=<float>
Video scaling
Scale factor to apply to the video while
transcoding (eg: 0.25)
--sout-transcode-fps=<float>
Video frame-rate
Target output frame rate for the video stream.
--sout-transcode-hurry-up, --no-sout-transcode-hurry-up
Hurry up (default enabled)
The transcoder will drop frames if your CPU
can't keep up with the encoding rate.
(default enabled)
--sout-transcode-deinterlace, --no-sout-transcode-deinterlace
Deinterlace video (default disabled)
Deinterlace the video before encoding.
(default disabled)
--sout-transcode-deinterlace-module={deinterlace,ffmpeg-deinterlace}
Deinterlace module
Specify the deinterlace module to use.
--sout-transcode-width=<integer>
Video width
Output video width.
--sout-transcode-height=<integer>
Video height
Output video height.
--sout-transcode-maxwidth=<integer>
Maximum video width
Maximum output video width.
--sout-transcode-maxheight=<integer>
Maximum video height
Maximum output video height.
--sout-transcode-vfilter=<string>
Video filter
Video filters will be applied to the video
streams (after overlays are applied). You
must enter a comma-separated list of filters.
--sout-transcode-croptop=<integer>
Video crop (top)
Number of pixels to crop at the top of the
video.
--sout-transcode-cropleft=<integer>
Video crop (left)
Number of pixels to crop at the left of the
video.
--sout-transcode-cropbottom=<integer>
Video crop (bottom)
Number of pixels to crop at the bottom of the
video.
--sout-transcode-cropright=<integer>
Video crop (right)
Number of pixels to crop at the right of the
video.
--sout-transcode-paddtop=<integer>
Video padding (top)
Size of the black border to add at the top of
the video.
--sout-transcode-paddleft=<integer>
Video padding (left)
Size of the black border to add at the left
of the video.
--sout-transcode-paddbottom=<integer>
Video padding (bottom)
Size of the black border to add at the bottom
of the video.
--sout-transcode-paddright=<integer>
Video padding (right)
Size of the black border to add at the right
of the video.
--sout-transcode-canvas-width=<integer>
Video canvas width
This will automatically crod and pad the
video to a specified width.
--sout-transcode-canvas-height=<integer>
Video canvas height
This will automatically crod and pad the
video to a specified height.
--sout-transcode-canvas-aspect=<string>
Video canvas aspect ratio
This sets aspect (like 4:3) of the video
canvas and letterbox the video accordingly.
--sout-transcode-aenc=<string>
Audio encoder
This is the audio encoder module that will be
used (and its associated options).
--sout-transcode-acodec=<string>
Destination audio codec
This is the audio codec that will be used.
--sout-transcode-ab=<integer>
Audio bitrate
Target bitrate of the transcoded audio stream.
--sout-transcode-channels=<integer>
Audio channels
Number of audio channels in the transcoded
streams.
--sout-transcode-samplerate=<integer>
Audio sample rate
Sample rate of the transcoded audio stream
(11250, 22500, 44100 or 48000).
--sout-transcode-audio-sync, --no-sout-transcode-audio-sync
Synchronise on audio track (default disabled)
This option will drop/duplicate video frames
to synchronise the video track on the audio
track. (default disabled)
--sout-transcode-afilter=<string>
Audio filter
Audio filters will be applied to the audio
streams (after conversion filters are
applied). You must enter a comma-separated
list of filters.
--sout-transcode-senc=<string>
Subtitles encoder
This is the subtitles encoder module that
will be used (and its associated options).
--sout-transcode-scodec=<string>
Destination subtitles codec
This is the subtitles codec that will be used.
--sout-transcode-soverlay, --no-sout-transcode-soverlay
Destination subtitles codec (default disabled)
This is the subtitles codec that will be
used. (default disabled)
--sout-transcode-sfilter=<string>
Overlays
This allows you to add overlays (also known
as "subpictures" on the transcoded video
stream. The subpictures produced by the
filters will be overlayed directly onto the
video. You must specify a comma-separated
list of subpicture modules
--sout-transcode-osd, --no-sout-transcode-osd
OSD menu (default disabled)
Stream the On Screen Display menu (using the
osdmenu subpicture module). (default disabled)
--sout-transcode-threads=<integer>
Number of threads
Number of threads used for the transcoding.
--sout-transcode-high-priority, --no-sout-transcode-high-priority
High priority (default disabled)
Runs the optional encoder thread at the
OUTPUT priority instead of VIDEO. (default
disabled)

Text subtitles decoder
--subsdec-align={0 (Center), 1 (Left), 2 (Right)}
Subtitles justification
Set the justification of subtitles
--subsdec-encoding={Default,ASCII,UTF-8,,ISO-8859-1,CP1252,MacRoman,MacIceland,ISO-8859-15,,ISO-8859-2,CP1250,MacCentralEurope,MacCroatian,MacRomania,,ISO-8859-5,CP1251,MacCyrillic,MacUkraine,KOI8-R,KOI8-U,KOI8-RU,,ISO-8859-6,CP1256,MacArabic,,ISO-8859-7,CP1253,MacGreek,,ISO-8859-8,CP1255,MacHebrew,,ISO-8859-9,CP1254,MacTurkish,,ISO-8859-13,CP1257,,ISO-2022-JP,ISO-2022-JP-1,ISO-2022-JP-2,EUC-JP,SHIFT_JIS,,ISO-2022-CN,ISO-2022-CN-EXT,EUC-CN,EUC-TW,BIG5,BIG5-HKSCS,,ISO-2022-KR,EUC-KR,,MacThai,KOI8-T,,ISO-8859-3,ISO-8859-4,ISO-8859-10,ISO-8859-14,ISO-8859-16,,CP850,CP862,CP866,CP874,CP932,CP949,CP950,CP1133,CP1258,,Macintosh,,UTF-7,UTF-16,UTF-16BE,UTF-16LE,UTF-32,UTF-32BE,UTF-32LE,C99,JAVA,UCS-2,UCS-2BE,UCS-2LE,UCS-4,UCS-4BE,UCS-4LE,,HZ,GBK,GB18030,JOHAB,ARMSCII-8,Georgian-Academy,Georgian-PS,TIS-620,MuleLao-1,VISCII,TCVN,HPROMAN8,NEXTSTEP}
Subtitles text encoding
Set the encoding used in text subtitles
--subsdec-autodetect-utf8, --no-subsdec-autodetect-utf8
UTF-8 subtitles autodetection (default
enabled)
This enables automatic detection of UTF-8
encoding within subtitles files. (default
enabled)
--subsdec-formatted, --no-subsdec-formatted
Formatted Subtitles (default enabled)
Some subtitle formats allow for text
formatting. VLC partly implements this, but
you can choose to disable all formatting.
(default enabled)

Text subtitles parser
--sub-fps=<float> Frames per second
Override the normal frames per second
settings. This will only work with MicroDVD
and SubRIP (SRT) subtitles.
--sub-delay=<integer> Subtitles delay
Apply a delay to all subtitles (in 1/10s, eg
100 means 10s).
--sub-type={auto,microdvd,subrip,subviewer,ssa1,ssa2-4,ass,vplayer,sami,dvdsubtitle}
Subtitles format
Force the subtiles format. Valid values are :
"microdvd", "subrip", "ssa1", "ssa2-4",
"ass", "vplayer" "sami", "dvdsubtitle" and
"auto" (meaning autodetection, this should
always work).

Philips OGT (SVCD subtitle) decoder
--svcdsub-debug=<integer> Enable debug
This integer when viewed in binary is a
debugging mask
calls 1
packet
assembly info 2

VLM remote control interface
--telnet-host=<string> Host
This is the host on which the interface will
listen. It defaults to all network interfaces
(0.0.0.0). If you want this interface to be
available only on the local machine, enter
"127.0.0.1".
--telnet-port=<integer> Port
This is the TCP port on which this interface
will listen. It defaults to 4212.
--telnet-password=<string> Password
A single administration password is used to
protect this interface. The default value is
"admin".

Theora video decoder
--sout-theora-quality=<integer>
Encoding quality
Enforce a quality between 1 (low) and 10
(high), instead of specifying a particular
bitrate. This will produce a VBR stream.

Video transformation filter
--transform-type={90,180,270,hflip,vflip}
Transform type
One of '90', '180', '270', 'hflip' and 'vflip'

MPEG Transport Stream demuxer
--ts-extra-pmt=<string> Extra PMT
Allows a user to specify an extra pmt
(pmt_pid=pid:stream_type[,...]).
--ts-es-id-pid, --no-ts-es-id-pid
Set id of ES to PID (default enabled)
Set the internal ID of each elementary stream
handled by VLC to the same value as the PID
in the TS stream, instead of 1, 2, 3, etc.
Useful to do '#duplicate{..., select="es=<pid>
"}'. (default enabled)
--ts-out=<string> Fast udp streaming
Sends TS to specific ip:port by udp (you must
know what you are doing).
--ts-out-mtu=<integer> MTU for out mode
MTU for out mode.
--ts-csa-ck=<string> CSA ck
Control word for the CSA encryption algorithm
--ts-csa-pkt=<integer> Packet size in bytes to decrypt
Specify the size of the TS packet to decrypt.
The decryption routines subtract the
TS-header from the value before decrypting.
--ts-silent, --no-ts-silent
Silent mode (default disabled)
Do not complain on encrypted PES. (default
disabled)
--ts-dump-file=<string> Filename of dump
Specify a filename where to dump the TS in.
--ts-dump-append, --no-ts-dump-append
Append (default disabled)
If the file exists and this option is
selected, the existing file will not be
overwritten. (default disabled)
--ts-dump-size=<integer> Dump buffer size
Tweak the buffer size for reading and writing
an integer number of packets.Specify the size
of the buffer here and not the number of
packets.

Libtwolame audio encoder
--sout-twolame-quality=<float>
Encoding quality
Force a specific encoding quality between 0.0
(high) and 50.0 (low), instead of specifying
a particular bitrate. This will produce a VBR
stream.
--sout-twolame-mode={0 (Stereo), 1 (Dual mono), 2 (Joint stereo)}
Stereo mode
Handling mode for stereo streams
--sout-twolame-vbr, --no-sout-twolame-vbr
VBR mode (default disabled)
Use Variable BitRate. Default is to use
Constant BitRate (CBR). (default disabled)
--sout-twolame-psy=<integer>
Psycho-acoustic model
Integer from -1 (no model) to 4.

VCD input
--vcd-caching=<integer> Caching value in ms
Caching value for VCDs. This value should be
set in milliseconds.

Visualizer filter
--effect-list=<string> Effects list
A list of visual effect, separated by
commas.
Current effects include: dummy,
scope, spectrum.
--effect-width=<integer> Video width
The width of the effects video window, in
pixels.
--effect-height=<integer> Video height
The height of the effects video window, in
pixels.
--visual-nbbands=<integer> Number of bands
Number of bands used by spectrum analyzer,
should be 20 or 80.
--visual-separ=<integer> Band separator
Number of blank pixels between bands.
--visual-amp=<integer> Amplification
This is a coefficient that modifies the
height of the bands.
--visual-peaks, --no-visual-peaks
Enable peaks (default enabled)
Draw "peaks" in the spectrum analyzer.
(default enabled)
--spect-show-original, --no-spect-show-original
Enable original graphic spectrum (default
disabled)
Enable the "flat" spectrum analyzer in the
spectrometer. (default disabled)
--spect-show-base, --no-spect-show-base
Enable base (default enabled)
Defines whether to draw the base of the
bands. (default enabled)
--spect-radius=<integer> Base pixel radius
Defines radius size in pixels, of base of
bands(beginning).
--spect-sections=<integer> Spectral sections
Determines how many sections of spectrum will
exist.
--spect-color=<integer> V-plane color
YUV-Color cube shifting across the V-plane (
0 - 127 ).
--spect-show-bands, --no-spect-show-bands
Enable bands (default enabled)
Draw bands in the spectrometer. (default
enabled)
--spect-nbbands=<integer> Number of bands
Number of bands used by the spectrometer,
from 20 to 80.
--spect-separ=<integer> Band separator
Number of blank pixels between bands.
--spect-amp=<integer> Amplification
This is a coefficient that modifies the
height of the bands.
--spect-show-peaks, --no-spect-show-peaks
Enable peaks (default enabled)
Draw "peaks" in the spectrum analyzer.
(default enabled)
--spect-peak-width=<integer>
Peak extra width
Additions or subtractions of pixels on the
peak width.
--spect-peak-height=<integer>
Peak height
Total pixel height of the peak items.

RTSP VoD server
--rtsp-host=<string> RTSP host address
This defines the address, port and path the
RTSP VOD server will listen on.
Syntax is
address:port/path. The default is to listen
on all interfaces (address 0.0.0.0), on port
554, with no path.
To listen only on the
local interface, use "localhost" as address.
--rtsp-raw-mux=<string> MUX for RAW RTSP transport
MUX for RAW RTSP transport
--rtsp-throttle-users=<integer>
Maximum number of connections
This limits the maximum number of clients
that can connect to the RTSP VOD. 0 means no
limit.

Vorbis audio decoder
--sout-vorbis-quality=<integer>
Encoding quality
Enforce a quality between 1 (low) and 10
(high), instead of specifying a particular
bitrate. This will produce a VBR stream.
--sout-vorbis-max-bitrate=<integer>
Maximum encoding bitrate
Maximum bitrate in kbps. This is useful for
streaming applications.
--sout-vorbis-min-bitrate=<integer>
Minimum encoding bitrate
Minimum bitrate in kbps. This is useful for
encoding for a fixed-size channel.
--sout-vorbis-cbr, --no-sout-vorbis-cbr
CBR encoding (default disabled)
Force a constant bitrate encoding (CBR).
(default disabled)

Wall video filter
--wall-cols=<integer> Number of columns
Number of horizontal windows in which to
split the video.
--wall-rows=<integer> Number of rows
Number of vertical windows in which to split
the video.
--wall-active=<string> Active windows
Comma-separated list of active windows,
defaults to all
--wall-element-aspect=<string>
Element aspect ratio
Aspect ratio of the individual displays
building the wall.

Win32 waveOut extension output
--waveout-float32, --no-waveout-float32
Use float32 output (default enabled)
The option allows you to enable or disable
the high-quality float32 audio output mode
(which is not well supported by some
soundcards). (default enabled)

wxWidgets interface module
--wx-embed, --no-wx-embed Embed video in interface (default enabled)
Embed the video inside the interface instead
of having it in a separate window. (default
enabled)
--wx-bookmarks, --no-wx-bookmarks
Bookmarks dialog (default disabled)
Show bookmarks dialog at startup (default
disabled)
--wx-taskbar, --no-wx-taskbar
Taskbar (default enabled)
Show VLC on the taskbar (default enabled)
--wx-extended, --no-wx-extended
Extended GUI (default disabled)
Show extended GUI (equalizer, image adjust,
video filters...) at startup (default
disabled)
--wx-minimal, --no-wx-minimal
Minimal interface (default disabled)
Use minimal interface, with no toolbar and
fewer menus. (default disabled)
--wx-autosize, --no-wx-autosize
Size to video (default enabled)
Resize VLC to match the video resolution.
(default enabled)
--wx-playlist-view={0 (Normal), 1 (Embedded), 2 (Both)}
Playlist view
There are two possible playlist views in the
interface : the normal playlist (separate
window), or an embedded playlist (within the
main interface, but with less features). You
can select which one will be available on the
toolbar (or both).
--wx-systray, --no-wx-systray
Systray icon (default disabled)
Show a systray icon for VLC (default disabled)
--wx-labels, --no-wx-labels
Show labels in toolbar (default disabled)
Show labels below the icons in the toolbar.
(default disabled)
--wx-config-last=<string> last config
last config

H.264/MPEG4 AVC encoder (using x264 library)
--sout-x264-keyint=<integer>
Maximum GOP size
Sets maximum interval between
IDR-frames.Larger values save bits, thus
improving quality for a given bitrate at the
cost of seeking precision.
--sout-x264-min-keyint=<integer>
Minimum GOP size
Sets minimum interval between IDR-frames. In
H.264, I-frames do not necessarily bound a
closed GOP because it is allowable for a
P-frame to be predicted from more frames than
just the one frame before it (also see
reference frame option). Therefore, I-frames
are not necessarily seekable. IDR-frames
restrict subsequent P-frames from referring
to any frame prior to the IDR-frame.
If
scenecuts appear within this interval, they
are still encoded as I-frames, but do not
start a new GOP.
--sout-x264-scenecut=<integer>
Extra I-frames aggressivity
Scene-cut detection. Controls how
aggressively to insert extra I-frames. With
small values of scenecut, the codec often has
to force an I-frame when it would exceed
keyint. Good values of scenecut may find a
better location for the I-frame. Large values
use more I-frames than necessary, thus
wasting bits. -1 disables scene-cut
detection, so I-frames are inserted only
every other keyint frames, which probably
leads to ugly encoding artifacts. Range 1 to
100.
--sout-x264-bframes=<integer>
B-frames between I and P
Number of consecutive B-frames between I and
P-frames. Range 1 to 16.
--sout-x264-b-adapt, --no-sout-x264-b-adapt
Adaptive B-frame decision (default enabled)
Force the specified number of consecutive
B-frames to be used, except possibly before
an I-frame. (default enabled)
--sout-x264-b-bias=<integer>
Influence (bias) B-frames usage
Bias the choice to use B-frames. Positive
values cause more B-frames, negative values
cause less B-frames.
--sout-x264-bpyramid, --no-sout-x264-bpyramid
Keep some B-frames as references (default
disabled)
Allows B-frames to be used as references for
predicting other frames. Keeps the middle of
2+ consecutive B-frames as a reference, and
reorders frame appropriately. (default
disabled)
--sout-x264-cabac, --no-sout-x264-cabac
CABAC (default enabled)
CABAC (Context-Adaptive Binary Arithmetic
Coding). Slightly slows down encoding and
decoding, but should save 10 to 15% bitrate.
(default enabled)
--sout-x264-ref=<integer> Number of reference frames
Number of previous frames used as predictors.
This is effective in Anime, but seems to make
little difference in live-action source
material. Some decoders are unable to deal
with large frameref values. Range 1 to 16.
--sout-x264-nf, --no-sout-x264-nf
Skip loop filter (default disabled)
Deactivate the deblocking loop filter
(decreases quality). (default disabled)
--sout-x264-deblock=<string>
Loop filter AlphaC0 and Beta parameters
alpha:beta
Loop filter AlphaC0 and Beta parameters.
Range -6 to 6 for both alpha and beta
parameters. -6 means light filter, 6 means
strong.
--sout-x264-level=<string> H.264 level
Specify H.264 level (as defined by Annex A of
the standard). Levels are not enforced; it's
up to the user to select a level compatible
with the rest of the encoding options. Range
1 to 5.1 (10 to 51 is also allowed).
--sout-x264-interlaced, --no-sout-x264-interlaced
Interlaced mode (default disabled)
Pure-interlaced mode. (default disabled)
--sout-x264-qp=<integer> Set QP
This selects the quantizer to use. Lower
values result in better fidelity, but higher
bitrates. 26 is a good default value. Range 0
(lossless) to 51.
--sout-x264-crf=<integer> Quality-based VBR
1-pass Quality-based VBR. Range 0 to 51.
--sout-x264-qpmin=<integer>
Min QP
Minimum quantizer parameter. 15 to 35 seems
to be a useful range.
--sout-x264-qpmax=<integer>
Max QP
Maximum quantizer parameter.
--sout-x264-qpstep=<integer>
Max QP step
Max QP step between frames.
--sout-x264-ratetol=<float>
Average bitrate tolerance
Allowed variance in average bitrate (in
kbits/s).
--sout-x264-vbv-maxrate=<integer>
Max local bitrate
Sets a maximum local bitrate (in kbits/s).
--sout-x264-vbv-bufsize=<integer>
VBV buffer
Averaging period for the maximum local
bitrate (in kbits).
--sout-x264-vbv-init=<float>
Initial VBV buffer occupancy
Sets the initial buffer occupancy as a
fraction of the buffer size. Range 0.0 to 1.0.
--sout-x264-ipratio=<float>
QP factor between I and P
QP factor between I and P. Range 1.0 to 2.0.
--sout-x264-pbratio=<float>
QP factor between P and B
QP factor between P and B. Range 1.0 to 2.0.
--sout-x264-chroma-qp-offset=<integer>
QP difference between chroma and luma
QP difference between chroma and luma.
--sout-x264-qcomp=<float> QP curve compression
QP curve compression. Range 0.0 (CBR) to 1.0
(QCP).
--sout-x264-cplxblur=<float>
Reduce fluctuations in QP
This reduces the fluctuations in QP before
curve compression. Temporally blurs
complexity.
--sout-x264-qblur=<float> Reduce fluctuations in QP
This reduces the fluctations in QP after
curve compression. Temporally blurs quants.
--sout-x264-partitions={none,fast,normal,slow,all}
Partitions to consider
Partitions to consider in analyse mode:
-
none :
- fast : i4x4
- normal:
i4x4,p8x8,(i8x8)
- slow : i4x4,p8x8,(i8x8),b
8x8
- all : i4x4,p8x8,(i8x8),b8x8,p4x4
(p4x
4 requires p8x8. i8x8 requires 8x8dct).
--sout-x264-direct={none,spatial,temporal,auto}
Direct MV prediction mode
Direct MV prediction mode.
--sout-x264-direct-8x8=<integer>
Direct prediction size
Direct prediction size: - 0: 4x4
- 1:
8x8
- -1: smallest possible according to
level

--sout-x264-weightb, --no-sout-x264-weightb
Weighted prediction for B-frames (default
disabled)
Weighted prediction for B-frames. (default
disabled)
--sout-x264-me={dia,hex,umh,esa}
Integer pixel motion estimation method
Selects the motion estimation algorithm: -
dia: diamond search, radius 1 (fast)
- hex:
hexagonal search, radius 2
- umh: uneven
multi-hexagon search (better but slower)
-
esa: exhaustive search (extremely slow,
primarily for testing)

--sout-x264-merange=<integer>
Maximum motion vector search range
Maximum distance to search for motion
estimation, measured from predicted
position(s). Default of 16 is good for most
footage, high motion sequences may benefit
from settings between 24 and 32. Range 0 to
64.
--sout-x264-subme=<integer>
Subpixel motion estimation and partition
decision quality
This parameter controls quality versus speed
tradeoffs involved in the motion estimation
decision process (lower = quicker and higher
= better quality). Range 1 to 7.
--sout-x264-b-rdo, --no-sout-x264-b-rdo
RD based mode decision for B-frames (default
disabled)
RD based mode decision for B-frames. This
requires subme 6 (or higher). (default
disabled)
--sout-x264-mixed-refs, --no-sout-x264-mixed-refs
Decide references on a per partition basis
(default disabled)
Allows each 8x8 or 16x8 partition to
independently select a reference frame, as
opposed to only one ref per macroblock.
(default disabled)
--sout-x264-chroma-me, --no-sout-x264-chroma-me
Chroma in motion estimation (default enabled)
Chroma ME for subpel and mode decision in
P-frames. (default enabled)
--sout-x264-bime, --no-sout-x264-bime
Jointly optimize both MVs in B-frames
(default disabled)
Joint bidirectional motion refinement.
(default disabled)
--sout-x264-8x8dct, --no-sout-x264-8x8dct
Adaptive spatial transform size (default
disabled)
SATD-based decision for 8x8 transform in
inter-MBs. (default disabled)
--sout-x264-trellis=<integer>
Trellis RD quantization
Trellis RD quantization:
- 0: disabled
-
1: enabled only on the final encode of a MB

- 2: enabled on all mode decisions
This
requires CABAC.
--sout-x264-fast-pskip, --no-sout-x264-fast-pskip
Early SKIP detection on P-frames (default
enabled)
Early SKIP detection on P-frames. (default
enabled)
--sout-x264-dct-decimate, --no-sout-x264-dct-decimate
Coefficient thresholding on P-frames (default
enabled)
Coefficient thresholding on P-frames.Eliminate
dct blocks containing only a small single
coefficient. (default enabled)
--sout-x264-nr=<integer> Noise reduction
Dct-domain noise reduction. Adaptive
pseudo-deadzone. 10 to 1000 seems to be a
useful range.
--sout-x264-deadzone-inter=<integer>
Inter luma quantization deadzone
Set the size of the intra luma quantization
deadzone. Range 0 to 32.
--sout-x264-deadzone-intra=<integer>
Intra luma quantization deadzone
Set the size of the intra luma quantization
deadzone. Range 0 to 32.
--sout-x264-asm, --no-sout-x264-asm
CPU optimizations (default enabled)
Use assembler CPU optimizations. (default
enabled)
--sout-x264-psnr, --no-sout-x264-psnr
PSNR computation (default disabled)
Compute and print PSNR stats. This has no
effect on the actual encoding quality.
(default disabled)
--sout-x264-ssim, --no-sout-x264-ssim
SSIM computation (default disabled)
Compute and print SSIM stats. This has no
effect on the actual encoding quality.
(default disabled)
--sout-x264-quiet, --no-sout-x264-quiet
Quiet mode (default disabled)
Quiet mode. (default disabled)
--sout-x264-sps-id=<integer>
SPS and PPS id numbers
Set SPS and PPS id numbers to allow
concatenating streams with different settings.
--sout-x264-aud, --no-sout-x264-aud
Access unit delimiters (default disabled)
Generate access unit delimiter NAL units.
(default disabled)
--sout-x264-verbose, --no-sout-x264-verbose
Statistics (default disabled)
Print stats for each frame. (default disabled)

DirectShow input
--dshow-caching=<integer> Caching value in ms
Caching value for DirectShow streams. This
value should be set in millisecondss.
--dshow-vdev={,none} Video device name
Name of the video device that will be used by
the DirectShow plugin. If you don't specify
anything, the default device will be used.
--dshow-adev={,none} Audio device name
Name of the audio device that will be used by
the DirectShow plugin. If you don't specify
anything, the default device will be used.
You can specify a standard size (cif, d1,
...) or <width>x<height>
--dshow-size=<string> Video size
Size of the video that will be displayed by
the DirectShow plugin. If you don't specify
anything the default size for your device
will be used.
--dshow-chroma=<string> Video input chroma format
Force the DirectShow video input to use a
specific chroma format (eg. I420 (default),
RV24, etc.)
--dshow-fps=<float> Video input frame rate
Force the DirectShow video input to use a
specific frame rate(eg. 0 means default, 25,
29.97, 50, 59.94, etc.)
--dshow-config, --no-dshow-config
Device properties (default disabled)
Show the properties dialog of the selected
device before starting the stream. (default
disabled)
--dshow-tuner, --no-dshow-tuner
Tuner properties (default disabled)
Show the tuner properties [channel selection]
page. (default disabled)
--dshow-tuner-channel=<integer>
Tuner TV Channel
Set the TV channel the tuner will set to (0
means default).
--dshow-tuner-country=<integer>
Tuner country code
Set the tuner country code that establishes
the current channel-to-frequency mapping (0
means default).
--dshow-tuner-input={0 (Default), 1 (Cable), 2 (Antenna)}
Tuner input type
Select the tuner input type (Cable/Antenna).
--dshow-video-input=<integer>
Video input pin
Select the video input source, such as
composite, s-video, or tuner. Since these
settings are hardware-specific, you should
find good settings in the "Device config"
area, and use those numbers here. -1 means
that settings will not be changed.
--dshow-audio-input=<integer>
Audio input pin
Select the audio input source. See the "video
input" option.
--dshow-video-output=<integer>
Video output pin
Select the video output type. See the "video
input" option.
--dshow-audio-output=<integer>
Audio output pin
Select the audio output type. See the "video
input" option.
--dshow-amtuner-mode={0 (Default), 1 (TV), 2 (FM radio), 4 (AM radio), 8 (DSS)}
AM Tuner mode
AM Tuner mode. Can be one of DEFAULT, TV,
AM_RADIO, FM_RADIO or DSS.

Skinnable Interface
--skins2-last=<string> Skin to use
Path to the skin to use.
--skins2-config=<string> Config of last used skin
Windows configuration of the last skin used.
This option is updated automatically, do not
touch it.
--skins2-systray, --no-skins2-systray
Systray icon (default disabled)
Show a systray icon for VLC (default disabled)
--skins2-taskbar, --no-skins2-taskbar
Show VLC on the taskbar (default enabled)
Show VLC on the taskbar (default enabled)
--skins2-transparency, --no-skins2-transparency
Enable transparency effects (default disabled)
You can disable all transparency effects if
you want. This is mainly useful when moving
windows does not behave correctly. (default
disabled)
--skinned-playlist, --no-skinned-playlist
Use a skinned playlist (default enabled)
Use a skinned playlist (default enabled)

DirectX video output
--directx-hw-yuv, --no-directx-hw-yuv
Use hardware YUV->RGB conversions (default
enabled)
Try to use hardware acceleration for YUV->RGB
conversions. This option doesn't have any
effect when using overlays. (default enabled)
--directx-use-sysmem, --no-directx-use-sysmem
Use video buffers in system memory (default
disabled)
Create video buffers in system memory instead
of video memory. This isn't recommended as
usually using video memory allows to benefit
from more hardware acceleration (like
rescaling or YUV->RGB conversions). This
option doesn't have any effect when using
overlays. (default disabled)
--directx-3buffering, --no-directx-3buffering
Use triple buffering for overlays (default
enabled)
Try to use triple buffering when using YUV
overlays. That results in much better video
quality (no flickering). (default enabled)
--directx-device={} Name of desired display device
In a multiple monitor configuration, you can
specify the Windows device name of the
display that you want the video window to
open on. For example, "\\.\DISPLAY1" or
"\\.\DISPLAY2".
--directx-wallpaper, --no-directx-wallpaper
Enable wallpaper mode (default disabled)
The wallpaper mode allows you to display the
video as the desktop background. Note that
this feature only works in overlay mode and
the desktop must not already have a
wallpaper. (default disabled)
</nowiki>

==See also==
*[[Mac OS X]] for special notes on using the command line on Mac OS X

[[Category:Documentation]]

VLC command-line help

2008-02-14T12:06:26Z

Tayssir: Undocumented -vvv (verbose) option

VLC HowTo/Add a logo

2008-01-03T15:03:54Z

Tayssir: Link to video codec list, for convenience

VLC HowTo/Add a logo

2008-01-03T14:43:58Z

Tayssir: Dynamic logos using RC