VideoLAN Wiki - User contributions [en]

Documentation:Video and Audio Filters

2010-12-23T13:39:40Z

OpenIDUser48: /* Video filters */

{{RightMenu|documentation play howto toc}}
VLC includes a system of ''filters'' that allow you to modify the audio and video.

==Deinterlacement and Post Processing==

VLC is able to deinterlace a video stream using different deinterlacement methods. Deinterlacement can be enabled in the ''Video'' menu, ''Deinterlacement'' menu item. The ''Blend'' methods gives the best results in most cases. The ''discard'' method is a less resource consuming alternative, although its results may be slightly compromised.

On some particular streams (MPEG 4, DIVX, XVID, Sorenson, etc.), some additional image filtering can be applied to the video before display, improving its quality in some cases. This can be enabled by using the ''Post processing'' menu item in ''Video''. Different levels of post processing can be chosen here. A higher level means more filtering.

==Video filters==

VLC features several filters able to change the video (distortion, brightness adjustment, motion blurring, etc.).

In Windows and Linux, the user must go to the ''Effects and Filters'' in the ''Tools'' menu item.

[[Image:Effects and Filters.PNG|center|]]

In Mac OS X you can enable these filters through the ''Extended Controls panel''. Click on the triangle next to ''Video filters'' to select your filters or expand the ''Adjust Image'' section to change the contrast, hue, etc.

[[File:intf-osx-vfilters.jpg|center]]

Example of combined effects on a video:

[[File:VLC-combined-effects.png|center]]

==Audio filters==

===Equalizer===

VLC features a 10-band graphical equalizer. You can display it by activating the advanced GUI on wxWidgets or by clicking the ''Equalizer'' button on the MacOS X interface. The following image is the interface of the
audio equalizer in the Windows and GNU/Linux interface.

[[Image:Audio Filters.PNG|center|]]

The equalizer in the MacOS X interface'''- needs verifying for 0.9'''

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-osx-equalizer.jpg

Presets are available in both of these dialog boxes.

===Other audio filters===

At the moment, VLC features two other audio filters: a volume normalizer and a filter providing sound spatialization with a headphone. They can be enabled in the ''Effects and Filters'' menu item in the ''Tools'' tab of the Windows and GNU/Linux interface and in the Audio section of the Extended Controls panel of the Mac OS X interface.

For better control, you need to go to the preferences. To select the filters to be enabled, go to ''Audio'', then to ''Filters''. In the "audio filters" box, enter the names of the filters to enable, separated by commas. Valid names are "equalizer", "normvol" and "headphone".

If you want to tune the behavior of these filters, go to ''Audio, Filters, [your filter]''. The equalizer and headphone filters can be tuned.

File:Intf-osx-vfilters.jpg

2010-12-23T13:39:26Z

OpenIDUser48:

Documentation:Video and Audio Filters

2010-12-23T13:38:02Z

OpenIDUser48: /* Video filters */

{{RightMenu|documentation play howto toc}}
VLC includes a system of ''filters'' that allow you to modify the audio and video.

==Deinterlacement and Post Processing==

VLC is able to deinterlace a video stream using different deinterlacement methods. Deinterlacement can be enabled in the ''Video'' menu, ''Deinterlacement'' menu item. The ''Blend'' methods gives the best results in most cases. The ''discard'' method is a less resource consuming alternative, although its results may be slightly compromised.

On some particular streams (MPEG 4, DIVX, XVID, Sorenson, etc.), some additional image filtering can be applied to the video before display, improving its quality in some cases. This can be enabled by using the ''Post processing'' menu item in ''Video''. Different levels of post processing can be chosen here. A higher level means more filtering.

==Video filters==

VLC features several filters able to change the video (distortion, brightness adjustment, motion blurring, etc.).

In Windows and Linux, the user must go to the ''Effects and Filters'' in the ''Tools'' menu item.

[[Image:Effects and Filters.PNG|center|]]

In Mac OS X you can enable these filters through the ''Extended Controls panel''. Click on the triangle next to ''Video filters'' to select your filters or expand the ''Adjust Image'' section to change the contrast, hue, etc.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-osx-vfilters.jpg

Example of combined effects on a video:

[[File:VLC-combined-effects.png|center]]

==Audio filters==

===Equalizer===

VLC features a 10-band graphical equalizer. You can display it by activating the advanced GUI on wxWidgets or by clicking the ''Equalizer'' button on the MacOS X interface. The following image is the interface of the
audio equalizer in the Windows and GNU/Linux interface.

[[Image:Audio Filters.PNG|center|]]

The equalizer in the MacOS X interface'''- needs verifying for 0.9'''

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-osx-equalizer.jpg

Presets are available in both of these dialog boxes.

===Other audio filters===

At the moment, VLC features two other audio filters: a volume normalizer and a filter providing sound spatialization with a headphone. They can be enabled in the ''Effects and Filters'' menu item in the ''Tools'' tab of the Windows and GNU/Linux interface and in the Audio section of the Extended Controls panel of the Mac OS X interface.

