* INSTALL.win32: added an instruction for using tar to extract the contrib.
[vlc.git] / INSTALL.win32
1 $Id: INSTALL.win32,v 1.17 2003/07/06 16:22:15 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   ( NOTE: if you want to run vlc under the msvc debugger, you need to run it
49     with the --fast-mutex --win9x-cv-method=1 options because the debugger
50     usually loses signals sent by PulseEvent() )
51
52 - or on Linux, using the mingw32 cross-compiler.
53
54 Getting the right compiler tools
55 ================================
56
57 - cross-compiling with mingw32:
58 You first need to download a linux cross-compiler version of mingw32.
59 (for Debian GNU/Linux users, you can use the mingw32, mingw32-binutils and
60 mingw32-runtime packages)
61
62 - compiling natively on Windoze with cygwin:
63 You will need to download and run the setup.exe app from cygwin's web site
64 (www.cygwin.com). You will also need to make sure you install at least the
65 gcc-mingw, mingw-runtime and w32api packages.
66
67 - compiling natively on Windoze with MSYS+MINGW:
68 You will need to download and install the latest MSYS, MSYS-DTK and MINGW.
69 The installation is really easy. Begin with the MSYS auto-installer and once
70 this is done, extract MINGW into c:\msys\1.0\mingw. You also have to remember
71 to remove the make utility included with MINGW as it conflicts with the one
72 from MSYS (just rename or remove c:\msys\1.0\mingw\bin\make.exe).
73
74 http://www.mingw.org/download.shtml
75 http://prdownloads.sf.net/mingw/MSYS-1.0.9-2003.14.18-1.exe
76 http://prdownloads.sf.net/mingw/MinGW-2.0.0-3.exe
77 http://prdownloads.sf.net/mingw/msysDTK-1.0.1.exe
78
79 Getting the additionnal libraries
80 =================================
81
82 VLC depends on other libraries to provide some features like ac3 audio decoding
83 or mpeg4 video decoding, etc...
84
85 Depending on your needs you will have to compile/install some or all of these
86 external libraries.
87
88 They can be found here (source code):
89 http://www.videolan.org/pub/testing/contrib/
90
91 I also provide a package with all the libraries already compiled so it is
92 actually really easy to compile a full-featured version of vlc (these compiled
93 libraries will only work with mingw or cygwin):
94 http://www.videolan.org/pub/testing/win32/contrib-20030622-win32-bin.tar.bz2
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: "tar xjvf contrib-20030622-win32-bin.tar.bz2 -C /"
98
99 A complete list of the libraries on which we depend can be found here:
100 http://developers.videolan.org/vlc/
101
102 Configuring the build
103 =====================
104
105 Once you've got all the files you need in place, you need to configure the
106 build with the `./configure' script.
107
108 I'll assume that you are using the pre-compiled 3rd party libraries I'm
109 providing and that they are in /usr/win32.
110
111 If you are cross-compiling from Debian, you can use something
112 along those lines:
113
114   ./bootstrap && \
115   CPPFLAGS=-I/usr/win32/include LDFLAGS=-L/usr/win32/lib \
116   CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++ \
117   ./configure --host=i586-mingw32msvc --build=i386-linux \
118       --disable-sdl --disable-gtk \
119       --with-included-gettext --enable-nls \
120       --enable-mad \
121       --enable-ffmpeg \
122       --enable-dvdread --enable-dvdplay \
123       --enable-faad \
124       --enable-flac \
125       --enable-theora \
126       --with-wx-config-path=/usr/win32/bin \
127       --with-skins-wx-config-path=/usr/win32/bin \
128       --with-freetype-config-path=/usr/win32/bin \
129       --enable-debug
130
131 If you are using cygwin, you can build VLC with or without the unix emulation
132 layer (without is usually better). To build without the emulaion layer, use
133 something like this:
134   ./bootstrap && \
135   CPPFLAGS=-I/usr/win32/include LDFLAGS=-L/usr/win32/lib \
136   CC="gcc -mno-cygwin" CXX="g++ -mno-cygwin" \
137   ./configure \
138       --disable-sdl --disable-gtk \
139       --with-included-gettext --enable-nls \
140       --enable-mad \
141       --enable-ffmpeg \
142       --enable-dvdread --enable-dvdplay \
143       --enable-faad \
144       --enable-flac \
145       --enable-theora \
146       --with-wx-config-path=/usr/win32/bin \
147       --with-skins-wx-config-path=/usr/win32/bin \
148       --with-freetype-config-path=/usr/win32/bin \
149       --enable-debug
150
151 If you want to use the emulation layer, then just omit the CC="gcc -mno-cygwin"
152 CXX="g++ -mno-cygwin" line.
153
154 If you are compiling with MSYS/MINGW, then you can use something along those
155 lines:
156   ./bootstrap && \
157   CPPFLAGS=-I/usr/win32/include LDFLAGS=-L/usr/win32/lib \
158   ./configure \
159       --disable-sdl --disable-gtk \
160       --with-included-gettext --enable-nls \
161       --enable-mad \
162       --enable-ffmpeg \
163       --enable-dvdread --enable-dvdplay \
164       --enable-faad \
165       --enable-flac \
166       --enable-theora \
167       --with-wx-config-path=/usr/win32/bin \
168       --with-skins-wx-config-path=/usr/win32/bin \
169       --with-freetype-config-path=/usr/win32/bin \
170       --enable-debug
171
172 See `./configure --help' for more information.
173
174 Actually Compiling the VLC source
175 =================================
176
177 Once configured, to build VLC, just run `make'.
178
179 Well done, now you're ready to use VLC!
180 =======================================