Merge po file from 0.8.6
[vlc.git] / 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 - compiling natively on Windoze with cygwin:
61 You will need to download and run the setup.exe app from cygwin's web site
62 (www.cygwin.com). You will also need to make sure you install at least the
63 gcc-g++, gcc-mingw, mingw-runtime and win32-api packages.
64
65 - compiling natively on Windoze with MSYS+MINGW:
66 You will need to download and install the latest MSYS, MSYS-DTK and MINGW.
67 The installation is really easy. Begin with the MSYS auto-installer and once
68 this is done, extract MINGW into c:\msys\1.0\mingw. You also have to remember
69 to remove the make utility included with MINGW as it conflicts with the one
70 from MSYS (just rename or remove c:\msys\1.0\mingw\bin\make.exe).
71
72 http://www.mingw.org/download.shtml
73 http://prdownloads.sf.net/mingw/MSYS-1.0.9.exe
74 http://prdownloads.sf.net/mingw/MinGW-3.1.0-1.exe
75 http://prdownloads.sf.net/mingw/msysDTK-1.0.1.exe
76
77 Getting the additional libraries
78 =================================
79
80 VLC depends on other libraries to provide some features like ac3 audio decoding
81 or mpeg4 video decoding, etc...
82
83 Depending on your needs you will have to compile/install some or all of these
84 external libraries.
85
86 * They can be found here (source code):
87   http://download.videolan.org/pub/testing/contrib/
88
89 * We also provide a package with all the libraries already compiled so it is
90   actually really easy to compile a full-featured version of vlc (these compiled
91   libraries will only work with mingw or cygwin):
92   http://download.videolan.org/pub/testing/win32/contrib-20060330-win32-bin-gcc-3.4.5-only.tar.bz2
93   (Check out for more recent versions at the same location). 
94
95   All you need to do is extract it in your root directory (the include files
96   and libraries will be put in /usr/win32). You can do this with the following
97   command: 
98
99     tar xjvf contrib-20060330-win32-bin-gcc-3.4.5-only.tar.bz2 -C /
100
101   Please note the "-C /". 
102
103 * An automated way of building the contrib libraries is provided in 
104   extra/contrib. It will download, configure and build the libraries.
105   See the extras/contrib/README for more info.
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   PKG_CONFIG_LIBDIR=/usr/win32/lib/pkgconfig \
124   CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
125   LDFLAGS=-L/usr/win32/lib \
126   CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++ \
127   ./configure --host=i586-mingw32msvc --build=i386-linux \
128       --disable-gtk \
129       --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
130       --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
131       --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
132       --with-wx-config-path=/usr/win32/bin \
133       --with-freetype-config-path=/usr/win32/bin \
134       --with-fribidi-config-path=/usr/win32/bin \
135       --enable-live555 --with-live555-tree=/usr/win32/live.com \
136       --enable-caca --with-caca-config-path=/usr/win32/bin \
137       --with-xml2-config-path=/usr/win32/bin \
138       --with-dvdnav-config-path=/usr/win32/bin \
139       --disable-cddax --disable-vcdx --enable-goom \
140       --enable-twolame --enable-dvdread \
141       --enable-debug
142
143 If you are using cygwin, you can build VLC with or without the POSIX
144 emulation layer. Without is usually better and with POSIX emulation
145 hasn't been tested in about a year or so. So to build without the
146 emulation layer, use something like this:
147
148   ./bootstrap && \
149   PKG_CONFIG_PATH=/usr/win32/lib/pkgconfig \
150   CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
151   LDFLAGS=-L/usr/win32/lib \
152   CC="gcc -mno-cygwin" CXX="g++ -mno-cygwin" \
153   ./configure \
154       --disable-gtk \
155       --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
156       --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
157       --with-ffmpeg-zlib --enable-faad --enable-flac --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-live555 --with-live555-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 --enable-goom \
166       --enable-twolame --enable-dvdread \
167       --enable-debug
168
169 If you want to use the emulation layer, then just omit the CC="gcc -mno-cygwin"
170 CXX="g++ -mno-cygwin" line. You're on your own though.
171
172 If you are compiling with MSYS/MINGW, then you can use something along those
173 lines:
174   ./bootstrap && \
175   PKG_CONFIG_PATH=/usr/win32/lib/pkgconfig \
176   CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
177   LDFLAGS=-L/usr/win32/lib \
178   ./configure \
179       --disable-gtk \
180       --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
181       --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
182       --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
183       --with-wx-config-path=/usr/win32/bin \
184       --with-freetype-config-path=/usr/win32/bin \
185       --with-fribidi-config-path=/usr/win32/bin \
186       --enable-caca --with-caca-config-path=/usr/win32/bin \
187       --with-xml2-config-path=/usr/win32/bin \
188       --with-dvdnav-config-path=/usr/win32/bin \
189       --disable-cddax --disable-vcdx --enable-goom \
190       --enable-twolame --enable-dvdread \
191       --disable-mkv \
192       --enable-debug
193
194 If you have used the "extras/contrib" way, you don't need to precise 
195 the CFLAGS, LDFLAGS and --with-foo-config-path=.
196  ./bootstrap && \
197   ./configure \
198       --disable-gtk \
199       --enable-nls --enable-sdl \
200       --enable-ffmpeg --enable-faad --enable-flac --enable-theora \
201       --disable-cddax --disable-vcdx --enable-goom \
202       --enable-twolame --enable-dvdread \
203       --enable-mkv --enable-caca --enable-live555\
204       --enable-debug
205
206
207 See `./configure --help' for more information.
208
209 Actually Compiling the VLC source
210 =================================
211
212 Once configured, to build VLC, just run `make'.
213
214 Once the compilation is done, you can either run VLC directly from the source
215 tree or you can build self-contained VLC packages with the following
216 'make' rules:
217
218   make package-win32-base
219    will create a subdirectory named vlc-x.x.x with all the binaries
220    'stripped' (ie. without any debugging symbols).
221
222   make package-win32-zip
223    Same as above but will package the directory in a zip file.
224
225   make package-win32
226    Same as above but will also create an auto-installer package. You will need
227    to have NSIS installed in its default location for this to work.
228
229 Well done, now you're ready to use VLC!
230 =======================================