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