]> git.sesse.net Git - vlc/blob - INSTALL.win32
* INSTALL.win32: added a section about the "make package-win32" rules.
[vlc] / INSTALL.win32
1 $Id$
2
3 INSTALL file for the Windows9x/Me/NT4/2k/XP version of the VLC media player
4
5
6 Running VLC
7 ===========
8
9 If you have already built VLC (see below) or are using a binary release,
10 just run 'vlc.exe'.
11
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'.
15
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.
19
20 Additional documentation is available at http://www.videolan.org/doc/
21
22
23 Building VLC from the source code
24 =================================
25
26 If you want to build VLC from sources, you can do it in several ways:
27
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
30   to do it on Windows.
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).
33
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.
39
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() )
48
49 - or on GNU/Linux, using the mingw32 cross-compiler.
50
51 Getting the right compiler tools
52 ================================
53
54 - cross-compiling with mingw32:
55 You first need to download a GNU/Linux cross-compiler version of mingw32.
56
57 For Debian GNU/Linux users, you can use the mingw32, mingw32-binutils and
58 mingw32-runtime packages.
59
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).
64
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.
69
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).
76
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
81
82 Getting the additional libraries
83 =================================
84
85 VLC depends on other libraries to provide some features like ac3 audio decoding
86 or mpeg4 video decoding, etc...
87
88 Depending on your needs you will have to compile/install some or all of these
89 external libraries.
90
91 They can be found here (source code):
92 http://download.videolan.org/pub/testing/contrib/
93
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-20040229-win32-bin-gcc3.3.1-only.tar.bz2
98
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
101 command: 
102
103   tar xjvf contrib-20040229-win32-bin-gcc3.3.1-only.tar.bz2 -C /
104
105 Please note the "-C /". 
106
107 A complete list of the libraries on which we depend can be found here:
108 http://developers.videolan.org/vlc/
109
110 Configuring the build
111 =====================
112
113 Once you've got all the files you need in place, you need to configure the
114 build with the `./configure' script.
115
116 I'll assume that you are using the pre-compiled 3rd party libraries I'm
117 providing and that they are in /usr/win32.
118
119 If you are cross-compiling from Debian, you can use something
120 along those lines:
121
122   ./bootstrap && \
123   CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
124   LDFLAGS=-L/usr/win32/lib \
125   CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++ \
126   ./configure --host=i586-mingw32msvc --build=i386-linux \
127       --disable-sdl --disable-gtk \
128       --enable-nls \
129       --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
130       --enable-faad \
131       --enable-flac \
132       --enable-theora \
133       --with-wx-config-path=/usr/win32/bin \
134       --with-freetype-config-path=/usr/win32/bin \
135       --with-fribidi-config-path=/usr/win32/bin \
136       --enable-livedotcom --with-livedotcom-tree=/usr/win32/live.com \
137       --enable-caca --with-caca-config-path=/usr/win32/bin \
138       --with-xml2-config-path=/usr/win32/bin \
139       --with-dvdnav-config-path=/usr/win32/bin \
140       --disable-cddax --disable-vcdx \
141       --enable-debug
142
143 If you are cross-compiling with our gcc-3.3.1 package, you can use something
144 along those lines:
145
146   ./bootstrap && \
147   PATH=/usr/local/mingw/bin:$PATH \
148   CPPFLAGS=-I/usr/win32/include \
149   LDFLAGS=-L/usr/win32/lib \
150   CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++ \
151   ./configure --host=i586-mingw32msvc --build=i386-linux \
152       --disable-sdl --disable-gtk \
153       --enable-nls \
154       --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
155       --enable-faad \
156       --enable-flac \
157       --enable-theora \
158       --with-wx-config-path=/usr/win32/bin \
159       --with-freetype-config-path=/usr/win32/bin \
160       --with-fribidi-config-path=/usr/win32/bin \
161       --enable-livedotcom --with-livedotcom-tree=/usr/win32/live.com \
162       --enable-caca --with-caca-config-path=/usr/win32/bin \
163       --with-xml2-config-path=/usr/win32/bin \
164       --with-dvdnav-config-path=/usr/win32/bin \
165       --disable-cddax --disable-vcdx \
166       --enable-debug
167
168 If you are using cygwin, you can build VLC with or without the POSIX
169 emulation layer. Without is usually better and with POSIX emulation
170 hasn't been tested in about a year or so. So to build without the
171 emulation layer, use something like this:
172
173   ./bootstrap && \
174   CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
175   LDFLAGS=-L/usr/win32/lib \
176   CC="gcc -mno-cygwin" CXX="g++ -mno-cygwin" \
177   ./configure \
178       --disable-sdl --disable-gtk \
179       --enable-nls \
180       --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
181       --enable-faad \
182       --enable-flac \
183       --enable-theora \
184       --with-wx-config-path=/usr/win32/bin \
185       --with-freetype-config-path=/usr/win32/bin \
186       --with-fribidi-config-path=/usr/win32/bin \
187       --enable-livedotcom --with-livedotcom-tree=/usr/win32/live.com \
188       --enable-caca --with-caca-config-path=/usr/win32/bin \
189       --with-xml2-config-path=/usr/win32/bin \
190       --with-dvdnav-config-path=/usr/win32/bin \
191       --disable-cddax --disable-vcdx \
192       --enable-debug
193
194 If you want to use the emulation layer, then just omit the CC="gcc -mno-cygwin"
195 CXX="g++ -mno-cygwin" line. You're on your own though.
196
197 If you are compiling with MSYS/MINGW, then you can use something along those
198 lines:
199   ./bootstrap && \
200   CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
201   LDFLAGS=-L/usr/win32/lib \
202   ./configure \
203       --disable-sdl --disable-gtk \
204       --enable-nls \
205       --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
206       --enable-faad \
207       --enable-flac \
208       --enable-theora \
209       --with-wx-config-path=/usr/win32/bin \
210       --with-freetype-config-path=/usr/win32/bin \
211       --with-fribidi-config-path=/usr/win32/bin \
212       --enable-caca --with-caca-config-path=/usr/win32/bin \
213       --with-xml2-config-path=/usr/win32/bin \
214       --with-dvdnav-config-path=/usr/win32/bin \
215       --disable-cddax --disable-vcdx \
216       --disable-mkv \
217       --enable-debug
218
219 See `./configure --help' for more information.
220
221 Actually Compiling the VLC source
222 =================================
223
224 Once configured, to build VLC, just run `make'.
225
226 ( If you are using our gcc-3.3.1 cross-compiler you'll need to use:
227   PATH=/usr/local/mingw/bin:$PATH make )
228
229 Once the compilation is done, you can either run VLC directly from the source
230 tree or you can build self-contained VLC packages with the following
231 'make' rules:
232
233   make package-win32-base
234    will create a subdirectory named vlc-x.x.x with all the binaries
235    'stripped' (ie. without any debugging symbols).
236
237   make package-win32-zip
238    Same as above but will package the directory in a zip file.
239
240   make package-win32
241    Same as above but will also create an auto-installer package. You will need
242    to have NSIS installed in its default location for this to work.
243
244 Well done, now you're ready to use VLC!
245 =======================================