Added stream output. (common work with titer).
[vlc.git] / INSTALL.win32
1 INSTALL file for the Windows9x/2k/XP version of vlc, the VideoLAN Client
2
3 Running VideoLAN Client
4 =======================
5
6 If you have already built vlc (see below) or are using a binary release,
7 just run 'vlc.exe'.
8
9 You can also run vlc from a dos command box, in which case you'll be able
10 to use the command line arguments. You can obtain a list of these command
11 line arguments by typing 'vlc --help'.
12 To store a debug log of the current vlc session, you can use
13 'vlc -vvvvv --intf=logger nameofyourvideofile', but this will unfortunatly
14 disable the GUI. You will end-up with a vlc.log file in your current directory.
15
16 If you want to play a DVD, run vlc and click on the Disc option in the
17 interface. You then have to type your drive letter followed by a colon in
18 the 'Device name' box (eg. 'D:' if this is the letter for your dvdrom drive).
19
20 Building VideoLAN Client from the source code
21 =============================================
22
23 If you want to do the tricky job of building vlc from sources, you can do it
24 in several ways:
25
26 - natively on Windows, using MSYS+MINGW (www.mingw.org)
27   (MSYS is a minimal build environnement to compile unixish projects under
28    windoze. It provides all the common unix tools like sh, gmake...)
29
30 - natively on Windows, using cygwin (www.cygwin.com) with or without the
31   unix emulation layer.
32
33 - or on Linux, using the mingw32 cross-compiler
34
35 Getting the right tools
36 =======================
37
38 - cross-compiling with mingw32:
39 All the necessary tools you need can be found on the videolan web site:
40 http://www.videolan.org/vlc/windows.html
41
42 You first need to download a linux cross-compiler version of mingw32.
43 (for Debian GNU/Linux users, there is a mingw32 package)
44
45 You must also not forget to install the extra development packages if you want
46 to build the DirectX, GTK and SDL plugins.
47
48 - compiling natively on Windoze with MSYS+MINGW:
49 You will need to download and install the latest MSYS (version 1.0.7 as
50 of now) and MINGW.
51 The installation is really easy. Begin with the MSYS auto-installer and once
52 this is done, extract MINGW into c:\msys\1.0\mingw. You also have to remember
53 to remove the make utility included with MINGW as it conflicts with the one
54 from MSYS (just rename or remove c:\msys\1.0\mingw\bin\make.exe).
55
56 http://www.mingw.org/download.shtml
57 http://prdownloads.sourceforge.net/mingw/MSYS-1.0.7-i686-2.exe
58 http://prdownloads.sourceforge.net/mingw/MinGW-1.1.tar.gz
59
60 You must also not forget to install the extra development packages if you want
61 to build the DirectX, GTK and SDL plugins.
62 (http://www.videolan.org/vlc/windows.html)
63
64 - compiling natively on Windoze with cygwin:
65 You will need to download and run the setup.exe app from cygwin's web site
66 (www.cygwin.com).
67 I'm personnaly running the experimental distribution (and gcc-3.2) with the
68 exception of the autoconf tool for which I'm using the autoconf-devel-2.52-4
69 package (I had problems with 2.53a-1). You will need to make sure you install
70 at least the gcc-mingw, mingw-runtime and w32api packages.
71
72 Also note that currently, even when using the -mno-cygwin option, the final
73 executable requires cygwin1.dll even if none of the objects linked to form the
74 executable does depend on cygwin1.dll itself. I don't know yet why the linker
75 plays this trick...
76
77
78 NOTE: by default, the GTK package is configured to be installed in
79 /usr/local/gtk-win32, if you want to change this path, then you need to edit
80 the gtk-win32/bin/gtk-config file and change "gtk_dir=" accordingly.
81 The same is true for the SDL package, it is installed in
82 /usr/local/SDL-1.2.3-win32 by default and you need to change "prefix=" in 
83 SDL-1.2.3-win32/i386-mingw32msvc/bin/sdl-config if you plan to extract the
84 archive in a different directory.
85
86 - compiling natively on Windoze with cygwin:
87 You will need to download and install cygwin (www.cygwin.com).
88
89 You must also not forget to install the extra development packages if you want
90 to build the DirectX, GTK and SDL plugins.
91 (http://www.videolan.org/vlc/windows.html)
92
93 Configuring the build
94 =====================
95
96 The best way to configure the build process of vlc is to use the
97 `./configure' script.
98
99 See `./configure --help' for more information.
100
101 If you are cross-compiling from Debian, you can use something
102 along those lines:
103
104   ./bootstrap; \
105   CC=i586-mingw32msvc-gcc \
106   ./configure --host=i586-mingw32msvc --build=i386-linux \
107   --with-gtk-config-path=/usr/local/gtk-win32/bin \
108   --with-sdl-config-path=/usr/local/SDL-1.2.3-win32/i386-mingw32msvc/bin \
109   --with-directx=/usr/local/dxheaders \
110   --with-dvdcss-tree=../libdvdcss-win
111
112 If you are cross-compiling using the mingw32 package provided by
113 www.videolan.org, you have to use something along those lines:
114
115   ./bootstrap; \
116   CC=i586-mingw32msvc-gcc \
117   PATH=/usr/local/cross-tools/bin:$PATH \
118   ./configure --host=i586-mingw32msvc --build=i386-linux \
119   --with-gtk-config-path=/usr/local/gtk-win32/bin \
120   --with-sdl-config-path=/usr/local/SDL-1.2.3-win32/i386-mingw32msvc/bin \
121   --with-directx=/usr/local/dxheaders \
122   --with-dvdcss-tree=../libdvdcss-win
123
124 If you are compiling natively on Windoze, then you can use something
125 along those lines:
126   ./bootstrap; \
127   ./configure \
128   --with-gtk-config-path=/c/dev/gtk-win32/bin \
129   --with-sdl-config-path=/c/dev/SDL-1.2.3-win32/i386-mingw32msvc/bin \
130   --with-directx=/c/dev/dxheaders \
131   --with-dvdcss-tree=../libdvdcss-win
132
133 If you are using cygwin, you can build vlc with or without the unix emulation
134 layer (without is usually better). To build without the emulaion layer, use
135 something like this:
136   ./bootstrap; \
137   CC="gcc -mno-cygwin" \
138   ./configure \
139   --with-gtk-config-path=/cygdrive/c/dev/gtk-win32/bin \
140   --with-sdl-config-path=/cygdrive/c/dev/SDL-1.2.3-win32/i386-mingw32msvc/bin \
141   --with-directx=/cygdrive/c/dev/dxheaders \
142   --with-dvdcss-tree=../libdvdcss-win
143 If you want to use the emulation layer, then just omit the CC="gcc -mno-cygwin"
144 line.
145
146 Note: when using the --with-dvdcss-tree you need to compile the libdvdcss tree
147 beforehand.
148
149 Building VideoLAN Client
150 ========================
151
152 Have a look at the generated Makefile.opts file, you may want to choose
153 which modules will be compiled as plugins, and which ones will remain in
154 the core application. The configure script tries to guess for you.
155
156 Once configured, to build vlc you have to:
157
158 If you are cross-compiling from Debian or compiling natively on Windoze,
159 then just run `make'.
160
161 If you are cross-compiling using the mingw32 package provided by
162 www.videolan.org, run `PATH=/usr/local/cross-tools/bin:$PATH make'.
163
164 Building Win32 interface with bcc32 (Borland's compiler)
165 ========================================================
166 (This stage is only necessary if you want to use the Win32 native interface.
167  If you are happy with the GTK interface, then you can skip this section)
168
169 1) Compile vlc as usual.
170
171 2) From the plugin\win32 directory, use Borland C++ command-line tools
172 as follows:
173 bpr2mak intfwin.bpr -s \
174   | sed 's#^LIBPATH = .*#&;$$(RELEASELIBPATH)# ; s#^USERDEFINES = .*#& -DWIN32 -D__PLUGIN__ -DMODULE_NAME_IS_intfwin -DMODULE_NAME=intfwin#' \
175   > intfwin.mak         // Create a makefile from intfwin.bpr
176 make -fintfwin          // It's Borland's make utility !
177
178 3) This should create a intfwin.so
179 You can remove any other generated file.
180
181
182 Well done, now you're ready to use vlc!
183 =======================================