2004-03-08 03:08:41 +01:00
$Id$
2002-04-01 11:59:41 +02:00
2003-05-18 01:57:35 +02:00
INSTALL file for the Windows9x/Me/NT4/2k/XP version of the VLC media player
2003-02-02 05:01:29 +01:00
Running VLC
===========
2002-04-01 11:59:41 +02:00
2003-02-02 05:01:29 +01:00
If you have already built VLC (see below) or are using a binary release,
2002-04-01 11:59:41 +02:00
just run 'vlc.exe'.
2003-02-02 05:01:29 +01:00
You can also run VLC from a dos command box, in which case you'll be able
2002-04-01 11:59:41 +02:00
to use the command line arguments. You can obtain a list of these command
2003-05-18 01:57:35 +02:00
line arguments by typing 'vlc --help' or 'vlc --help --advanced'.
2003-02-02 05:01:29 +01:00
To store a debug log of the current VLC session, you can use
2003-05-18 01:57:35 +02:00
'vlc -vv --extraintf=logger'. You will end-up with a vlc-log.txt file in
your current directory.
2002-04-01 11:59:41 +02:00
2003-05-18 01:57:35 +02:00
Additional documentation is available at http://www.videolan.org/doc/
2003-02-02 05:01:29 +01:00
Building VLC from the source code
=================================
2002-04-01 11:59:41 +02:00
2003-05-18 01:57:35 +02:00
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
2004-03-08 03:08:41 +01:00
POSIX emulation layer. This is the preferred way to compile vlc if you want
2003-05-18 01:57:35 +02:00
to do it on Windows.
2004-03-08 03:08:41 +01:00
NOTE: This is the PREFERRED way of building VLC natively (the others
2004-02-29 15:35:10 +01:00
are not as much tested so expect more difficulties with them).
2002-04-01 11:59:41 +02:00
- natively on Windows, using MSYS+MINGW (www.mingw.org)
2004-03-08 04:20:19 +01:00
(MSYS is a minimal build environment to compile Unixish projects under
2004-03-08 03:08:41 +01:00
windoze. It provides all the common Unix tools like sh, gmake...)
2003-07-25 15:24:29 +02:00
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.
2002-04-01 11:59:41 +02:00
2003-05-18 01:57:35 +02:00
- natively on Windows, using Microsoft Visual C++. Even though we provide some
msvc project files with vlc, this method is advised only if you just want to
2004-03-08 03:08:41 +01:00
experiment/play with some basic functionality in vlc. The reason for this
2003-05-18 01:57:35 +02:00
is that vlc depends on a lot of 3rd party libraries and building them in
MSVC is not convenient and sometimes even impossible.
2003-05-22 14:00:57 +02:00
( NOTE: if you want to run vlc under the msvc debugger, you need to run it
with the --fast-mutex --win9x-cv-method=1 options because the debugger
usually loses signals sent by PulseEvent() )
2002-10-06 21:28:28 +02:00
2004-03-08 03:08:41 +01:00
- or on GNU/Linux, using the mingw32 cross-compiler.
2002-04-01 11:59:41 +02:00
2003-05-18 01:57:35 +02:00
Getting the right compiler tools
================================
2002-04-01 11:59:41 +02:00
- cross-compiling with mingw32:
2004-03-08 03:08:41 +01:00
You first need to download a GNU/Linux cross-compiler version of mingw32.
2003-10-26 14:07:50 +01:00
For Debian GNU/Linux users, you can use the mingw32, mingw32-binutils and
mingw32-runtime packages.
Or you can use our mingw32 gcc-3.3.1 cross-compiler package:
http://www.videolan.org/pub/testing/win32/mingw-gcc3.3.1-linux-crosscompiler.tar.bz2 (requires libc6 >= 2.3.2).
You will need to extract this package in your root directory (everything will
be extracted in /usr/local/cross-tools).
2002-04-01 11:59:41 +02:00
2003-05-18 01:57:35 +02:00
- compiling natively on Windoze with cygwin:
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
2003-11-13 15:23:30 +01:00
gcc-g++, gcc-mingw, mingw-runtime and win32-api packages.
2002-04-01 11:59:41 +02:00
2002-10-06 21:28:28 +02:00
- compiling natively on Windoze with MSYS+MINGW:
2003-05-18 01:57:35 +02:00
You will need to download and install the latest MSYS, MSYS-DTK and MINGW.
2002-04-26 22:49:26 +02:00
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
2003-07-25 15:24:29 +02:00
http://prdownloads.sf.net/mingw/MSYS-1.0.9.exe
2004-03-08 03:39:04 +01:00
http://prdownloads.sf.net/mingw/MinGW-3.1.0-1.exe
2003-05-18 01:57:35 +02:00
http://prdownloads.sf.net/mingw/msysDTK-1.0.1.exe
2002-04-01 11:59:41 +02:00
2004-03-08 03:08:41 +01:00
Getting the additional libraries
2003-05-18 01:57:35 +02:00
=================================
2002-04-01 11:59:41 +02:00
2003-05-18 01:57:35 +02:00
VLC depends on other libraries to provide some features like ac3 audio decoding
or mpeg4 video decoding, etc...
2002-04-01 11:59:41 +02:00
2003-05-18 01:57:35 +02:00
Depending on your needs you will have to compile/install some or all of these
external libraries.
2002-10-06 21:28:28 +02:00
2003-05-18 01:57:35 +02:00
They can be found here (source code):
2004-01-24 22:06:52 +01:00
http://download.videolan.org/pub/testing/contrib/
2003-05-18 01:57:35 +02:00
2003-07-25 15:24:29 +02:00
We also provide a package with all the libraries already compiled so it is
2003-05-18 01:57:35 +02:00
actually really easy to compile a full-featured version of vlc (these compiled
libraries will only work with mingw or cygwin):
2004-09-14 13:45:44 +02:00
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).
2004-03-08 03:08:41 +01:00
2003-05-18 01:57:35 +02:00
All you need to do is extract it in your root directory (the include files
2003-07-06 18:22:15 +02:00
and libraries will be put in /usr/win32). You can do this with the following
2004-03-08 03:08:41 +01:00
command:
2004-09-14 13:45:44 +02:00
tar xjvf contrib-20040902-win32-bin-gcc3.3.1-only.tar.bz2 -C /
2004-03-08 03:08:41 +01:00
Please note the "-C /".
2003-05-18 01:57:35 +02:00
A complete list of the libraries on which we depend can be found here:
http://developers.videolan.org/vlc/
2002-10-06 21:28:28 +02:00
2002-04-01 11:59:41 +02:00
Configuring the build
=====================
2003-05-18 01:57:35 +02:00
Once you've got all the files you need in place, you need to configure the
build with the `./configure' script.
2002-04-01 11:59:41 +02:00
2003-05-18 01:57:35 +02:00
I'll assume that you are using the pre-compiled 3rd party libraries I'm
providing and that they are in /usr/win32.
2002-04-01 11:59:41 +02:00
If you are cross-compiling from Debian, you can use something
along those lines:
2003-05-18 01:57:35 +02:00
./bootstrap && \
2003-07-25 15:24:29 +02:00
CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
LDFLAGS=-L/usr/win32/lib \
2002-12-18 09:08:30 +01:00
CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++ \
2002-05-19 00:41:43 +02:00
./configure --host=i586-mingw32msvc --build=i386-linux \
2003-05-18 01:57:35 +02:00
--disable-sdl --disable-gtk \
2003-07-25 15:24:29 +02:00
--enable-nls \
2004-02-29 15:35:10 +01:00
--enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
2004-09-14 13:45:44 +02:00
--with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
2003-05-18 01:57:35 +02:00
--with-wx-config-path=/usr/win32/bin \
--with-freetype-config-path=/usr/win32/bin \
2004-02-29 15:35:10 +01:00
--with-fribidi-config-path=/usr/win32/bin \
--enable-livedotcom --with-livedotcom-tree=/usr/win32/live.com \
--enable-caca --with-caca-config-path=/usr/win32/bin \
--with-xml2-config-path=/usr/win32/bin \
--with-dvdnav-config-path=/usr/win32/bin \
2004-05-15 14:58:07 +02:00
--disable-cddax --disable-vcdx --enable-goom \
2004-09-14 13:45:44 +02:00
--enable-toolame --enable-dvdread \
2003-05-18 01:57:35 +02:00
--enable-debug
2002-04-26 22:49:26 +02:00
2003-10-26 14:07:50 +01:00
If you are cross-compiling with our gcc-3.3.1 package, you can use something
along those lines:
./bootstrap && \
PATH=/usr/local/mingw/bin:$PATH \
CPPFLAGS=-I/usr/win32/include \
LDFLAGS=-L/usr/win32/lib \
CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++ \
./configure --host=i586-mingw32msvc --build=i386-linux \
--disable-sdl --disable-gtk \
--enable-nls \
2004-02-29 15:35:10 +01:00
--enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
2004-09-14 13:45:44 +02:00
--with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
2003-10-26 14:07:50 +01:00
--with-wx-config-path=/usr/win32/bin \
--with-freetype-config-path=/usr/win32/bin \
--with-fribidi-config-path=/usr/win32/bin \
2004-02-29 15:35:10 +01:00
--enable-livedotcom --with-livedotcom-tree=/usr/win32/live.com \
--enable-caca --with-caca-config-path=/usr/win32/bin \
--with-xml2-config-path=/usr/win32/bin \
--with-dvdnav-config-path=/usr/win32/bin \
2004-05-15 14:58:07 +02:00
--disable-cddax --disable-vcdx --enable-goom \
2004-09-14 13:45:44 +02:00
--enable-toolame --enable-dvdread \
2004-02-29 15:35:10 +01:00
--enable-debug
2003-10-26 14:07:50 +01:00
2004-03-08 03:08:41 +01:00
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:
2003-05-18 01:57:35 +02:00
./bootstrap && \
2003-07-25 15:24:29 +02:00
CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
LDFLAGS=-L/usr/win32/lib \
2002-12-18 09:08:30 +01:00
CC="gcc -mno-cygwin" CXX="g++ -mno-cygwin" \
2002-10-06 21:28:28 +02:00
./configure \
2003-05-18 01:57:35 +02:00
--disable-sdl --disable-gtk \
2003-07-25 15:24:29 +02:00
--enable-nls \
2004-02-29 15:35:10 +01:00
--enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
2004-09-14 13:45:44 +02:00
--with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
2003-05-18 01:57:35 +02:00
--with-wx-config-path=/usr/win32/bin \
--with-freetype-config-path=/usr/win32/bin \
2003-10-26 14:07:50 +01:00
--with-fribidi-config-path=/usr/win32/bin \
2004-02-29 15:35:10 +01:00
--enable-livedotcom --with-livedotcom-tree=/usr/win32/live.com \
--enable-caca --with-caca-config-path=/usr/win32/bin \
--with-xml2-config-path=/usr/win32/bin \
--with-dvdnav-config-path=/usr/win32/bin \
2004-05-15 14:58:07 +02:00
--disable-cddax --disable-vcdx --enable-goom \
2004-09-14 13:45:44 +02:00
--enable-toolame --enable-dvdread \
2003-05-18 01:57:35 +02:00
--enable-debug
2002-10-06 21:28:28 +02:00
If you want to use the emulation layer, then just omit the CC="gcc -mno-cygwin"
2004-03-08 03:08:41 +01:00
CXX="g++ -mno-cygwin" line. You're on your own though.
2002-10-06 21:28:28 +02:00
2003-05-18 01:57:35 +02:00
If you are compiling with MSYS/MINGW, then you can use something along those
lines:
./bootstrap && \
2003-07-25 15:24:29 +02:00
CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
LDFLAGS=-L/usr/win32/lib \
2003-05-18 01:57:35 +02:00
./configure \
--disable-sdl --disable-gtk \
2003-07-25 15:24:29 +02:00
--enable-nls \
2004-02-29 15:35:10 +01:00
--enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
2004-09-14 13:45:44 +02:00
--with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
2003-05-18 01:57:35 +02:00
--with-wx-config-path=/usr/win32/bin \
--with-freetype-config-path=/usr/win32/bin \
2003-10-26 14:07:50 +01:00
--with-fribidi-config-path=/usr/win32/bin \
2004-02-29 15:35:10 +01:00
--enable-caca --with-caca-config-path=/usr/win32/bin \
--with-xml2-config-path=/usr/win32/bin \
--with-dvdnav-config-path=/usr/win32/bin \
2004-05-15 14:58:07 +02:00
--disable-cddax --disable-vcdx --enable-goom \
2004-09-14 13:45:44 +02:00
--enable-toolame --enable-dvdread \
2004-02-29 15:35:10 +01:00
--disable-mkv \
2003-05-18 01:57:35 +02:00
--enable-debug
2002-04-01 11:59:41 +02:00
2003-05-18 01:57:35 +02:00
See `./configure --help' for more information.
2002-04-01 11:59:41 +02:00
2003-05-18 01:57:35 +02:00
Actually Compiling the VLC source
=================================
2002-04-01 11:59:41 +02:00
2003-05-18 01:57:35 +02:00
Once configured, to build VLC, just run `make'.
2002-04-01 11:59:41 +02:00
2003-10-26 14:07:50 +01:00
( If you are using our gcc-3.3.1 cross-compiler you'll need to use:
PATH=/usr/local/mingw/bin:$PATH make )
2004-03-10 14:28:07 +01:00
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.
2003-02-02 05:01:29 +01:00
Well done, now you're ready to use VLC!
2002-04-05 05:27:27 +02:00
=======================================