VideoLAN Wiki - User contributions [en]

Win32Compile

2007-03-10T21:42:34Z

EnlightenedTeamster: fix my errors

From http://developers.videolan.org/vlc/vlc/INSTALL.win32

$Id: INSTALL.win32 15707 2006-05-22 09:42:08Z xtophe $
INSTALL file for the Windows9x/Me/NT4/2k/XP version of the VLC media player

==Before you start==

One common desire that leads people to want to rebuild VLC is to "rebuild a debug version" or "add printf()s", but this is not strictly necessary, as VLC includes a debug logging feature by default. If you are using a binary release (or have already built VLC), just run <CODE>'vlc.exe'</CODE> and select "Messages..." from the "View" menu.

You can also run VLC from the Windows command-line interpreter, <CODE>cmd.exe</CODE> (a.k.a. "DOS window"), in which case you'll be able to use the command-line arguments. You can obtain a list of these command line arguments by typing <CODE>'vlc --help'</CODE> or <CODE>'vlc --help --advanced'</CODE>.

To store a debug log of the current VLC session, you can use <CODE>'vlc -vvv --extraintf=logger'</CODE>. You will end-up with a <CODE>vlc-log.txt</CODE> file in your current directory.

==Building VLC from source==

If you want to build VLC from source, you have several choices:

