Add an INSTALL.maemo file
authorAntoine Lejeune <phytos@videolan.org>
Mon, 10 Nov 2008 16:43:00 +0000 (17:43 +0100)
committerRémi Denis-Courmont <rdenis@simphalempin.com>
Mon, 24 Nov 2008 16:48:56 +0000 (18:48 +0200)
Signed-off-by: Rémi Denis-Courmont <rdenis@simphalempin.com>
INSTALL.maemo [new file with mode: 0644]

diff --git a/INSTALL.maemo b/INSTALL.maemo
new file mode 100644 (file)
index 0000000..8d92fdf
--- /dev/null
@@ -0,0 +1,82 @@
+INSTALL file for the Maemo version of the VLC media player
+
+
+Building VLC from the source code
+=================================
+
+If you want to build the maemo version of VLC from the source, you have to install the
+Maemo Software Development Kit as indicated in the Maemo Diablo Reference Manual for
+Maemo 4.1 that you can find on this page : http://maemo.org/development/documentation/tutorials/
+
+You have to use the ARMEL target (arm) of the Maemo SDK. The X86 target isn't tested.
+
+
+Installing the correct tools in the scratchbox
+==============================================
+
+When you have a working scratchbox with the Maemo SDK installed, before compiling VLC, you
+must install additional tools and libraries.
+
+To compile, VLC needs the lastest version of automake avaible in the SDK : automake-1.9. To
+use it, you must set the environment variable SBOX_DEFAULT_AUTOMAKE to 1.9 :
+    export SBOX_DEFAULT_AUTOMAKE=1.9
+You can put it in the .bashrc file inside the scratchbox.
+
+You also need autoconf-2.61 which is *not* avaible in the Maemo SDK. You have to build it and
+install it yourself.
+
+Additional libraries
+====================
+
+You have to install libgcrypt under the scratchbox to build VLC.
+
+You can also install fribidi, libvorbixidev, libmad and other VLC dependancies that you can find
+in the extra repositories of Maemo :
+    deb http://repository.maemo.org/extras/ diablo free
+    deb-src http://repository.maemo.org/extras/ diablo free
+
+Installing correct headers
+==========================
+
+For VLC to compile under the Maemo SDK, you must copy the linux/videodev2.h from your Linux
+distribution into the scratchbox.
+
+To build the omap frame buffer video output module, you also need an up-to-date
+asm/arch-omap/omapfb.h (you can find it on google by searching omapfb.h).
+
+FFmpeg (not necessary)
+======
+
+You can also build ffmpeg. For this, you can use Debian source package.
+
+You have to get the ffmpeg-free_0.svn20080206.orig.tar.gz and the Debian diff file
+ffmpeg-free_0.svn20080206-8.diff.gz for example. Decompress them and apply the patch.
+
+You have to modify the debian/rules and debian/control files to remove the dependancies
+which aren't available in the maemo or maemo extra repositories.
+
+You might have to change the line 3550 of ffmpeg/libavcodec/dsputil.c from
+    DECLARE_ALIGNED_8 (uint64_t, aligned_bak[stride]);
+to
+    uint64_t *aligned_bak[stride];
+to build ffmpeg into the scratchbox.
+
+Configuring
+===========
+
+You can do :
+./bootstrap && ./configure --disable-qt4 --disable-skins2 --disable-glx --disable-a52 \
+                           --enable-tremor --enable-maemo --enable-omapfb --enable-flac \
+                           --enable-debug
+for example.
+
+Building VLC
+============
+
+Just do :
+    make
+
+Run VLC
+=======
+
+VLC doesn't run inside the scratchbox, you must test it directly on a N800/N810 devices.
\ No newline at end of file