3 INSTALL file for the Windows9x/Me/NT4/2k/XP version of the VLC media player
9 If you have already built VLC (see below) or are using a binary release,
12 You can also run VLC from a dos command box, in which case you'll be able
13 to use the command line arguments. You can obtain a list of these command
14 line arguments by typing 'vlc --help' or 'vlc --help --advanced'.
16 To store a debug log of the current VLC session, you can use
17 'vlc -vv --extraintf=logger'. You will end-up with a vlc-log.txt file in
18 your current directory.
20 Additional documentation is available at http://www.videolan.org/doc/
23 Building VLC from the source code
24 =================================
26 If you want to build VLC from sources, you can do it in several ways:
28 - natively on Windows, using cygwin (www.cygwin.com) with or without the
29 POSIX emulation layer. This is the preferred way to compile vlc if you want
31 NOTE: This is the PREFERRED way of building VLC natively (the others
32 are not as much tested so expect more difficulties with them).
34 - natively on Windows, using MSYS+MINGW (www.mingw.org)
35 (MSYS is a minimal build environment to compile Unixish projects under
36 windoze. It provides all the common Unix tools like sh, gmake...)
37 Please note that the gettext utilities are not included in the default
38 MSYS/MINGW packages so you won't be able to build VLC with i18n support.
40 - natively on Windows, using Microsoft Visual C++. Even though we provide some
41 msvc project files with vlc, this method is advised only if you just want to
42 experiment/play with some basic functionality in vlc. The reason for this
43 is that vlc depends on a lot of 3rd party libraries and building them in
44 MSVC is not convenient and sometimes even impossible.
45 ( NOTE: if you want to run vlc under the msvc debugger, you need to run it
46 with the --fast-mutex --win9x-cv-method=1 options because the debugger
47 usually loses signals sent by PulseEvent() )
49 - or on GNU/Linux, using the mingw32 cross-compiler.
51 Getting the right compiler tools
52 ================================
54 - cross-compiling with mingw32:
55 You first need to download a GNU/Linux cross-compiler version of mingw32.
57 For Debian GNU/Linux users, you can use the mingw32, mingw32-binutils and
58 mingw32-runtime packages.
60 Or you can use our mingw32 gcc-3.3.1 cross-compiler package:
61 http://www.videolan.org/pub/testing/win32/mingw-gcc3.3.1-linux-crosscompiler.tar.bz2 (requires libc6 >= 2.3.2).
62 You will need to extract this package in your root directory (everything will
63 be extracted in /usr/local/cross-tools).
65 - compiling natively on Windoze with cygwin:
66 You will need to download and run the setup.exe app from cygwin's web site
67 (www.cygwin.com). You will also need to make sure you install at least the
68 gcc-g++, gcc-mingw, mingw-runtime and win32-api packages.
70 - compiling natively on Windoze with MSYS+MINGW:
71 You will need to download and install the latest MSYS, MSYS-DTK and MINGW.
72 The installation is really easy. Begin with the MSYS auto-installer and once
73 this is done, extract MINGW into c:\msys\1.0\mingw. You also have to remember
74 to remove the make utility included with MINGW as it conflicts with the one
75 from MSYS (just rename or remove c:\msys\1.0\mingw\bin\make.exe).
77 http://www.mingw.org/download.shtml
78 http://prdownloads.sf.net/mingw/MSYS-1.0.9.exe
79 http://prdownloads.sf.net/mingw/MinGW-3.1.0-1.exe
80 http://prdownloads.sf.net/mingw/msysDTK-1.0.1.exe
82 Getting the additional libraries
83 =================================
85 VLC depends on other libraries to provide some features like ac3 audio decoding
86 or mpeg4 video decoding, etc...
88 Depending on your needs you will have to compile/install some or all of these
91 * They can be found here (source code):
92 http://download.videolan.org/pub/testing/contrib/
94 * We also provide a package with all the libraries already compiled so it is
95 actually really easy to compile a full-featured version of vlc (these compiled
96 libraries will only work with mingw or cygwin):
97 http://download.videolan.org/pub/testing/win32/contrib-20040902-win32-bin-gcc3.3.1-only.tar.bz2 (Check out fo more recent versions at the same location).
99 All you need to do is extract it in your root directory (the include files
100 and libraries will be put in /usr/win32). You can do this with the following
103 tar xjvf contrib-20040902-win32-bin-gcc3.3.1-only.tar.bz2 -C /
105 Please note the "-C /".
107 * An automated way of building the contrib libraries is provided in
108 extra/contrib. It will download, configure and build the libraries.
109 See the extras/contrib/README for more info.
111 A complete list of the libraries on which we depend can be found here:
112 http://developers.videolan.org/vlc/
114 Configuring the build
115 =====================
117 Once you've got all the files you need in place, you need to configure the
118 build with the `./configure' script.
120 I'll assume that you are using the pre-compiled 3rd party libraries I'm
121 providing and that they are in /usr/win32.
123 If you are cross-compiling from Debian, you can use something
127 PKG_CONFIG_LIBDIR=/usr/win32/lib/pkgconfig \
128 CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
129 LDFLAGS=-L/usr/win32/lib \
130 CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++ \
131 ./configure --host=i586-mingw32msvc --build=i386-linux \
133 --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
134 --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
135 --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
136 --with-wx-config-path=/usr/win32/bin \
137 --with-freetype-config-path=/usr/win32/bin \
138 --with-fribidi-config-path=/usr/win32/bin \
139 --enable-livedotcom --with-livedotcom-tree=/usr/win32/live.com \
140 --enable-caca --with-caca-config-path=/usr/win32/bin \
141 --with-xml2-config-path=/usr/win32/bin \
142 --with-dvdnav-config-path=/usr/win32/bin \
143 --disable-cddax --disable-vcdx --enable-goom \
144 --enable-twolame --enable-dvdread \
147 If you are cross-compiling with our gcc-3.3.1 package, you can use something
151 PATH=/usr/local/mingw/bin:$PATH \
152 PKG_CONFIG_LIBDIR=/usr/win32/lib/pkgconfig \
153 CPPFLAGS=-I/usr/win32/include \
154 LDFLAGS=-L/usr/win32/lib \
155 CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++ \
156 ./configure --host=i586-mingw32msvc --build=i386-linux \
158 --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
159 --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
160 --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
161 --with-wx-config-path=/usr/win32/bin \
162 --with-freetype-config-path=/usr/win32/bin \
163 --with-fribidi-config-path=/usr/win32/bin \
164 --enable-livedotcom --with-livedotcom-tree=/usr/win32/live.com \
165 --enable-caca --with-caca-config-path=/usr/win32/bin \
166 --with-xml2-config-path=/usr/win32/bin \
167 --with-dvdnav-config-path=/usr/win32/bin \
168 --disable-cddax --disable-vcdx --enable-goom \
169 --enable-twolame --enable-dvdread \
172 If you are using cygwin, you can build VLC with or without the POSIX
173 emulation layer. Without is usually better and with POSIX emulation
174 hasn't been tested in about a year or so. So to build without the
175 emulation layer, use something like this:
178 PKG_CONFIG_PATH=/usr/win32/lib/pkgconfig \
179 CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
180 LDFLAGS=-L/usr/win32/lib \
181 CC="gcc -mno-cygwin" CXX="g++ -mno-cygwin" \
184 --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
185 --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
186 --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
187 --with-wx-config-path=/usr/win32/bin \
188 --with-freetype-config-path=/usr/win32/bin \
189 --with-fribidi-config-path=/usr/win32/bin \
190 --enable-livedotcom --with-livedotcom-tree=/usr/win32/live.com \
191 --enable-caca --with-caca-config-path=/usr/win32/bin \
192 --with-xml2-config-path=/usr/win32/bin \
193 --with-dvdnav-config-path=/usr/win32/bin \
194 --disable-cddax --disable-vcdx --enable-goom \
195 --enable-twolame --enable-dvdread \
198 If you want to use the emulation layer, then just omit the CC="gcc -mno-cygwin"
199 CXX="g++ -mno-cygwin" line. You're on your own though.
201 If you are compiling with MSYS/MINGW, then you can use something along those
204 PKG_CONFIG_PATH=/usr/win32/lib/pkgconfig \
205 CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
206 LDFLAGS=-L/usr/win32/lib \
209 --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
210 --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
211 --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
212 --with-wx-config-path=/usr/win32/bin \
213 --with-freetype-config-path=/usr/win32/bin \
214 --with-fribidi-config-path=/usr/win32/bin \
215 --enable-caca --with-caca-config-path=/usr/win32/bin \
216 --with-xml2-config-path=/usr/win32/bin \
217 --with-dvdnav-config-path=/usr/win32/bin \
218 --disable-cddax --disable-vcdx --enable-goom \
219 --enable-twolame --enable-dvdread \
223 If you have used the "extras/contrib" way, you don't need to precise
224 the CFLAGS, LDFLAGS and --with-foo-config-path=.
228 --enable-nls --enable-sdl \
229 --enable-ffmpeg --enable-faad --enable-flac --enable-theora \
230 --disable-cddax --disable-vcdx --enable-goom \
231 --enable-twolame --enable-dvdread \
232 --enable-mkv --enable-caca \
236 See `./configure --help' for more information.
238 Actually Compiling the VLC source
239 =================================
241 Once configured, to build VLC, just run `make'.
243 ( If you are using our gcc-3.3.1 cross-compiler you'll need to use:
244 PATH=/usr/local/mingw/bin:$PATH make )
246 Once the compilation is done, you can either run VLC directly from the source
247 tree or you can build self-contained VLC packages with the following
250 make package-win32-base
251 will create a subdirectory named vlc-x.x.x with all the binaries
252 'stripped' (ie. without any debugging symbols).
254 make package-win32-zip
255 Same as above but will package the directory in a zip file.
258 Same as above but will also create an auto-installer package. You will need
259 to have NSIS installed in its default location for this to work.
261 Well done, now you're ready to use VLC!
262 =======================================