Fix oggplay-dump-first-frame
[liboggplay.git] / README
blobf1c44046f85349087cb5ac4bdcdc039f2ba6d7e8
1 OggPlay: a library for playing Ogg multimedia
3 Overview
4 --------
6 The current version of the plugin is still under development therefore
7 the setup requires manual installation of the plugin. For more information,
8 see also:
10   http://wiki.xiph.org/index.php/OggPlay
12 Dependencies
13 ------------
15 For the core library (liboggplay), you need
17   * libogg, libvorbis, libtheora, optionally libspeex -- from http://www.xiph.org/
19     svn co http://svn.xiph.org/trunk/ogg/ ogg
20     svn co http://svn.xiph.org/trunk/vorbis/ vorbis
21     svn co http://svn.xiph.org/trunk/theora/ theora
23   * liboggz, libfishsound and libskeleton:
25     git clone git://git.xiph.org/liboggz.git
26     git clone git://git.xiph.org/libfishsound.git
27     git clone git://git.xiph.org/libskeleton.git
29 Optionally, for Kate stream support, you need
31   * libkate -- from http://libkate.googlecode.com/
33 To render Kate streams as video overlays, you need
35   * libtiger -- from http://libtiger.googlecode.com/
37 Note that libtiger needs Pango and Cairo:
39   * Pango -- http://www.pango.org/
40   * Cairo -- http://cairographics.com/
42 See the README files associated with these libraries for installation
43 instructions.
45 To build src/examples/glut-player, you need:
46   * The core liboggplay dependencies (listed above)
47   * GLUT -- see http://www.opengl.org/resources/libraries/
49 To build src/examples/dump-all-streams, you need:
50   * The core liboggplay dependencies (listed above)
51   * libsndfile -- from http://www.mega-nerd.com/libsndfile/
53 To build src/tools/oggplay-dump-first-frame, you need:
54   * The core liboggplay dependencies (listed above)
55   * Imlib2 -- from your distribution or from 
56               http://sourceforge.net/project/showfiles.php?group_id=2&package_id=11130
58 On Debian, the required packages for all these additional libraries are:
59   g++ libogg-dev libvorbis-dev libspeex-dev libtheora-dev libsndfile1-dev
60   libimlib2-dev libglut-dev
62 Compile and Install liboggplay
63 ------------------------------
65 ./autogen.sh
66 ./configure
67 make && make install