For better control, you need to go to the preferences. To select the filters to be enabled, go to ''Audio'', then to ''Filters''. In the "audio filters" box, enter the names of the filters to enable, separated by commas. Valid names are "equalizer", "normvol" and "headphone".

If you want to tune the behavior of these filters, go to ''Audio, Filters, [your filter]''. The equalizer and headphone filters can be tuned.

Documentation:Video and Audio Filters

2010-12-23T13:37:28Z

OpenIDUser48: /* Video filters */

{{RightMenu|documentation play howto toc}}
VLC includes a system of ''filters'' that allow you to modify the audio and video.

==Deinterlacement and Post Processing==

VLC is able to deinterlace a video stream using different deinterlacement methods. Deinterlacement can be enabled in the ''Video'' menu, ''Deinterlacement'' menu item. The ''Blend'' methods gives the best results in most cases. The ''discard'' method is a less resource consuming alternative, although its results may be slightly compromised.

On some particular streams (MPEG 4, DIVX, XVID, Sorenson, etc.), some additional image filtering can be applied to the video before display, improving its quality in some cases. This can be enabled by using the ''Post processing'' menu item in ''Video''. Different levels of post processing can be chosen here. A higher level means more filtering.

==Video filters==

VLC features several filters able to change the video (distortion, brightness adjustment, motion blurring, etc.).

In Windows and Linux, the user must go to the ''Effects and Filters'' in the ''Tools'' menu item.

[[Image:Effects and Filters.PNG|center|]]

In Mac OS X you can enable these filters through the ''Extended Controls panel''. Click on the triangle next to ''Video filters'' to select your filters or expand the ''Adjust Image'' section to change the contrast, hue, etc.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-osx-vfilters.jpg

Example of combined effects on a video:

[[File:VLC-combined-effects.png]]

==Audio filters==

===Equalizer===

VLC features a 10-band graphical equalizer. You can display it by activating the advanced GUI on wxWidgets or by clicking the ''Equalizer'' button on the MacOS X interface. The following image is the interface of the
audio equalizer in the Windows and GNU/Linux interface.

[[Image:Audio Filters.PNG|center|]]

The equalizer in the MacOS X interface'''- needs verifying for 0.9'''

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-osx-equalizer.jpg

Presets are available in both of these dialog boxes.

===Other audio filters===

At the moment, VLC features two other audio filters: a volume normalizer and a filter providing sound spatialization with a headphone. They can be enabled in the ''Effects and Filters'' menu item in the ''Tools'' tab of the Windows and GNU/Linux interface and in the Audio section of the Extended Controls panel of the Mac OS X interface.

For better control, you need to go to the preferences. To select the filters to be enabled, go to ''Audio'', then to ''Filters''. In the "audio filters" box, enter the names of the filters to enable, separated by commas. Valid names are "equalizer", "normvol" and "headphone".

If you want to tune the behavior of these filters, go to ''Audio, Filters, [your filter]''. The equalizer and headphone filters can be tuned.

2010-12-23T13:22:26Z

OpenIDUser48:

Documentation:Audio

2010-12-23T13:19:00Z

OpenIDUser48: /* Audio Channels */

{{RightMenu|documentation play howto toc}} Using the VLC media player, you can play audio files of different formats. You can enable tracks, convert audio tracks, view tracks in various visualizations, and set visualizations. Audio tracks of the ''.asf, .avi, .divx, .dv, .mxf, .ogg, .gm, .ps, .ts, .vob,'' and ''.wmv'' formats are supported.

'''Note:''' The options under the '''Audio''' menu are enabled only if an audio file is played.

== Playing an Audio Track ==

You can play, enable and disable an audio track. To play a track:

#Select ''Open File'' from the ''Media'' menu.
#Select an audio file and click on the [[Image:VLC - play button.png]] ''Open'' button. The selected track is played.
#To disable a track, select the ''Disable'' option in the ''Audio Track'' from the ''Audio'' menu. The selected track will then stop.
#To play the same track again, select the designated ''Track'' option in the ''Audio Track'' from the ''Audio'' menu. The selected track will then play.

== Audio Device ==

This option helps you to listen to audio files in two modes: stereo and mono.

#To listen to an audio track in either the Stereo or Mono mode, select ''Open File or Open Disc'' from the ''Media'' menu. The Open dialog box is displayed.
#Select an audio file and click on the [[Image:VLC - play button.png]] ''Play'' button. The selected track is played.
#Select ''Mono'' in ''Audio Device'' from the ''Audio'' menu if you want to listen to the audio track in the Mono mode.
Mono refers to monaural sound that uses a single channel for sound reproduction.

#Select ''Stereo'' in ''Audio Device'' from the ''Audio'' menu if you want to listen to the audio track in the Stereo mode.
Stereo refers to sound that uses two channels for sound reproduction or stereophonic sound.

