merge from release branch
[platform/upstream/gstreamer.git] / REQUIREMENTS
1 GStreamer uses a *large* array of tools and libraries, most of which are
2 optional.  We have attempted to make sure that any code that depends on
3 optional libraries doesn't get built unless you have those libraries.  If
4 you find this not to be the case, please, let us know by filing a bug
5 report at http://sourceforge.net/bugs/?group_id=1936.
6
7
8 Required libraries:
9 ===================
10
11 The core GStreamer libraries are required which depend on the following:
12
13 the latest glib2, currently at v2.0.4
14 libxml2         (also called gnome-xml, available from http://xmlsoft.org/)
15
16 These libraries are all central parts of gnome, and are available from the
17 ftp.gnome.org or its mirrors, amongst other places.
18
19
20 Optional libraries:
21 ===================
22
23 This file lists supporting libraries for which gst-plugins contains plugins,
24 as well as their minimum version.  You can find the corresponding plugins in
25 ext/(library)
26
27 gdk_pixbuf
28 libgnomeui      (for gstplay, gsteditor, autoplug example, several tests)
29 libglade        (for gstplay, gsteditor)
30 libHermes       (for colorspace conversions; you need this for any video work)
31                         http://www.clanlib.org/hermes/
32 libghttp        (for httpsrc)
33                         http://ftp.gnome.org/pub/GNOME/stable/sources/libghttp/
34 libaudiofile    (for afsrc/afsink)
35                         http://oss.sgi.com/projects/audiofile/
36 libmad          (for the mad mp3 decoder plugin)
37                         http://www.mars.org/home/rob/proj/mpeg/
38 libjpeg         (for jpegenc/jpegdec)
39                         http://www.ijg.org/
40 libopenquicktime (for the QT plugin)
41                         http://sourceforge.net/projects/openquicktime/
42 libXv           (for videosink)
43 libxaudio       (for xa mp3 decoder)
44                         http://www.xaudio.com/
45 libvorbis       (for vorbisenc, vorbisdec)
46                         http://www.xiph.org/ogg/vorbis/index.html
47 libcdparanoia   (for cdparanoia ripper)
48                         http://www.xiph.org/paranoia/index.html
49 liblame         (for lame mp3 encoder)
50                         http://www.mp3dev.org/mp3/
51 libshout        (for the shoutcast plugin)
52                         http://www.icecast.org
53 libasound       (for the alsa src/sink plugin)
54                         http://alsa-project.org/
55 ortp            (for the rtp sink plugin)
56                         http://www.linphone.org/ortp/
57 aalib           (for the aa sink plugin)
58                         http://aa-project.sourceforge.net/aalib/
59 aRts            (for the arts plugin wrapper, and the artsd sink)
60                         http://www.arts-project.org
61 raw1394/linux1394       (for the dv plugin)
62                         http://linux1394.sourceforge.net
63 libdvdread      (for the dvdsrc)
64                         http://www.dtek.chalmers.se/groups/dvd/
65                         (optional: libcss for encrypted DVDs)
66 libesound       (for the esd sink 
67                         ftp.gnome.org/pub/GNOME/stable/sources/esound)
68 gnome-vfs       (for the gnome-vfs src)
69 libgsm          (for the gsm plugin)
70                         http://kbs.cs.tu-berlin.de/~jutta/toast.html
71 sdl             (for the sdl sink)
72                         http://www.libsdl.org
73 xmms            (for the xmms plugins wrapper)
74                         http://www.xmms.org
75 mpeg2dec/a52dec (for mpeg2 related plugins and dvd playback)
76                         http://libmpeg2.sourceforge.net/
77                         and http://liba52.sourceforge.net/
78                 >=      v0.2.1/v0.7.2
79 avifile         (for the avi windows decoder plugins)
80                         http://avifile.sourceforge.net/
81                         you might want to get the windows libraries 
82                         from http://divx.euro.ru/ and put the .dll files 
83                         in /usr/lib/win32/
84                 >=      0.6.0 (cvs)
85
86
87 flac            (for the FLAC lossless audio format)
88                         http://flac.sourceforge.net
89
90
91 Required tools:
92 ===============
93
94 An extra set of tools is required if you wish to build GStreamer out of
95 CVS (using autogen.sh):
96
97 autoconf 2.52
98 automake 1.5
99 libtool v1.4 or better
100 pkgconfig 0.8.0 (http://www.freedesktop.org/software/pkgconfig/)
101
102
103 Optional tools:
104 ===============
105
106 gtkdoc
107 db2html
108 fig2dev
109 xsltproc
110
111
112 Optional debian packages:
113 =========================
114
115 (This is an incomplete list, made only of problems which have been reported,
116 rather than by an audit.)
117 task-helix-gnome-dev   OR libgnome-dev
118
119 gtk-doc-tools 0.4-0.2  -- needed to build documentation
120
121 Alternatively, the docbook-gnome-bin package, which is available by adding the
122 following lines to apt's sources.list (/etc/apt/sources.list):
123
124 deb ftp://ftp.home-of-linux.org/pub/debian gnome/
125 deb-src ftp://ftp.home-of-linux.org/pub/debian gnome/