INSTALL.win32 8.83 KB
Newer Older
1
INSTALL file for the Windows 2k/XP/Vista version of the VLC media player
2 3 4 5


Running VLC
===========
Gildas Bazin's avatar
Gildas Bazin committed
6

7
If you have already built VLC (see below) or are using a binary release,
Gildas Bazin's avatar
Gildas Bazin committed
8 9
just run 'vlc.exe'.

10
You can also run VLC from a dos command box, in which case you'll be able
Gildas Bazin's avatar
Gildas Bazin committed
11
to use the command line arguments. You can obtain a list of these command
12 13
line arguments by typing 'vlc --help' or 'vlc --help --advanced'.

14
To store a debug log of the current VLC session, you can use
15 16
'vlc -vv --extraintf=logger'. You will end-up with a vlc-log.txt file in
your current directory.
Gildas Bazin's avatar
Gildas Bazin committed
17

18 19 20
Additional documentation is available at http://www.videolan.org/doc/


21 22
Building VLC from the source code
=================================
Gildas Bazin's avatar
Gildas Bazin committed
23

24 25 26
If you want to build VLC from sources, you can do it in several ways:

- natively on Windows, using cygwin (www.cygwin.com) with or without the
27
  POSIX emulation layer. This is the preferred way to compile vlc if you want
28
  to do it on Windows.
29 30 31
  Read http://wiki.videolan.org/Win32CompileCygwinNew to have a complete HOWTO

- On GNU/Linux, using the mingw32 cross-compiler.
32
  This method is preferred over all the others.
33 34 35

UNSUPPORTED METHODS
-------------------
Gildas Bazin's avatar
Gildas Bazin committed
36
- natively on Windows, using MSYS+MINGW (www.mingw.org)
37
  (MSYS is a minimal build environment to compile Unixish projects under
38
  windoze. It provides all the common Unix tools like sh, gmake...)
39 40
  Please note that the gettext utilities are not included in the default
  MSYS/MINGW packages so you won't be able to build VLC with i18n support.
Gildas Bazin's avatar
Gildas Bazin committed
41

42
- natively on Windows, using Microsoft Visual Studio. This will not work.
43

44 45
Getting the right compiler tools
================================
Gildas Bazin's avatar
Gildas Bazin committed
46 47

- cross-compiling with mingw32:
48
You first need to download a GNU/Linux cross-compiler version of mingw32.
49 50 51

For Debian GNU/Linux users, you can use the mingw32, mingw32-binutils and
mingw32-runtime packages.
52
For Fedora users, you can use mingw-binutils, mingw-gcc-core, mingw-gcc-g++
53

54
- compiling natively on Windows with cygwin:
55 56
You will need to download and run the setup.exe app from cygwin's web site
(www.cygwin.com). You will also need to make sure you install at least the
57
gcc-g++, gcc-mingw, mingw-runtime and win32-api packages.
Gildas Bazin's avatar
Gildas Bazin committed
58

59
- compiling natively on Windows with MSYS+MINGW:
60
You will need to download and install the latest MSYS, MSYS-DTK and MINGW.
61 62 63 64 65 66
The installation is really easy. Begin with the MSYS auto-installer and once
this is done, extract MINGW into c:\msys\1.0\mingw. You also have to remember
to remove the make utility included with MINGW as it conflicts with the one
from MSYS (just rename or remove c:\msys\1.0\mingw\bin\make.exe).

http://www.mingw.org/download.shtml
67
http://prdownloads.sf.net/mingw/MSYS-1.0.9.exe
68
http://prdownloads.sf.net/mingw/MinGW-3.1.0-1.exe
69
http://prdownloads.sf.net/mingw/msysDTK-1.0.1.exe
Gildas Bazin's avatar
Gildas Bazin committed
70

71
Getting the additional libraries
72
=================================
Gildas Bazin's avatar
Gildas Bazin committed
73

74 75
VLC depends on other libraries to provide some features like ac3 audio decoding
or mpeg4 video decoding, etc...
Gildas Bazin's avatar
Gildas Bazin committed
76

77 78
Depending on your needs you will have to compile/install some or all of these
external libraries.
79

80 81 82
* We also provide a package with all the libraries already compiled so it is
  actually really easy to compile a full-featured version of vlc (these compiled
  libraries will only work with mingw or cygwin):
83 84
  http://download.videolan.org/pub/testing/win32/contrib-20060330-win32-bin-gcc-3.4.5-only.tar.bz2
  (Check out for more recent versions at the same location). 
85

86 87 88
  All you need to do is extract it in your root directory (the include files
  and libraries will be put in /usr/win32). You can do this with the following
  command: 
89

90
    tar xjvf contrib-20060330-win32-bin-gcc-3.4.5-only.tar.bz2 -C /
91

92 93
  Please note the "-C /". 

94 95 96
* They can also be found here (source code):
  http://download.videolan.org/pub/testing/contrib/

97 98 99
* An automated way of building the contrib libraries is provided in 
  extra/contrib. It will download, configure and build the libraries.
  See the extras/contrib/README for more info.
100 101 102

A complete list of the libraries on which we depend can be found here:
http://developers.videolan.org/vlc/
103

Gildas Bazin's avatar
Gildas Bazin committed
104 105 106
Configuring the build
=====================

