git.sesse.net Git - vlc/blob - INSTALL.win32

   1 INSTALL file for the Windows9x/Me/NT4/2k/XP version of the VLC media player
   2
   3
   4 Running VLC
   5 ===========
   6
   7 If you have already built VLC (see below) or are using a binary release,
   8 just run 'vlc.exe'.
   9
  10 You can also run VLC from a dos command box, in which case you'll be able
  11 to use the command line arguments. You can obtain a list of these command
  12 line arguments by typing 'vlc --help' or 'vlc --help --advanced'.
  13
  14 To store a debug log of the current VLC session, you can use
  15 'vlc -vv --extraintf=logger'. You will end-up with a vlc-log.txt file in
  16 your current directory.
  17
  18 Additional documentation is available at http://www.videolan.org/doc/
  19
  20
  21 Building VLC from the source code
  22 =================================
  23
  24 If you want to build VLC from sources, you can do it in several ways:
  25
  26 - 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   NOTE: This is the PREFERRED way of building VLC natively (the others
  30   are not as much tested so expect more difficulties with them).
  31
  32   Read http://wiki.videolan.org/Win32CompileCygwinNew to have a complete HOWTO
  33
  34 - On GNU/Linux, using the mingw32 cross-compiler.
  35   This method is  preferred over all the others.
  36
  37 UNSUPPORTED METHODS
  38 -------------------
  39 - natively on Windows, using MSYS+MINGW (www.mingw.org)
  40   (MSYS is a minimal build environment to compile Unixish projects under
  41   windoze. It provides all the common Unix tools like sh, gmake...)
  42   Please note that the gettext utilities are not included in the default
  43   MSYS/MINGW packages so you won't be able to build VLC with i18n support.
  44
  45 - natively on Windows, using Microsoft Visual C++. Even though we provide some
  46   msvc project files with vlc, this method is advised only if you just want to
  47   experiment/play with some basic functionality in vlc. The reason for this
  48   is that vlc depends on a lot of 3rd party libraries and building them in
  49   MSVC is not convenient and sometimes even impossible.
  50   ( NOTE: if you want to run vlc under the msvc debugger, you need to run it
  51     with the --fast-mutex --win9x-cv-method=1 options because the debugger
  52     usually loses signals sent by PulseEvent() )
  53
  54 Getting the right compiler tools
  55 ================================
  56
  57 - cross-compiling with mingw32:
  58 You first need to download a GNU/Linux cross-compiler version of mingw32.
  59
  60 For Debian GNU/Linux users, you can use the mingw32, mingw32-binutils and
  61 mingw32-runtime packages.
  62
  63 - compiling natively on Windoze with cygwin:
  64 You will need to download and run the setup.exe app from cygwin's web site
  65 (www.cygwin.com). You will also need to make sure you install at least the
  66 gcc-g++, gcc-mingw, mingw-runtime and win32-api packages.
  67
  68 - compiling natively on Windoze with MSYS+MINGW:
  69 You will need to download and install the latest MSYS, MSYS-DTK and MINGW.
  70 The installation is really easy. Begin with the MSYS auto-installer and once
  71 this is done, extract MINGW into c:\msys\1.0\mingw. You also have to remember
  72 to remove the make utility included with MINGW as it conflicts with the one
  73 from MSYS (just rename or remove c:\msys\1.0\mingw\bin\make.exe).
  74
  75 http://www.mingw.org/download.shtml
  76 http://prdownloads.sf.net/mingw/MSYS-1.0.9.exe
  77 http://prdownloads.sf.net/mingw/MinGW-3.1.0-1.exe
  78 http://prdownloads.sf.net/mingw/msysDTK-1.0.1.exe
  79
  80 Getting the additional libraries
  81 =================================
  82
  83 VLC depends on other libraries to provide some features like ac3 audio decoding
  84 or mpeg4 video decoding, etc...
  85
  86 Depending on your needs you will have to compile/install some or all of these
  87 external libraries.
  88
  89 * They can be found here (source code):
  90   http://download.videolan.org/pub/testing/contrib/
  91
  92 * We also provide a package with all the libraries already compiled so it is
  93   actually really easy to compile a full-featured version of vlc (these compiled
  94   libraries will only work with mingw or cygwin):
  95   http://download.videolan.org/pub/testing/win32/contrib-20060330-win32-bin-gcc-3.4.5-only.tar.bz2
  96   (Check out for more recent versions at the same location).
  97
  98   All you need to do is extract it in your root directory (the include files
  99   and libraries will be put in /usr/win32). You can do this with the following
 100   command:
 101
 102     tar xjvf contrib-20060330-win32-bin-gcc-3.4.5-only.tar.bz2 -C /
 103
 104   Please note the "-C /".
 105
 106 * An automated way of building the contrib libraries is provided in
 107   extra/contrib. It will download, configure and build the libraries.
 108   See the extras/contrib/README for more info.
 109
 110 A complete list of the libraries on which we depend can be found here:
 111 http://developers.videolan.org/vlc/
 112
 113 Configuring the build
 114 =====================
 115
 116 Once you've got all the files you need in place, you need to configure the
 117 build with the `./configure' script.
 118
 119 I'll assume that you are using the pre-compiled 3rd party libraries we are
 120 providing and that they are in /usr/win32.
 121
 122 If you are cross-compiling from Debian, you can use something
 123 along those lines:
 124
 125   ./bootstrap && \
 126   PATH=/usr/win32/bin:$PATH \
 127   PKG_CONFIG_LIBDIR=/usr/win32/lib/pkgconfig \
 128   CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
 129   LDFLAGS=-L/usr/win32/lib \
 130   CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++ \
 131   ./configure --host=i586-mingw32msvc --build=i386-linux \
 132       --disable-gtk \
 133       --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
 134       --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
 135       --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
 136       --with-wx-config-path=/usr/win32/bin \
 137       --with-freetype-config-path=/usr/win32/bin \
 138       --with-fribidi-config-path=/usr/win32/bin \
 139       --enable-live555 --with-live555-tree=/usr/win32/live.com \
 140       --enable-caca --with-caca-config-path=/usr/win32/bin \
 141       --with-xml2-config-path=/usr/win32/bin \
 142       --with-dvdnav-config-path=/usr/win32/bin \
 143       --disable-cddax --disable-vcdx --enable-goom \
 144       --enable-twolame --enable-dvdread \
 145       --enable-debug
 146
 147 If you are using cygwin, you can build VLC with or without the POSIX
 148 emulation layer. Without is usually better and with POSIX emulation
 149 hasn't been tested in about a year or so. So to build without the
 150 emulation layer, use something like this:
 151
 152   ./bootstrap && \
 153   PATH=/usr/win32/bin:$PATH \
 154   PKG_CONFIG_PATH=/usr/win32/lib/pkgconfig \
 155   CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
 156   LDFLAGS=-L/usr/win32/lib \
 157   CC="gcc -mno-cygwin" CXX="g++ -mno-cygwin" \
 158   ./configure \
 159       --disable-gtk \
 160       --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
 161       --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
 162       --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
 163       --with-wx-config-path=/usr/win32/bin \
 164       --with-freetype-config-path=/usr/win32/bin \
 165       --with-fribidi-config-path=/usr/win32/bin \
 166       --enable-live555 --with-live555-tree=/usr/win32/live.com \
 167       --enable-caca --with-caca-config-path=/usr/win32/bin \
 168       --with-xml2-config-path=/usr/win32/bin \
 169       --with-dvdnav-config-path=/usr/win32/bin \
 170       --disable-cddax --disable-vcdx --enable-goom \
 171       --enable-twolame --enable-dvdread \
 172       --enable-debug
 173
 174 If you want to use the emulation layer, then just omit the CC="gcc -mno-cygwin"
 175 CXX="g++ -mno-cygwin" line. You're on your own though.
 176
 177 If you are compiling with MSYS/MINGW, then you can use something along those
 178 lines:
 179   ./bootstrap && \
 180   PKG_CONFIG_PATH=/usr/win32/lib/pkgconfig \
 181   PATH=/usr/win32/bin:$PATH \
 182   CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
 183   LDFLAGS=-L/usr/win32/lib \
 184   ./configure \
 185       --disable-gtk \
 186       --enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
 187       --enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
 188       --with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
 189       --with-wx-config-path=/usr/win32/bin \
 190       --with-freetype-config-path=/usr/win32/bin \
 191       --with-fribidi-config-path=/usr/win32/bin \
 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       --disable-mkv \
 198       --enable-debug
 199
 200 If you have used the "extras/contrib" way, you don't need to precise
 201 the CFLAGS, LDFLAGS and --with-foo-config-path=.
 202  ./bootstrap && \
 203   ./configure \
 204       --disable-gtk \
 205       --enable-nls --enable-sdl \
 206       --enable-ffmpeg --enable-faad --enable-flac --enable-theora \
 207       --disable-cddax --disable-vcdx --enable-goom \
 208       --enable-twolame --enable-dvdread \
 209       --enable-mkv --enable-caca --enable-live555\
 210       --enable-debug
 211
 212
 213 See `./configure --help' for more information.
 214
 215 Actually Compiling the VLC source
 216 =================================
 217
 218 Once configured, to build VLC, just run `make'.
 219
 220 Once the compilation is done, you can either run VLC directly from the source
 221 tree or you can build self-contained VLC packages with the following
 222 'make' rules:
 223
 224   make package-win32-base
 225    will create a subdirectory named vlc-x.x.x with all the binaries
 226    'stripped' (ie. without any debugging symbols).
 227
 228   make package-win32-zip
 229    Same as above but will package the directory in a zip file.
 230
 231   make package-win32
 232    Same as above but will also create an auto-installer package. You will need
 233    to have NSIS installed in its default location for this to work.
 234
 235 Well done, now you're ready to use VLC!
 236 =======================================