== Audio Channels ==

In audio, a channel refers to a stream of audio that is to be played by one speaker. For example, stereo audio, consists of two channels. This option is useful for codecs that don’t have support for more than 2 channels.

Select a channel type in ''Audio Channels'' from the ''Audio'' menu. VLC media player provides four audio channels and they are:

#''Stereo'' – Refers to the reproduction of the sound in two or more independent audio channels using more than one speaker. If you use this option, you would feel as though the sound is played from all the directions. You can observe this in a regular home theatre with 5.1 or 6.1 speakers.
#''Left'' – You can observe this in a regular audio player with 2.1 speakers. If you select the '''Left''' option, the music is played only in the left speaker. The speaker on your right is automatically switched OFF.
#''Right'' - If you select the '''Right''' option, the music is played only in the speaker on your right side. The speaker on your left is automatically switched OFF.
#''Reverse Stereo'' – There are several applications that are used to reverse the stereo whereas VLC has an in-built feature to reverse the stereo. This option is useful if you want the audio to play in tandem with the video. You can use the '''Reverse Stereo''' option if you want to deliberately change the audio output.

Imagine that you are watching a video. In the video, a person walks on the left side but the sound is produced on the right speaker. You can correct this by selecting the ''Reverse Stereo'' option in VLC. Select the ''Reverse Stereo'' option and play the same scene in the video and observe the difference.

You can observe this with 2.1, 5.1, 6.1 and 8.1 speakers.

== Visualize Audio ==

Visualizations display splashes of colour and geometric shapes and generate animated imagery based on a piece of music.

The different visual effects available are Spectrometer, Scope, Spectrum, VU Meter and Goom. This menu item can also be used to disable a visualization.

#Select an option under the ''Visualizations'' option from the ''Audio'' menu to view the effects. The selected visualization is then played.
#To disable visualizations, select ''Disable'' under ''Visualizations'' from the ''Audio'' menu. The visualization is then disabled.

Documentation:Open Media

2010-12-23T13:17:38Z

OpenIDUser48: /* Play from an acquisition card */

{{RightMenu|documentation play howto toc}}

== Play a file ==

To play a file, open the ''Media'' menu, and select the ''Open File'' menu item.

[[File:Open_File.PNG]]

An ''Open File'' dialog box will appear. Select the file you want to open and select ''Open''.

[[File:Open_Dialog_Box.PNG]]

VLC with then start playing the designated file. An alternative is to simply drag 'n' drop your file into the VLC main interface or the playlist window from the file explorer (Finder on Mac OS X).

== Play a CD/DVD/VCD ==

To play a CD, VCD or a DVD, open the ''Media'' menu and select ''Open Disc'' menu item. In the ''Open Disk'' dialog box, select the type of media (DVD, SVCD/VCD or Audio CD). There is also an option for ''No DVD menus'', when reading a DVD.

You can either select the drive from which the media should be read from by selecting the drive letter from the ''Disc Device'' drop-down list or you can select the ''Browse'' button, from which you will be given a dialog box to browse to the media files.

If you want to start the DVD or VCD playback from a given title and chapter instead of from the beginning, you can set it using the ''Title'' and ''Chapter'' selectors. You can also set the ''Audio'' and ''Subtitles'' track using the selectors.

You can start playback by selecting the ''Ok'' button.

[[File:Open_DVD.PNG]]

== Play a network stream (WebRadio, WebTV, etc.) ==

To open a network stream, open the ''Media'' menu and select the ''Open Network Stream'' menu item. A dialog box will then open with three user input boxes.

The first one is for the user to select the ''Protocol'' of the stream which they wish to open (HTTP/HTTPS/MMS/FTP/RTSP/RTP/UDP/RDMP). The second box is for the user to input the ''Address'' of the stream and the third one is for the user to select the appropriate port.

You can then start playback by selecting the ''Ok'' button.

If you get some stuttering during playback, you can try to increase the size of the read buffer. This can be done in the ''Open Network Stream'' dialog box, by firstly checking the ''Show more options'' check box then adjusting the Caching selector, which allows you to choose the amount of time (in milliseconds) VLC should store data in its buffer before starting playback.

[[File:Open_Network_Strem.PNG]]

== Play from an acquisition card ==

To play from an acquisition open the ''File'' menu, and select ''Open Capture Device''. From here you can choose the ''Capture Mode'' and the ''Video/Audio Device Name''. The user can also adjust the configuration for these devices by clicking ''Configure''. The user is also able to set the size of the video that will be played by the Direct Show plugin and options such as 'Device Properties' and 'Tuner Properties' by clicking ''Advanced Options''.

For Video4Linux devices, you can set the name of the video and audio devices using the "Video device name" and "Audio device name" text inputs. The "Advanced options..." button allows to select some further settings useful in some rare cases, such as the chroma of the input (the way colors are encoded) and the size of the input buffer.

