added changelog
[platform/upstream/gstreamer.git] / REQUIREMENTS
1 GStreamer use 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 the latest glib2, currently at v1.3.13
11 libxml2         (also called gnome-xml, available from http://xmlsoft.org/)
12
13 These libraries are all central parts of gnome, and are available from the
14 ftp.gnome.org or its mirrors, amongst other places.
15
16 Optional libraries:
17 ===================
18 gdk_pixbuf
19 libgnomeui      (for gstplay, gsteditor, autoplug example, several tests)
20 libglade        (for gstplay, gsteditor)
21 libHermes       (for colorspace conversions; you need this for any video work)
22                         http://www.clanlib.org/hermes/
23 libghttp        (for httpsrc)
24                         http://ftp.gnome.org/pub/GNOME/stable/sources/libghttp/
25 libaudiofile    (for afsrc/afsink)
26                         http://oss.sgi.com/projects/audiofile/
27 libmad          (for the mad mp3 decoder plugin)
28                         http://www.mars.org/home/rob/proj/mpeg/
29 libjpeg         (for jpegenc/jpegdec)
30                         http://www.ijg.org/
31 libopenquicktime (for the QT plugin)
32                         http://sourceforge.net/projects/openquicktime/
33 libXv           (for videosink)
34 libxaudio       (for xa mp3 decoder)
35                         http://www.xaudio.com/
36 libvorbis       (for vorbisenc, vorbisdec)
37                         http://www.xiph.org/ogg/vorbis/index.html
38 libcdparanoia   (for cdparanoia ripper)
39                         http://www.xiph.org/paranoia/index.html
40 liblame         (for lame mp3 encoder)
41                         http://www.mp3dev.org/mp3/
42 libshout        (for the shoutcast plugin)
43                         http://www.icecast.org
44 libasound       (for the alsa src/sink plugin)
45                         http://alsa-project.org/
46 librtp          (for the rtp sink plugin, shipped with Gnome-O-Phone)
47                         http://sourceforge.net/projects/gphone
48 aalib           (for the aa sink plugin)
49                         http://aa-project.sourceforge.net/aalib/
50 aRts            (for the arts plugin wrapper, and the artsd sink)
51                         http://www.arts-project.org
52 raw1394/linux1394       (for the dv plugin)
53                         http://linux1394.sourceforge.net
54 libdvdread      (for the dvdsrc)
55                         http://www.dtek.chalmers.se/groups/dvd/
56                         (optional: libcss for encrypted DVDs)
57 libesound       (for the esd sink 
58                         ftp.gnome.org/pub/GNOME/stable/sources/esound)
59 gnome-vfs       (for the gnome-vfs src)
60 libgsm          (for the gsm plugin)
61                         http://kbs.cs.tu-berlin.de/~jutta/toast.html
62 sdl             (for the sdl sink)
63                         http://www.libsdl.org
64 xmms            (for the xmms plugins wrapper)
65                         http://www.xmms.org
66 mpeg2dec/a52dec (for mpeg2 related plugins and dvd playback)
67                         http://libmpeg2.sourceforge.net/
68                         and http://liba52.sourceforge.net/
69 avifile         (for the avi windows decoder plugins)
70                         http://avifile.sourceforge.net/
71                         you might want to get the windows libraries 
72                         from http://divx.euro.ru/ and put the .dll files 
73                         in /usr/lib/win32/
74 flac            (for the FLAC lossless audio format)
75                         http://flac.sourceforge.net
76
77 An extra set of tools is required if you wish to build GStreamer out of
78 CVS (using autogen.sh):
79
80 Required tools:
81 ===============
82 autoconf 2.52
83 automake 1.5
84 libtool v1.4 or better
85 pkgconfig 0.8.0 (http://www.freedesktop.org/software/pkgconfig/)
86
87 Optional tools:
88 ===============
89 gtkdoc
90 db2html
91 fig2dev
92 xsltproc
93
94 Optional debian packages:
95 =========================
96 (This is an incomplete list, made only of problems which have been reported,
97 rather than by an audit.)
98 task-helix-gnome-dev   OR libgnome-dev
99
100 gtk-doc-tools 0.4-0.2  -- needed to build documentation
101
102 Alternatively, the docbook-gnome-bin package, which is available by adding the
103 following lines to apt's sources.list (/etc/apt/sources.list):
104
105 deb ftp://ftp.home-of-linux.org/pub/debian gnome/
106 deb-src ftp://ftp.home-of-linux.org/pub/debian gnome/