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   This method is  preferred over all the others.
  51
  52 Getting the right compiler tools
  53 ================================
  54
  55 - cross-compiling with mingw32:
  56 You first need to download a GNU/Linux cross-compiler version of mingw32.
  57
  58 For Debian GNU/Linux users, you can use the mingw32, mingw32-binutils and
  59 mingw32-runtime packages.
  60
  61 - compiling natively on Windoze with cygwin:
  62 You will need to download and run the setup.exe app from cygwin's web site
  63 (www.cygwin.com). You will also need to make sure you install at least the
  64 gcc-g++, gcc-mingw, mingw-runtime and win32-api packages.
  65
  66 - compiling natively on Windoze with MSYS+MINGW:
  67 You will need to download and install the latest MSYS, MSYS-DTK and MINGW.
  68 The installation is really easy. Begin with the MSYS auto-installer and once
  69 this is done, extract MINGW into c:\msys\1.0\mingw. You also have to remember
  70 to remove the make utility included with MINGW as it conflicts with the one
  71 from MSYS (just rename or remove c:\msys\1.0\mingw\bin\make.exe).
  72
  73 http://www.mingw.org/download.shtml
  74 http://prdownloads.sf.net/mingw/MSYS-1.0.9.exe
  75 http://prdownloads.sf.net/mingw/MinGW-3.1.0-1.exe
  76 http://prdownloads.sf.net/mingw/msysDTK-1.0.1.exe
  77
  78 Getting the additional libraries
  79 =================================
  80
  81 VLC depends on other libraries to provide some features like ac3 audio decoding
  82 or mpeg4 video decoding, etc...
  83
  84 Depending on your needs you will have to compile/install some or all of these
  85 external libraries.
  86
  87 * They can be found here (source code):
  88   http://download.videolan.org/pub/testing/contrib/
  89
  90 * We also provide a package with all the libraries already compiled so it is
  91   actually really easy to compile a full-featured version of vlc (these compiled
  92   libraries will only work with mingw or cygwin):
  93   http://download.videolan.org/pub/testing/win32/contrib-20060330-win32-bin-gcc-3.4.5-only.tar.bz2
  94   (Check out for more recent versions at the same location).
  95
  96   All you need to do is extract it in your root directory (the include files
  97   and libraries will be put in /usr/win32). You can do this with the following
  98   command:
  99
 100     tar xjvf contrib-20060330-win32-bin-gcc-3.4.5-only.tar.bz2 -C /
 101
 102   Please note the "-C /".
 103
 104 * An automated way of building the contrib libraries is provided in
 105   extra/contrib. It will download, configure and build the libraries.
 106   See the extras/contrib/README for more info.
 107
 108 A complete list of the libraries on which we depend can be found here:
 109 http://developers.videolan.org/vlc/
 110
 111 Configuring the build
 112 =====================
 113
 114 Once you've got all the files you need in place, you need to configure the
 115 build with the `./configure' script.
 116
 117 I'll assume that you are using the pre-compiled 3rd party libraries we are
 118 providing and that they are in /usr/win32.
 119
 120 If you are cross-compiling from Debian, you can use something
 121 along those lines:
 122
 123   ./bootstrap && \
 124   PATH=/usr/win32/bin:$PATH \
 125   PKG_CONFIG_LIBDIR=/usr/win32/lib/pkgconfig \
 126   CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
 127   LDFLAGS=-L/usr/win32/lib \
 128   CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++ \
 129   ./configure --host=i586-mingw32msvc --build=i386-linux \
 130       --disable-gtk \
 131       --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
 132       --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
 133       --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
 134       --with-wx-config-path=/usr/win32/bin \
 135       --with-freetype-config-path=/usr/win32/bin \
 136       --with-fribidi-config-path=/usr/win32/bin \
 137       --enable-live555 --with-live555-tree=/usr/win32/live.com \
 138       --enable-caca --with-caca-config-path=/usr/win32/bin \
 139       --with-xml2-config-path=/usr/win32/bin \
 140       --with-dvdnav-config-path=/usr/win32/bin \
 141       --disable-cddax --disable-vcdx --enable-goom \
 142       --enable-twolame --enable-dvdread \
 143       --enable-debug
 144
 145 If you are using cygwin, you can build VLC with or without the POSIX
 146 emulation layer. Without is usually better and with POSIX emulation
 147 hasn't been tested in about a year or so. So to build without the
 148 emulation layer, use something like this:
 149
 150   ./bootstrap && \
 151   PATH=/usr/win32/bin:$PATH \
 152   PKG_CONFIG_PATH=/usr/win32/lib/pkgconfig \
 153   CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
 154   LDFLAGS=-L/usr/win32/lib \
 155   CC="gcc -mno-cygwin" CXX="g++ -mno-cygwin" \
 156   ./configure \
 157       --disable-gtk \
 158       --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
 159       --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
 160       --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
 161       --with-wx-config-path=/usr/win32/bin \
 162       --with-freetype-config-path=/usr/win32/bin \
 163       --with-fribidi-config-path=/usr/win32/bin \
 164       --enable-live555 --with-live555-tree=/usr/win32/live.com \
 165       --enable-caca --with-caca-config-path=/usr/win32/bin \
 166       --with-xml2-config-path=/usr/win32/bin \
 167       --with-dvdnav-config-path=/usr/win32/bin \
 168       --disable-cddax --disable-vcdx --enable-goom \
 169       --enable-twolame --enable-dvdread \
 170       --enable-debug
 171
 172 If you want to use the emulation layer, then just omit the CC="gcc -mno-cygwin"
 173 CXX="g++ -mno-cygwin" line. You're on your own though.
 174
 175 If you are compiling with MSYS/MINGW, then you can use something along those
 176 lines:
 177   ./bootstrap && \
 178   PKG_CONFIG_PATH=/usr/win32/lib/pkgconfig \
 179   PATH=/usr/win32/bin:$PATH \
 180   CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
 181   LDFLAGS=-L/usr/win32/lib \
 182   ./configure \
 183       --disable-gtk \
 184       --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
 185       --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
 186       --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
 187       --with-wx-config-path=/usr/win32/bin \
 188       --with-freetype-config-path=/usr/win32/bin \
 189       --with-fribidi-config-path=/usr/win32/bin \
 190       --enable-caca --with-caca-config-path=/usr/win32/bin \
 191       --with-xml2-config-path=/usr/win32/bin \
 192       --with-dvdnav-config-path=/usr/win32/bin \
 193       --disable-cddax --disable-vcdx --enable-goom \
 194       --enable-twolame --enable-dvdread \
 195       --disable-mkv \
 196       --enable-debug
 197
 198 If you have used the "extras/contrib" way, you don't need to precise
 199 the CFLAGS, LDFLAGS and --with-foo-config-path=.
 200  ./bootstrap && \
 201   ./configure \
 202       --disable-gtk \
 203       --enable-nls --enable-sdl \
 204       --enable-ffmpeg --enable-faad --enable-flac --enable-theora \
 205       --disable-cddax --disable-vcdx --enable-goom \
 206       --enable-twolame --enable-dvdread \
 207       --enable-mkv --enable-caca --enable-live555\
 208       --enable-debug
 209
 210
 211 See `./configure --help' for more information.
 212
 213 Actually Compiling the VLC source
 214 =================================
 215
 216 Once configured, to build VLC, just run `make'.
 217
 218 Once the compilation is done, you can either run VLC directly from the source
 219 tree or you can build self-contained VLC packages with the following
 220 'make' rules:
 221
 222   make package-win32-base
 223    will create a subdirectory named vlc-x.x.x with all the binaries
 224    'stripped' (ie. without any debugging symbols).
 225
 226   make package-win32-zip
 227    Same as above but will package the directory in a zip file.
 228
 229   make package-win32
 230    Same as above but will also create an auto-installer package. You will need
 231    to have NSIS installed in its default location for this to work.
 232
 233 Well done, now you're ready to use VLC!
 234 =======================================