To use a Hauppauge PVR card, select the PVR tab in the "Open" dialog box. Use the "Device" text input to set the device of the card you want to use. You can set the Norm of the tuner (''PAL, SECAM or NTSC'') by using the "Norm" Drop Down. The Frequency selector allows you to set the frequency of the tuner (in kHz), the bitrate selector to set the bitrate of the resulting encoded stream (in bit/s). The "Advanced Options button allows to set some more settings, such as the size of the encoded video (in pixels), its framerate (in frame per second), the interval between 2 key frames, etc.

After setting the appropriate action you can begin playback by clicking 'Play'

[[File:Open_Acquisition_Card.PNG]]

Documentation:Building Pages for the HTTP Interface

2010-12-22T12:35:41Z

OpenIDUser48: /* Operators */

{{RightMenu|documentation play howto toc}}

==Introduction==

This appendix describes the language used for writing dynamic web pages for the HTTP interface.

Pages must be placed in the share/http folder in either VLC's folder (Windows, Mac) or /usr/share/vlc/share/http or /usr/local/share/vlc/share/http (or wherever vlc's shared files are installed).

Some files are handled a bit specially:
*Files beginning with '.' are not exported.
*A '.access' file will be opened and the http interface will expect to find at the first line a login/password (written as login:password). This login/password will be used to protect all files in this directory. Be careful that only files in this directory will be protected. (sub-directories won't be protected.)
* A '.hosts' file will be opened and the http interface will expect to find a list of network/mask pairs separated by new line, for instance 192.168.0.0/255.255.255.0. If this file is present, then the default behaviour is to deny access from hosts which don't match any of the network/mask pairs to all the files of the directory. If the file is not present, then any host has access to the files of the directory. Be careful that only files in this directory will be protected. (sub-directories won't be protected.)
*The file <dir>/index.html will be exported as <dir> and <dir>/ and not as index.html.

The MIME type is set by looking at the file extension and cannot be specified nor modified for a specific file. Unknown extensions will have "application/octet-stream" as MIME type.

You should avoid exporting big files. Each file is indeed first loaded into the memory before being sent to the client, so please be careful.

==VLC macros==

Each time a .html/.htm page is requested, it is parsed by VLC before being sent. The parser searches for the VLC macros, and executes or substitutes them. Moreover, URL arguments received by the GET method can be interpreted.

A VLC macro looks like:
<vlc id="macro-name" param1="macro-parameters1" param2="macro-parameters2" />
"id" is the only mandatory field, param1 and param2 may or may not be present and depend on the value of "id".

You should take care that you '''have to''' respect this syntax, VLC won't like invalid syntax. (It could easily leads to crashes).

Examples:

Correct:
<vlc id="value" param1="version" />
Incorrect:
<vlc id="value" param1="version" > (missing tag ending)
<vlc id=value param1="version" /> (missing "" )

Valid macros are:
*'''control''' (1 optional parameter)
*'''include''' (1 parameter)
*'''get''' (2 parameters)
*'''set''' (2 parameters)
*'''rpn''' (1 parameter)
*'''if''' (1 optional parameter)
*'''else''' (no parameter)
*'''end''' (no parameter)
*'''value''' (1 optional parameter)
*'''foreach''' (2 parameters)

For powerful macros, you may use these tools:

*RPN Evaluator (see part 2)
*Stacks: The stack is a place where you can push numbers and strings, and then pop them backs. It's used with the little RPN evaluator.
*Local variables: You can dynamically create new variables and changes their values. Some local variables are predefined:
**'''url_value''': parameter of the URL
**'''url_param''': 1 if url_value isn't empty else 0
**'''version''': the VLC version
**'''copyright''': the VLC copyright
**'''vlc_compile_time, vlc_compile_by, vlc_compile_host, vlc_compile_domain, vlc_compiler, vlc_changeset''': information on the VLC build
**'''stream_position, stream_time, stream_length, stream_state''': information on the currently playing stream
**'''volume''': current volume setting

Remark: The stacks, and local variables context is reset before the page is executed.

==The RPN evaluator==

RPN means Reverse Polish Notation.

===Introduction===

RPN may look strange but it's a fast and easy way to write expressions. It also avoids the use of ( and ).

Instead of writing ( 1 + 2 ) * 5 you just use 1 2 + 5 *.

The idea behind it is: if we have a number or a string (using ''), push it on the stack. If it is an operator (like +), pop the arguments from the stack, execute the operators and then push the result onto the stack. The result of the RPN sequence is the value on the top of the stack.

stack: Word processed
empty 1 1 is pushed on the stack
1 2 2 same things
1 | 2 + +: remove 1 and 2 and write 3 on the stack
3 5 5 is pushed on the stack
3 | 5 * *: remove 3 and 5 and write 15
15 <- result

===Operators===

Notation: ST(1) means the first stack element, ST(2) the second one ... and op is the operator.

You have access to :

*Standard arithmetics operators: '''+, -, *, /, %''' these ones push the result of ST(1) op ST(2) onto the stack

