VideoLAN Wiki - User contributions [en]

Documentation:Advanced Use of VLC

2012-02-02T16:47:13Z

Dasvlc: /* Filters */

{{RightMenu|documentation play howto toc}}

== Use the command line ==

'''TODO: completely outdated'''

All standard operations of VLC should be available from the GUI. However, some complex operations can only be done from the command line and there are situations in which you don't need or want a GUI. Here is the complete description of VLC's command line and how to use it.

You need to be quite comfortable with command line usage to use this.

Note: Windows users have to use the ''--option-name="value"'' syntax instead of the ''--option-name value'' syntax.

=== Getting help ===

VLC uses a modular structure. The core mainly manages communication between modules. All the multimedia processing is done by modules. There are input modules, demultiplexers, decoders, video output modules, ...

This chapter will only describe the "general" options, i.e. the core options. Each module adds new options. For example, the HTTP input module will add options for caching, proxy, authentication, ...

By using '''vlc --help''', you will get the basic core options. '''vlc --longhelp''' will give all the basic options (core + modules). Adding '''--advanced''' will give the "advanced options" (for advanced users). So '''vlc --longhelp --advanced''' will give you all options. You can also append '''--help-verbose''' if you want more detailed help.

Also, you might want to get debug informations. To do this, use '''-v''' or '''-vv''' (this will show lower severity messages). If your console supports it, you can add '''--color to get messages in color.'''

=== Opening streams ===

The following commands start VLC and start reading the given element(s):

==== Opening a file ====

Start VLC with:

% '''vlc my_file'''

VLC should be able to recognize the file type. If it does not, you can force demultiplexer and decoder (see below).

