* Got rid of the DVD_DEVICE macro. We now use the dvd_device config option.
[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 in the 'Device name'
18 box (eg. 'D:' if your dvdrom drive is assigned the letter 'D').
19 ( !WARNING: you have to be in administrator mode (for now) on Win2k/XP or the
20   DVD won't play. )
21
22 Building VideoLAN Client from the source code
23 =============================================
24
25 If you want to do the tricky job of building vlc from sources, you can do it
26 in two ways:
27
28 - natively on Windows, using MSYS+MINGW (www.mingw.org)
29   (MSYS is a minimal build environnement to compile unixish projects under
30    windoze. It provides all the common unix tools like sh, gmake...)
31
32 - or on Linux, using the mingw32 cross-compiler
33
34 Getting the right tools
35 =======================
36
37 - cross-compiling with mingw32:
38 All the necessary tools you need can be found on the videolan web site:
39 http://www.videolan.org/vlc/windows.html
40
41 You first need to download a linux cross-compiler version of mingw32.
42 (for Debian GNU/Linux users, there is a mingw32 package)
43
44 You must also not forget to install the extra development packages if you want
45 to build the DirectX, GTK and SDL plugins.
46
47 - compiling natively on Windoze:
48 You first need to download and install MSYS-1.0.5 (version 1.0.6 doesn't seem
49 to work as well) and MINGW.
50 http://prdownloads.sourceforge.net/mingw/msys-1.0.5-i686-bin.tar.gz
51 http://prdownloads.sourceforge.net/mingw/MinGW-1.1.tar.gz
52
53 You must also not forget to install the extra development packages if you want
54 to build the DirectX, GTK and SDL plugins.
55 (http://www.videolan.org/vlc/windows.html)
56
57
58 NOTE: by default, the GTK package is configured to be installed in
59 /usr/local/gtk-win32, if you want to change this path, then you need to edit
60 the gtk-win32/bin/gtk-config file and change "gtk_dir=" accordingly.
61 The same is true for the SDL package, it is installed in
62 /usr/local/SDL-1.2.3-win32 by default and you need to change "prefix=" in 
63 SDL-1.2.3-win32/i386-mingw32msvc/bin/sdl-config if you plan to extract the
64 archive in a different directory.
65
66 Configuring the build
67 =====================
68
69 The best way to configure the build process of vlc is to use the
70 `./configure' script.
71
72 See `./configure --help' for more information.
73
74 If you are cross-compiling from Debian, you can use something
75 along those lines:
76
77   make distclean ; \
78   ./configure --host=i586-mingw32msvc --target=i586-mingw32msvc \
79   --build=i386-linux \
80   --with-gtk-config-path=/usr/local/gtk-win32/bin \
81   --with-sdl-config-path=/usr/local/SDL-1.2.3-win32/i386-mingw32msvc/bin \
82   --with-directx=/usr/local/dxheaders
83
84 If you are cross-compiling using the mingw32 package provided by
85 www.videolan.org, you have to use something along those lines:
86
87   CC=/usr/local/cross-tools/bin/i586-mingw32msvc-gcc \
88   PATH=/usr/local/cross-tools/bin:$PATH \
89   ./configure --host=i586-mingw32msvc --target=i586-mingw32msvc \
90   --build=i386-linux \
91   --with-gtk-config-path=/usr/local/gtk-win32/bin \
92   --with-sdl-config-path=/usr/local/SDL-1.2.3-win32/i386-mingw32msvc/bin \
93   --with-directx=/usr/local/dxheaders
94
95 If you are compiling natively on Windoze, then you can use something
96 along those lines:
97   MAKE=gmake ./configure \
98   --with-gtk-config-path=/c/dev/gtk-win32/bin \
99   --with-sdl-config-path=/c/dev/SDL-1.2.3-win32/i386-mingw32msvc/bin \
100   --with-directx=/c/dev/dxheaders
101
102 Building VideoLAN Client
103 ========================
104
105 Have a look at the generated Makefile.opts file, you may want to choose
106 which modules will be compiled as plugins, and which ones will remain in
107 the core application. The configure script tries to guess for you.
108
109 Once configured, to build vlc you have to:
110
111 If you are cross-compiling from Debian, then just run `make'.
112
113 If you are cross-compiling using the mingw32 package provided by
114 www.videolan.org, run `PATH=/usr/local/cross-tools/bin:$PATH make'.
115
116 If you are compiling natively on Windoze, run `MAKE=gmake gmake'.
117 (note that msys sometimes stops in the middle of the build process and
118 complains about not being able to create .dep files. If this happens, just
119 re-run the above command another time and it should work)
120
121 Building Win32 interface with bcc32 (Borland's compiler)
122 ========================================================
123 (This stage is only necessary if you want to use the Win32 native interface.
124  If you are happy with the GTK interface, then you can skip this section)
125
126 [Steps 2 and 3 are temporary]
127
128 1) Compile vlc as usual.
129 include\defs.h should be generated.
130
131 2) Edit include\defs.h, and add the following lines if necessary:
132 #define WIN32
133 #define MODULE_NAME win32
134 #define MODULE_NAME_IS win32
135 #define PLUGIN
136 #define HAVE_DYNAMIC_PLUGINS
137
138 3) Still in defs.h, comment the following line to avoid compilation warnings:
139 #define PACKAGE "vlc"
140
141 4) From the plugin\win32 directory, use Borland C++ command-line tools
142 as follows:
143 bpr2mak intfwin.bpr     // Create a makefile from intfwin.bpr
144 make -fintfwin          // It's Borland's make utility !
145
146 5) This should create a intfwin.so
147 You can remove any other generated file.
148
149
150 Well done, now you're ready to use vlc!
151 =======================================