*Binary operators: '''!''' (push !ST(1)); '''^, &, |''': push the result ST(1) op ST(2)

*test: '''=, <, <=, >, >=''': execute ST(1) op ST(2) and push -1 if true else 0

*string functions:
**'''strcat''': pushes the result of 'ST(1)ST(2)
**'''strcmp''': compares ST(1) and ST(2) (0 if equal)
**'''strncmp''': compares the first ST(1) characters of ST(2) and ST(3) (0 if equal)
**'''strsub''': extracts characters ST(2) to ST(1) of string ST(3)
**'''strlen''': pushes the length of ST(1)
**'''str_replace''': replaces string ST(2) with ST(1) in ST(3)
**'''url_encode''': encodes non-alphanumeric characters of ST(1) as %XX so that they can be safely passed as GET or POST variables
**'''url_extract''': performs the reverse operation of url_encode
**'''addslashes''': protects single quotes (') and double quotes (") of ST(1) with backslashes (\) so that they can be safely passed to a VLC playlist function
**'''stripslashes''': performs the reverse operation of addslashes
**'''htmlspecialchars''': encodes &, ', ", <, and > of ST(1) as their &stuff; HTML counterpart, so that they don't interact with HTML tags
**'''realpath''': parses ST(1) as a filename path, and pushes an absolute path to that file, removing ~ and ../

*stack manipulation:
**'''dup''': pops ST(1) and pushes the same string twice
**'''drop''': pops ST(1) and drops it
**'''swap''': exchanges ST(1) and ST(2)
**'''flush''': empties the stack

*variables manipulation:
**'''store''': stores ST(2) in a local variable named ST(1)
**'''value''': pushes the value of the local variable named ST(1)

*player control:
**'''vlc_play''': plays the playlist item whose ID is ST(1), and pushes the return value of the play function (0 in case of success); see playlist functions below
**'''vlc_stop''': stops the playlist
**'''vlc_pause''': pauses the playlist
**'''vlc_next''': plays the next playlist item
**'''vlc_previous''': plays the previous playlist item
**'''vlc_seek''': seeks the current input to a location defined in ST(1), for instance+3m (minutes), -20s, 45%, 1:12, 1h12m25s
**'''vlc_var_type''': pushes the type of the variable ST(2) of object ST(1); the type is one of these strings '''VLC_VAR_BOOL, VLC_VAR_INTEGER, VLC_VAR_HOTKEY, VLC_VAR_STRING, VLC_VAR_MODULE, VLC_VAR_FILE, VLC_VAR_DIRECTORY, VLC_VAR_VARIABLE, VLC_VAR_FLOAT, UNDEFINED''' (no such variable) or '''INVALID''' (no input stream); the object is one of '''VLC_OBJECT_ROOT, VLC_OBJECT_VLC, VLC_OBJECT_INTF, VLC_OBJECT_PLAYLIST, VLC_OBJECT_INPUT, VLC_OBJECT_VOUT, VLC_OBJECT_AOUT''' or '''VLC_OBJECT_SOUT'''
**'''vlc_var_set''': sets variable ST(2) of object ST(1) to ST(3)
**'''vlc_var_get''': pushes the value of the variable ST(2) of object ST(1)
**'''vlc_object_exists''': checks if object ST(1) exists
**'''vlc_config_type''': pushes the type of the configuration variable ST(1); see '''vlc_var_type''' for a list of types
**'''vlc_config_set''': sets configuration variable ST(1) to ST(2)
**'''vlc_config_get''': pushes the value of the configuration variable ST(1)
**'''vlc_config_save''': saves the modification made to the configuration variables of module ST(1) to the configuration file (ST(1) may be empty, in which case the whole configuration is saved) and pushes the return status (0 in case of success)
**'''vlc_config_reset''': resets the configuration file to the default value (use with caution)
**'''vlc_volume_set''': sets the volume value to ST(1) which can be a raw value between 0 and 1024, or a relative one between 0% and 400%, where 1% is equal to the maximum volume value divided by 400 (thus, the maximum volume value is equal to 400%, that is 1024). If ST(1) begins with a '+' (or '-') operator, the volume is increased (or decreased) by the raw value which follows this operator
**'''vlc_get_meta''': pushes the value of the meta information named by ST(1) from the stream being played. Available meta names are: "Title" (or "TITLE"), "Author", "Artist" (or "ARTIST"), "Genre" (or "GENRE"), "Copyright", "Album/movie/show title" (or "ALBUM"), "Track number/position in set", "Description", "Rating", "Date", "Setting", "URL", "Language", "Now Playing", "Publisher"
**'''vlm_command''' or '''vlm_cmd''': sends the command that is on the stack to the VLM (VideoLan Manager). Since the command can contain more than one component on the stack, it must be ended by an ';' or an empty string pushed on the stack (e.g.: param1="';' 'command' 'my' 'this is' vlm_command"). Once the VLM has executed the command, the return value is assigned to the local variable '''vlm_value''' and the error string (if available) is assigned to '''vlm_error'''
**'''snapshot''': takes a snapshot

*playlist functions:
**'''playlist_add''': adds MRL ST(1) to the playlist, with name ST(2) and returns the playlist ID associated to this item; special characters must be escaped with addslashes first; it is very convenient to call 'toto.mpg' playlist_add vlc_play
**'''playlist_empty''': clears the playlist of all items
**'''playlist_move''': moves playlist item at position ST(2) to position ST(1)
**'''playlist_delete''': deletes playlist item ID ST(1)
**'''playlist_sort''': sorts the playlist using the mode ST(2) and order ST(1). Available order values are 0 (normal order) and 1 (reverse order). Available mode values are 0 (sort by ID), 1 (sort by title), 2 (sort by title, nodes first), 3 (sort by author), 4 (sort by genre), 5 (sort randomly), 6 (sort by duration), 7 (numerically sort by title) and 8 (sort by album)
**'''services_discovery_add''': adds the service discovery ST(1) to the playlist
**'''services_discovery_remove''': removes the service discovery ST(1) from the playlist
**'''services_discovery_is_loaded''': checks if the service discovery ST(1) is loaded in the playlist, and pushes the answer on the stack

==The macros==

===The ''control'' macro===

'''The use of the control macro is now deprecated in favour of the RPN functions above. The documentation is provided here for the maintainance of HTML pages still using this old API. The main problem with this API is that there is no way to retrieve the playlist ID of the last added item.'''

When asking for a page, you can give arguments to it through the url. (e.g. using a <form>). Ex: http://host:port/page.html?var=value&var2=value2&... The "control" macro tells a page to parse these arguments and to execute the ones that are allowed. param1 of this macro says which commands are allowed. If empty, all commands will be permitted.

Some commands require an argument that must be passed in the URL too.
*URL commands
**Name, Argument, Description
**'''play''', item (integer), Play the specified playlist item
**'''stop''', ,Stop
**'''pause''', Pause
**'''next''', , Go to next playlist item
**'''previous''', , Go to previous playlist item
**'''add''', mrl (string), Add a [[MRL]] to the playlist
**'''delete''', item (integer), Delete the specified playlist item or list of playlist items
**'''empty''', , Empty the playlist
**'''close''', id (hexa), Close a specific connection
**'''shutdown''', , Quit VLC

For example, you can restrict execution of the '''shutdown''' command to protected page (through a ''.access'' file), using the control macro in all unprotected pages.

===The ''include'' macro===

This macro is replaced by the contents of the file param1. If the file contains vlc macros, they are correctly parsed and replaced.

===The ''get'' macro===

This macro will be replaced by the value of the configuration variable which name is stored in param1 and which type is given by param2.

param1 must be the name of an existing configuration variable. param2 must be the right type of the variable. It can be one of ''int'', ''float'', or ''string''.

Example:
<vlc id="get" param1="sout" param2="string" /> will be replaced in the output page by the value of sout.

===The ''set'' macro===

This macro allows to set the value of a configuration variable. The name is given by param1 and the type by param2 (like for get). The value is retrieved from the url using the name given in param1.

For example, if player.html contains
<vlc id="set" param1="sout" param2="string" />
and if you browse at <emphasis> http://host:ip/player.html?sout=sout_value</emphasis>, the sout variable will be set to "sout_value". If the URL doesn't contain sout, nothing will be done.

===The ''rpn'' macro===

This macro allows you to interpret RPN commands. (See II).

===The ''if,else,end'' macro===

This macro allows you to control the parsing of the HTML page.

If param1 isn't empty, it is first executed with the RPN evaluator. If the first element from the stack is not 0, the test value is true, else false..

<vlc id="if" param1="1 2 =" />

<vlc id="else" />
 Test succeed: 1 isn't equal to 2 
<vlc id="end" />

You can also just use "if" and "end".

===The ''value'' macro===

If param1 isn't empty, it is first executed with the RPN evaluator. The macro is replaced with the value of the first element of the stack.

Note: If the element is the name of a local variable, its value will be displayed instead of its name.

===The ''foreach,end'' macro===

param1 is the name of the variable that will be used for the loop. param2 is the name of the set to be built:
*integer: take the first element from the stack to construct a set of integer. The stack element should be a string like: ''first:last[:step][,first2:last2[:step2][,...]'' (Ex:1:5:2,6:8:1 will be expanded into 1,3,5,6,7,8)
*directory: take the first element of the stack as the base directory and construct a set of filename and directly in it. Each element has the following fields:
**basename: file/directory name
**name: complete file/directory name (including path)
**ext: file extension in lowercase
**type: "directory" or "file" or "unknown"
**size: size of the file
**date
*playlist: set based on the playlist with fields: current is 1 if item is currently selected, 0 else. index is the index value, that can be used by the play or delete control command. name is the
name of the item.
*"information": Create information for the current playing stream. name is the name of the category, value is its value, info is a new set that can be parsed with a new foreach (subfields of info are name and value).
*input variables such as "program", "title", "chapter", "audio-es", "video-es" and "spu-es": Create lists for the current playing stream. Every list has the following fields:
**name: item name (language for elementary streams, tracks, etc.) to display in places where a human-readable format is preferred
**id: item ID to pass to the RPN function vlc_var_set, and returned by vlc_var_get
**selected: 1 if the item is selected, 0 otherwise
*the name of a foreach variable if it's a set of set of value.

<vlc id="foreach" param1="cat" param2="informations" />
<vlc id="value" param1="cat.name" />
<ul>
<vlc id="foreach" param1="info" param2="cat.info" />
<li>
<vlc id="value" param1="info.name" /> :
<vlc id="value" param1="info.value" />
</li>
<vlc id="end" />
</ul>
<vlc id="end" />

For more details, have a look at the share/http directory of the VLC source tree...

{{Documentation}}

Documentation:Snapshots

2010-12-22T12:27:34Z

2010-12-22T11:22:23Z

OpenIDUser48: /* Debian testing (etch) */

{{RightMenu|documentation play howto toc}}

There are VLC binaries available for the many OSes, but not for all supported ones. If there are no binaries for your OS or if you want to change the default settings, you can compile VLC from sources.

== Windows ==

 {{VLC}} is compatible and works under Windows Operating Systems 2000/XP/Vista/7. It can also be used under Windows 95/98/Me using [http://kernelex.sourceforge.net/wiki/Main_Page KernelEx].

#Download the self-extracting package (or the 7-zip/zip package, which requires an extraction first) from the [http://www.videolan.org/vlc/download-windows.html VLC Windows download page].
#Launch the '''.exe''' to install VLC.
#Follow the steps in the installer.

Unattended/silent installation: Use "filename" /L="languagecode" /S. Example for english installation: vlc-1.1.0-win32.exe /L=1033 /S

== Mac OS X ==

#Download the Mac OS X package from the [http://www.videolan.org/vlc/download-macosx.html VLC MacOS X download page].
#Double-click on the icon of the package: an icon will appear on your Desktop, right beside your drives.
#Open it and drag the VLC application from the resulting window to the place where you want to install it (it should be '''/Applications''').

== BeOS ==

#Download the Zip file from the [http://www.videolan.org/vlc/download-beos.html VLC BeOS download page].
#Unzip the file in a directory to install VLC.

== Debian GNU/Linux ==

=== Debian stable (lenny) ===

Add the following lines to your '''/etc/apt/sources.list''':

'''deb''' http://download.videolan.org/pub/videolan/debian '''stable main'''
'''deb-src''' http://download.videolan.org/pub/videolan/debian '''stable main'''

Then, for a normal install, write the following commands in '''Terminal''':

# '''apt-get update'''
# '''apt-get install vlc libdvdcss2'''

=== Debian testing (squeeze) ===

You should not be using Debian testing unless you perfectly know what you are doing. It is almost impossible to support Debian testing and there are no plans to do it.

For more information on Debian testing, please look at the [http://www.debian.org/devel/testing Testing Page].

=== Debian unstable (sid) ===

Add the following lines to your '''/etc/apt/sources.list''':

'''deb''' http://download.videolan.org/pub/videolan/debian '''sid main'''
'''deb-src''' http://download.videolan.org/pub/videolan/debian '''sid main'''

Then, for a normal install, write the following commands in '''Terminal''':

# '''apt-get update'''
# '''apt-get install vlc libdvdcss2'''

== Linux Mandrake ==

There are VLC packages for Mandrake 9.1 and Cooker.

To install them, add the following sources for either Mandrake 9.1 or Cooker (you can use [http://plf.zarb.org/~nanardon/ Easy urpmi] for that): ''contrib'' from the core distribution and ''plf'' (Penguin Liberation Front) from the external add-ons.

Then install the required packages with '''urpmi''':

# '''urpmi libdvdcss2 libdvdplay0 wxvlc vlc-plugin-a52 vlc-plugin-ogg vlc-plugin-mad'''

== Linux CentOS (EL5) ==

1. Download and install the latest rpmforge-release rpm (eg rpmforge-release-0.3.6-1.el5.rf.i386.rpm)

2. Either;

# '''yum install vlc'''

or (if you have epel-release installed);

# '''yum --disablerepo='epel' install vlc'''

 

== Linux Redhat ==

Download the RPM package ''vlc'' and the packages listed in the ''required libraries and codecs'' section (the other packages are optional) from the [http://www.videolan.org/vlc/download-redhat.html VLC Red Hat download page] and put them all into the same directory.

Then install the RPM packages you have downloaded:

# '''rpm -U *.rpm'''

If you have not installed all the RPM packages included with your distribution, you may be asked to install a few of them first.

== Compile the sources by yourself (for every other OS) ==

For more detailed information on compiling VLC by yourself, please have a look at the documentation on our [http://developers.videolan.org developers website].

{{Documentation}}

Documentation:Installing VLC

2010-12-22T11:22:05Z

OpenIDUser48: /* Debian stable (sarge) */

{{RightMenu|documentation play howto toc}}

There are VLC binaries available for the many OSes, but not for all supported ones. If there are no binaries for your OS or if you want to change the default settings, you can compile VLC from sources.

== Windows ==

 {{VLC}} is compatible and works under Windows Operating Systems 2000/XP/Vista/7. It can also be used under Windows 95/98/Me using [http://kernelex.sourceforge.net/wiki/Main_Page KernelEx].

#Download the self-extracting package (or the 7-zip/zip package, which requires an extraction first) from the [http://www.videolan.org/vlc/download-windows.html VLC Windows download page].
#Launch the '''.exe''' to install VLC.
#Follow the steps in the installer.

Unattended/silent installation: Use "filename" /L="languagecode" /S. Example for english installation: vlc-1.1.0-win32.exe /L=1033 /S

== Mac OS X ==

#Download the Mac OS X package from the [http://www.videolan.org/vlc/download-macosx.html VLC MacOS X download page].
#Double-click on the icon of the package: an icon will appear on your Desktop, right beside your drives.
#Open it and drag the VLC application from the resulting window to the place where you want to install it (it should be '''/Applications''').

== BeOS ==

#Download the Zip file from the [http://www.videolan.org/vlc/download-beos.html VLC BeOS download page].
#Unzip the file in a directory to install VLC.

== Debian GNU/Linux ==

=== Debian stable (lenny) ===

Add the following lines to your '''/etc/apt/sources.list''':

'''deb''' http://download.videolan.org/pub/videolan/debian '''stable main'''
'''deb-src''' http://download.videolan.org/pub/videolan/debian '''stable main'''

Then, for a normal install, write the following commands in '''Terminal''':

# '''apt-get update'''
# '''apt-get install vlc libdvdcss2'''

=== Debian testing (etch) ===

You should not be using Debian testing unless you perfectly know what you are doing. It is almost impossible to support Debian testing and there are no plans to do it.

For more information on Debian testing, please look at the [http://www.debian.org/devel/testing Testing Page].

=== Debian unstable (sid) ===

Add the following lines to your '''/etc/apt/sources.list''':

'''deb''' http://download.videolan.org/pub/videolan/debian '''sid main'''
'''deb-src''' http://download.videolan.org/pub/videolan/debian '''sid main'''

Then, for a normal install, write the following commands in '''Terminal''':

# '''apt-get update'''
# '''apt-get install vlc libdvdcss2'''

== Linux Mandrake ==

There are VLC packages for Mandrake 9.1 and Cooker.

To install them, add the following sources for either Mandrake 9.1 or Cooker (you can use [http://plf.zarb.org/~nanardon/ Easy urpmi] for that): ''contrib'' from the core distribution and ''plf'' (Penguin Liberation Front) from the external add-ons.

Then install the required packages with '''urpmi''':

# '''urpmi libdvdcss2 libdvdplay0 wxvlc vlc-plugin-a52 vlc-plugin-ogg vlc-plugin-mad'''

== Linux CentOS (EL5) ==

1. Download and install the latest rpmforge-release rpm (eg rpmforge-release-0.3.6-1.el5.rf.i386.rpm)

2. Either;

# '''yum install vlc'''

or (if you have epel-release installed);

# '''yum --disablerepo='epel' install vlc'''

 

== Linux Redhat ==

Download the RPM package ''vlc'' and the packages listed in the ''required libraries and codecs'' section (the other packages are optional) from the [http://www.videolan.org/vlc/download-redhat.html VLC Red Hat download page] and put them all into the same directory.

Then install the RPM packages you have downloaded:

# '''rpm -U *.rpm'''

If you have not installed all the RPM packages included with your distribution, you may be asked to install a few of them first.

== Compile the sources by yourself (for every other OS) ==

For more detailed information on compiling VLC by yourself, please have a look at the documentation on our [http://developers.videolan.org developers website].

{{Documentation}}

Documentation:Hotkeys

Documentation:Advanced Use of VLC

2010-12-21T18:44:03Z

OpenIDUser48: /* Specifying Streaming Options */

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

*'''--novideo''' 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.

==== Deinterlacing video filter ====

Module name: '''deinterlace'''

*'''--deinterlace-mode {discard,blend,mean,bob,linear}''' 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 ====

Install the ''mozilla-plugin-vlc'' package:

# '''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 you open a link to a video file handled by the VLC plugin (To get the list of handled types, browse to '''about:plugins''') or a page with an embedded video, the plugin should open and read the video.

See the [[Documentation:WebPlugin|documentation]] for building page for this 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 type.
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''.

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.
By clicking stream it will return to VLC main user interface and the playbar will scroll as the video will play.