VideoLAN Wiki - User contributions [en]

Midi

2013-08-13T03:58:03Z

Skierpage: improve opening paragraph

{{wikipedia|Musical_Instrument_Digital_Interface#Standard MIDI files|Midi files}}
{{Module|name=fluidsynth|type=Codec|description=SMF files playback through fluidsynth library|first_version=0.9.0}}

Standard MIDI Files (SMF) contain sounds events that indicate the notes and instruments in a musical performance, but do not include the digital waveform of the audio.
They usually have the extension <tt>.mid</tt> or <tt>.midi</tt>.
To play a MIDI file, software has to synthesize the music, which usually requires reading digital samples of musical instruments from a large file.

== Play .midi files in VLC ==
{{VLC}} can play MIDI since 0.9.0 on most platforms. On Windows, you need {{VLC}} 1.1.0.

=== SoundFonts file ===
To playback .midi files, you need a [[wikipedia:SoundFont|SoundFont]] file (with extension <tt>.sf2</tt>).
You can download them from either of these two places:

* http://www.schristiancollins.com/generaluser.php
* http://sourceforge.net/apps/trac/fluidsynth/wiki/SoundFont

=== Configure SoundFont in VLC ===
You need to open VLC's preferences. The preferences window has two display modes called '''Simple''' and '''All'''. Choose the display mode called '''All''', then go to '''Codecs''', '''Audio codecs''', '''FluidSynth'''.

You select the .sf2 file with the preferences select button. Due to a bug in the software it may ask if you want to replace the file you selected. Choose "Yes" to continue (your file remains intact).

=== Linux ===
If the '''FluidSynth''' codec is not shown in VLC's preferences, you have to install it as well as sound fonts.
E.g. on [[Ubuntu]] 13.04 it is in the '''vlc-plugin-fluidsynth''' package, while the '''fluid-soundfont-gs''' and '''fluid-soundfont-gm''' packages install some sound fonts in <code>/usr/share/sounds/sf2</code>.

Midi

2013-08-13T03:55:29Z

Skierpage: fix WIkipedia link, better MIDI explanation, link SoundFont, separate Linux section

{{wikipedia|Musical_Instrument_Digital_Interface#Standard MIDI files|Midi files}}
{{Module|name=fluidsynth|type=Codec|description=SMF files playback through fluidsynth library|first_version=0.9.0}}

Standard MIDI Files (SMF) contain sounds events that indicate the notes and instruments in a musical performance, but do not include the digital waveform of the audio. To play a MIDI file, software has to synthesize the music, which usually requires reading instrument samples from a "sound font" file.
They usually have the extension <tt>.mid</tt> or <tt>.midi</tt>.

== Play .midi files in VLC ==
{{VLC}} can play MIDI since 0.9.0 on most platforms. On Windows, you need {{VLC}} 1.1.0.

=== SoundFonts file ===
To playback .midi files, you need a [[wikipedia:SoundFont|SoundFont]] file (with extension <tt>.sf2</tt>).
You can download them from either of these two places:

* http://www.schristiancollins.com/generaluser.php
* http://sourceforge.net/apps/trac/fluidsynth/wiki/SoundFont

=== Configure SoundFont in VLC ===
You need to open VLC's preferences. The preferences window has two display modes called '''Simple''' and '''All'''. Choose the display mode called '''All''', then go to '''Codecs''', '''Audio codecs''', '''FluidSynth'''.

You select the .sf2 file with the preferences select button. Due to a bug in the software it may ask if you want to replace the file you selected. Choose "Yes" to continue (your file remains intact).

=== Linux ===
If the '''FluidSynth''' codec is not shown in VLC's preferences, you have to install it as well as sound fonts.
E.g. on [[Ubuntu]] 13.04 it is in the '''vlc-plugin-fluidsynth''' package, while the '''fluid-soundfont-gs''' and '''fluid-soundfont-gm''' packages install some sound fonts in <code>/usr/share/sounds/sf2</code>.

Media resource locator

2012-07-13T06:45:32Z

Skierpage: the delimiter is # these days! guess that simpledvd: bypasses menus

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

The MRL syntax is:

[[access][/demux]://]URL[#[title][:chapter][-[title][:chapter]]] [:option=value ...]

(in earlier versions of VLC, the delimiter before the optional title and chapter was '@', not '#'.)

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

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

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

[[Category:Glossary]]

Media resource locator

2012-07-13T05:17:10Z

Skierpage: there was no mention of simpledvd:, added it and dvd:, and vlc: IMPROVE ME!

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

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

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

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

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

[[Category:Glossary]]

Media resource locator

2012-07-13T05:01:17Z

Skierpage: remove redundant pre tag

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

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

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

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

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

[[Category:Glossary]]

VLC Features Formats

2011-09-17T11:03:05Z

Skierpage: /* Audio Codecs */ add QCELP , it's mentioned in http://www.videolan.org/vlc/features.php?cat=audio

This is a new page that lists the audio/video codecs that VLC can or cannot read. It is still under development, don't hesitate to add a some FourCC and infos.

It should now be a bit more complete than the official features page on [http://www.videolan.org/vlc/features.html VideoLAN website].

If you have any question about those codecs, just consult our [[Knowledge Base]] or our friends on the [http://wiki.multimedia.cx Multimedia Wiki]. If you don't find information, search with Wikipedia or Google.

== Video Codecs ==

=== Widely Used Video Codecs ===

{| class="wikitable" style="font-size: small; text-align: center; width: 100%; margin: 1em auto 1em auto; border : 1px"
|+ '''Most used Video Codecs'''
|-
! Name !! FOURCC !! Playable !! Encoder !! library !! Comment
|-
! MPEG-1 Part 2
|| mpeg, mp1v, mpg1, PIM1 || {{Yes}} || {{Yes}} || libmpeg2 , ffmpeg ||
|-
! MPEG-2 Part 2
|| mp2v, mpg2, vcr2, hdv1, hdv2, hdv3, mx*n, mx*p|| {{Yes}} || {{Yes}} || libmpeg2 , ffmpeg ||
|-
! MJPEG (A/B)
|| ||{{Yes}} || {{Yes}} || ffmpeg ||
|-
! Divx (1, 2, 3)
|| DIV1, DIV2, DIV3, mp41, mp42, MPG4, MPG3 || {{Yes}} || {{Yes}} || ffmpeg ||
|-
! DivX 4, 5, 6 , 3ivx D4, MPEG-4
|| DIV4, DIV5, DIV6, col1, col0, 3ivd || {{Yes}} || {{Yes}} || ffmpeg ||
|-
! MPEG-4 Part 2 (AVP), Xvid
|| DIVX, Xvid, mp4s, m4s2, xvid, mp4v, fmp4, 3iv2, smp4, ... || {{Yes}} || {{Yes}} || ffmpeg ||
|-
! H.261
|| h261 || {{Yes}} || {{Yes}} || ffmpeg ||
|-
! H.262
|| h262 || {{Yes}} || {{Yes}} || ffmpeg || Same as MPEG-2 Video
|-
! H.263 / H.263i
|| h263 || {{Yes}} || {{Yes}} || ffmpeg ||
|-
! H.264 / X.264
(MPEG-4/AVC)
(MPEG-4 Part.10)
|| h264, s264, AVC1, DAVC, H264, X264, VSSH ||{{Yes}} || {{Yes}} || ffmpeg (decode), x264 (encode) ||
|-
! Sorenson 1 (Quicktime)
|| SVQ 1 || {{Yes}} || {{Yes}} || ffmpeg ||
|-
! Sorenson 3 (Quicktime)
|| SVQ 3 || {{Yes}} || {{No}} || ffmpeg ||
|-
! DV
|| ||{{Yes}} || {{Yes}} || ffmpeg ||
|-
! Cinepak
|| cvid ||{{Yes}} || {{No}} || internal, ffmpeg ||
|-
! Theora
|| thra || {{Yes}} || {{Yes}} broken || libtheora ||
|-
! WMV 1/2 (7/8)
|| wmv1, wmv2 || {{Yes}} || {{Yes}} || ffmepg ||
|-
! WMV 3 / WMV-9 / VC-1
|| wmv3, wvc1, wmva || {{Yes}} || {{No}} || ffmpeg || Not all profiles are supported. See [[DMO]].
|-
! On2 VP3,
|| VP31, VP30, VP3 || {{Yes}} || {{No}} || ffmpeg ||
|-
! On2 VP5
|| VP50, VP5, VP51 || {{Yes}} || {{No}} || ffmpeg ||
|-
! On2 VP6 (used by FLV)
|| VP60, VP61, VP62, VP6F, VP6A || {{Yes}} || {{Yes}} || ffmpeg ||
|-
! On2 VP7
|| VP7 || {{No}} || {{No}} || ||
|-
! Flash Screen Video
|| FSV1 || {{Yes}} || {{Yes}} || ffmpeg ||
|-
! Indeo Video 3
|| IV31, IV32 || {{Yes}} || {{no}} || ffmpeg ||
|-
! Indeo Video 4/5
||IV41, IV51 || {{No}} || {{no}} || ||
|-
!Real Video 1.0, 1.3, 2.0
|| RV10, RV13, RV20 || {{Yes}} || {{Yes}} || ffmpeg ||
|-
!Real Video 3.0, 4.0
|| RV30, RV40 || {{No}} || {{No}} || ||
|-
! Dirac
|| BBCD || {{Yes}} || {{Yes}} || dirac ||
|-
! Huffyuv / Lagarith
|| || {{Yes}} || {{Yes}} || ffmpeg ||
|-
|}

=== Rarer Video Codecs ===

{| class="wikitable" style="font-size: small; text-align: center; width: 100%; margin: 1em auto 1em auto; border : 1px"
|+ '''Less Used Video Codecs'''
|-
! Rare codecs !! FOURCC !! Decoder !! Encoder !! library !! Comment
|-
! Apple Animation, Graphics, Video, QuickDraw
|| 'rle','smc ','rpza', 'qdrw' || {{Yes}} || {{No}} || ffmpeg ||
|-
! SheerVideo
|| || {{No}} || {{No}} || || Professional use, no open source decoders
|-
! CorePNG
|| || ?? || ?? || ||
|-
! MSU Lossless
|| || ?? || ?? || ||
|-
! Snow
|| || {{Yes}} || {{Yes}} || ||
|-
! Pixlet
|| || ?? || ?? || ||
|-
! Rare codecs (Asus V1, Asus V2)
|| ASV1, ASV2 || {{Yes}} || {{Yes}} || ffmpeg ||
|-
! Game Codecs (Some)
|| || {{Yes}} || {{no}} || ffmpeg ||
|-
! Tarkin
|| || {{No}} || {{No}} || ||
|}

== Audio Codecs ==

{| class="wikitable" style="font-size: small; text-align: center; width: 100%; margin: 1em auto 1em auto; border : 1px"
|+ '''Audio Codecs Status'''
|-
! Name !! FOURCC !! Decoder !! Encoder !! library !! Comment
|-
! MPEG-Audio 1 Layer-1/2
|| mpga || {{Yes}} || {{Yes}} || libmad (decoding), twolame (encoding) || ISO/IEC MPEG
|-
! MP3
|| mp3, .mp3, LAME || {{Yes}} || {{Yes}} || libmad (decoding), ffmpeg-mp3lame || ISO/IEC MPEG - '''(recompile needed for encoding)'''
|-
! AAC
|| mp4a|| {{Yes}} || {{Yes}} || faad (decode), faac (encoding) || ISO/IEC MPEG
|-
! HE-AAC
|| || {{Yes}} || {{Untested}} || faad (decode), libaacplus + ffmpeg (encoding) || ISO/IEC MPEG, AAC+ encoding through libaacplus + ffmpeg (patched) - untested
'''RECOMPILE VLC & ffmpeg for this''' Audio codec
|-
! AC-3
|| a52, a52b || {{Yes}} || {{Yes}} || liba52 (decode), ffmpeg (encode) ||
|-
! ATRAC
|| atrc ||{{Yes}} || {{No}} || ||
|-
! iLBC
|| ILBC, ilbc || {{Untested}} || {{Untested}} || QuickTime (decode) || (check for encoder and free decoder)
|-
! Mu-Law
|| ||{{Yes}} || {{No}} || ffmpeg || (check for encoder)
|-
! NellyMoser
|| ||{{Yes}} || {{No}} || ffmpeg ||
|-
! QCELP (PureVoice)
|| Qclp ||{{Yes}} || {{No}}? || ffmpeg || Usually in QCP container. [https://trac.videolan.org/vlc/ticket/5347 buggy?]
|-
! Real Audio
|| lpcJ, 28_8, dnet, sipr, cook, atrc, raac, racp, ralf || {{Yes}} || {{No}} || || Some works. ralf don't
|-
! Shorten
|| shrn || {{No}} || {{No}} || || ffmpeg and ffplay do it. VLC doesn't. (It is in the FOURCC list in VLC's ffmpeg.c [[User:Dionoea|Dionoea]])
|-
! Speex
|| spex || {{Yes}} || {{Yes}} || libspeex ||
|-
! Vorbis
|| vorb || {{Yes}} || {{Yes}} || libvorbis ||
|-
! DTS
|| dts || {{Yes}} || {{No}} || libdca || DTS-HD unsupported
|-
! MPC
|| || {{Yes}} || {{No}} || libmpcdec ||
|-
! WMA 1/2
|| wma1, wma2 || {{Yes}} || {{Yes}} broken || ffmpeg || WMA9 is not supported
|-
! Flac
|| flac || {{Yes}} || {{Yes}} || libflac || lossless
|-
! Apple Lossless Audio Codec
|| alac || {{Yes}} || {{No}} || ffmpeg || lossless
|-
! Monkey's Audio
|| ||{{Yes}} || {{No}} || || lossless
|-
! Musepack
|| || {{Yes}} || {{No}} || libmpcdec ||
|-
! ADMPCM (various)
|| || {{Yes}} || {{Yes}} || ffmpeg and internal ||
|-
! AMR
|| samr || {{Yes}} || {{Yes}} || ffmpeg + libamrnb + libamrwb || '''RECOMPILE VLC for this''' Speech codec
|-
! Sonic
|| SONC || {{Yes}} || {{Yes}} || ffmpeg ||
|-
|}

== Subtitles Codecs ==

See [[SubtitlesCodec]] for the matter.

== Format/Container/Muxers ==

{| class="wikitable" style="font-size: small; text-align: center; width: 100%; margin: 1em auto 1em auto; border : 1px"
|+ '''Muxer'''
|-
! Name !! extensions !! Playable !! Savable !! Comment
|-
! 3GP
|| .3gp || {{Yes}} || {{Untested}} ||
|-
! AIFF
|| .asf, .wmv || {{Yes}} || {{No}} ||
|-
! ASF
|| .asf, .wmv || {{Yes}} || {{Yes}} ||
|-
! AU
|| .au || {{Yes}} || ||
|-
! AVI
|| .avi || {{Yes}} || {{Yes}}, broken ||
|-
! DMF
|| || {{Untested}} || {{Untested}} ||
|-
! FLV
|| .flv || {{Yes}} || {{Yes}} || through ffmpeg
|-
! MOV
|| .mov || {{Yes}} || {{Yes}} ||
|-
! MP4
|| .mp4 || {{Yes}} || {{Yes}} ||
|-
! OGG
|| .ogm, .ogg || {{Yes}} || {{Yes}} ||
|-
! MKV
|| .mkv, .mka || {{Yes}} || {{No}}, WIP || Summer of Code 2007 Project
|-
! MPEG-2 / TS
|| .ts, .mpg || {{Yes}} || {{Yes}} ||
|-
! MPEG-2 / ES, PS, PVA, MP3
|| .mpg, .mp3, .mp2 || {{Yes}} || {{Yes}} ||
|-
! NSC
|| .nsc || {{Yes}} || {{No}} ||
|-
! NSV
|| .nsv || {{Yes}} || {{No}} ||
|-
! Nut
|| .nut || {{Yes}} || {{Yes}} || Muxable through libavformat
|-
! Real
|| .ra, .ram, .rm, .rv , .rmbv || {{Partial}} || {{No }} || version 4 and 5, no support for version 3
|-
! Raw (a52, dts, aac, flac, .dv, .vid)
|| .a52, .dts, .aac, .flac, .dv, .vid || {{Yes}} || ?? ||
|-
! True Audio Codec
|| .tta, .tac || {{Yes}} || {{No}} ||
|-
! Ty Tivo
|| .ty || {{Yes}} || {{No}} ||
|-
! Wav
|| .wav, .dts || {{Yes}} || {{Yes}} ||
|-
! Xa
|| .xa || {{Yes}} || {{No}} ||
|-
|}

{{:HD-Discs}}

[[Category:About VideoLAN]]

Windows

2011-09-06T06:42:47Z

Skierpage: /* VLC Plugin for Firefox (Mozilla) */ replace "Use" section with improved text from Documentation:Play HowTo/Advanced Use of VLC#Use the Mozilla plugin (but why is there ANY duplication?

The '''Windows port''' of VLC usually starts up with the [[Qt]] interface which is used in the [[Linux]] one as well. The user can decide to use the [[Skins]] interface instead to be able to modify the interface according to his or her mood.
[[File:VLC_-_main.png|thumb|alt=Alt text|Main window]]

== Frequently Asked Questions ==
There are some user-maintained FAQs (as distinct from the official VLC FAQ that may be found [http://www.videolan.org/support/faq.html here]):
* [[WindowsFAQ-1.0.x|Version 1.0 and newer]]
* [[WindowsFAQ-0.9.x|Version 0.9.x]]
* [[WindowsFAQ-0.8.x|Version 0.8.x]]

==Keyboard shortcuts in the Windows (directx) video output==
:''See also: [[QtHotkeys]], [[How to set global hotkeys]]''.

Note: these shortcuts are only default settings and can be customized (along with many others). To tweak hotkeys settings, go to Settings->Preferences->Interface->Hotkeys settings

{| class="wikitable"
| F
| Fullscreen
|-
| Space
| Play/Pause
|-
| T
| Show position (time)
|-
| S
| Stop
|-
| Ctrl+Q
| Quit
|-
| +/-
| Faster/Slower
|-
| N/P
| Next/Previous
|-
| Shift+Left/Shift+Right
| Jump very short
|-
| Alt+Left/Alt+Right
| Jump short
|-
| Ctrl+Left/Ctrl+Right
| Jump medium
|-
| Ctrl+Alt+Left/Ctrl+Alt+Right
| Jump long
|-
| Ctrl+Up/Ctrl+Down
| Volume up/down
|-
| M
| Mute
|-
| Ctrl+M
| Show DVD-menu
|-
| Left/Right Up/Down Enter
| DVD-menu navigation keys
|}

==How to store streaming station presets==

To use VLC as a streaming client, store your station presets under the Media Library on the Playlist panel (''not'' the bookmarks and ''not'' the actual playlist itself).
#Open the playlist panel (Ctrl-L or click on the Playlist button).
#Click on the Plus button at the bottom of the panel. (A dropdown menu will appear.)
#Select "Advanced Open" from the dropdown menu. (A new panel, named Open Media, will appear.)
#Select the "Networking" tab on the Open Media panel.
#Enter the full URL of the streaming station in the Address field. e.g. http://mystation.org:8000/mystream.ogg
#Click the Enqueue button at the bottom of the panel.

==How to associate media files to VLC==

This should be done through the VLC settings interface, choose "Tools | Preferences " and then click on the "Set up Associations..." button.
Select any file extension that you wish to open with VLC, then click "Apply". This should change all media files icons to the VLC cone, and double-clicking any of them should open VLC and immediately start playing the media.

If this seems to have no effect on the UI, and/or double-clicking the file icon does not start VLC, check that you have correctly set Windows preferences through "Start | Default Programs" (on Vista; see the relevant item on Windows XP or newer Windows OS; possibly this is not applicable to Windows 2000).
In that UI click on "Set default programs", select the "VLC media player" item and check the description (it will usually say "All default settings for this program are active"). Then choose your own course of actions by either clicking on "Set this program as default" or "Choose default settings for this program".

Other ways to achieve the same effects are as follows (not really recommended).

===Use Windows Explorer's context menu===

#In Windows Explorer, ''right''-click a file you wish to open.
#Click "Open With" in the context menu that pops up.
#Click "VLC media player" to use VLC just this once, or click "Default program..."
#Click the name of the program (VLC) which you want to be used to open the file.
#*If VLC is not displayed, click Browse to locate it on your hard drive.

Alternatively:
#In Windows Explorer, ''right''-click the file you want to open with VLC.
#Click Properties in the context menu that pops up.
#On the General tab, click Change.
#Click the name of the program (VLC) which you want to be used to open the file.

Either of these options affects all files that have the same filename extension (the letters after the filename's period) as the file you selected. For example, if you change the program that opens ''goober.avi'', then all ''.avi'' files will be opened with VLC.

===Rerun the installer===
#Reinstall VLC and choose the "associate files" option when it comes up. ''Please note'' that on Vista and newer OSes this will not cure the "Windows Media Player won't go away" symptom, and you should go the "Set default program" route instead, as described above.

===Edit the registry===
'''''Warning''''': this instruction set is outdated and should ''not'' be used. Direct registry editing should be avoided anyway unless you're desperate and you really ''really'' know what you're doing.

'''Warning''': use this technique only if you really know what you are doing! And be sure to back-up your registry first.

#Open a text editor, like Notepad (but not WordPad).
#Copy this text below.
#Modify the strings ''C:\\Program Files\\VideoLAN\\VLC\\vlc.exe'' to match your VLC installation.
#Save as ''vlc.reg''.
#Execute ''vlc.reg'' (adding this data to your registry).
#Enjoy VLC :)

Text to copy:
<pre>
Windows Registry Editor Version 5.00

[HKEY_CLASSES_ROOT\.ASF]
@="VlcFile"

[HKEY_CLASSES_ROOT\.ASX]
@="VlcFile"

[HKEY_CLASSES_ROOT\.AVI]
@="VlcFile"

[HKEY_CLASSES_ROOT\.DIVX]
@="VlcFile"

[HKEY_CLASSES_ROOT\.MPEG]
@="VlcFile"

[HKEY_CLASSES_ROOT\.MPG]
@="VlcFile"

[HKEY_CLASSES_ROOT\.VOB]
@="VlcFile"

[HKEY_CLASSES_ROOT\.WMV]
@="VlcFile"

[HKEY_CLASSES_ROOT\VlcFile]
@="VLC File"

[HKEY_CLASSES_ROOT\VlcFile\DefaultIcon]
@="C:\\Program Files\\VideoLAN\\VLC\\vlc.exe,0"

[HKEY_CLASSES_ROOT\VlcFile\shell\Open]
[HKEY_CLASSES_ROOT\VlcFile\shell\Open\command]
@="C:\\Program Files\\VideoLAN\\VLC\\vlc.exe \"%L\""
</pre>

'''Note''': This associates ''asf'', ''asx'', ''avi'', ''divx'', ''mpeg'', ''mpg'', ''vob'' and ''wmv'' files. If you get the idea, you can associate any file you want.

==How To Start VLC Server with 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.

===Step 1: VLC Server Preferences Settings===
1. Set up the http interface details in the VLC server application: Open VLC, then select Tools > Preferences. In the bottom left corner of the window, under "Show settings", click "All".

2. In the left hand menu click on the + button next to Interface. This will display three choices. Control interfaces, Hotkeys settings, and Main Interfaces. Click "Main Interfaces". Select "HTTP remote control interface".

3. Click on the plus button next to "Main interfaces". This will display four settings HTTP, Qt, RC, Skins. Click on HTTP to display the "HTTP remote control interface" settings.

4. Host address: Enter the port number that you want to use. Default is 8080.

5. Source directory: If you have installed VLC in a different folder than the default, enter '''path\to\VLC\'''\http.

6. If you are NOT using handlers or SSL certificates the setup is complete.

7. Click on the Save button in the lower right hand of the window.

8. If needed, edit the .hosts file in the vlc/http directory. By default only "localhost" is allowed, edit to enable other hosts.

9. Exit and restart VLC

===Step 2: Command Line Startup===

The VLC appplication can be run in a server or client environment. For complicated
video and audio streaming on a LAN, one should consider dedicating a machine to act
as the VLC server.

To start the VLC application in a server mode with the http interface automatically
set, use the following command line in your desktop shortcut. This assumes the default
location for installation was selected.

<nowiki>"C:\Program Files\VideoLAN\VLC\vlc.exe" --extraintf http --intf wx</nowiki>

===Step 3: Testing the Interface===

From another computer, connect to the VLC server computer using your browser to the URL

<nowiki>http://server_ip_address:8080, such as http://192.168.0.186:8080</nowiki>

The Main VLC Interface page will be displayed,

See [[Web_Interface]] for additional information

==VLC Plugin for Internet Explorer==

This section will provide guidelines to incorporate the VLC ActiveX plugin to be used to view streaming audio and video from a VLC server.

How to embed the ActiveX Plugin in a Web Page: [[ActiveX/HTML]]

Supported ActiveX Function Calls: [[ActiveX]]

==VLC Plugin for Firefox (Mozilla)==
The Mozilla plugin
(Excerpted from the [[Documentation:Play_HowTo/Advanced_Use_of_VLC#The_Mozilla_plugin|VLC User Guide]])

'''Install'''

There are at least two ways to install the VLC Mozilla Plugin. One way is to to check the "Install Firefox Plugin" when you install VLC.

If the standard exe installation does not install the mozilla plugin directory then download zip version which includes the required data and continue with the next installation (2nd way of installing of the plugin)

The second way involves several steps:

1. Quit Firefox or Mozilla

2. Copy the two files in VLC_Installation_folder\mozilla (usually C:\Program Files\VideoLAN\VLC\mozilla) to your mozilla plugins directory (Usually C:\Program Files\Mozilla\plugins or C:\Program Files\Mozilla Firefox\plugins).

3. Restart Firefox or Mozilla

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

More example code, as well as a working implementation using Javascript, XHTML, and PHP that auto-detects browsers (the code is good, but the stream doesn't work) can be found at http://altair.videolan.org/~dionoea/vlc-plugin-demo/ ''(broken as of 2011-09-04)''

== Related article ==
* [[Common Problems]]
* [[VLC command-line help]]
* [[VLCSout]] how to create a DVD

== Portable VLC ==
A version of VLC in a portable format exists. It is useful, for example, if you want to put it on a USB stick and use it on computers you don't own. It can also be very useful on your own computer: if you have to reinstall Windows, you won't need to reinstall VLC, it will be up and running almost instantly: 
http://portableapps.com/apps/music_video/vlc_portable

[[Category:Operating systems]]

Windows

2011-09-06T06:35:00Z

Skierpage: delete the garbled out-of-date copy of non-Windows-specific plug-in programming from Documentation:WebPlugin

The '''Windows port''' of VLC usually starts up with the [[Qt]] interface which is used in the [[Linux]] one as well. The user can decide to use the [[Skins]] interface instead to be able to modify the interface according to his or her mood.
[[File:VLC_-_main.png|thumb|alt=Alt text|Main window]]

== Frequently Asked Questions ==
There are some user-maintained FAQs (as distinct from the official VLC FAQ that may be found [http://www.videolan.org/support/faq.html here]):
* [[WindowsFAQ-1.0.x|Version 1.0 and newer]]
* [[WindowsFAQ-0.9.x|Version 0.9.x]]
* [[WindowsFAQ-0.8.x|Version 0.8.x]]

==Keyboard shortcuts in the Windows (directx) video output==
:''See also: [[QtHotkeys]], [[How to set global hotkeys]]''.

Note: these shortcuts are only default settings and can be customized (along with many others). To tweak hotkeys settings, go to Settings->Preferences->Interface->Hotkeys settings

{| class="wikitable"
| F
| Fullscreen
|-
| Space
| Play/Pause
|-
| T
| Show position (time)
|-
| S
| Stop
|-
| Ctrl+Q
| Quit
|-
| +/-
| Faster/Slower
|-
| N/P
| Next/Previous
|-
| Shift+Left/Shift+Right
| Jump very short
|-
| Alt+Left/Alt+Right
| Jump short
|-
| Ctrl+Left/Ctrl+Right
| Jump medium
|-
| Ctrl+Alt+Left/Ctrl+Alt+Right
| Jump long
|-
| Ctrl+Up/Ctrl+Down
| Volume up/down
|-
| M
| Mute
|-
| Ctrl+M
| Show DVD-menu
|-
| Left/Right Up/Down Enter
| DVD-menu navigation keys
|}

==How to store streaming station presets==

To use VLC as a streaming client, store your station presets under the Media Library on the Playlist panel (''not'' the bookmarks and ''not'' the actual playlist itself).
#Open the playlist panel (Ctrl-L or click on the Playlist button).
#Click on the Plus button at the bottom of the panel. (A dropdown menu will appear.)
#Select "Advanced Open" from the dropdown menu. (A new panel, named Open Media, will appear.)
#Select the "Networking" tab on the Open Media panel.
#Enter the full URL of the streaming station in the Address field. e.g. http://mystation.org:8000/mystream.ogg
#Click the Enqueue button at the bottom of the panel.

==How to associate media files to VLC==

This should be done through the VLC settings interface, choose "Tools | Preferences " and then click on the "Set up Associations..." button.
Select any file extension that you wish to open with VLC, then click "Apply". This should change all media files icons to the VLC cone, and double-clicking any of them should open VLC and immediately start playing the media.

If this seems to have no effect on the UI, and/or double-clicking the file icon does not start VLC, check that you have correctly set Windows preferences through "Start | Default Programs" (on Vista; see the relevant item on Windows XP or newer Windows OS; possibly this is not applicable to Windows 2000).
In that UI click on "Set default programs", select the "VLC media player" item and check the description (it will usually say "All default settings for this program are active"). Then choose your own course of actions by either clicking on "Set this program as default" or "Choose default settings for this program".

Other ways to achieve the same effects are as follows (not really recommended).

===Use Windows Explorer's context menu===

#In Windows Explorer, ''right''-click a file you wish to open.
#Click "Open With" in the context menu that pops up.
#Click "VLC media player" to use VLC just this once, or click "Default program..."
#Click the name of the program (VLC) which you want to be used to open the file.
#*If VLC is not displayed, click Browse to locate it on your hard drive.

Alternatively:
#In Windows Explorer, ''right''-click the file you want to open with VLC.
#Click Properties in the context menu that pops up.
#On the General tab, click Change.
#Click the name of the program (VLC) which you want to be used to open the file.

Either of these options affects all files that have the same filename extension (the letters after the filename's period) as the file you selected. For example, if you change the program that opens ''goober.avi'', then all ''.avi'' files will be opened with VLC.

===Rerun the installer===
#Reinstall VLC and choose the "associate files" option when it comes up. ''Please note'' that on Vista and newer OSes this will not cure the "Windows Media Player won't go away" symptom, and you should go the "Set default program" route instead, as described above.

===Edit the registry===
'''''Warning''''': this instruction set is outdated and should ''not'' be used. Direct registry editing should be avoided anyway unless you're desperate and you really ''really'' know what you're doing.

'''Warning''': use this technique only if you really know what you are doing! And be sure to back-up your registry first.

#Open a text editor, like Notepad (but not WordPad).
#Copy this text below.
#Modify the strings ''C:\\Program Files\\VideoLAN\\VLC\\vlc.exe'' to match your VLC installation.
#Save as ''vlc.reg''.
#Execute ''vlc.reg'' (adding this data to your registry).
#Enjoy VLC :)

Text to copy:
<pre>
Windows Registry Editor Version 5.00

[HKEY_CLASSES_ROOT\.ASF]
@="VlcFile"

[HKEY_CLASSES_ROOT\.ASX]
@="VlcFile"

[HKEY_CLASSES_ROOT\.AVI]
@="VlcFile"

[HKEY_CLASSES_ROOT\.DIVX]
@="VlcFile"

[HKEY_CLASSES_ROOT\.MPEG]
@="VlcFile"

[HKEY_CLASSES_ROOT\.MPG]
@="VlcFile"

[HKEY_CLASSES_ROOT\.VOB]
@="VlcFile"

[HKEY_CLASSES_ROOT\.WMV]
@="VlcFile"

[HKEY_CLASSES_ROOT\VlcFile]
@="VLC File"

[HKEY_CLASSES_ROOT\VlcFile\DefaultIcon]
@="C:\\Program Files\\VideoLAN\\VLC\\vlc.exe,0"

[HKEY_CLASSES_ROOT\VlcFile\shell\Open]
[HKEY_CLASSES_ROOT\VlcFile\shell\Open\command]
@="C:\\Program Files\\VideoLAN\\VLC\\vlc.exe \"%L\""
</pre>

'''Note''': This associates ''asf'', ''asx'', ''avi'', ''divx'', ''mpeg'', ''mpg'', ''vob'' and ''wmv'' files. If you get the idea, you can associate any file you want.

==How To Start VLC Server with 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.

===Step 1: VLC Server Preferences Settings===
1. Set up the http interface details in the VLC server application: Open VLC, then select Tools > Preferences. In the bottom left corner of the window, under "Show settings", click "All".

2. In the left hand menu click on the + button next to Interface. This will display three choices. Control interfaces, Hotkeys settings, and Main Interfaces. Click "Main Interfaces". Select "HTTP remote control interface".

3. Click on the plus button next to "Main interfaces". This will display four settings HTTP, Qt, RC, Skins. Click on HTTP to display the "HTTP remote control interface" settings.

4. Host address: Enter the port number that you want to use. Default is 8080.

5. Source directory: If you have installed VLC in a different folder than the default, enter '''path\to\VLC\'''\http.

6. If you are NOT using handlers or SSL certificates the setup is complete.

7. Click on the Save button in the lower right hand of the window.

8. If needed, edit the .hosts file in the vlc/http directory. By default only "localhost" is allowed, edit to enable other hosts.

9. Exit and restart VLC

===Step 2: Command Line Startup===

The VLC appplication can be run in a server or client environment. For complicated
video and audio streaming on a LAN, one should consider dedicating a machine to act
as the VLC server.

To start the VLC application in a server mode with the http interface automatically
set, use the following command line in your desktop shortcut. This assumes the default
location for installation was selected.

<nowiki>"C:\Program Files\VideoLAN\VLC\vlc.exe" --extraintf http --intf wx</nowiki>

===Step 3: Testing the Interface===

From another computer, connect to the VLC server computer using your browser to the URL

<nowiki>http://server_ip_address:8080, such as http://192.168.0.186:8080</nowiki>

The Main VLC Interface page will be displayed,

See [[Web_Interface]] for additional information

==VLC Plugin for Internet Explorer==

This section will provide guidelines to incorporate the VLC ActiveX plugin to be used to view streaming audio and video from a VLC server.

How to embed the ActiveX Plugin in a Web Page: [[ActiveX/HTML]]

Supported ActiveX Function Calls: [[ActiveX]]

==VLC Plugin for Firefox (Mozilla)==
The Mozilla plugin
(Excerpted from the [[Documentation:Play_HowTo/Advanced_Use_of_VLC#The_Mozilla_plugin|VLC User Guide]])

'''Install'''

There are at least two ways to install the VLC Mozilla Plugin. One way is to to check the "Install Firefox Plugin" when you install VLC.

If the standard exe installation does not install the mozilla plugin directory then download zip version which includes the required data and continue with the next installation (2nd way of installing of the plugin)

The second way involves several steps:

1. Quit Firefox or Mozilla

2. Copy the two files in VLC_Installation_folder\mozilla (usually C:\Program Files\VideoLAN\VLC\mozilla) to your mozilla plugins directory (Usually C:\Program Files\Mozilla\plugins or C:\Program Files\Mozilla Firefox\plugins).

3. Restart Firefox or Mozilla

'''Use the 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.

'''Build HTML pages that use the plugin (VLC version > 0.8.5)'''

Check the [[Documentation:WebPlugin|WebPlugin]] documentation for information on the Javascript API. It's substantially changed since v0.8.5.

More example code, as well as a working implementation using Javascript, XHTML, and PHP that auto-detects browsers (the code is good, but the stream doesn't work) can be found at http://altair.videolan.org/~dionoea/vlc-plugin-demo/

== Related article ==
* [[Common Problems]]
* [[VLC command-line help]]
* [[VLCSout]] how to create a DVD

== Portable VLC ==
A version of VLC in a portable format exists. It is useful, for example, if you want to put it on a USB stick and use it on computers you don't own. It can also be very useful on your own computer: if you have to reinstall Windows, you won't need to reinstall VLC, it will be up and running almost instantly: 
http://portableapps.com/apps/music_video/vlc_portable

[[Category:Operating systems]]

Template:File

2011-09-06T04:56:17Z

Skierpage: See also SVNSourceFile and VLCSourceFile

* [http://git.videolan.org/?p=vlc.git;a=history;f={{{1}}} {{{1}}}] {{#if:{{{2|}}}|({{{2}}})}}

<noinclude>
For linking to source code file. Links to http://git.videolan.org.

== Usage ==
<nowiki>{{file|name|info}}</nowiki>

For example
{{file|modules/mux/dummy.c|Dummy muxer}}
<nowiki>{{file|modules/mux/dummy.c|Dummy muxer}}</nowiki>
{{file|modules/mux/avi.c}}
<nowiki>{{file|modules/mux/avi.c}}</nowiki>

== See also ==
* {{tl|SVNSourceFile}}
* {{tl|VLCSourceFile}}
</noinclude>

Template:File

2011-09-06T04:30:42Z

Skierpage: correct documentation

* [http://git.videolan.org/?p=vlc.git;a=history;f={{{1}}} {{{1}}}] {{#if:{{{2|}}}|({{{2}}})}}

<noinclude>
For linking to source code file. Links to http://git.videolan.org.

Usage:
<nowiki>{{file|name|info}}</nowiki>

eg
{{file|modules/mux/dummy.c|Dummy muxer}}
<nowiki>{{file|modules/mux/dummy.c|Dummy muxer}}</nowiki>
{{file|modules/mux/avi.c}}
<nowiki>{{file|modules/mux/avi.c}}</nowiki>
</noinclude>

Documentation:Advanced Use of VLC

2011-09-06T04:26:07Z

Skierpage: /* GNU/Linux Debian */ also Ubuntu, apt is just one way

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

==== 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:Advanced Use of VLC

2011-09-05T23:07:24Z

Skierpage: /* Use the mozilla plugin */ rewrite this section, mention the plugin has no UI

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

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

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 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:Snapshots

2011-07-14T23:10:53Z

Skierpage: /* Snapshot location, format and name */ location for XP, be consistent with trailing slash

{{RightMenu|documentation play howto toc}}
There are two ways to take snapshots (i.e., screenshots or frame grabs) with VLC:
#Open the ''Video'' menu, and select the ''Snapshot'' menu item.
#Press the snapshot hotkey
#*Linux / Unix: Ctrl-Alt-s
#*Windows (Qt interface): Shift-s
#*Mac OS X: Command-Alt-s

When a snapshot is taken, it will briefly preview as a thumbnail with its filename and then fade away.

To change the hotkey, go to Tools -> Preferences. If "Show settings" is set to Simple, click Hotkeys; if "Show settings" is set All, navigate to Interface -> Hotkeys settings. Set the hotkey for Take video snapshot.

==Snapshot location, format and name==

The snapshot location depends upon your operating system:

*Windows XP: My Documents\My Pictures\

*Windows Vista and 7: C:\Users\''Username''\Pictures\

*Linux / Unix: $(HOME)/.vlc/

*Mac OS X: Desktop/

The default format for snapshots is PNG, but this may be changed to JPEG. Also, the default name for snapshots is ''vlcsnap-'' followed by a timestamp that is ''not'' the time of the frame in the video you're viewing, but rather the current name.

The location, format and name of snapshots may be changed in the ''Preferences'' menu item in the ''Tools'' tab. Also, you may substitute other text for ''vlcsnap-'' in the ''Video snapshot file prefix'' and you may choose to have snapshots numbered sequentially (i.e., 000001, 000002, 000003, and so on) instead of with a timestamp.

As of version 0.9.0, you may even use [[Documentation:Play HowTo/Format String|variables]] in the text used for the filename. For example, ''$T'' (must be upper case) will insert the video's time code into the file name. If you were to change the prefix to ''Friends-$T-'' while watching a DVD of ''Friends'', then the snapshot filenames would look something like this: Friends-00_05_21-00004.png . This indicates a snapshot taken at 5 minutes and 21 seconds into the video; and it was the number 00004 snapshot of the day.

For a full list of variables, please see [[Documentation:Play HowTo/Format String]].

[[File:Basic_snapshots_config.png]]

Configuring snapshot options under Windows

Documentation:Snapshots

2011-07-14T23:09:45Z

Skierpage: rephrase taking snapshot (there's no Video "tab") to be consistent with Documentation:Play_HowTo/Basic_Use/Open

{{RightMenu|documentation play howto toc}}
There are two ways to take snapshots (i.e., screenshots or frame grabs) with VLC:
#Open the ''Video'' menu, and select the ''Snapshot'' menu item.
#Press the snapshot hotkey
#*Linux / Unix: Ctrl-Alt-s
#*Windows (Qt interface): Shift-s
#*Mac OS X: Command-Alt-s

When a snapshot is taken, it will briefly preview as a thumbnail with its filename and then fade away.

To change the hotkey, go to Tools -> Preferences. If "Show settings" is set to Simple, click Hotkeys; if "Show settings" is set All, navigate to Interface -> Hotkeys settings. Set the hotkey for Take video snapshot.

==Snapshot location, format and name==

The snapshot location depends upon your operating system:

*Windows: My Documents\My Pictures\

*Windows Vista and 7: C:\Users\''Username''\Pictures

*Linux / Unix: $(HOME)/.vlc/

*Mac OS X: Desktop/

The default format for snapshots is PNG, but this may be changed to JPEG. Also, the default name for snapshots is ''vlcsnap-'' followed by a timestamp that is ''not'' the time of the frame in the video you're viewing, but rather the current name.

The location, format and name of snapshots may be changed in the ''Preferences'' menu item in the ''Tools'' tab. Also, you may substitute other text for ''vlcsnap-'' in the ''Video snapshot file prefix'' and you may choose to have snapshots numbered sequentially (i.e., 000001, 000002, 000003, and so on) instead of with a timestamp.

As of version 0.9.0, you may even use [[Documentation:Play HowTo/Format String|variables]] in the text used for the filename. For example, ''$T'' (must be upper case) will insert the video's time code into the file name. If you were to change the prefix to ''Friends-$T-'' while watching a DVD of ''Friends'', then the snapshot filenames would look something like this: Friends-00_05_21-00004.png . This indicates a snapshot taken at 5 minutes and 21 seconds into the video; and it was the number 00004 snapshot of the day.

For a full list of variables, please see [[Documentation:Play HowTo/Format String]].

[[File:Basic_snapshots_config.png]]

Configuring snapshot options under Windows

VideoLAN Wiki:Syntax

2011-07-14T23:09:13Z

Skierpage: /* Templates */ better link to view templates, bulleted list

Please follow these guidelines when editing this wiki.
There will be more guidelines later.

== Templates ==

* See the [[List of templates|Documented List of Templates]].
* See [[Special:PrefixIndex/Template:|all templates on {{SERVERNAME}}]]

Documentation:Snapshots

2011-07-14T23:04:12Z

Skierpage: in my VLC 1.1.10 in Windows Vista, the snapshot key is Shift-S ! I give the two paths to Hotkey settings, they might be different for other interfaces.

{{RightMenu|documentation play howto toc}}
There are two ways to take snapshots (i.e., screenshots or frame grabs) with VLC:
#To take a snapshot go to the ''Snapshot'' menu item in the ''Video'' tab
#Press the snapshot hotkey
#*Linux / Unix: Ctrl-Alt-s
#*Windows (Qt interface): Shift-s
#*Mac OS X: Command-Alt-s

When a snapshot is taken, it will briefly preview as a thumbnail with its filename and then fade away.

To change the hotkey, go to Tools -> Preferences. If "Show settings" is set to Simple, click Hotkeys; if "Show settings" is set All, navigate to Interface -> Hotkeys settings. Set the hotkey for Take video snapshot.

==Snapshot location, format and name==

The snapshot location depends upon your operating system:

*Windows: My Documents\My Pictures\

*Windows Vista and 7: C:\Users\''Username''\Pictures

*Linux / Unix: $(HOME)/.vlc/

*Mac OS X: Desktop/

The default format for snapshots is PNG, but this may be changed to JPEG. Also, the default name for snapshots is ''vlcsnap-'' followed by a timestamp that is ''not'' the time of the frame in the video you're viewing, but rather the current name.

The location, format and name of snapshots may be changed in the ''Preferences'' menu item in the ''Tools'' tab. Also, you may substitute other text for ''vlcsnap-'' in the ''Video snapshot file prefix'' and you may choose to have snapshots numbered sequentially (i.e., 000001, 000002, 000003, and so on) instead of with a timestamp.

As of version 0.9.0, you may even use [[Documentation:Play HowTo/Format String|variables]] in the text used for the filename. For example, ''$T'' (must be upper case) will insert the video's time code into the file name. If you were to change the prefix to ''Friends-$T-'' while watching a DVD of ''Friends'', then the snapshot filenames would look something like this: Friends-00_05_21-00004.png . This indicates a snapshot taken at 5 minutes and 21 seconds into the video; and it was the number 00004 snapshot of the day.

For a full list of variables, please see [[Documentation:Play HowTo/Format String]].

[[File:Basic_snapshots_config.png]]

Configuring snapshot options under Windows

Quality

2011-06-28T08:33:38Z

Skierpage: /* Versions roadmaps */ remove obsolete information (version 0.9 and 2007 builds?!)

'''Quality Assurance'''

This section of the wiki is about helping to increase the quality of different versions of VideoLAN's products, mainly [[VLC media player]].

==Why this page ?==
===Main idea===
There is not much on this page yet, but the idea is to develop ''test protocols'', regroup ''test files'', and at the end improve the whole quality of VLC, to avoid ''regressions'' and check ''roadmaps.''

===Who is concerned===
The community of VideoLAN's numerous users and developers can enforce the project by doing systematic tests and reporting bugs and regressions. Some projects rely on a lot of external code that evolves a lot. Being '''numerous''' can help to make it better.

===Bugs===
The '''bugs''' should be tracked down and killed using [http://trac.videolan.org '''trac'''].

==Why should you get involved ?==
The '''more''' we are, the more bugs are spotted, the better VLC is !
Easy, ain't it ?

So if '''you''' help, everyone will be a winner.

==How can you get involved ?==
Use this talk page or contact; for a start [[User_talk:J-b]] (this will change).
Then, just run the tests and modify this wiki's pages.

===Bug reporting===
Use trac to do these. If you compile {{VLC}} yourself, please enable [[debug]] to get readable bactraces if any.

==Urgent==
* Prepare the tests for VLC 0.8.6
* Gather original and references video and audio files

=VLC=
Motto: ''Let's improve VLC !!!''

==Tests to run==
You want to help by testing VLC ? There are a few tests that you can handle:

* VLC playback tests (codecs and files related) Win32 and MacOS focused.

* VLC functionality tests

* VLC transcode and streaming tests

==Files==
=== Official files ===
All those files should be tested inside the reference FTP.

ftp://streams.videolan.org/streams-videolan/

Use that structure to create the reports.

=== More files ===
Where to search for more files:
* MPlayer's [http://samples.mplayerhq.hu/ MPlayer's FTP]
* References codecs pages usually, linking to those should be enough...

==Nightly builds==

In general, use the latest nightly build when you run your tests and report,
available at http://nightlies.videolan.org/.

[[Category:Coding]]