* INSTALL.win32: finally updated the instructions on how to build vlc for win32 :)
[vlc.git] / INSTALL.win32
1 $Id: INSTALL.win32,v 1.14 2003/05/17 23:57:35 gbazin Exp $
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 If you want to play a DVD, run VLC and click on the Disc option in the
21 interface. You then have to type your drive letter followed by a colon in
22 the 'Device name' box (eg. 'D:' if this is the letter for your dvdrom drive).
23
24 Additional documentation is available at http://www.videolan.org/doc/
25
26
27 Building VLC from the source code
28 =================================
29
30 If you want to build VLC from sources, you can do it in several ways:
31
32 - natively on Windows, using cygwin (www.cygwin.com) with or without the
33   unix emulation layer. This is the prefered way to compile vlc if you want
34   to do it on Windows.
35
36 - natively on Windows, using MSYS+MINGW (www.mingw.org)
37   (MSYS is a minimal build environnement to compile unixish projects under
38   windoze. It provides all the common unix tools like sh, gmake...)
39   Please note that there is currenlty a bug in MSYS which requires you to
40   edit the acgeneral.m4 file and replace the value of ac_max_sed_lines to
41   something higher, for instance 976.
42
43 - natively on Windows, using Microsoft Visual C++. Even though we provide some
44   msvc project files with vlc, this method is advised only if you just want to
45   experiment/play with some basic functionnalities in vlc. The reason for this
46   is that vlc depends on a lot of 3rd party libraries and building them in
47   MSVC is not convenient and sometimes even impossible.
48
49 - or on 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 linux cross-compiler version of mingw32.
56 (for Debian GNU/Linux users, you can use the mingw32, mingw32-binutils and
57 mingw32-runtime packages)
58
59 - compiling natively on Windoze with cygwin:
60 You will need to download and run the setup.exe app from cygwin's web site
61 (www.cygwin.com). You will also need to make sure you install at least the
62 gcc-mingw, mingw-runtime and w32api packages.
63
64 - compiling natively on Windoze with MSYS+MINGW:
65 You will need to download and install the latest MSYS, MSYS-DTK and MINGW.
66 The installation is really easy. Begin with the MSYS auto-installer and once
67 this is done, extract MINGW into c:\msys\1.0\mingw. You also have to remember
68 to remove the make utility included with MINGW as it conflicts with the one
69 from MSYS (just rename or remove c:\msys\1.0\mingw\bin\make.exe).
70
71 http://www.mingw.org/download.shtml
72 http://prdownloads.sf.net/mingw/MSYS-1.0.9-2003.14.18-1.exe
73 http://prdownloads.sf.net/mingw/MinGW-2.0.0-3.exe
74 http://prdownloads.sf.net/mingw/msysDTK-1.0.1.exe
75
76 Getting the additionnal libraries
77 =================================
78
79 VLC depends on other libraries to provide some features like ac3 audio decoding
80 or mpeg4 video decoding, etc...
81
82 Depending on your needs you will have to compile/install some or all of these
83 external libraries.
84
85 They can be found here (source code):
86 http://www.videolan.org/pub/testing/contrib/
87
88 I also provide a package with all the libraries already compiled so it is
89 actually really easy to compile a full-featured version of vlc (these compiled
90 libraries will only work with mingw or cygwin):
91 http://www.videolan.org/pub/testing/win32/contrib-20030420-win32-bin.tar.bz2
92 All you need to do is extract it in your root directory (the include files
93 and libraries will be put in /usr/win32)
94
95 A complete list of the libraries on which we depend can be found here:
96 http://developers.videolan.org/vlc/
97
98 Configuring the build
99 =====================
100
101 Once you've got all the files you need in place, you need to configure the
102 build with the `./configure' script.
103
104 I'll assume that you are using the pre-compiled 3rd party libraries I'm
105 providing and that they are in /usr/win32.
106
107 If you are cross-compiling from Debian, you can use something
108 along those lines:
109
110   ./bootstrap && \
111   CPPFLAGS=-I/usr/win32/include LDFLAGS=-L/usr/win32/lib \
112   CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++ \
113   ./configure --host=i586-mingw32msvc --build=i386-linux \
114       --disable-sdl --disable-gtk \
115       --with-included-gettext --enable-nls \
116       --enable-mad \
117       --enable-ffmpeg \
118       --enable-dvdread --enable-dvdplay \
119       --enable-faad \
120       --enable-flac \
121       --enable-theora \
122       --with-wx-config-path=/usr/win32/bin \
123       --with-skins-wx-config-path=/usr/win32/bin \
124       --with-freetype-config-path=/usr/win32/bin \
125       --enable-debug
126
127 If you are using cygwin, you can build VLC with or without the unix emulation
128 layer (without is usually better). To build without the emulaion layer, use
129 something like this:
130   ./bootstrap && \
131   CPPFLAGS=-I/usr/win32/include LDFLAGS=-L/usr/win32/lib \
132   CC="gcc -mno-cygwin" CXX="g++ -mno-cygwin" \
133   ./configure \
134       --disable-sdl --disable-gtk \
135       --with-included-gettext --enable-nls \
136       --enable-mad \
137       --enable-ffmpeg \
138       --enable-dvdread --enable-dvdplay \
139       --enable-faad \
140       --enable-flac \
141       --enable-theora \
142       --with-wx-config-path=/usr/win32/bin \
143       --with-skins-wx-config-path=/usr/win32/bin \
144       --with-freetype-config-path=/usr/win32/bin \
145       --enable-debug
146
147 If you want to use the emulation layer, then just omit the CC="gcc -mno-cygwin"
148 CXX="g++ -mno-cygwin" line.
149
150 If you are compiling with MSYS/MINGW, then you can use something along those
151 lines:
152   ./bootstrap && \
153   CPPFLAGS=-I/usr/win32/include LDFLAGS=-L/usr/win32/lib \
154   ./configure \
155       --disable-sdl --disable-gtk \
156       --with-included-gettext --enable-nls \
157       --enable-mad \
158       --enable-ffmpeg \
159       --enable-dvdread --enable-dvdplay \
160       --enable-faad \
161       --enable-flac \
162       --enable-theora \
163       --with-wx-config-path=/usr/win32/bin \
164       --with-skins-wx-config-path=/usr/win32/bin \
165       --with-freetype-config-path=/usr/win32/bin \
166       --enable-debug
167
168 See `./configure --help' for more information.
169
170 Actually Compiling the VLC source
171 =================================
172
173 Once configured, to build VLC, just run `make'.
174
175 Well done, now you're ready to use VLC!
176 =======================================