Decomp: vmsplice support
[vlc.git] / INSTALL.wince
1 INSTALL file for the WinCE version of the VLC media player
2
3
4 Building VLC from the source code
5 =================================
6
7 If you want to build VLC from sources, you can do it in several ways:
8
9 - On GNU/Linux, using the wince gcc cross-compiler.
10   (Right now we only provide an ARM version of the cross-compiler)
11
12 - Natively on Windows, using Microsoft Embedded Visual C++.
13   Even though we provide some evc project files with vlc, this method is
14   advised only if you just want to experiment/play with some basic
15   functionality in vlc. The reason for this is that vlc depends on a lot of
16   3rd party libraries and building them in EVC is not convenient and
17   sometimes even impossible.
18
19 Getting the right compiler tools
20 ================================
21
22 You will need to download our wince gcc cross-compiler package:
23 http://www.videolan.org/pub/testing/wince/wince-arm-gcc4.0.0-cvs-linux-crosscompiler-20050517.tar.bz2.
24 Extract this package in your root directory (everything will be extracted in
25 /usr/local/wince/cross-tools).
26
27 The source code for this cross-compiler in also available at the same location.
28
29 Getting the additional libraries
30 =================================
31
32 VLC depends on other libraries to provide some features like ac3 audio decoding
33 or mpeg4 video decoding, etc...
34
35 Depending on your needs you will have to compile/install some or all of these
36 external libraries.
37
38 They can be found here (source code):
39 http://download.videolan.org/pub/testing/contrib/
40
41 We also provide a package with all the libraries already compiled so it is
42 actually really easy to compile a full-featured version of vlc:
43 http://download.videolan.org/pub/testing/wince/contrib-20050220-wince-xscale-bin.tar.bz2 (Check out fo more recent versions at the same location). 
44
45 All you need to do is extract it in your root directory (the include files
46 and libraries will be put in /usr/local/wince/contrib-xscale).
47 You can do this with the following command: 
48
49   tar xjvf contrib-20050220-wince-xscale-bin.tar.bz2 -C /
50
51 Please note the "-C /".
52
53 A complete list of the libraries on which we depend can be found here:
54 http://developers.videolan.org/vlc/
55
56 Configuring the build
57 =====================
58
59 Once you've got all the files you need in place, you need to configure the
60 build with the `./configure' script.
61
62 I'll assume that you are using the pre-compiled 3rd party libraries I'm
63 providing and that they are in /usr/local/wince/contrib-xscale.
64
65 Use something along those lines:
66
67 ./bootstrap &&
68 PATH=/usr/local/wince/cross-tools/bin:$PATH \
69 CFLAGS="-D__stdcall= -D_OFF_T_ -I/usr/local/wince/cross-tools/include" \
70 CFLAGS="$CFLAGS -I/usr/local/wince/contrib-xscale/include" \
71 LDFLAGS="-L/usr/local/wince/cross-tools/lib" \
72 LDFLAGS="$LDFLAGS -L/usr/local/wince/contrib-xscale/lib" \
73 CC="arm-wince-pe-gcc -mcpu=xscale" \
74    ../configure --host=arm-wince-pe --target=arm-wince-pe \
75     --build=i686-linux --prefix=/usr/local/wince \
76     --disable-sdl --disable-gtk --disable-dvdnav --disable-dvdread \
77     --disable-nls --disable-sout --disable-vlm --disable-wxwindows \
78     --disable-a52 --disable-libmpeg2 --disable-freetype --disable-fribidi \
79     --disable-mad --disable-plugins --enable-optimize-memory \
80     --with-freetype-config-path=/usr/local/wince-xscale/bin \
81     --with-fribidi-config-path=/usr/local/wince-xscale/bin \
82     --enable-tremor --enable-faad
83
84 See `./configure --help' for more information.
85
86 Actually Compiling the VLC source
87 =================================
88
89 Once configured, to build VLC, just run:
90   PATH=/usr/local/wince/cross-tools/bin:$PATH make
91
92 Once the compilation is done, you can build self-contained VLC packages with
93 the following 'make' rules:
94
95   make package-win32-base
96    will create a subdirectory named vlc-x.x.x with all the binaries
97    'stripped' (ie. without any debugging symbols).
98
99   make package-win32-zip
100    Same as above but will package the directory in a zip file.
101
102 Well done, now you're ready to use VLC!
103 =======================================