107 108
Once you've got all the files you need in place, you need to configure the
build with the `./configure' script.
Gildas Bazin's avatar
Gildas Bazin committed
109

110
I'll assume that you are using the pre-compiled 3rd party libraries we are
111
providing and that they are in /usr/win32.
Gildas Bazin's avatar
Gildas Bazin committed
112 113 114 115

If you are cross-compiling from Debian, you can use something
along those lines:

116
  ./bootstrap && \
117
  PATH=/usr/win32/bin:$PATH \
118
  PKG_CONFIG_LIBDIR=/usr/win32/lib/pkgconfig \
119 120
  CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
  LDFLAGS=-L/usr/win32/lib \
121
  CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++ \
Gildas Bazin's avatar
Gildas Bazin committed
122
  ./configure --host=i586-mingw32msvc --build=i386-linux \
123
      --disable-gtk \
124
      --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
125
      --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
126
      --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
127 128
      --with-wx-config-path=/usr/win32/bin \
      --with-freetype-config-path=/usr/win32/bin \
129
      --with-fribidi-config-path=/usr/win32/bin \
Christophe Mutricy's avatar
Christophe Mutricy committed
130
      --enable-live555 --with-live555-tree=/usr/win32/live.com \
131 132 133
      --enable-caca --with-caca-config-path=/usr/win32/bin \
      --with-xml2-config-path=/usr/win32/bin \
      --with-dvdnav-config-path=/usr/win32/bin \
Gildas Bazin's avatar
Gildas Bazin committed
134
      --disable-cddax --disable-vcdx --enable-goom \
135
      --enable-twolame --enable-dvdread \
136
      --enable-debug
137

138 139 140 141 142
If you are using cygwin, you can build VLC with or without the POSIX
emulation layer. Without is usually better and with POSIX emulation
hasn't been tested in about a year or so. So to build without the
emulation layer, use something like this:

143
  ./bootstrap && \
144
  PATH=/usr/win32/bin:$PATH \
145
  PKG_CONFIG_PATH=/usr/win32/lib/pkgconfig \
146 147
  CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
  LDFLAGS=-L/usr/win32/lib \
148
  CC="gcc -mno-cygwin" CXX="g++ -mno-cygwin" \
149
  ./configure \
150
      --disable-gtk \
151
      --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
152
      --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
153
      --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
154 155
      --with-wx-config-path=/usr/win32/bin \
      --with-freetype-config-path=/usr/win32/bin \
156
      --with-fribidi-config-path=/usr/win32/bin \
Christophe Mutricy's avatar
Christophe Mutricy committed
157
      --enable-live555 --with-live555-tree=/usr/win32/live.com \
158 159 160
      --enable-caca --with-caca-config-path=/usr/win32/bin \
      --with-xml2-config-path=/usr/win32/bin \
      --with-dvdnav-config-path=/usr/win32/bin \
Gildas Bazin's avatar
Gildas Bazin committed
161
      --disable-cddax --disable-vcdx --enable-goom \
162
      --enable-twolame --enable-dvdread \
163 164
      --enable-debug

165
If you want to use the emulation layer, then just omit the CC="gcc -mno-cygwin"
166
CXX="g++ -mno-cygwin" line. You're on your own though.
167

168 169 170
If you are compiling with MSYS/MINGW, then you can use something along those
lines:
  ./bootstrap && \
171
  PKG_CONFIG_PATH=/usr/win32/lib/pkgconfig \
172
  PATH=/usr/win32/bin:$PATH \
173 174
  CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
  LDFLAGS=-L/usr/win32/lib \
175
  ./configure \
176
      --disable-gtk \
177
      --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
178
      --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
179
      --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
180 181
      --with-wx-config-path=/usr/win32/bin \
      --with-freetype-config-path=/usr/win32/bin \
182
      --with-fribidi-config-path=/usr/win32/bin \
183 184 185
      --enable-caca --with-caca-config-path=/usr/win32/bin \
      --with-xml2-config-path=/usr/win32/bin \
      --with-dvdnav-config-path=/usr/win32/bin \
Gildas Bazin's avatar
Gildas Bazin committed
186
      --disable-cddax --disable-vcdx --enable-goom \
187
      --enable-twolame --enable-dvdread \
188
      --disable-mkv \
189
      --enable-debug
Gildas Bazin's avatar
Gildas Bazin committed
190

191 192 193 194 195 196 197 198 199
If you have used the "extras/contrib" way, you don't need to precise 
the CFLAGS, LDFLAGS and --with-foo-config-path=.
 ./bootstrap && \
  ./configure \
      --disable-gtk \
      --enable-nls --enable-sdl \
      --enable-ffmpeg --enable-faad --enable-flac --enable-theora \
      --disable-cddax --disable-vcdx --enable-goom \
      --enable-twolame --enable-dvdread \
Christophe Mutricy's avatar
Christophe Mutricy committed
200
      --enable-mkv --enable-caca --enable-live555\
201 202 203
      --enable-debug


204
See `./configure --help' for more information.
Gildas Bazin's avatar
Gildas Bazin committed
205

206 207
Actually Compiling the VLC source
=================================
Gildas Bazin's avatar
Gildas Bazin committed
208

209
Once configured, to build VLC, just run `make'.
Gildas Bazin's avatar
Gildas Bazin committed
210

211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
Once the compilation is done, you can either run VLC directly from the source
tree or you can build self-contained VLC packages with the following
'make' rules:

  make package-win32-base
   will create a subdirectory named vlc-x.x.x with all the binaries
   'stripped' (ie. without any debugging symbols).

  make package-win32-zip
   Same as above but will package the directory in a zip file.

  make package-win32
   Same as above but will also create an auto-installer package. You will need
   to have NSIS installed in its default location for this to work.

226
Well done, now you're ready to use VLC!
227
=======================================