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