git.sesse.net Git - vlc/blob - 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-20040902-win32-bin-gcc3.3.1-only.tar.bz2 (Check out fo more recent versions at the same location).
  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-20040902-win32-bin-gcc3.3.1-only.tar.bz2 -C /
 104
 105   Please note the "-C /".
 106
 107 * An automated way of building the contrib libraries is provided in
 108   extra/contrib. It will download, configure and build the libraries.
 109   See the extras/contrib/README for more info.
 110
 111 A complete list of the libraries on which we depend can be found here:
 112 http://developers.videolan.org/vlc/
 113
 114 Configuring the build
 115 =====================
 116
 117 Once you've got all the files you need in place, you need to configure the
 118 build with the `./configure' script.
 119
 120 I'll assume that you are using the pre-compiled 3rd party libraries I'm
 121 providing and that they are in /usr/win32.
 122
 123 If you are cross-compiling from Debian, you can use something
 124 along those lines:
 125
 126   ./bootstrap && \
 127   CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
 128   LDFLAGS=-L/usr/win32/lib \
 129   CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++ \
 130   ./configure --host=i586-mingw32msvc --build=i386-linux \
 131       --disable-gtk \
 132       --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
 133       --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
 134       --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
 135       --with-wx-config-path=/usr/win32/bin \
 136       --with-freetype-config-path=/usr/win32/bin \
 137       --with-fribidi-config-path=/usr/win32/bin \
 138       --enable-livedotcom --with-livedotcom-tree=/usr/win32/live.com \
 139       --enable-caca --with-caca-config-path=/usr/win32/bin \
 140       --with-xml2-config-path=/usr/win32/bin \
 141       --with-dvdnav-config-path=/usr/win32/bin \
 142       --disable-cddax --disable-vcdx --enable-goom \
 143       --enable-twolame --enable-dvdread \
 144       --enable-debug
 145
 146 If you are cross-compiling with our gcc-3.3.1 package, you can use something
 147 along those lines:
 148
 149   ./bootstrap && \
 150   PATH=/usr/local/mingw/bin:$PATH \
 151   CPPFLAGS=-I/usr/win32/include \
 152   LDFLAGS=-L/usr/win32/lib \
 153   CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++ \
 154   ./configure --host=i586-mingw32msvc --build=i386-linux \
 155       --disable-gtk \
 156       --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
 157       --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
 158       --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
 159       --with-wx-config-path=/usr/win32/bin \
 160       --with-freetype-config-path=/usr/win32/bin \
 161       --with-fribidi-config-path=/usr/win32/bin \
 162       --enable-livedotcom --with-livedotcom-tree=/usr/win32/live.com \
 163       --enable-caca --with-caca-config-path=/usr/win32/bin \
 164       --with-xml2-config-path=/usr/win32/bin \
 165       --with-dvdnav-config-path=/usr/win32/bin \
 166       --disable-cddax --disable-vcdx --enable-goom \
 167       --enable-twolame --enable-dvdread \
 168       --enable-debug
 169
 170 If you are using cygwin, you can build VLC with or without the POSIX
 171 emulation layer. Without is usually better and with POSIX emulation
 172 hasn't been tested in about a year or so. So to build without the
 173 emulation layer, use something like this:
 174
 175   ./bootstrap && \
 176   CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
 177   LDFLAGS=-L/usr/win32/lib \
 178   CC="gcc -mno-cygwin" CXX="g++ -mno-cygwin" \
 179   ./configure \
 180       --disable-gtk \
 181       --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
 182       --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
 183       --with-ffmpeg-zlib --enable-faad --enable-flac --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 --enable-goom \
 192       --enable-twolame --enable-dvdread \
 193       --enable-debug
 194
 195 If you want to use the emulation layer, then just omit the CC="gcc -mno-cygwin"
 196 CXX="g++ -mno-cygwin" line. You're on your own though.
 197
 198 If you are compiling with MSYS/MINGW, then you can use something along those
 199 lines:
 200   ./bootstrap && \
 201   CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
 202   LDFLAGS=-L/usr/win32/lib \
 203   ./configure \
 204       --disable-gtk \
 205       --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
 206       --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
 207       --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
 208       --with-wx-config-path=/usr/win32/bin \
 209       --with-freetype-config-path=/usr/win32/bin \
 210       --with-fribidi-config-path=/usr/win32/bin \
 211       --enable-caca --with-caca-config-path=/usr/win32/bin \
 212       --with-xml2-config-path=/usr/win32/bin \
 213       --with-dvdnav-config-path=/usr/win32/bin \
 214       --disable-cddax --disable-vcdx --enable-goom \
 215       --enable-twolame --enable-dvdread \
 216       --disable-mkv \
 217       --enable-debug
 218
 219 If you have used the "extras/contrib" way, you don't need to precise
 220 the CFLAGS, LDFLAGS and --with-foo-config-path=.
 221  ./bootstrap && \
 222   ./configure \
 223       --disable-gtk \
 224       --enable-nls --enable-sdl \
 225       --enable-ffmpeg --enable-faad --enable-flac --enable-theora \
 226       --disable-cddax --disable-vcdx --enable-goom \
 227       --enable-twolame --enable-dvdread \
 228       --enable-mkv --enable-caca \
 229       --enable-debug
 230
 231
 232 See `./configure --help' for more information.
 233
 234 Actually Compiling the VLC source
 235 =================================
 236
 237 Once configured, to build VLC, just run `make'.
 238
 239 ( If you are using our gcc-3.3.1 cross-compiler you'll need to use:
 240   PATH=/usr/local/mingw/bin:$PATH make )
 241
 242 Once the compilation is done, you can either run VLC directly from the source
 243 tree or you can build self-contained VLC packages with the following
 244 'make' rules:
 245
 246   make package-win32-base
 247    will create a subdirectory named vlc-x.x.x with all the binaries
 248    'stripped' (ie. without any debugging symbols).
 249
 250   make package-win32-zip
 251    Same as above but will package the directory in a zip file.
 252
 253   make package-win32
 254    Same as above but will also create an auto-installer package. You will need
 255    to have NSIS installed in its default location for this to work.
 256
 257 Well done, now you're ready to use VLC!
 258 =======================================