{| class="wikitable"
! Method
! Documentation
! Notes
|-
| Cross-compile with mingw32 on GNU/Linux
| None
| '''Preferred''' cross-compilation method
|-
| Native-compile with [http://www.cygwin.com Cygwin]
| [[Win32CompileCygwin]]
| '''Preferred''' native compilation method
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| [[Win32CompileMSYS]]
| MSYS is a minimal build environment to compile Unixish projects under Microsoft Windows. It provides all the commonly-required Unix tools (like sh, gmake, and so forth). Please note that the gettext utilities are not included in the default MSYS/MINGW packages so you won't be able to build VLC with i18n support.
|-
| Native-compile with Microsoft Visual C++
| None
|
'''Not advised.''' 
Even though VLC includes some MSVC project files, this method is advised only if you just want to experiment/play with some basic functionality in VLC. VLC depends on a lot of third-party libraries and building them in MSVC is inconvenient (and in some cases, impossible). 
If you want to run VLC under the MSVC debugger, use <CODE>--fast-mutex --win9x-cv-method=1</CODE> because the debugger usually loses signals sent by PulseEvent().
|}

==Obtaining the build tools==

Each build method requires its own toolchain:

{| class="wikitable"
! Method
! Notes
|-
| Cross-compile with mingw32 on GNU/Linux
|
*Debian/Ubuntu users can <CODE>apt-get install mingw32 mingw32-binutils</CODE>
*Gentoo users can <CODE>emerge xmingw-gcc xmingw-binutils</CODE>
*Other systems may attempt http://www.mingw.org/mingwfaq.shtml#faq-cross
|-
| Native-compile with [http://www.cygwin.com Cygwin]
| Install Cygwin, adding the optional <CODE>gcc-g++</CODE>, <CODE>gcc-mingw</CODE>, <CODE>mingw-runtime</CODE> and <CODE>win32-api</CODE> packages from the <CODE>Devel</CODE> category.
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| Download and install the latest MSYS, MSYS-DTK, and MINGW from http://www.mingw.org/download.shtml. Begin with the MSYS auto-installer, then extract MINGW into <CODE>C:\MSYS\1.0\MINGW</CODE>. You also have to remember to remove the <CODE>make</CODE> utility included with MINGW as it conflicts with the one from MSYS (just rename or remove <CODE>C:\MSYS\1.0\MINGW\BIN\MAKE.EXE</CODE>).
|}

==Saving time by using pre-built libraries==

VLC requires other open source projects to provide some features (like AC3 audio decoding and MPEG-4 video decoding). A complete list of required libraries from these projects can be found at http://developers.videolan.org/vlc/. Depending on your needs, you must either build your own versions of these libraries or use VLC's convenient pre-built versions.

If you feel you must build these libraries from source, the blessed source code may be found at http://download.videolan.org/pub/testing/contrib/. An automated way of building the contrib libraries is provided in extra/contrib. It will download, configure, and build the libraries. See the extras/contrib/README for more info.

If you want to save yourself time and energy by using the pre-built versions of these libraries, you may download them from http://download.videolan.org/pub/testing/win32/ . The pre-built versions will ''only work with MINGW or Cygwin''. Note that the version you download must match that of the MINGW compiler, <CODE>i586-mingw32msvc-gcc</CODE>, which you can verify by typing <CODE>'i586-mingw32msvc-gcc --ver'</CODE>.

There are two installation strategies:

{| class="wikitable"
! Location
! Command
! Advantages
! Disadvantages
|-
| Install the pre-built libraries into the Cygwin standard directories (/usr/win32/*)
| <CODE>tar jxf contrib-20061122-win32-bin-gcc-3.4.5-only.tar.bz2 -C /</CODE> (Note the <CODE>"-C /"</CODE>!)
|
*Shorter initial setup time
|
*May conflict with other headers/libraries in the standard directories
*Difficult to get rid of if you want to free up space or to upgrade to the next version of the pre-built libraries (Installing over the top of older versions is highly discouraged!)
|-
| Install the pre-built libraries into a project-specific directory (e.g., <CODE>D:\VLC</CODE>)
| <CODE>tar jxf contrib-20061122-win32-bin-gcc-3.4.5-only.tar.bz2 -C /cygdrive/d/VLC</CODE>
|
*No conflicts with other projects built under Cygwin
*Easy to get rid of if you want to free up space or to upgrade to the next version of the pre-built libraries
*For multi-person projects, easy to put under revision control to ensure all project members are using the correct pre-built versions
|
*Requires that you set <CODE>CPPFLAGS</CODE>, <CODE>LDFLAGS</CODE> appropriately when building
*Requires that you modify hard-coded paths in the pre-built libraries (see below)
|}

If installing into a project-specific directory, you must modify some hard-coded paths in the pre-build libraries as follows:
<PRE>
CONTRIBS=/cygdrive/d/VLC
for file in $CONTRIBS/bin/*-config $CONTRIBS/lib/*.la ; do
perl -i.bak -p -e 's|/usr/win32|$ENV{"CONTRIBS"}|g' $file
done
</PRE>

==Configuring the build==

Once you've got all the files you need in place, you need to configure the build with the <CODE>configure</CODE> script. In the following examples, assume that the third-party libraries are installed in <CODE>$CONTRIBS</CODE>. If installed in the Cygwin standard directories, use <CODE>export CONTRIBS=/usr/win32</CODE>. Otherwise use <CODE>export CONTRIBS=/cygdrive/d/VLC</CODE>.

If you are cross-compiling under GNU/Linux, you can use something along these lines:

./bootstrap && \
export PKG_CONFIG_PATH=$CONTRIBS/lib/pkgconfig \
CPPFLAGS="-I$CONTRIBS/include -I$CONTRIBS/include/ebml" CXXCPP=$CPPFLAGS \
LDFLAGS=-L$CONTRIBS/lib \
CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++ \
./configure --host=i586-mingw32msvc --build=i386-linux \
--disable-[[gtk]] \
--enable-[[nls]] --enable-[[sdl]] --with-sdl-config-path=$CONTRIBS/bin \
--enable-[[ffmpeg]] --with-ffmpeg-mp3lame --with-ffmpeg-[[faac]] \
--with-ffmpeg-[[zlib]] --enable-[[faad]] --enable-[[flac]] --enable-[[theora]] \
--with-[[wx]]-config-path=$CONTRIBS/bin \
--with-[[freetype]]-config-path=$CONTRIBS/bin \
--with-[[fribidi]]-config-path=$CONTRIBS/bin \
--enable-[[live555]] --with-live555-tree=$CONTRIBS/live.com \
--enable-[[caca]] --with-caca-config-path=$CONTRIBS/bin \
--with-[[xml2]]-config-path=$CONTRIBS/bin \
--with-[[dvdnav]]-config-path=$CONTRIBS/bin \
--disable-[[cddax]] --disable-[[vcdx]] --enable-[[goom]] \
--enable-[[twolame]] --enable-[[dvdread]] \
--enable-[[debug]]

If you are using cygwin, you can build VLC with or without the POSIX emulation layer. Without is usually better and with POSIX emulation hasn't been tested in over a year. So to build without the emulation layer, use something like this:

./bootstrap && \
export PKG_CONFIG_PATH=$CONTRIBS/lib/pkgconfig \
CPPFLAGS="-I$CONTRIBS/include -I$CONTRIBS/include/ebml" CXXCPP=$CPPFLAGS \
LDFLAGS=-L$CONTRIBS/lib \
CC='gcc -mno-cygwin' CXX='g++ -mno-cygwin' \
./configure \
--disable-gtk \
--enable-nls --enable-sdl --with-sdl-config-path=$CONTRIBS/bin \
--enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
--with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
--with-wx-config-path=$CONTRIBS/bin \
--with-freetype-config-path=$CONTRIBS/bin \
--with-fribidi-config-path=$CONTRIBS/bin \
--enable-live555 --with-live555-tree=$CONTRIBS/live.com \
--enable-caca --with-caca-config-path=$CONTRIBS/bin \
--with-xml2-config-path=$CONTRIBS/bin \
--with-dvdnav-config-path=$CONTRIBS/bin \
--disable-cddax --disable-vcdx --enable-goom \
--enable-twolame --enable-dvdread \
--enable-debug

If you want to use the emulation layer, then just omit <CODE>CFLAGS</CODE> and <CODE>CXXFLAGS</CODE>. You're on your own, though.

If you are compiling with MSYS/MINGW, then you can use something along those lines:
./bootstrap && \
export PKG_CONFIG_PATH=$CONTRIBS/lib/pkgconfig \
CPPFLAGS="-I$CONTRIBS/include -I$CONTRIBS/include/ebml" CXXCPP=$CPPFLAGS \
LDFLAGS=-L$CONTRIBS/lib \
./configure \
--disable-gtk \
--enable-nls --enable-sdl --with-sdl-config-path=$CONTRIBS/bin \
--enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
--with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
--with-wx-config-path=$CONTRIBS/bin \
--with-freetype-config-path=$CONTRIBS/bin \
--with-fribidi-config-path=$CONTRIBS/bin \
--enable-caca --with-caca-config-path=$CONTRIBS/bin \
--with-xml2-config-path=$CONTRIBS/bin \
--with-dvdnav-config-path=$CONTRIBS/bin \
--disable-cddax --disable-vcdx --enable-goom \
--enable-twolame --enable-dvdread \
--disable-[[mkv]] \
--enable-debug

If you have used the "extras/contrib" way, you don't need to specify <CODE>CFLAGS</CODE>, <CODE>LDFLAGS</CODE> and <CODE>--with-foo-config-path=</CODE>.
./bootstrap && \
./configure \
--disable-gtk \
--enable-nls --enable-sdl \
--enable-ffmpeg --enable-faad --enable-flac --enable-theora \
--disable-cddax --disable-vcdx --enable-goom \
--enable-twolame --enable-dvdread \
--enable-mkv --enable-caca --enable-live555\
--enable-debug

See <CODE>'./configure --help'</CODE> for more information.

==Building VLC==

Once configured, to build VLC, just run <CODE>'make'</CODE>.

Once the compilation is done, you can either run VLC directly from the source tree or you can build self-contained VLC packages with the following <CODE>make</CODE> rules:

{| class="wikitable"
! Command
! Description
|-
| <CODE>make package-win32-base</CODE>
| Creates a subdirectory named <CODE>vlc-x.x.x</CODE> with all the binaries 'stripped' (that is, smallest size, unusable with a debugger)
|-
| <CODE>make package-win32-zip</CODE>
| Same as above but will package the directory in a zip file.
|-
| <CODE>make package-win32</CODE>
| Same as above but will also create an auto-installer package. You must have NSIS installed in its default location for this to work.
|}

'''''Well done—you're ready to use VLC!'''''

[[Category:Building]]

Win32Compile

2007-03-09T20:54:41Z

EnlightenedTeamster: copyedit

From http://developers.videolan.org/vlc/vlc/INSTALL.win32

$Id: INSTALL.win32 15707 2006-05-22 09:42:08Z xtophe $
INSTALL file for the Windows9x/Me/NT4/2k/XP version of the VLC media player

==Before you start==

One common desire that leads people to want to rebuild VLC is to "rebuild a debug version" or "add printf()s", but this is not strictly necessary, as VLC includes a debug logging feature by default. If you are using a binary release (or have already built VLC), just run <CODE>'vlc.exe'</CODE> and select "Messages..." from the "View" menu.

You can also run VLC from the Windows command-line interpreter, <CODE>cmd.exe</CODE> (a.k.a. "DOS window"), in which case you'll be able to use the command-line arguments. You can obtain a list of these command line arguments by typing <CODE>'vlc --help'</CODE> or <CODE>'vlc --help --advanced'</CODE>.

To store a debug log of the current VLC session, you can use <CODE>'vlc -vvv --extraintf=logger'</CODE>. You will end-up with a <CODE>vlc-log.txt</CODE> file in your current directory.

==Building VLC from source==

If you want to build VLC from source, you have several choices:

{| class="wikitable"
! Method
! Documentation
! Notes
|-
| Cross-compile with mingw32 on GNU/Linux
| None
| '''Preferred''' cross-compilation method
|-
| Native-compile with [http://www.cygwin.com Cygwin]
| [[Win32CompileCygwin]]
| '''Preferred''' native compilation method
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| [[Win32CompileMSYS]]
| MSYS is a minimal build environment to compile Unixish projects under Microsoft Windows. It provides all the commonly-required Unix tools (like sh, gmake, and so forth). Please note that the gettext utilities are not included in the default MSYS/MINGW packages so you won't be able to build VLC with i18n support.
|-
| Native-compile with Microsoft Visual C++
| None
|
'''Not advised.''' 
Even though VLC includes some MSVC project files, this method is advised only if you just want to experiment/play with some basic functionality in VLC. VLC depends on a lot of third-party libraries and building them in MSVC is inconvenient (and in some cases, impossible). 
If you want to run VLC under the MSVC debugger, use <CODE>--fast-mutex --win9x-cv-method=1</CODE> because the debugger usually loses signals sent by PulseEvent().
|}

==Obtaining the build tools==

Each build method requires its own toolchain:

{| class="wikitable"
! Method
! Notes
|-
| Cross-compile with mingw32 on GNU/Linux
|
*Debian/Ubuntu users can <CODE>apt-get install mingw32 mingw32-binutils</CODE>
*Gentoo users can <CODE>emerge xmingw-gcc xmingw-binutils</CODE>
*Other systems may attempt http://www.mingw.org/mingwfaq.shtml#faq-cross
|-
| Native-compile with [http://www.cygwin.com Cygwin]
| Install Cygwin, adding the optional <CODE>gcc-g++</CODE>, <CODE>gcc-mingw</CODE>, <CODE>mingw-runtime</CODE> and <CODE>win32-api</CODE> packages from the <CODE>Devel</CODE> category.
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| Download and install the latest MSYS, MSYS-DTK, and MINGW from http://www.mingw.org/download.shtml. Begin with the MSYS auto-installer, then extract MINGW into <CODE>C:\MSYS\1.0\MINGW</CODE>. You also have to remember to remove the <CODE>make</CODE> utility included with MINGW as it conflicts with the one from MSYS (just rename or remove <CODE>C:\MSYS\1.0\MINGW\BIN\MAKE.EXE</CODE>).
|}

==Saving time by using pre-built libraries==

VLC requires other open source projects to provide some features (like AC3 audio decoding and MPEG-4 video decoding). A complete list of required libraries from these projects can be found at http://developers.videolan.org/vlc/. Depending on your needs, you must either build your own versions of these libraries or use VLC's convenient pre-built versions.

If you feel you must build these libraries from source, the blessed source code may be found at http://download.videolan.org/pub/testing/contrib/. An automated way of building the contrib libraries is provided in extra/contrib. It will download, configure, and build the libraries. See the extras/contrib/README for more info.

If you want to save yourself time and energy by using the pre-built versions of these libraries, you may download them from http://download.videolan.org/pub/testing/win32/ . The pre-built versions will ''only work with MINGW or Cygwin''. Note that the version you download must match that of the MINGW compiler, <CODE>i586-mingw32msvc-gcc</CODE>, which you can verify by typing <CODE>'i586-mingw32msvc-gcc --ver'</CODE>.

There are two installation strategies:

{| class="wikitable"
! Location
! Command
! Advantages
! Disadvantages
|-
| Install the pre-built libraries into the Cygwin standard directories (/usr/win32/*)
| <CODE>tar jxf contrib-20061122-win32-bin-gcc-3.4.5-only.tar.bz2 -C /</CODE> (Note the <CODE>"-C /"</CODE>!)
|
*Shorter initial setup time
|
*May conflict with other headers/libraries in the standard directories
*Difficult to get rid of if you want to free up space or to upgrade to the next version of the pre-built libraries (Installing over the top of older versions is highly discouraged!)
|-
| Install the pre-built libraries into a project-specific directory (e.g., <CODE>D:\VLC</CODE>)
| <CODE>tar jxf contrib-20061122-win32-bin-gcc-3.4.5-only.tar.bz2 -C /cygdrive/d/VLC</CODE>
|
*No conflicts with other projects built under Cygwin
*Easy to get rid of if you want to free up space or to upgrade to the next version of the pre-built libraries
*For multi-person projects, easy to put under revision control to ensure all project members are using the correct pre-built versions
|
*Requires that you set <CODE>CPPFLAGS</CODE>, <CODE>LDFLAGS</CODE> appropriately
|}

==Configuring the build==

Once you've got all the files you need in place, you need to configure the build with the <CODE>configure</CODE> script. In the following examples, assume that the third-party libraries are installed in <CODE>$CONTRIBS</CODE>. If installed in the Cygwin standard directories, use <CODE>export CONTRIBS=/usr/win32</CODE>. Otherwise use <CODE>export CONTRIBS=/cygdrive/d/VLC</CODE>.

If you are cross-compiling under GNU/Linux, you can use something along these lines:

./bootstrap && \
export PKG_CONFIG_PATH=$CONTRIBS/lib/pkgconfig \
CPPFLAGS="-I$CONTRIBS/include -I$CONTRIBS/include/ebml" CXXCPP=$CPPFLAGS \
LDFLAGS=-L$CONTRIBS/lib \
CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++ \
./configure --host=i586-mingw32msvc --build=i386-linux \
--disable-[[gtk]] \
--enable-[[nls]] --enable-[[sdl]] --with-sdl-config-path=$CONTRIBS/bin \
--enable-[[ffmpeg]] --with-ffmpeg-mp3lame --with-ffmpeg-[[faac]] \
--with-ffmpeg-[[zlib]] --enable-[[faad]] --enable-[[flac]] --enable-[[theora]] \
--with-[[wx]]-config-path=$CONTRIBS/bin \
--with-[[freetype]]-config-path=$CONTRIBS/bin \
--with-[[fribidi]]-config-path=$CONTRIBS/bin \
--enable-[[live555]] --with-live555-tree=$CONTRIBS/live.com \
--enable-[[caca]] --with-caca-config-path=$CONTRIBS/bin \
--with-[[xml2]]-config-path=$CONTRIBS/bin \
--with-[[dvdnav]]-config-path=$CONTRIBS/bin \
--disable-[[cddax]] --disable-[[vcdx]] --enable-[[goom]] \
--enable-[[twolame]] --enable-[[dvdread]] \
--enable-[[debug]]

If you are using cygwin, you can build VLC with or without the POSIX emulation layer. Without is usually better and with POSIX emulation hasn't been tested in about a year or so. So to build without the emulation layer, use something like this:

./bootstrap && \
export PKG_CONFIG_PATH=$CONTRIBS/lib/pkgconfig \
CFLAGS=-mno-cygwin CXXFLAGS=$CFLAGS \
CPPFLAGS="-I$CONTRIBS/include -I$CONTRIBS/include/ebml" CXXCPP=$CPPFLAGS \
LDFLAGS=-L$CONTRIBS/lib \
./configure \
--disable-gtk \
--enable-nls --enable-sdl --with-sdl-config-path=$CONTRIBS/bin \
--enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
--with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
--with-wx-config-path=$CONTRIBS/bin \
--with-freetype-config-path=$CONTRIBS/bin \
--with-fribidi-config-path=$CONTRIBS/bin \
--enable-live555 --with-live555-tree=$CONTRIBS/live.com \
--enable-caca --with-caca-config-path=$CONTRIBS/bin \
--with-xml2-config-path=$CONTRIBS/bin \
--with-dvdnav-config-path=$CONTRIBS/bin \
--disable-cddax --disable-vcdx --enable-goom \
--enable-twolame --enable-dvdread \
--enable-debug

If you want to use the emulation layer, then just omit <CODE>CFLAGS</CODE> and <CODE>CXXFLAGS</CODE>. You're on your own, though.

If you are compiling with MSYS/MINGW, then you can use something along those lines:
./bootstrap && \
export PKG_CONFIG_PATH=$CONTRIBS/lib/pkgconfig \
CPPFLAGS="-I$CONTRIBS/include -I$CONTRIBS/include/ebml" CXXCPP=$CPPFLAGS \
LDFLAGS=-L$CONTRIBS/lib \
./configure \
--disable-gtk \
--enable-nls --enable-sdl --with-sdl-config-path=$CONTRIBS/bin \
--enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
--with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
--with-wx-config-path=$CONTRIBS/bin \
--with-freetype-config-path=$CONTRIBS/bin \
--with-fribidi-config-path=$CONTRIBS/bin \
--enable-caca --with-caca-config-path=$CONTRIBS/bin \
--with-xml2-config-path=$CONTRIBS/bin \
--with-dvdnav-config-path=$CONTRIBS/bin \
--disable-cddax --disable-vcdx --enable-goom \
--enable-twolame --enable-dvdread \
--disable-[[mkv]] \
--enable-debug

If you have used the "extras/contrib" way, you don't need to specify <CODE>CFLAGS</CODE>, <CODE>LDFLAGS</CODE> and <CODE>--with-foo-config-path=</CODE>.
./bootstrap && \
./configure \
--disable-gtk \
--enable-nls --enable-sdl \
--enable-ffmpeg --enable-faad --enable-flac --enable-theora \
--disable-cddax --disable-vcdx --enable-goom \
--enable-twolame --enable-dvdread \
--enable-mkv --enable-caca --enable-live555\
--enable-debug

See <CODE>'./configure --help'</CODE> for more information.

==Building VLC==

Once configured, to build VLC, just run <CODE>'make'</CODE>.

Once the compilation is done, you can either run VLC directly from the source tree or you can build self-contained VLC packages with the following <CODE>make</CODE> rules:

{| class="wikitable"
! Command
! Description
|-
| <CODE>make package-win32-base</CODE>
| Creates a subdirectory named <CODE>vlc-x.x.x</CODE> with all the binaries 'stripped' (that is, smallest size, unusable with a debugger)
|-
| <CODE>make package-win32-zip</CODE>
| Same as above but will package the directory in a zip file.
|-
| <CODE>make package-win32</CODE>
| Same as above but will also create an auto-installer package. You must have NSIS installed in its default location for this to work.
|}

'''''Well done—you're ready to use VLC!'''''

[[Category:Building]]

Win32Compile

2007-03-09T16:31:17Z

EnlightenedTeamster: /* Building VLC from the source code */ copyedit

From http://developers.videolan.org/vlc/vlc/INSTALL.win32

$Id: INSTALL.win32 15707 2006-05-22 09:42:08Z xtophe $
INSTALL file for the Windows9x/Me/NT4/2k/XP version of the VLC media player

==Running VLC with debug==

If you have already built VLC (see below) or are using a binary release, just run 'vlc.exe'.

You can also run VLC from a dos command box, in which case you'll be able to use the command line arguments. You can obtain a list of these command line arguments by typing 'vlc --help' or 'vlc --help --advanced'.

To store a debug log of the current VLC session, you can use 'vlc -vv --extraintf=logger'. You will end-up with a vlc-log.txt file in your current directory.

==Building VLC from the source code==

If you want to build VLC from source, you have several choices:

{| class="wikitable"
! Method
! Documentation
! Notes
|-
| Cross-compile with mingw32 on GNU/Linux
| None
| '''Preferred''' cross-compilation method
|-
| Native-compile with [http://www.cygwin.com Cygwin]
| [[Win32CompileCygwin]]
| '''Preferred''' native compilation method
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| [[Win32CompileMSYS]]
| MSYS is a minimal build environment to compile Unixish projects under Microsoft Windows. It provides all the commonly-required Unix tools (like sh, gmake, and so forth). Please note that the gettext utilities are not included in the default MSYS/MINGW packages so you won't be able to build VLC with i18n support.
|-
| Native-compile with Microsoft Visual C++
| None
|
'''Not advised.''' 
Even though VLC includes some MSVC project files, this method is advised only if you just want to experiment/play with some basic functionality in VLC. VLC depends on a lot of third-party libraries and building them in MSVC is inconvenient (and in some cases, impossible). 
If you want to run VLC under the MSVC debugger, use <PRE>--fast-mutex --win9x-cv-method=1</PRE> because the debugger usually loses signals sent by PulseEvent().
|}

==Getting the right compiler tools==

; cross-compiling with mingw32
: You first need to download a GNU/Linux cross-compiler version of mingw32.
: For Debian GNU/Linux users, you can use the mingw32, mingw32-binutils and mingw32-runtime packages.

; compiling natively on Windows with cygwin
:You will need to download and run the setup.exe app from cygwin's web site (www.cygwin.com). You will also need to make sure you install at least the gcc-g++, gcc-mingw, mingw-runtime and win32-api packages.

; compiling natively on Windows with MSYS+MINGW:
: You will need to download and install the latest MSYS, MSYS-DTK and MINGW. The installation is really easy. Begin with the MSYS auto-installer and once this is done, extract MINGW into c:\msys\1.0\mingw. You also have to remember to remove the make utility included with MINGW as it conflicts with the one from MSYS (just rename or remove c:\msys\1.0\mingw\bin\make.exe).
:* http://www.mingw.org/download.shtml
:* http://prdownloads.sf.net/mingw/MSYS-1.0.9.exe
:* http://prdownloads.sf.net/mingw/MinGW-3.1.0-1.exe
:* http://prdownloads.sf.net/mingw/msysDTK-1.0.1.exe

==Getting the additional libraries==

VLC depends on other libraries to provide some features like ac3 audio decoding or mpeg4 video decoding, etc...

Depending on your needs you will have to compile/install some or all of these
external libraries.

They can be found here (source code):
: http://download.videolan.org/pub/testing/contrib/

We also provide a package with all the libraries already compiled so it is actually really easy to compile a full-featured version of vlc (these compiled libraries will only work with mingw or cygwin):
:http://download.videolan.org/pub/testing/win32/contrib-20061122-win32-bin-gcc-3.4.5-only.tar.bz2 (Check out for more recent versions at the same location). The gcc version mentioned (3.4.5 in this case) is that of i586-mingw32msvc-gcc, which you can verify by typing i586-mingw32msvc-gcc --ver.

All you need to do is extract it in your root directory (the include files and libraries will be put in /usr/win32). You can do this with the following command:
tar -xjvf contrib-20061122-win32-bin-gcc-3.4.5-only.tar.bz2 -C /
Please note the "-C /".

An automated way of building the contrib libraries is provided in extra/contrib. It will download, configure and build the libraries. See the extras/contrib/README for more info.

A complete list of the libraries on which we depend can be found here:
: http://developers.videolan.org/vlc/

==Configuring the build==

Once you've got all the files you need in place, you need to configure the build with the `./configure' script.

I'll assume that you are using the pre-compiled 3rd party libraries I'm providing and that they are in /usr/win32.

If you are cross-compiling from Debian, you can use something along those lines:

./bootstrap && \
PKG_CONFIG_LIBDIR=/usr/win32/lib/pkgconfig \
CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
LDFLAGS=-L/usr/win32/lib \
CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++ \
./configure --host=i586-mingw32msvc --build=i386-linux \
--disable-[[gtk]] \
--enable-[[nls]] --enable-[[sdl]] --with-sdl-config-path=/usr/win32/bin \
--enable-[[ffmpeg]] --with-ffmpeg-mp3lame --with-ffmpeg-[[faac]] \
--with-ffmpeg-[[zlib]] --enable-[[faad]] --enable-[[flac]] --enable-[[theora]] \
--with-[[wx]]-config-path=/usr/win32/bin \
--with-[[freetype]]-config-path=/usr/win32/bin \
--with-[[fribidi]]-config-path=/usr/win32/bin \
--enable-[[live555]] --with-live555-tree=/usr/win32/live.com \
--enable-[[caca]] --with-caca-config-path=/usr/win32/bin \
--with-[[xml2]]-config-path=/usr/win32/bin \
--with-[[dvdnav]]-config-path=/usr/win32/bin \
--disable-[[cddax]] --disable-[[vcdx]] --enable-[[goom]] \
--enable-[[twolame]] --enable-[[dvdread]] \
--enable-[[debug]]

If you are using cygwin, you can build VLC with or without the POSIX emulation layer. Without is usually better and with POSIX emulation hasn't been tested in about a year or so. So to build without the emulation layer, use something like this:

./bootstrap && \
PKG_CONFIG_PATH=/usr/win32/lib/pkgconfig \
CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
LDFLAGS=-L/usr/win32/lib \
CC="gcc -mno-cygwin" CXX="g++ -mno-cygwin" \
./configure \
--disable-gtk \
--enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
--enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
--with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
--with-wx-config-path=/usr/win32/bin \
--with-freetype-config-path=/usr/win32/bin \
--with-fribidi-config-path=/usr/win32/bin \
--enable-live555 --with-live555-tree=/usr/win32/live.com \
--enable-caca --with-caca-config-path=/usr/win32/bin \
--with-xml2-config-path=/usr/win32/bin \
--with-dvdnav-config-path=/usr/win32/bin \
--disable-cddax --disable-vcdx --enable-goom \
--enable-twolame --enable-dvdread \
--enable-debug

If you want to use the emulation layer, then just omit the CC="gcc -mno-cygwin" CXX="g++ -mno-cygwin" line. You're on your own though.

If you are compiling with MSYS/MINGW, then you can use something along those lines:
./bootstrap && \
PKG_CONFIG_PATH=/usr/win32/lib/pkgconfig \
CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
LDFLAGS=-L/usr/win32/lib \
./configure \
--disable-gtk \
--enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
--enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
--with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
--with-wx-config-path=/usr/win32/bin \
--with-freetype-config-path=/usr/win32/bin \
--with-fribidi-config-path=/usr/win32/bin \
--enable-caca --with-caca-config-path=/usr/win32/bin \
--with-xml2-config-path=/usr/win32/bin \
--with-dvdnav-config-path=/usr/win32/bin \
--disable-cddax --disable-vcdx --enable-goom \
--enable-twolame --enable-dvdread \
--disable-[[mkv]] \
--enable-debug

If you have used the "extras/contrib" way, you don't need to precise the CFLAGS, LDFLAGS and --with-foo-config-path=.
./bootstrap && \
./configure \
--disable-gtk \
--enable-nls --enable-sdl \
--enable-ffmpeg --enable-faad --enable-flac --enable-theora \
--disable-cddax --disable-vcdx --enable-goom \
--enable-twolame --enable-dvdread \
--enable-mkv --enable-caca --enable-live555\
--enable-debug

See `./configure --help' for more information.

==Actually Compiling the VLC source==

Once configured, to build VLC, just run `make'.

Once the compilation is done, you can either run VLC directly from the source tree or you can build self-contained VLC packages with the following 'make' rules:

make package-win32-base
will create a subdirectory named vlc-x.x.x with all the binaries 'stripped' (ie. without any debugging symbols).

make package-win32-zip
Same as above but will package the directory in a zip file.

make package-win32
Same as above but will also create an auto-installer package. You will need to have NSIS installed in its default location for this to work.

'''''Well done, now you're ready to use VLC!'''''

[[Category:Building]]

Streaming to ActiveX for Windows Media Player

2007-02-23T19:35:25Z

EnlightenedTeamster: copyedit

==Use case==

*Stream from a webcam on computer A (running Microsoft Windows) to
*Computer B (running Linux) which broadcasts the stream to
*Computer C (running Microsoft Windows) with a web browser and [[Windows Media Player]]

==Procedure==

===Computer A===

Configure your capture device as follows:
*Use a codec that [[Windows Media Player]] recognizes, such as:

{| class="wikitable"
! Type
! Codec
|-
| Video codec
| [[DIV3]] or possibly [[WMV]]
|-
| Audio codec
| [[mp3]]
|-
| Container
| [[ASF]]
|}

*Use communcation settings that Windows Media Player recognizes, such as:
{| class="wikitable"
! Item
! Suggested value
|-
| Transport
| [[MMSH]]
|-
| Address
| Computer A's IP address, say 10.1.2.3
|-
| Port
| Any value over 8000, say 8123
|}

===Computer B===

*Install vlc (e.g., via [http://en.wikipedia.org/wiki/Yellow_dog_Updater%2C_Modified yum]) or build from source
*Invoke vlc with the command line options to stream to via a port (e.g., 8456) on computer B (with IP address 10.4.5.6)
<PRE>
vlc -vvv mmsh://10.1.2.3:8123 --sout='#standard{access=mmsh,mux=asfh,url=10.4.5.6:8456}'
</PRE>
*Embed the following in a web page (e.g., in /home/myaccount/public_html/bcast.htm) to be served from computer B:

<PRE>
<OBJECT id="Player" width="320" height="240" CLASSID="CLSID:6BF52A52-394A-11d3-B153-00C04F79FAA6" type="application/x-oleobject">
<PARAM NAME="URL" VALUE="mms://10.4.5.6:8456">
<PARAM NAME="SendPlayStateChangeEvents" VALUE="True">
<PARAM NAME="AutoStart" VALUE="True">
<PARAM name="uiMode" value="full">
<PARAM name="PlayCount" value="9999">
<PARAM NAME="stretchtofit" value="true">
</OBJECT>
</PRE>

===Computer C===

*Browse the web page from computer B (e.g., <NOWIKI>http://10.4.5.6/~myaccount/bcast.htm</NOWIKI>)

{{stub}}

Documentation:Building Pages for the HTTP Interface

2007-02-16T17:17:42Z

EnlightenedTeamster: /* The ''control'' macro */

==Introduction==

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

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

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

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

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

==VLC macros==

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

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

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

Examples:

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

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

For powerful macros, you may use these tools:

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

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

==The RPN evaluator==

RPN means Reverse Polish Notation.

===Introduction===

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

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

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

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

===Operators===

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

You have access to :
*Standard arithmetics operators: '''+, -, *, /, %''' these ones push the result of ST(1) op ST(2) to the stack
*Binary operators: '''!''' (push !ST(1)); '''^, &, |''': push the result ST(1) op ST(2)
*test: '''=, <, <=, >, >=''': execute ST(1) op ST(2) and push -1 if true else 0
*string functions:
**'''strcat''': pushes the result of 'ST(1)ST(2)
**'''strcmp''': compares ST(1) and ST(2) (0 if equal)
**'''strncmp''': compares the first ST(1) characters of ST(2) and ST(3) (0 if equal)
**'''strsub''': extracts characters ST(1) to ST(2) of streaing ST(3)
**'''strlen''': pushes the length of ST(1)
**'''str_replace''': replaces string ST(2) with ST(1) in ST(3)
**'''url_encode''': encodes non-alphanumeric characters of ST(1) as %XX so that they can be safely passed as GET or POST variables
**'''url_extract''': performs the reverse operation of url_encode
**'''addslashes''': protects single quotes (') and double quotes (") of ST(1) with backslashes (\) so that they can be safely passed to a VLC playlist function
**'''stripslashes''': performs the reverse operation of addslashes
**'''htmlspecialchars''': encodes &, ', ", <, and > of ST(1) as their &stuff; HTML counterpart, so that they don't interact with HTML tags
**'''realpath''': parses ST(1) as a filename path, and pushes an absolute path to that file, removing ~ and ../
*stack manipulation:
**'''dup''': pops ST(1) and pushes the same string twice
**'''drop''': pops ST(1) and drops it
**'''swap''': exchanges ST(1) and ST(2)
**'''flush''': empties the stack
*variables manipulation:
**'''store''': stores ST(2) in a local variable named ST(1)
**'''value''': pushes the value of the local variable named ST(1)
*player control:
**'''vlc_play''': plays the playlist item whose ID is ST(1), and pushes the return value of the play function (0 in case of success); see playlist functions below
**'''vlc_stop''': stops the playlist
**'''vlc_pause''': pauses the playlist
**'''vlc_next''': plays the next playlist item
**'''vlc_previous''': plays the previous playlist item
**'''vlc_seek''': seeks the current input to a location defined in ST(1), for instance+3m (minutes), -20s, 45%, 1:12, 1h12m25s
**'''vlc_var_type''': pushes the type of the variable ST(2) of object ST(1); the type is one of these strings '''VLC_VAR_BOOL, VLC_VAR_INTEGER, VLC_VAR_HOTKEY, VLC_VAR_STRING, VLC_VAR_MODULE, VLC_VAR_FILE, VLC_VAR_DIRECTORY, VLC_VAR_VARIABLE, VLC_VAR_FLOAT, UNDEFINED''' (no such variable) or '''INVALID''' (no input stream); the object is one of '''VLC_OBJECT_ROOT, VLC_OBJECT_VLC, VLC_OBJECT_INTF, VLC_OBJECT_PLAYLIST, VLC_OBJECT_INPUT, VLC_OBJECT_VOUT, VLC_OBJECT_AOUT''' or '''VLC_OBJECT_SOUT'''
**'''vlc_var_set''': sets variable ST(2) of object ST(1) to ST(3)
**'''vlc_var_get''': pushes the value of the variable ST(2) of object ST(1)
**'''vlc_object_exists''': checks if object ST(1) exists
**'''vlc_config_type''': pushes the type of the configuration variable ST(1); see '''vlc_var_type''' for a list of types
**'''vlc_config_set''': sets configuration variable ST(1) to ST(2)
**'''vlc_config_get''': pushes the value of the configuration variable ST(1)
**'''vlc_config_save''': saves the modification made to the configuration variables of module ST(1) to the configuration file (ST(1) may be empty, in which case the whole configuration is saved) and pushes the return status (0 in case of success)
**'''vlc_config_reset''': resets the configuration file to the default value (use with caution)
*playlist functions:
**'''playlist_add''': adds MRL ST(1) to the playlist, with name ST(2) and returns the playlist ID associated to this item; special characters must be escaped with addslashes first; it is very convenient to call 'toto.mpg' playlist_add vlc_play
**'''playlist_empty''': clears the playlist of all items
**'''playlist_move''': moves playlist item at position ST(2) to position ST(1)
**'''playlist_delete''': deletes playlist item ID ST(1)

==The macros==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{{Documentation}}

Documentation:Advanced Use of VLC

2007-02-16T17:16:21Z

EnlightenedTeamster: wikify MRL

==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 UDP stream (sent by VLS or VLC's stream output), start VLC with:

% '''vlc udp:[@:server_port]'''

If you use the default port (1234), '''vlc udp:''' will do. For more information, look at the Streaming Howto.

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

% '''vlc udp:@multicast_address[:server_port]'''

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

% '''vlc udp:server_address@multicast_address[:server_port]'''

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

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 try 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.
*'''--mono''' forces VLC to treat the stream in mono audio.
*'''--volume <integer>''' sets the level of audio output (between 0 and 1024).
*'''--aout-rate <integer>''' sets the audio output frequency (Hz). By default, VLC will try to autodetect this.
*'''--desync <integer>''' compensates desynchronization of audio (ms). (If audio and video streams are not synchronized, use this setting to delay the audio stream)
*'''--audio-filter <string>''' adds audio filters to the processing chain. Available filters are visual (visualizer with spectrum analyzer and oscilloscope), headphone (virtual headphone patialization) and normalizer (volume normalizer)

====Video options====

*'''--novideo''' disables video output.
*'''--greyscale''' 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.
*'''--zoom <float>''' adds a zoom factor.
*'''--aspect-ratio <mode>''' forces source aspect ratio. Modes are 4x3, 16x9, ...
*'''--spumargin <integer>''' forces SPU subtitles postion.
*'''--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.

====Playlist options====

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

====Network options====

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

====CPU options====

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

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

====Miscellaneous options====

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

===Item-specific options===

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

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

Examples:

% '''vlc file1.mpg :fullscreen file2.mpg'''
will play file1.mpg in fullscreen mode and file2.mpg in the default mode (which is generally no fullscreen), whereas
% '''vlc --fullscreen file1.mpg file2.mpg'''
will play both files in fullscreen mode

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

==Advanced use of filters==

===Filters===

These are the old style VLC filters. They only apply to on screen display and thus cannot be streamed.

====Deinterlacing video filter====

Module name: '''deinterlace'''

*'''--deinterlace-mode {discard,blend,mean,bob,linear}''' choose a deinterlacing mode.

====Invert video filter====

Module name: '''invert'''

====Image properties filter====

Module name: '''adjust'''

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

====Wall video filter====

Module name: '''wall'''

This filter splits the output in several windows.

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

====Video transformation filter====

Module name: '''transform'''

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

====Distort video filter====

Module name: '''distort'''

====Clone video filter====

This filter clones the output window.

Module name: '''clone'''

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

====Crop video filter====

Module name: '''crop'''

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

====Motion blur filter====

Module name: '''motionblur'''

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

====Video pictures blending====

Module name: '''blend'''

====Video scaling filter====

Module name: '''scale'''

===Subpictures Filters===

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

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

Module name: '''time'''

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

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

Module name: '''marq'''

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

====Logo video filter====

Module name: '''logo'''

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

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

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

==The HTTP interface==

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

To start VLC with the HTTP interface, use:
% '''vlc -I http [--http-src /directory/] [--http-host host:port]'''

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

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

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

VLC is shipped with a set of files that should be enough for generic needs. It is also possible to customize pages. See [[Documentation:Play_HowTo/Building_Pages_for_the_HTTP_Interface]].

Available pages are:
* '''list was obsolete'''

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

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

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

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''').

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 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 (version < 0.8.5)===

The following API description is only valid uptill version 0.8.5 of the mozilla plugin.

Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the
plugin.

The vlc plugin supports the following function calls:
*'''play()''': Start playing media in the plugin.
*'''pause()''': Pause playback.
*'''stop()''': Stop media playback.
*'''fullscreen()''': Switch the video to full screen.
*'''set_volume(vol)''': Set the volume. '''vol''' has to be an int in the 0-200 range.
*'''get_volume()''': Get the current volume setting.
*'''mute()''': Toggle volume muting.
*'''set_int_variable(var_name, value)''':
*'''set_bool_variable(var_name, value)''':
*'''set_str_variable(var_name, value)''':
*'''get_int_variable(var_name)''':
*'''get_bool_variable(var_name)''':
*'''get_str_variable(var_name)''':
*'''clear_playlist()''': Clear the playlist.
*'''add_item(mrl)''': Append an item whose location is given by the [[media resource locator]] to the playlist.
*'''next()'''
*'''previous()'''
*'''isplaying()''': return true if the plugin is playing something.
*'''get_length()''': Get the media's length in seconds.
*'''get_position()''': Get the current position in the media in percent.
*'''get_time()''': Get the current position in the media in seconds.
*'''seek(seconds,is_relative)''': If is_relative is true, seek relatively to current time, else seek from beginning of the stream. Seek time is specified in seconds.

Here are a few examples of HTML pages that use the
Mozilla plugin.

====Example 1====

In this example, the plugin will read an HTTP stream inside the web page. If the user goes fullscreen, he will have to press ''f'' to go back in normal view.

<html>
<head><title>Demo of VLC mozilla plugin</title></head>

<body>

<h1>Demo of VLC mozilla plugin - Example 1</h1>

<embed type="application/x-vlc-plugin"
name="video1"
autoplay="no" loop="yes" width="400" height="300"
target="http://server.example.org/video1.vob" />
 
<a href="javascript:;" onclick='document.video1.play()'>Play video1</a>
<a href="javascript:;" onclick='document.video1.pause()'>Pause video1</a>
<a href="javascript:;" onclick='document.video1.stop()'>Stop video1</a>
<a href="javascript:;" onclick='document.video1.fullscreen()'>Fullscreen</a>

</body>
</html>

====Example 2====

In this example, the plugin will read a multicast UDP stream in a dedicated video output window.

<html>
<head><title>Demo of VLC mozilla plugin</title></head>

<body>

<h1>Demo of VLC mozilla plugin - Example 2</h1>

<embed type="application/x-vlc-plugin"
name="video2"
autoplay="no" loop="no" hidden="yes"
target="udp:@239.255.12.42" />
 
<a href="javascript:;" onclick='document.video2.play()'>Play video2</a>
<a href="javascript:;" onclick='document.video2.stop()'>Stop video2</a>
<a href="javascript:;" onclick='document.video2.fullscreen()'>Fullscreen</a>

</body>
</html>

===Build HTML pages that use the plugin (version > 0.8.5.1)===

Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the
plugin.

The vlc plugin exports serveral objects that can be accessed for setting and getting information. When used improperly the API's will throw an exception that includes a string that explains what happened. For example when asking for vlc.input.length when there is no playlist item playing.

The vlc plugin knows the following objects:

*'''audio''': Access audio properties.
*'''input''': Access input properties.
*'''playlist''': Access playlist properties.
*'''video''': Access video properties.
*'''log''': Access log properties.
*'''messages''': Access to log message properties.
*'''iterator''': Access to log iterator properties.

The following JavaScript code shows howto get a reference to the vlc plugin. This reference can then be used to access the objects of the vlc plugin.

<html>
<title>VLC Mozilla plugin test page</title>
<body>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org" version="VideoLAN.VLCPlugin.2"
width="640"
height="480"
id="vlc">
</embed>
<script language="Javascript">

</script>
</body>
</html>

====Root object====

readonly properties
*'''VersionInfo''': returns version information string

read/write properties
*''none''

methods
*'''vlc.versionInfo()''': returns version information string

====Audio object====

readonly properties
*''none''

read/write properties
*'''vlc.audio.mute''': boolean value to mute and ummute the audio
*'''vlc.audio.volume''': a value between [0-200] which indicates a percentage of the volume.
*'''vlc.audio.track''': (supported in vlc version > 0.8.6) a value between [0-65535] which indicates the audio track to play or that is playing.
*'''vlc.audio.channel''': (supported in vlc version > 0.8.6) integer value between [1-5] that indicates which audio channel mode is used, values can be: "1=stereo", "2=reverse stereo", "3=left", "4=right", "5=dolby". Use vlc.audio.channel to check if setting of the audio channel mode has succeeded.

Audio Channel:
<SELECT readonly onChange='doAudioChannel(this.value)'>
<OPTION value=1>Stereo</OPTION>
<OPTION value=2>Reverse stereo</OPTION>
<OPTION value=3>Left</OPTION>
<OPTION value=4>Right</OPTION>
<OPTION value=5>Dolby</OPTION>
</SELECT>

<SCRIPT language="javascript">


methods
*'''vlc.audio.toggleMute()''': boolean toggle that mutes and unmutes the audio based upon the previous state

====Input object====

readonly properties
*'''vlc.input.length''': length of the input file in number of milliseconds
*'''vlc.input.fps''': frames per second returned as a float
*'''vlc.input.hasVout''': a boolean that returns true when the video is being displayed, it returns false when video is not displayed

read/write properties
*'''vlc.input.position''': normalized position in multimedia stream item given as a float value between [0.0 - 1.0]
*'''vlc.input.time''': the absolute position in time given in milliseconds, this property can be used to seek through the stream

vlc.input.time = <absolute seek>

vlc.input.time = vlc.input.time + <relative seek>
*'''vlc.input.state''': current state of the input chain given as enumeration (IDLE/CLOSE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4, STOPPING=5, ERROR=6)
*'''vlc.input.rate''': input speed given as float (1.0 for normal speed, 0.5 for half speed, 2.0 for twice as fast, etc.)

methods
*''none''

====Playlist object====

readonly properties
*'''vlc.playlist.itemCount''': number that returns the amount of items currently in the playlist
*'''vlc.playlist.isPlaying''': a boolean that returns true if the current playlist item is playing and false when it is not playing

read/write properties
*''none''

methods
*'''vlc.playlist.add(mrl)''': add a playlist item as [[MRL]]. The MRL must be given as a string.
*'''vlc.playlist.add(mrl,name,options)''': add a playlist item as MRL, with metaname 'name' and options 'options'. All input values must be given as string.
*'''vlc.playlist.play()''': start playing the current playlist item
*'''vlc.playlist.togglePause()''': toggle the pause state for the current playlist item
*'''vlc.playlist.stop()''': stop playing the current playlist item
*'''vlc.playlist.next()''': iterate to the next playlist item
*'''vlc.playlist.prev()''': iterate to the previous playlist item
*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist
*'''vlc.playlist.removeItem(number)''': remove the given item number (which cannot be greater then vlc.playlist.itemCount)

====Video object====

readonly properties
*'''vlc.video.width''': returns the horizontal size of the video
*'''vlc.video.height''': returns the vertical size of the video

read/write properties
*'''vlc.video.fullscreen''': when set to true the video will be displayed in fullscreen mode, when set to false the video will be shown inside the video output size. The property takes a boolean as input.
*'''vlc.video.aspectRatio''': get and set the aspect ratio to use in the video screen. The property takes a string as input value. Valid values are: "1:1", "4:3", "16:9", "16:10", "221:100" and "5:4"

methods
*'''vlc.video.toggleFullscreen()''': toggle the fullscreen mode based on the previous setting

====Log object====

readonly properties
*'''vlc.log.messages''': returns a messages object

read/write properties
*'''vlc.log.verbosity''': write number [-1,0,1,2,3] for changing the verbosity level of the log messages. The numbers have the following meaning: -1 disable, 0 info, 1 error, 2 warning, 3 debug.

methods
*''none''

====Messages object====

readonly properties
*'''messages.count''': returns number of messages in the log
*'''messages.severity''': number that indicates the severity of the log message (0 = info, 1 = error, 2 = warning, 3 = debug)
*'''message.name''': name of VLC module that printed the log message (e.g: main, http, directx, etc...)
*'''message.type''': type of VLC module that printed the log message (eg: input, access, vout, sout, etc...)
*'''message.message''': the message text

read/write properties
*''none''

methods
*'''messages.clear()''': clear the current log buffer. It should be called as frequently as possible to not overflow the plugins logging buffer. Call this method after the log messages of interest are read.
*'''messages.iterator()''': returns a messages iterator object, which is used to iterate over the messages in the log. '''Don't clear the log buffer while holding an iterator object.'''

====Iterator object====

readonly properties
*'''iterator.hasNext''': returns a boolean that indicates when true, that wheter vlc.log.messages.next() returns the next message.

read/write properties
*''none''

methods
*'''iterator.next()''': returns the next message object it the log

{{Documentation}}

OldFAQ

2007-02-16T17:12:59Z

EnlightenedTeamster: /* Unable to play any DVDs */

{{stub}}
Answers to some common problems people encounter with VLC. More help is available in the
* [http://www.videolan.org/doc/ Documentation]
* [http://www.videolan.org/doc/faq/en/videolan-faq-en.html FAQ]
* [[Forum]]

== Installing VLC ==

=== On Mac OS 9 ===

{{faqlink|239006}}
* Sorry, VLC will not work on OS 9, and probably never will. However, Mac OS X is supported - [[Unsupported|Find out Why]]

=== Compiling VLC ===

==== How do I compile VLC? ====

* Look at [http://developers.videolan.org/vlc/ how to compile VLC]. There are pre-compiled (binary / executable) versions [http://www.videolan.org/vlc/ here].

==== Mozilla Firefox Plugin ====

* ''Debian:'' All you need is to download the vlc plugin package - mozilla-plugin-vlc ([http://packages.debian.org/stable/graphics/mozilla-plugin-vlc stable release])
* ''All Linux:'' To make the firefox plugin with the vlc player, you will first need the Firefox Development package (from: [http://packages.ubuntu.com/breezy/devel/firefox-dev ubuntu] ...). Then, when you compile, run ./configure with --enable-mozilla, and if needed with --with-mozilla-sdk-path=''/path_to_firefox_sdk''

==== "Missing header file ffmpeg/avcodec.h" and "Missing header file postproc/postprocess.h" Errors ====

* Make sure that you have all the libraries you need.
* When you run ./configure for [[ffmpeg]], make sure that at least the following flags are set (descriptions of these avaliable from ./configure --help )
./configure --enable-shared --enable-shared-pp --enable-pp --enable-gpl
* The path of ffmpeg is not set. Check if you can locate the file '''libavcodec.pc''' on your computer, and export PKG_CONFIG_PATH to where you found it before running ./configure. For example
export PKG_CONFIG_PATH=/home/you/ffmpeg/

==== "cc1: error: invalid option `tune=opteron'" Error on 64-bit systems ====

* One user writes: "From what I can see, the -mtune flag is not available for this type of processor in man gcc. I had to change the configure options comment out all the lines where they set mcpu or mtune flags.) I don't know if this is the correct way to proceed but was the only way for me to get results fast."

==== "/usr/bin/ld: cannot find -lX11" Error on 64-bit systems ====

* In configure, there is an x_libraries variable there that is set to "/usr/X11R6/lib" (around line 16371). Because it is a 64 bit system, this variable needs to be /usr/X11R6/lib64. After changing that, it should continue compiling.

== Problems Starting VLC ==

=== VLC does not launch on my Mac anymore. What to do? ===

* Please have a look at the [[FAQ_on_MacOSX_only_issues|specific FAQ]], which covers multiple solutions to this issue.

== Error Messages ==

Error messages can be viewed by selecting Messages from the View menu.

=== main private error: no sout mux module matched "ts" ===

* This can be an error if '''libdvbpsi''' was not installed when vlc was compiled. To fix this error, install libdvbpsi; then re-compile vlc. [http://developers.videolan.org/libdvbpsi/ libdvbpsi]

=== main dialogs provider error: no dialogs provider module matched "any" ===

* The solution is found in [http://forum.videolan.org/viewtopic.php?t=14733 the forum]

== Problems playing types of files ==

=== WMV files ===

* Starting with VLC media player 0.8.6, the playback of WMV3-encoded videos is available on all platforms. Please note, that encrypted / DRM-protected video-clips still cannot played. That is because of the nature of DRM and is not about to change, so please do not ask.

=== Real Media files ===

* Realmedia files (.rm, .rpm, etc) are proprietary (ie, copyrighted) file formats, created by RealNetworks. Because of this, VLC can't support them at present.

=== QuickTime Files (.mov) ===

* Mov file doesn't play, but plays ok in QuickTime
** open the url in QuickTime player
** let it decide which datarate is best for your connection
** let it play for a few seconds, then pause it
** open the stream info, copy the url
** open & save that one in VLC

=== Flash Video Files (.flv) ===

* Flash Video support has recently been added (provided through ffmpeg) - to view .flv files you will need version 0.8.4a. Download and install the latest version [http://www.videolan.org/vlc/ here].
* VLC still has problems with a few .flv files. If you have problems playing a file in VLC you might be able to change it to an avi using [[ffmpeg]]. See [[Fixing .flv to .avi with Ffmpeg]].
* VLC 0.8.6 provided enhanced Flash Video support on all platforms, so it is probably worth to update if you experience problems with prior releases.

=== Other Files ===

{{faqlink|238663}}
* Make sure that VLC supports that file - look at the [http://www.videolan.org/vlc/features.html list of supposted formats]

* Make sure that the file isn't corrupted

== VLC and Other Programs ==

=== AMR ===

* To use [http://en.wikipedia.org/wiki/Adaptive_Multi-Rate AMR], you'll need to compile vlc and ffmpeg with amr support yourself. This is because the amr license is not compatible with the vlc license.

=== ratDVD ===

* VLC does not support [http://en.wikipedia.org/wiki/RatDVD ratDVD] and is not going to be, both for political and technical reasons.

== Problems Playing DVDs ==

===Unable to play any DVDs===

{{faqlink|239006}}
* ''Linux:'' To play DVDs with VLC in linux, you need to install the libdvdcss package
* ''Linux:'' Make sure you have access rigths to your DVD player. In linux, you can use chmod to edit access rights to your DVD block device:
** <nowiki>#</nowiki> chmod 666 /dev/dvd
** The videolan FAQ seems to suggest you need write access to this device - is this true? If you know, please edit this entry.
* ''Linux:'' Make sure VLC knows where your DVD drive is located (/dev/dvd usually). Go to Settings | Preferences | Input/Codecs | General and under "Default devices" make sure your dvd drive path is entered in the "Default DVD" box. When you go to open a DVD, you should see something like "dvd:///dev/dvd" as the [[media resource locator]] in the "Open:" box near the top of the Open dialog.

=== Playing DVDs from other Region Codes ===

{{faqlink|239426}}
* The ability to play DVDs from all regions depends mostly on your DVD drive, and testing it is usually the quickest way to find out if your DVD drive can do it. Most newer DVD drives are RPC2 drives, which don't allow raw access to the drive untill the drive firmware has done a regioncheck. VLC uses libdvdcss and it needs raw access to the DVD drive to crack the encryption key. So with these drives it is impossible to circumvent the region protection. (This goes for all software. You will need to flash your drives firmware, but sometimes there is no alternate firmware available for your drive). On other RPC2 drives that DO allow raw access, it might take VLC a long time to crack the key. So just pop the disc in your drive and try it out, while you get a coffee. RPC1 drives should 'always' work regardless of the regioncode.

== Poor Quality Video and Audio ==

=== The video runs but the picture is distorted ===

{{faqlink|238431}}
* ''Linux:'' There is probably a problem with the output layer. There are several ways of troubleshooting it.
** First, try with another output plugin, for instance:
**: % vlc -V sdl
**: % vlc -V x11
** Second, change your screen depth and/or definition. It quite often helps.
** Lastly, if running Unix, have a look at your XFree86 video driver.

=== Video is choppy ===

{{faqlink|238474}}
* Your system may be too slow to decode all pictures. Sometimes, your CPU (computer) really isn't fast enough, but often the situation can be improved by changing your system configuration to be a bit kinder to VLC.
** Quit other programs running in the background
** Turn on DMA on your DVD device:
*** ''Linux:''
***: <nowiki>#</nowiki> hdparm -d1 /dev/dvd
*** ''Windows:'' go to the System section of the control panel, and go to the Hardware manager (it is sometimes in a separate tab, and sometimes, you have to go to the Advanced tab. Then, right-click on your DVD player, and check the DMA checkbox.
** Upgrade to the latest driver for your video board.
** ''Linux:'' you can additionally upgrade your drivers to the latest XFree86 version. If supported, check that the xvideo plug-in is effectively used with:
**: % vlc -vvvv

=== Audio and video are out of sync ===

{{faqlink|238571}}
* If you are [[transcoding]] a file, use the [[audio-sync]] option.
* You can manually set the audio offset while playing (so you can put the audio back in sync). The default keys in Windows are Ctrl+K and Ctrl+L to increase/decrease the delay.
* ''Linux/Unix:'' Try using another audio output plugin and, under Unix, kill esd or artsd if they are running. If the problem is due to the input file, have a look at the "Audio desynchronization compensation" option.

== Problems with Streaming ==

==="main input error: no suitable access module for `rtsp://...'"===

vlc needs livemedia from '''live555.com''' to read rtsp stream this way.

You can check you have it by :

vlc -l | grep live

It should read

livedotcom live.com (RTSP/RTP/SDP) demuxer
livedotcom RTSP/RTP access and demux

If not, you have to install '''livemedia''' and point your compilation to this lib directory :

./configure '''--enable-livedotcom --with-livedotcom-tree=/usr/local/lib/live/'''

===Streaming playlist continuously between files (sout-keep not working)===

you should add gather-module sout-chain, example
vlc *mpeg --sout-keep --sout '#gather:transcode{plapla}:rtp{plapla}'

===Streaming 1 playlist item continuously and change input without stream break===

you can use this kinda vlm.conf file and --sout-keep option
new output1 broadcast enabled loop
setup output1 input "inputfile1.mpeg"
setup output1 input "inputfile2.mpeg"
setup output1 input "/path/to/inputfile3.mpeg"
setup output1 option sout-keep=1
setup output1 option input-repeat=-1
setup output1 output #gather:transcode{etc...}:std{plapal}

control output1 play 2

you then chan telnet into vlm and just command
control output1 play <playlistnumber>
to change streamed input.

===Streaming to Windows Media Player===

See [[Windows Media Player]] for details.

== Problems converting between file formats (transcoding) ==

=== Missing Audio and/or Video ===

* Certain containers (aka muxers) can only hold certain types of video and audio - look at [http://www.videolan.org/streaming/features.html Streaming features]

== VLC Crashes ==

=== General ===

{{faqlink|238592}}
* If VLC crashes, the following steps will help determine the cause.
** Increase the verbosity level (either in the preferences or with a -vvvv command line option) and look at the debug messages (in the terminal or in the Messages window).
* If you are convinced that it is a bug in VLC, have a look at the [http://www.videolan.org/support/bug-reporting.html bug reporting page].

=== When using DirectShow (eg Webcam) ===

{{forum|12394}}
* There was a bug a while back when you tried to stream using a directshow/webcam it would reboot the computer. The fix was to specify the resolution on the command line or in the "Advanced" section when opening the directshow.

== Other Problems ==

=== I only want one VLC player! ===

* To use the same VLC player for all the media files, go to Settings, Preferences, Advanced. The following options should give behavior similar to WMP: minimize # of threads, allow only one running instance, VLC is started from file association, allow only "on" running instance when started from file (typo in v0.8.5).

=== Licensing, legal issues and logo use ===

* Information on this is avaliable on the main videolan website, [http://videolan.org videolan.org]. Also read the [http://www.videolan.org/doc/faq/en/index.html#id238663 Legal concerns] section of the [http://www.videolan.org/doc/faq/en/index.html FAQ].
* This is a wiki site: it is editable by all, so it is best to check to official website.

=== Fixing Strange Behaviour ===

{{faqlink|238992}}
* The first thing to do is to reset the VLC preferences in the preferences dialog of the application and restart VLC. If VLC doesn't even start anymore, delete VLC's configuration file ([[#Configuration File|where is it?]]). Then restart VLC. If it does not get any better, read the rest of this page or FAQ page, or ask for help at the [[forum]].

=== Subtitles Problem ===
* In the File | Open File dialog, select "Use a subtitles file", and enter both the video's filename and the video's subtitle filename.
* If you are having displaying the subtitles, the problem might be an encoding problem. Choose the right encoding for your language and it should fix your problem. You'll find the ISOs here: [http://alis.isoc.org/codage/iso8859/jeuxiso.en.htm]. Once you find a text encoding method that works well for you enter it in Preferences, Input / Codecs, Other codecs, Subtitles then press Save and restart VLC. If you have a specialized language like Hebrew, Arabic, Chinese or Japanese changing the font to a Unicode font will be helpful.

MRL

2007-02-15T23:37:19Z

EnlightenedTeamster: initial version

#REDIRECT [[Media resource locator]]

Media resource locator

2007-02-15T23:35:22Z

EnlightenedTeamster: initial version

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

VLM

2007-02-13T19:49:06Z

EnlightenedTeamster: Redirecting to Documentation:Streaming HowTo/VLM

#REDIRECT [[Documentation:Streaming HowTo/VLM]]

Windows Media Player

2007-02-07T18:57:46Z

EnlightenedTeamster: /* Streaming from VLC */

{{wikipedia|Windows Media Player}}
Windows Media Player is the standard multimedia player for Microsoft® [[Windows]]® systems.

=Supported formats=

According to Microsoft® [http://support.microsoft.com/kb/316992 Knowledge Base Article 316992], Windows Media Player supports the following formats "out of the box":

{| class="wikitable"
! Type
! Supported formats
|-
| Microsoft® media formats
|
*Advanced Systems Format (.asf)
*Audio Visual Interleave (.avi)
*Audio for Windows (.wav)
*Microsoft® Digital Video Recording (.dvr-ms)
*Windows Media Audio (.wma)
*Windows Media Video (.wmv, .wm)
|-
| Microsoft® media metafiles
|
*Advanced Stream Redirector (.asx)
*Windows Media Audio Redirector (.wax)
*Windows Media Download Package (.wmd)
*Windows Media Player Playlist (.wpl)
*Windows Media Redirector (.wmx)
*Windows Media Video Redirector (.wvx)
|-
| ISO/IEC (MPEG)
|
*MPEG-1 (.mpeg, .mpg, .m1v)
*MPEG Audio Layer III (.mp3)
*MPEG Audio Layer II (.mp2, .mpa)
*Metafile Playlist (.m3u)
|-
| Industry standard
|
*Audio Interchange File Format ( .aif, .aifc, .aiff)
*CD Audio Track (.cda)
*Musical Instrument Digital Interface (.mid, .midi, .rmi)
*Sun Microsystems and NeXT (.au, .snd)
|}

=Common Issues=

==MPEG-2 and MPEG-4 playback==

Microsoft® does not bundle codecs for MPEG-2 or MPEG-4 with Windows and recommends purchasing them as part of a "DVD decoder pack" from a third-party vendor.

The symptom associated with a missing codec is Windows Media Player displaying the cryptic "C00D11CD" error code immediately after opening an MPEG-2 or MPEG-4 coded file or stream. At that point, you must purchase the appropriate codec, perhaps from Microsoft's® [http://www.microsoft.com/windows/windowsmedia/player/plugins.aspx list of approved vendors].

==Streaming from VLC==
To date, the only option for streaming from VLC to Windows Media Player is to:
*Transcode the file or feed into [[WMV]] format
*Encapsulate the transcoded stream in the [[ASF]] container format
*Use [[MMS]] or [[MMSH]] for the stream transport

A command-line example may be found in Chapter 4 of the [http://www.videolan.org/doc/streaming-howto/en/ch04.html#id294991 VideoLAN Streaming Howto]. {{forum|255}}.

Otherwise, Windows Media Player does not appear to support streaming for anything other than its proprietary formats.

<BLOCKQUOTE>
"Windows Media Player 9 Series can play files in a wide variety of digital media file formats, but Windows Media Services 9 Series cannot stream all of those files. In certain cases, you may need to convert digital media files into a compatible format before you can stream them." [http://www.microsoft.com/windows/windowsmedia/forpros/server/faq.aspx#2_3]
</BLOCKQUOTE>

Streaming to Windows Media Player over HTTP is supported, but the multimedia stream must be converted to a Microsoft-proprietary format with [http://www.microsoft.com/windows/windowsmedia/9series/encoder/default.aspx Windows Media Encoder] beforehand. [http://www.microsoft.com/windows/windowsmedia/howto/articles/webserver.aspx]

Streaming is known to work with Windows Media Player 9 or higher. In particular, Windows Media Player 8 does not interoperate with VLC. {{forum|5199}}

==Compatability==
If you discover problems with your Windows Media Player please download the latest version:
*[http://www.microsoft.com/windows/windowsmedia/download/default.asp?DispLang=en English]
*[http://www.microsoft.com/windows/windowsmedia/download/default.asp?DispLang=de Deutsch]
*[http://www.microsoft.com/windows/windowsmedia/download/default.asp?DispLang=fr Français]

{{compat}}
[[Category:Player]]

Windows Media Player

2007-02-06T21:22:17Z

EnlightenedTeamster: +WMP8 issue

{{wikipedia|Windows Media Player}}
Windows Media Player is the standard multimedia player for Microsoft® [[Windows]]® systems.

=Supported formats=

According to Microsoft® [http://support.microsoft.com/kb/316992 Knowledge Base Article 316992], Windows Media Player supports the following formats "out of the box":

{| class="wikitable"
! Type
! Supported formats
|-
| Microsoft® media formats
|
*Advanced Systems Format (.asf)
*Audio Visual Interleave (.avi)
*Audio for Windows (.wav)
*Microsoft® Digital Video Recording (.dvr-ms)
*Windows Media Audio (.wma)
*Windows Media Video (.wmv, .wm)
|-
| Microsoft® media metafiles
|
*Advanced Stream Redirector (.asx)
*Windows Media Audio Redirector (.wax)
*Windows Media Download Package (.wmd)
*Windows Media Player Playlist (.wpl)
*Windows Media Redirector (.wmx)
*Windows Media Video Redirector (.wvx)
|-
| ISO/IEC (MPEG)
|
*MPEG-1 (.mpeg, .mpg, .m1v)
*MPEG Audio Layer III (.mp3)
*MPEG Audio Layer II (.mp2, .mpa)
*Metafile Playlist (.m3u)
|-
| Industry standard
|
*Audio Interchange File Format ( .aif, .aifc, .aiff)
*CD Audio Track (.cda)
*Musical Instrument Digital Interface (.mid, .midi, .rmi)
*Sun Microsystems and NeXT (.au, .snd)
|}

=Common Issues=

==MPEG-2 and MPEG-4 playback==

Microsoft® does not bundle codecs for MPEG-2 or MPEG-4 with Windows and recommends purchasing them as part of a "DVD decoder pack" from a third-party vendor.

The symptom associated with a missing codec is Windows Media Player displaying the cryptic "C00D11CD" error code immediately after opening an MPEG-2 or MPEG-4 coded file or stream. At that point, you must purchase the appropriate codec, perhaps from Microsoft's® [http://www.microsoft.com/windows/windowsmedia/player/plugins.aspx list of approved vendors].

==Streaming from VLC==
To date, the only option for streaming from VLC to Windows Media Player is to:
*Transcode the file or feed into [[WMV]] format
*Encapsulate the transcoded stream in the [[ASF]] container format
*Use [[MMS]] or [[MMSH]] for the stream transport

In particular, Windows Media Player does not appear to support UDP, RTSP, or HTTP (except in conjunction with MMSH) transports, MPEG program streams, or MPEG transport streams.

A command-line example may be found in Chapter 4 of the [http://www.videolan.org/doc/streaming-howto/en/ch04.html#id294991 VideoLAN Streaming Howto]. {{forum|255}}.

Streaming is known to work with Windows Media Player 9 or higher. In particular, Windows Media Player 8 does not interoperate with VLC. {{forum|5199}}

==Compatability==
If you discover problems with your Windows Media Player please download the latest version:
*[http://www.microsoft.com/windows/windowsmedia/download/default.asp?DispLang=en English]
*[http://www.microsoft.com/windows/windowsmedia/download/default.asp?DispLang=de Deutsch]
*[http://www.microsoft.com/windows/windowsmedia/download/default.asp?DispLang=fr Français]

{{compat}}
[[Category:Player]]

OldFAQ

2007-02-06T21:13:52Z

EnlightenedTeamster: +Streaming to Windows Media Player

{{stub}}
Answers to some common problems people encounter with VLC. More help is available in the
* [http://www.videolan.org/doc/ Documentation]
* [http://www.videolan.org/doc/faq/en/videolan-faq-en.html FAQ]
* [[Forum]]

== Installing VLC ==

=== On Mac OS 9 ===

{{faqlink|239006}}
* Sorry, VLC will not work on OS 9, and probably never will. However, Mac OS X is supported - [[Unsupported|Find out Why]]

=== Compiling VLC ===

==== How do I compile VLC? ====

* Look at [http://developers.videolan.org/vlc/ how to compile VLC]. There are pre-compiled (binary / executable) versions [http://www.videolan.org/vlc/ here].

==== Mozilla Firefox Plugin ====

* ''Debian:'' All you need is to download the vlc plugin package - mozilla-plugin-vlc ([http://packages.debian.org/stable/graphics/mozilla-plugin-vlc stable release])
* ''All Linux:'' To make the firefox plugin with the vlc player, you will first need the Firefox Development package (from: [http://packages.ubuntu.com/breezy/devel/firefox-dev ubuntu] ...). Then, when you compile, run ./configure with --enable-mozilla, and if needed with --with-mozilla-sdk-path=''/path_to_firefox_sdk''

==== "Missing header file ffmpeg/avcodec.h" and "Missing header file postproc/postprocess.h" Errors ====

* Make sure that you have all the libraries you need.
* When you run ./configure for [[ffmpeg]], make sure that at least the following flags are set (descriptions of these avaliable from ./configure --help )
./configure --enable-shared --enable-shared-pp --enable-pp --enable-gpl
* The path of ffmpeg is not set. Check if you can locate the file '''libavcodec.pc''' on your computer, and export PKG_CONFIG_PATH to where you found it before running ./configure. For example
export PKG_CONFIG_PATH=/home/you/ffmpeg/

==== "cc1: error: invalid option `tune=opteron'" Error on 64-bit systems ====

* One user writes: "From what I can see, the -mtune flag is not available for this type of processor in man gcc. I had to change the configure options comment out all the lines where they set mcpu or mtune flags.) I don't know if this is the correct way to proceed but was the only way for me to get results fast."

==== "/usr/bin/ld: cannot find -lX11" Error on 64-bit systems ====

* In configure, there is an x_libraries variable there that is set to "/usr/X11R6/lib" (around line 16371). Because it is a 64 bit system, this variable needs to be /usr/X11R6/lib64. After changing that, it should continue compiling.

== Problems Starting VLC ==

=== VLC does not launch on my Mac anymore. What to do? ===

* Please have a look at the [[FAQ_on_MacOSX_only_issues|specific FAQ]], which covers multiple solutions to this issue.

== Error Messages ==

Error messages can be viewed by selecting Messages from the View menu.

=== main private error: no sout mux module matched "ts" ===

* This can be an error if '''libdvbpsi''' was not installed when vlc was compiled. To fix this error, install libdvbpsi; then re-compile vlc. [http://developers.videolan.org/libdvbpsi/ libdvbpsi]

=== main dialogs provider error: no dialogs provider module matched "any" ===

* The solution is found in [http://forum.videolan.org/viewtopic.php?t=14733 the forum]

== Problems playing types of files ==

=== WMV files ===

* Starting with VLC media player 0.8.6, the playback of WMV3-encoded videos is available on all platforms. Please note, that encrypted / DRM-protected video-clips still cannot played. That is because of the nature of DRM and is not about to change, so please do not ask.

=== Real Media files ===

* Realmedia files (.rm, .rpm, etc) are proprietary (ie, copyrighted) file formats, created by RealNetworks. Because of this, VLC can't support them at present.

=== QuickTime Files (.mov) ===

* Mov file doesn't play, but plays ok in QuickTime
** open the url in QuickTime player
** let it decide which datarate is best for your connection
** let it play for a few seconds, then pause it
** open the stream info, copy the url
** open & save that one in VLC

=== Flash Video Files (.flv) ===

* Flash Video support has recently been added (provided through ffmpeg) - to view .flv files you will need version 0.8.4a. Download and install the latest version [http://www.videolan.org/vlc/ here].
* VLC still has problems with a few .flv files. If you have problems playing a file in VLC you might be able to change it to an avi using [[ffmpeg]]. See [[Fixing .flv to .avi with Ffmpeg]].
* VLC 0.8.6 provided enhanced Flash Video support on all platforms, so it is probably worth to update if you experience problems with prior releases.

=== Other Files ===

{{faqlink|238663}}
* Make sure that VLC supports that file - look at the [http://www.videolan.org/vlc/features.html list of supposted formats]

* Make sure that the file isn't corrupted

== VLC and Other Programs ==

=== AMR ===

* To use [http://en.wikipedia.org/wiki/Adaptive_Multi-Rate AMR], you'll need to compile vlc and ffmpeg with amr support yourself. This is because the amr license is not compatible with the vlc license.

=== ratDVD ===

* VLC does not support [http://en.wikipedia.org/wiki/RatDVD ratDVD] and is not going to be, both for political and technical reasons.

== Problems Playing DVDs ==

=== Unable to play any DVDs ===

{{faqlink|239006}}
* ''Linux:'' To play DVDs with VLC in linux, you need to install the libdvdcss package
* ''Linux:'' Make sure you have access rigths to your DVD player. In linux, you can use chmod to edit access rights to your DVD block device:
** <nowiki>#</nowiki> chmod 666 /dev/dvd
** The videolan FAQ seems to suggest you need write access to this device - is this true? If you know, please edit this entry.
* ''Linux:'' Make sure VLC knows where your DVD drive is located (/dev/dvd usually). Go to Settings | Preferences | Input/Codecs | General and under "Default devices" make sure your dvd drive path is entered in the "Default DVD" box. When you go to open a DVD, you should see something like "dvd:///dev/dvd" as the Media Resource Locator in the "Open:" box near the top of the Open dialog.

=== Playing DVDs from other Region Codes ===

{{faqlink|239426}}
* The ability to play DVDs from all regions depends mostly on your DVD drive, and testing it is usually the quickest way to find out if your DVD drive can do it. Most newer DVD drives are RPC2 drives, which don't allow raw access to the drive untill the drive firmware has done a regioncheck. VLC uses libdvdcss and it needs raw access to the DVD drive to crack the encryption key. So with these drives it is impossible to circumvent the region protection. (This goes for all software. You will need to flash your drives firmware, but sometimes there is no alternate firmware available for your drive). On other RPC2 drives that DO allow raw access, it might take VLC a long time to crack the key. So just pop the disc in your drive and try it out, while you get a coffee. RPC1 drives should 'always' work regardless of the regioncode.

== Poor Quality Video and Audio ==

=== The video runs but the picture is distorted ===

{{faqlink|238431}}
* ''Linux:'' There is probably a problem with the output layer. There are several ways of troubleshooting it.
** First, try with another output plugin, for instance:
**: % vlc -V sdl
**: % vlc -V x11
** Second, change your screen depth and/or definition. It quite often helps.
** Lastly, if running Unix, have a look at your XFree86 video driver.

=== Video is choppy ===

{{faqlink|238474}}
* Your system may be too slow to decode all pictures. Sometimes, your CPU (computer) really isn't fast enough, but often the situation can be improved by changing your system configuration to be a bit kinder to VLC.
** Quit other programs running in the background
** Turn on DMA on your DVD device:
*** ''Linux:''
***: <nowiki>#</nowiki> hdparm -d1 /dev/dvd
*** ''Windows:'' go to the System section of the control panel, and go to the Hardware manager (it is sometimes in a separate tab, and sometimes, you have to go to the Advanced tab. Then, right-click on your DVD player, and check the DMA checkbox.
** Upgrade to the latest driver for your video board.
** ''Linux:'' you can additionally upgrade your drivers to the latest XFree86 version. If supported, check that the xvideo plug-in is effectively used with:
**: % vlc -vvvv

=== Audio and video are out of sync ===

{{faqlink|238571}}
* If you are [[transcoding]] a file, use the [[audio-sync]] option.
* You can manually set the audio offset while playing (so you can put the audio back in sync). The default keys in Windows are Ctrl+K and Ctrl+L to increase/decrease the delay.
* ''Linux/Unix:'' Try using another audio output plugin and, under Unix, kill esd or artsd if they are running. If the problem is due to the input file, have a look at the "Audio desynchronization compensation" option.

== Problems with Streaming ==

==="main input error: no suitable access module for `rtsp://...'"===

vlc needs livemedia from '''live555.com''' to read rtsp stream this way.

You can check you have it by :

vlc -l | grep live

It should read

livedotcom live.com (RTSP/RTP/SDP) demuxer
livedotcom RTSP/RTP access and demux

If not, you have to install '''livemedia''' and point your compilation to this lib directory :

./configure '''--enable-livedotcom --with-livedotcom-tree=/usr/local/lib/live/'''

===Streaming playlist continuously between files (sout-keep not working)===

you should add gather-module sout-chain, example
vlc *mpeg --sout-keep --sout '#gather:transcode{plapla}:rtp{plapla}'

===Streaming 1 playlist item continuously and change input without stream break===

you can use this kinda vlm.conf file and --sout-keep option
new output1 broadcast enabled loop
setup output1 input "inputfile1.mpeg"
setup output1 input "inputfile2.mpeg"
setup output1 input "/path/to/inputfile3.mpeg"
setup output1 option sout-keep=1
setup output1 option input-repeat=-1
setup output1 output #gather:transcode{etc...}:std{plapal}

control output1 play 2

you then chan telnet into vlm and just command
control output1 play <playlistnumber>
to change streamed input.

===Streaming to Windows Media Player===

See [[Windows Media Player]] for details.

== Problems converting between file formats (transcoding) ==

=== Missing Audio and/or Video ===

* Certain containers (aka muxers) can only hold certain types of video and audio - look at [http://www.videolan.org/streaming/features.html Streaming features]

== VLC Crashes ==

=== General ===

{{faqlink|238592}}
* If VLC crashes, the following steps will help determine the cause.
** Increase the verbosity level (either in the preferences or with a -vvvv command line option) and look at the debug messages (in the terminal or in the Messages window).
* If you are convinced that it is a bug in VLC, have a look at the [http://www.videolan.org/support/bug-reporting.html bug reporting page].

=== When using DirectShow (eg Webcam) ===

{{forum|12394}}
* There was a bug a while back when you tried to stream using a directshow/webcam it would reboot the computer. The fix was to specify the resolution on the command line or in the "Advanced" section when opening the directshow.

== Other Problems ==

=== I only want one VLC player! ===

* To use the same VLC player for all the media files, go to Settings, Preferences, Advanced. The following options should give behavior similar to WMP: minimize # of threads, allow only one running instance, VLC is started from file association, allow only "on" running instance when started from file (typo in v0.8.5).

=== Licensing, legal issues and logo use ===

* Information on this is avaliable on the main videolan website, [http://videolan.org videolan.org]. Also read the [http://www.videolan.org/doc/faq/en/index.html#id238663 Legal concerns] section of the [http://www.videolan.org/doc/faq/en/index.html FAQ].
* This is a wiki site: it is editable by all, so it is best to check to official website.

=== Fixing Strange Behaviour ===

{{faqlink|238992}}
* The first thing to do is to reset the VLC preferences in the preferences dialog of the application and restart VLC. If VLC doesn't even start anymore, delete VLC's configuration file ([[#Configuration File|where is it?]]). Then restart VLC. If it does not get any better, read the rest of this page or FAQ page, or ask for help at the [[forum]].

=== Subtitles Problem ===
* In the File | Open File dialog, select "Use a subtitles file", and enter both the video's filename and the video's subtitle filename.
* If you are having displaying the subtitles, the problem might be an encoding problem. Choose the right encoding for your language and it should fix your problem. You'll find the ISOs here: [http://alis.isoc.org/codage/iso8859/jeuxiso.en.htm]. Once you find a text encoding method that works well for you enter it in Preferences, Input / Codecs, Other codecs, Subtitles then press Save and restart VLC. If you have a specialized language like Hebrew, Arabic, Chinese or Japanese changing the font to a Unicode font will be helpful.

Windows Media Player

2007-02-06T20:37:35Z

EnlightenedTeamster: copyedit

{{wikipedia|Windows Media Player}}
Windows Media Player is the standard multimedia player for Microsoft® [[Windows]]® systems.

=Supported formats=

According to Microsoft® [http://support.microsoft.com/kb/316992 Knowledge Base Article 316992], Windows Media Player supports the following formats "out of the box":

{| class="wikitable"
! Type
! Supported formats
|-
| Microsoft® media formats
|
*Advanced Systems Format (.asf)
*Audio Visual Interleave (.avi)
*Audio for Windows (.wav)
*Microsoft® Digital Video Recording (.dvr-ms)
*Windows Media Audio (.wma)
*Windows Media Video (.wmv, .wm)
|-
| Microsoft® media metafiles
|
*Advanced Stream Redirector (.asx)
*Windows Media Audio Redirector (.wax)
*Windows Media Download Package (.wmd)
*Windows Media Player Playlist (.wpl)
*Windows Media Redirector (.wmx)
*Windows Media Video Redirector (.wvx)
|-
| ISO/IEC (MPEG)
|
*MPEG-1 (.mpeg, .mpg, .m1v)
*MPEG Audio Layer III (.mp3)
*MPEG Audio Layer II (.mp2, .mpa)
*Metafile Playlist (.m3u)
|-
| Industry standard
|
*Audio Interchange File Format ( .aif, .aifc, .aiff)
*CD Audio Track (.cda)
*Musical Instrument Digital Interface (.mid, .midi, .rmi)
*Sun Microsystems and NeXT (.au, .snd)
|}

=Common Issues=

==MPEG-2 and MPEG-4 playback==

Microsoft® does not bundle codecs for MPEG-2 or MPEG-4 with Windows and recommends purchasing them as part of a "DVD decoder pack" from a third-party vendor.

The symptom associated with a missing codec is Windows Media Player displaying the cryptic "C00D11CD" error code immediately after opening an MPEG-2 or MPEG-4 coded file or stream. At that point, you must purchase the appropriate codec, perhaps from Microsoft's® [http://www.microsoft.com/windows/windowsmedia/player/plugins.aspx list of approved vendors].

==Streaming from VLC==
To date, the only option for streaming from VLC to Windows Media Player is to:
*Transcode the file or feed into [[WMV]] format
*Encapsulate the transcoded stream in the [[ASF]] container format
*Use [[MMS]] or [[MMSH]] for the stream transport

In particular, Windows Media Player does not appear to support UDP, RTSP, or HTTP (except in conjunction with MMSH) transports, MPEG program streams, or MPEG transport streams.

A command-line example may be found in Chapter 4 of the [http://www.videolan.org/doc/streaming-howto/en/ch04.html#id294991 VideoLAN Streaming Howto]. {{forum|255}}.

==Compatability==
If you discover problems with your Windows Media Player please download the latest version:
*[http://www.microsoft.com/windows/windowsmedia/download/default.asp?DispLang=en English]
*[http://www.microsoft.com/windows/windowsmedia/download/default.asp?DispLang=de Deutsch]
*[http://www.microsoft.com/windows/windowsmedia/download/default.asp?DispLang=fr Français]

{{compat}}
[[Category:Player]]

MMS

2007-02-06T20:28:30Z

EnlightenedTeamster:

MMS is a proprietary digital media streaming protocol developed by Microsoft. It is supported in [[Windows Media Player]] and Microsoft® Windows® Media Server v4.0 or later.
MMSH is MMS over [[HTTP]].

[[Category:Protocols]]