A list of all video and audio codecs supported by VLC is available on the [http://www.videolan.org/vlc/features.html VLC features list].

==== Opening a DVD or VCD, or an audio CD ====

Start VLC with:

For a DVD with menus:

% '''vlc dvd://[device][@raw_device][@[title][:[chapter][:angle]]]'''

In most cases, '''vlc dvd://''' or '''vlc dvd://[device]''' will do. [device] is for example '''/dev/dvd''' on GNU/Linux or '''D:''' on Windows (complete path to your DVD drive).

or

(DVD without menus):

% '''vlc dvdsimple://[device][@raw_device][@[title][:[chapter][:angle]]]'''

or

(VCD):

% '''vlc vcd://[device][@{E|P|E|T|S}[number]]'''

or

(Audio CD):

% '''vlc cdda://[device][@[track]]'''

==== Receiving a network stream ====

To receive an unicast RTP/UDP stream (sent by VLC's stream output), start VLC with:

% '''vlc rtp://@:5004'''

If 5004 is the port to which packets are sent. 1234 is another commonly used port number. you use the default port (1234), '''vlc rtp://''' will do. For more information, look at the Streaming Howto.

To receive an multicast UDP/RTP stream (sent by VLC's stream output), start VLC with:

% '''vlc rtp://@multicast_address:port'''

To receive a SSM (source specific multicast) stream, you can use:

% '''vlc rtp://server_address@multicast_address:port'''

This only works on OSs that support SSM (Windows XP and Linux).

To receive a HTTP stream, start VLC with:

% '''vlc http://www.example.org/your_file.mpg'''

To receive a RTSP stream, start VLC with:</para>

% '''vlc rtsp://www.example.org/your_stream'''

=== Modules selection ===

VLC always tries to select the most appropriate interface, input and output modules, among the ones available on the system, according to the stream it is given to read. However, you may wish to force the use of a specific module with the following options.

*'''--intf <module>''' allows you to select the interface module.
*'''--extraintf <module>''' allows you to select extra interface modules that will be launched in addition to the main one. This is mainly useful for special ''control'' interfaces, like HTTP, RC (Remote Control), ... (see below)
*'''--aout <module>''' allows you to select the audio output module.
*'''--vout <module>''' allows you to select the video output module.
*'''--memcpy <module>''' allows you to choose a memory copy module. You should probably never touch that.

You can get a listing of the available modules by using '''vlc -l'''

=== Stream Output ===

The Stream output system allows vlc to become a streaming server.

For more details on the stream output system, please have a look at the [[Documentation:Streaming HowTo|Streaming HowTo]].

 

=== Other Options ===

==== Audio options ====

*'''--noaudio''' disables audio output. Note that if you are streaming (ex: to a file) this has no effect (streaming copies the audio verbatim). Use --sout-xxx instead (ex: --no-sout-audio)
*'''--mono''' forces VLC to treat the stream in mono audio.
*'''--volume <integer>''' sets the level of audio output (between 0 and 1024). Also only applies to local playback (like --noaudio).
*'''--aout-rate <integer>''' sets the audio output frequency (Hz). By default, VLC will try to autodetect this.
*'''--desync <integer>''' compensates desynchronization of audio (ms). (If audio and video streams are not synchronized, use this setting to delay the audio stream)
*'''--audio-filter <string>''' adds audio filters to the processing chain. Available filters are visual (visualizer with spectrum analyzer and oscilloscope), headphone (virtual headphone patialization) and normalizer (volume normalizer)

==== Video options ====

*'''--no-video''' disables video output.
*'''--grayscale''' turns video output into grayscale mode.
*'''--fullscreen''' ( or '''-f''') sets fullscreen video.
*'''--nooverlay''' disables hardware acceleration for the video output.
*'''--width, --height <integer>''' sets the video window dimensions. By default, the video window size will be adjusted to match the video dimensions.
*'''--start-time <integer>''' starts the video here; the integer is the number of seconds from the beginning (e.g. 1:30 is written as 90)
*'''--stop-time <integer>''' stops the video here; the integer is the number of seconds from the beginning (e.g. 1:30 is written as 90)
*'''--zoom <float>''' adds a zoom factor.
*'''--aspect-ratio <mode>''' forces source aspect ratio. Modes are 4x3, 16x9, ...
*'''--spumargin <integer>''' forces SPU subtitles postion.
*'''--video-filter <string>''' adds video filters to the processing chain. You can add several filters, separated by commas
*'''--sub-filter <string>''' adds video subpictures filter to the processing chain.

==== Desktop/Screen grab options ====

You can see the various options for "grabbing the desktop" (VLC's built-in screen grabber capture device) by using the GUI. See http://forum.videolan.org/viewtopic.php?f=4&t=46971

==== Playlist options ====

*'''--random''' plays files randomly forever.
*'''--loop''' loops playlist on end.
*'''--repeat''' repeats current item until another item is forced
*'''--play-and-stop''' stops the playlist after each played item.

==== Network options ====

*'''--server-port <integer>''' sets server port.
*'''--iface <string>''' specifies the network interface to use.
*'''--iface-addr <string>''' specifies your network interface IP address.
*'''--mtu <integer>''' specifies the MTU of the network interface.
*'''--ipv6''' forces IPv6.
*'''--ipv4''' forces IPv4.

==== CPU options ====

You should probably not touch these options unless you know what you are doing.

*'''--nommx''' disables the use of MMX CPU extensions.
*'''--no3dn''' disables the use of 3D Now! CPU extensions.
*'''--nommxext''' disables the use of MMX Ext CPU extensions.
*'''--nosse''' disables the use of SSE CPU extensions.
*'''--noaltivec''' disables the use of Altivec CPU extensions.

==== Miscellaneous options ====

*'''--quiet''' deactivates all console messages.
*'''--color''' displays color messages.
*'''--search-path <string>''' specifies interface default search path.
*'''--plugin-path <string>''' specifies plugin search path.
*'''--no-plugins-cache''' disables the plugin cache (plugins cache speeds up startup)
*'''--dvd <string>''' specifies the default DVD device.
*'''--vcd <string>''' specifies the default VCD device.
*'''--program <integer>''' specifies program (SID) (for streams with several programs, like satellite ones).
*'''--audio-type <integer>''' specifies the default audio type to use with dvds.
*'''--audio-channel <integer>''' specifies the default audio channel to use with dvds.
*'''--spu-channel <integer>''' specifies the default subtitle channel to use with dvds.
*'''--version''' gives you information about the current VLC version.
*'''--module <module> ''' displays help about specified module. (Shortcut: '''-p''')

=== Item-specific options ===

There are many options that are related to items (like '''--novideo''', '''--codec''', '''--fullscreen''').

For all of these, you have the possibility to make them item-specific, using ":" instead of "--" and putting the option just after the concerned item.

Examples:

% '''vlc file1.mpg :fullscreen file2.mpg'''

will play file1.mpg in fullscreen mode and file2.mpg in the default mode (which is generally no fullscreen), whereas

% '''vlc --fullscreen file1.mpg file2.mpg'''

will play both files in fullscreen mode

% '''vlc --fullscreen file1.mpg :sub-file=file1.srt :no-fullscreen file2.mpg :filter=distort'''

will play file1.mpg in windowed (no-fullscreen) mode with the subtitles file file1.srt and will play file2.mpg with video filter distort enabled in fullscreen mode (item-specific options override global options).

== Advanced use of filters ==

=== Filters ===

These are the old style VLC filters. They only apply to on screen display and thus cannot be streamed. However, on version 1.1.11 you are still able to apply these filters in ''transcode'' module using parameter ''vfilter''. More information can be found on [http://wiki.videolan.org/Documentation:Streaming_HowTo/Advanced_Streaming_Using_the_Command_Line#vfilter Advanced Streaming Using the Command Line].

==== Deinterlacing video filter ====

Module name: '''deinterlace'''

*'''--deinterlace-mode {discard,blend,mean,bob,linear,x,yadif,yadif (2x),phosophor,ivtc}''' choose a deinterlacing mode.

==== Invert video filter ====

Module name: '''invert'''

==== Image properties filter ====

Module name: '''adjust'''

*'''--contrast <float>''' Image contrast in the 0-2 range.
*'''--brightness <float>''' Image brightness in the 0-2 range.
*'''--hue <integer>''' Image hue in the 0-360 range.
*'''--saturation <float>''' Image saturation in the 0-3 range.
*'''-gamma <float>''' Image gamma in the 0-10 range.

==== Wall video filter ====

Module name: '''wall'''

This filter splits the output in several windows.

*'''--wall-cols <integer>''' Number of columns.
*'''--wall-rows <integer>''' Number of rows.
*'''--wall-active <string>''' Select the windows you want to display. To select windows 2 and 4 you would write '''--wall-active 2,4'''. When this option isn't specified, all windows are displayed.

==== Video transformation filter ====

Module name: '''transform'''

*'''--transform-type {90,180,270,hflip,vflip}''' Select rotation angle or symmetry.

==== Distort video filter ====

Module name: '''distort'''

==== Clone video filter ====

This filter clones the output window.

Module name: '''clone'''

*'''--clone-count <integer>''' Number of clones.
*'''--clone-vout-list <string>''' Comma separated string of video output modules.

==== Crop video filter ====

Module name: '''crop'''

*'''--crop-geometry <string>''' Set the geometry of the zone to crop. This is set as <width> x <height> + <left offset> + <top offset>.
*'''--autocrop''' Enable automatic black border cropping.

==== Motion blur filter ====

Module name: '''motionblur'''

*'''blur-factor <integer>''' Blur factor in the 1-127 range.

==== Video pictures blending ====

Module name: '''blend'''

==== Video scaling filter ====

Module name: '''scale'''

 

=== Subpictures Filters ===

These are the new VLC filters. They can be streamed.

==== Time display sub filter ====

Module name: '''time'''

*'''--time-format <string>''' Time format string. You can use the following special characters %Y = year, %m = month, %d = day, %H = hour, %M = minute, %S = second.
*'''--time-x <integer>''' X offset from the left in pixels.
*'''--time-y <integer>''' Y offset from the top in pixels.

==== Marquee display sub filter ====

Module name: '''marq'''

*'''--marq-marquee <string>''' Marquee text to display.
*'''--marq-x <integer>''' X offset from the left in pixels.
*'''--marq-y <integer>''' Y offset from the top in pixels.
*'''--marq-timeout <timeout>''' Defines the time the marquee must remain displayed in milliseconds. Default value is 0 (remain forever).

==== Logo video filter ====

Module name: '''logo'''

This filter can be used both as an old style filter or a subpictures filter.

*'''--logo-file <string>''' Full path of the PNG file to use.
*'''--logo-x <integer>''' X offset from the left in pixels.
*'''--logo-y <integer>''' Y offset from the top in pixels.
*'''--logo-transparency <integer>''' You can set the logo transparency value here (from 0 for full transparency to 255 for full opacity).

Note: You can move the logo by left-clicking on it.

 

== The HTTP interface ==

VLC ships with a little HTTP server integrated. It is used both to stream using HTTP, and for the HTTP remote control interface.

To start VLC with the HTTP interface, use:

% '''vlc -I http [--http-src /directory/] [--http-host host:port]'''

If you want to have both the "normal" interface and the HTTP interface, use '''vlc --extraintf http'''.

The HTTP interface will start listening at host:port (<all interfaces>:8080 if omitted), and will reproduce the structure of /directory at http://host:port/ ( vlc_source_path/share/http if omitted ).

Use a browser to go to http://your_host_machine:port. You should be taken to the main page.

VLC is shipped with a set of files that should be enough for generic needs. It is also possible to customize pages. See [[Documentation:Play HowTo/Building Pages for the HTTP Interface]].

Available pages for 1.0.3 :

*http://host:port - Main Interface
*http://host:port/vlm.html - VLM Interface
*http://host:port/mosaic.html - Mosaic Wizard
*http://host:port/flash.html - Flash based remote playback

== Other control interfaces ==

VLC includes a number of so-called interfaces that are not really interfaces, but means of controlling VLC. Nevertheless, they are enabled by setting them as interface or extra interface, either in the Preferences, in General/Interface, or using '''-I''' or '''--extraintf''' on the command line.

=== Hotkeys ===

This module allows you to control VLC and playback via hotkeys. It is always enabled by default. You can use hotkeys in the video output window, you can't in the audio dummy interface.

Hotkeys can be hacked by:

% '''vlc --key-<function> <code>'''

Code is composed by modifiers keys (Alt, Shift, Ctrl, Meta,Command) separated by a dash (-) and terminated by a key (a...z, +, =, -, ',', +, <, >, `, /, ;, ', \, [, ], *, Left, Right, Up, Down, Space, Enter, F1...F12, Home, End, Menu, Esc, Page Up, Page Down, Tab, Backspace, Mouse Wheel Up and Mouse Wheel Down). Main controls are available from hotkeys, such as : fullscreen, play-pause, faster, slower, next, prev, stop, quit, vol-up, etc. (use the '''--longhelp''' option for full list of functions). For example, for binding fullscreen to Ctrl-f, run:

% '''vlc --key-fullscreen 'Ctrl-f' '''

The list of the default hotkeys is available [[HotKeys|here]].

=== RC and RTCI ===

These two interfaces allow you to control VLC from a command shell (possibly using a remote connexion or a Unix socket).

Start VLC with '''-I rc''' or '''--extraintf rc'''. When you get the '''Remote control interface initialized, `h' for help''' message, press h and Enter to get help about available commands.

To be able to remote connect to your VLC using a TCP socket (telnet-like connexion), use '''--rc-host your_host:port'''. Then, by connecting (using telnet or netcat) to the host on the given port, you will get the command shell.

To use a UNIX socket (local socket, this does not work for Windows), use '''--rc-unix /path/to/socket'''. Commands can then be passed using this UNIX socket.

The RTCI interface gives you more advanced options, such as marquee control for the marquee subpicture filter (See filter section).

 

=== Ncurses ===

This is a text interface, using ncurses library.

Start VLC with '''-I ncurses''' or '''--extraintf ncurses'''. You will then get something like that:

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-ncurses-playlist.jpg

The ncurses interface

Press h to get the list of all available commands, with a short description.

There is also a filebrowser available for the ncurses interface in order to add playlist items. Press 'B' to use it.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-ncurses-filebrowser.jpg

The ncurses filebrowser

You can set the filebrowser starting point by launching vlc with the '''--browse-dir''' option:

% '''vlc -I ncurses --browse-dir /filebrowser/starting/point/'''

 

=== Gestures ===

Gestures provide a simple mouse gestures control. TODO

 

== The Mozilla plugin ==

VLC can also be embedded in a web browser! The following browsers are supported [http://www.mozilla.org/ Mozilla], [http://www.mozilla.org/products/firefox/ Firefox] and [http://www.apple.com/macosx/features/safari Safari].

=== Install the plugin ===

==== GNU/Linux Debian, Ubuntu, etc. ====

Install the ''mozilla-plugin-vlc'' package using your preferred package manager. For example, at the command line enter:

# '''apt-get update'''
# '''apt-get install mozilla-plugin-vlc'''

==== Windows ====

Quit Firefox or Mozilla.

Select the Mozilla Plugin option when installing VLC Media Player. The installer will then automatically detect your browser and install the plugin.

Restart Firefox or Mozilla.

==== MacOS X ====

''The Mozilla/Safari plugin for MacOS X is only available from vlc version 0.8.5.1 and onwards.''

Quit Safari browser.

Download the Mozilla/safari plugin package from [http://www.videolan.org/vlc/download-macosx.html MacOS X download page].

Run the installer from the dmg image.

 

==== Compile the sources yourself ====

Please look at the [http://developers.videolan.org developers page] for information on how to do this.

 

=== Use the Mozilla plugin ===

If in the browser you open a link to an audio or video URL handled by the VLC plugin, or if a web page has HTML code that embeds audio or video handled by the VLC plugin, then the plugin should start and play the audio/video.
Note the plugin (as of version 1.1.9) does not present any user interface — it has no default control panel and no keyboard shortcuts.

To get the list of the media types handled by the VLC plugin, browse to '''about:plugins'''.
Conflicts will arise if you have more than one plugin installed that supports the same media type.

See the [[Documentation:WebPlugin|Web plugin documentation]] to create HTML pages that use JavaScript to control the plugin.

{{Documentation}}

= Snapshot Tool =

Did you know you can use special codes to automatically generate filenames in the [[SnapshotTool|Snaphot Tool]]?

= Specifying Streaming Options =

The dialog will show various option to set the output to stream.

First there is an input text called '''Source''', where you'll find your media path and the its type.

[[File:VlcStream.png]]

If you'll click on Destination you'll see the destination of stream that could be: ''File'', ''HTTP'', ''MS-WSMP'', ''RTSP'', ''RTP/MPG'', ''RTP, Audio/Video'', ''UDP'' and ''Icecast''.

[[File:Stream-destination.png]]

You can abilitate '''Transcoding''' to transcode your video to one in the list or in a one you can specify by clicking on the proper icon.

Last you have the option of stream you'll share.

[[File:Stream-option.png]]

By clicking stream it will return to VLC main user interface and the playbar will scroll as the video will play.

= Audio Bar Graph over Video =

This section specifies how to enable the audiobargraph audio filter and video overlay, (mostly) via the GUI. This displays an audio meter overlaid on the video.

There are three parts - an audio filter, which sends it's output via TCP to the Remote Control (RC) Interface. This information is then picked up and displayed by the Audio Bar Graph video subpicture filter (OSD).

To enable this, VLC needs to be started with the '''--rc-host''' command-line switch - e.g.
'''"C:\Program Files\VideoLAN\VLC\vlc.exe" --rc-host localhost:12345'''

In the GUI, set the following (this example from VLC v1.1.9 on Windows 7):
* Preferences:Show settings:All
* Audio/Filters > Enable "Audio part of the BarGraph function"
* Audio/Filters/audiobargraph > use defaults, change "Sends the barGraph information every n audio packets" to 1 to enable see a more accurate display
* Interface/Main interfaces > Enable "Remote control interface"
* Interface/Main interfaces/RC > Enable "Do not open a DOS command box interface"
* Video/Subtitles-OSD > Enable "Audio Bar Graph Video sub filter"
* Video/Subtitles-OSD/Audio Bar Graph > Set the following settings:
** "Value of the audio channels levels" = 0 (setting this to 0:1 crashes VLC v1.1.9)
** "X coordinate" = 0
** "Y coordinate" = 0 (this doesn't seem to affect anything)
** "Transparency of the bargraph" = 128 for 50% transparency which looks ok
** "Bargraph position" = Left (seems to only work Left,Center,Right - can't go top or bottom)
** "Alarm" = 1 (enables the silence alarm - puts a red border around the bargraph if silent for too long)
** "Bar width in pixel" = 10 (20 if you want it to be really visible)

Documentation:Streaming HowTo/Advanced Streaming Using the Command Line

2012-02-02T16:42:59Z

Dasvlc: /* transcode */

{{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. This can only be used to stream MPEG-TS over plain RTP.
Support for this option has been removed in VLC 0.9.0 and latter.
You should use the '''rtp''' stream output module instead.
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''' is possible for RTP streams. By default, each elementary stream is sent as a separate RTP media, i.e. no encapsulation is done.

====rtcp-mux====

This options enables RTP/RTCP multiplexing (see draft-ietf-avt-rtp-and-rtcp-mux), i.e. sends and receives RTCP packets on the same port numbers as RTP packets.

By default, RTCP packets are sent and received on the next port.

====proto=====

This selects the transport protocol to carry RTP packets.

Possible values include:
* '''dccp''', accept incoming DCCP connections at the specified IP address (dst=),
* '''sctp''', accept SCTP connections at the specified IP address (dst=), ''not implemented yet'',
* '''tcp''', accept TCP connections at the specified IP address (dst=) and use RFC4571 RTP framing, ''not implemented yet,''
* '''udp''', send UDP packets to the specified destination (either unicast or multicast); this is the default value,
* '''udplite''', send UDP-Lite packets to the specified destination (either unicast or multicast).

This options uses UDP-Lite instead of UDP as the transport protocol for RTP and RTCP packets.

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

====vfilter====

Uses video filter during transcode process. Parameters of vfilter can be found on the [http://wiki.videolan.org/Documentation:Play_HowTo/Advanced_Use_of_VLC#Filters Advanced Use of VLC Filters].

The example
'''vlc input_file --sout="#transcode{vfilter=adjust{gamma=1.5},vcodec=theo,vb=2000,scale=0.67,acodec=vorb,ab=128,channels=2}:standard{access=file,mux=ogg,dst="output_file.ogg"}" '''

will adjust ''input_file'' gamma to 1.5, resize the video size (resolution) by 0.67 (eg. 1080x720 to 720x480) and convert video using Theora codec with bitrate 2000 kb/s and audio using Vorbis codec with bitrate 128 kb/s, encapsulate the video and audio to Ogg container and saves it to ''output_file.ogg''.

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