1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY gstreamer-download-http "&gnome-download-http;/gstreamer/0.10/gstreamer-&gstreamer-version;.tar.xz">
|
---|
8 | <!ENTITY gstreamer-download-ftp "&gnome-download-ftp;/gstreamer/0.10/gstreamer-&gstreamer-version;.tar.xz">
|
---|
9 | <!ENTITY gstreamer-md5sum "1da0b170d4d17d358b27011647054f0a">
|
---|
10 | <!ENTITY gstreamer-size "2.9 MB">
|
---|
11 | <!ENTITY gstreamer-buildsize "112 MB">
|
---|
12 | <!ENTITY gstreamer-time "1.2 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="gstreamer" xreflabel="GStreamer-&gstreamer-version;">
|
---|
16 | <?dbhtml filename="gstreamer.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>GStreamer-&gstreamer-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="gstreamer">
|
---|
26 | <primary sortas="a-GStreamer">GStreamer</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to GStreamer</title>
|
---|
31 |
|
---|
32 | <para>The <application>GStreamer</application> package contains a streaming
|
---|
33 | media framework that enables applications to share a common set of plugins for
|
---|
34 | things like video decoding and encoding, audio encoding and decoding, audio
|
---|
35 | and video filters, audio visualisation, Web streaming and anything else that
|
---|
36 | streams in real-time or otherwise. It is modelled after research software
|
---|
37 | worked on at the Oregon Graduate Institute. After installing
|
---|
38 | <application>GStreamer</application>, you'll likely need to install
|
---|
39 | one or more of the <xref linkend="gst-plugins-good"/>,
|
---|
40 | <xref linkend="gst-plugins-ugly"/>, <xref linkend="gst-plugins-bad"/>
|
---|
41 | and <xref linkend="gst-ffmpeg"/> packages.</para>
|
---|
42 |
|
---|
43 | &lfs70_built;
|
---|
44 |
|
---|
45 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
46 | <itemizedlist spacing="compact">
|
---|
47 | <listitem>
|
---|
48 | <para>Download (HTTP): <ulink url="&gstreamer-download-http;"/></para>
|
---|
49 | </listitem>
|
---|
50 | <listitem>
|
---|
51 | <para>Download (FTP): <ulink url="&gstreamer-download-ftp;"/></para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>Download MD5 sum: &gstreamer-md5sum;</para>
|
---|
55 | </listitem>
|
---|
56 | <listitem>
|
---|
57 | <para>Download size: &gstreamer-size;</para>
|
---|
58 | </listitem>
|
---|
59 | <listitem>
|
---|
60 | <para>Estimated disk space required: &gstreamer-buildsize;</para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>Estimated build time: &gstreamer-time;</para>
|
---|
64 | </listitem>
|
---|
65 | </itemizedlist>
|
---|
66 |
|
---|
67 | <bridgehead renderas="sect3">GStreamer Dependencies</bridgehead>
|
---|
68 |
|
---|
69 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
70 | <para role="required"><xref linkend="glib2"/>, and
|
---|
71 | <xref linkend="libxml2"/></para>
|
---|
72 |
|
---|
73 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
74 | <para role="optional"><xref linkend="gobject-introspection"/>,
|
---|
75 | <ulink url="http://www.gnu.org/software/gsl/">GSL</ulink>,
|
---|
76 | <xref linkend='check'/> (required to run the unit regression tests and also enables
|
---|
77 | <filename class='libraryfile'>libgstcheck-0.10</filename>), and
|
---|
78 | <ulink url="http://www.valgrind.org/">Valgrind</ulink>
|
---|
79 | (optionally used during the unit regression tests)
|
---|
80 | </para>
|
---|
81 |
|
---|
82 | <!-- exceptionally, there seems no way to install the shipped
|
---|
83 | API docs, so they have to be built, not rebuilt.-->
|
---|
84 | <bridgehead renderas="sect4">Optional (Required to build the API
|
---|
85 | Documentation)</bridgehead>
|
---|
86 | <para role="optional"><xref linkend="gtk-doc"/> and
|
---|
87 | <xref linkend="python"/> (compiled against an XML Parser such as
|
---|
88 | <xref linkend="expat"/>). Alternatively, developers can access
|
---|
89 | the online API docs at <ulink
|
---|
90 | url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/api-index-full.html">freedesktop.org</ulink>
|
---|
91 | </para>
|
---|
92 |
|
---|
93 | <bridgehead renderas="sect4">Optional (Required to Build
|
---|
94 | Manuals)</bridgehead>
|
---|
95 | <para role="optional"><xref linkend="libxslt"/>,
|
---|
96 | <!--<xref linkend="tetex"/> or--> <xref linkend="texlive"/>,
|
---|
97 | <xref linkend="docbook-utils"/>,
|
---|
98 | <ulink url="http://www.xfig.org/">Transfig</ulink> (all needed
|
---|
99 | to build the HTML manual), plus
|
---|
100 | <xref linkend="gs"/>, and <!-- or
|
---|
101 | <xref linkend="espgs"/>, and -->
|
---|
102 | <ulink url="http://netpbm.sourceforge.net/">Netpbm</ulink>
|
---|
103 | to build the postscript and PDF manuals.
|
---|
104 | Alternatively, developers can access the online manual at <ulink
|
---|
105 | url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/index.html">freedesktop.org</ulink>
|
---|
106 | </para>
|
---|
107 |
|
---|
108 | <para condition="html" role="usernotes">User Notes:
|
---|
109 | <ulink url="&blfs-wiki;/gstreamer"/></para>
|
---|
110 |
|
---|
111 | </sect2>
|
---|
112 |
|
---|
113 | <sect2 role="installation">
|
---|
114 | <title>Installation of GStreamer</title>
|
---|
115 |
|
---|
116 | <!-- Commenting as the Valgrind stuff has been fixed, but leaving it in
|
---|
117 | here so in case we need it again
|
---|
118 | <para>Newer versions of <application>Valgrind</application> are known to
|
---|
119 | cause the build to break. If you have <application>Valgrind</application>
|
---|
120 | version >= 3.1.0 installed, you should add
|
---|
121 | <option>-disable-valgrind</option> to the <command>configure</command>
|
---|
122 | command below so the build will complete.</para>
|
---|
123 | -->
|
---|
124 |
|
---|
125 | <para>Install <application>GStreamer</application> by running the following
|
---|
126 | commands:</para>
|
---|
127 |
|
---|
128 | <screen><userinput>sed -i 's/\(.*gtkdoc-rebase --relative.* \)\(;.*\)/\1|| true\2/' \
|
---|
129 | docs/{gst,libs}/Makefile.in &&
|
---|
130 | ./configure --prefix=/usr \
|
---|
131 | --libexecdir=/usr/lib &&
|
---|
132 | make</userinput></screen>
|
---|
133 |
|
---|
134 | <para>To test the results, issue: <command>make check</command>. There are
|
---|
135 | many other <filename>Makefile</filename> targets you can specify for
|
---|
136 | running the tests, issue <command>make -C tests/check help</command> to see
|
---|
137 | the complete list.</para>
|
---|
138 |
|
---|
139 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
140 |
|
---|
141 | <screen role="root"><userinput>make install &&
|
---|
142 | install -v -m755 -d /usr/share/doc/gstreamer-0.10/design &&
|
---|
143 | install -v -m644 docs/design/*.txt \
|
---|
144 | /usr/share/doc/gstreamer-0.10/design &&
|
---|
145 |
|
---|
146 | if [ -d /usr/share/doc/gstreamer-0.10/faq/html ]; then
|
---|
147 | chown -v -R root:root \
|
---|
148 | /usr/share/doc/gstreamer-0.10/*/html
|
---|
149 | fi</userinput></screen>
|
---|
150 |
|
---|
151 | <!-- Gtk-Docs are now installed by default, even without building them
|
---|
152 | <para>If you did not rebuild the API documentation by passing
|
---|
153 | <option>-enable-gtk-doc</option> to the <command>configure</command>
|
---|
154 | script and you wish to install the pre-built documentation, issue the
|
---|
155 | following command as the <systemitem class="username">root</systemitem>
|
---|
156 | user:</para>
|
---|
157 |
|
---|
158 | <screen role="root"><userinput>for DOCS in gst libs plugins; do make -C docs/$DOCS install-data; done</userinput></screen>
|
---|
159 | -->
|
---|
160 |
|
---|
161 | <sect3>
|
---|
162 | <title>Testing the Installation</title>
|
---|
163 |
|
---|
164 | <para>To test the functionality of the
|
---|
165 | <application>GStreamer</application> installation, you can run a simple
|
---|
166 | test as an unprivileged user (you may have to run
|
---|
167 | <command>ldconfig</command> as the
|
---|
168 | <systemitem class="username">root</systemitem> user before attempting
|
---|
169 | the test).</para>
|
---|
170 |
|
---|
171 | <screen><userinput>gst-launch -v fakesrc num_buffers=5 ! fakesink</userinput></screen>
|
---|
172 |
|
---|
173 | <para>If the command outputs a series of messages from fakesrc and
|
---|
174 | fakesink, everything is okay.</para>
|
---|
175 |
|
---|
176 | </sect3>
|
---|
177 |
|
---|
178 | </sect2>
|
---|
179 |
|
---|
180 | <sect2 role="commands">
|
---|
181 | <title>Command Explanations</title>
|
---|
182 |
|
---|
183 | <para><option>sed -i 's/\(.*gtkdoc-rebase --relative.* \)\(;.*\)/\1|| true\2/' \
|
---|
184 | docs/{gst,libs}/Makefile.in</option>: Two of the Makefiles test if
|
---|
185 | <command>gtkdoc-rebase</command> is present, and only use it if it is,
|
---|
186 | but the test <command>which gtk-doc</command> is interpreted as an error by
|
---|
187 | <command>make</command> if <command>gtkdoc-rebase</command> is not present. The
|
---|
188 | <command>sed</command> command ensures the command is always regarded as
|
---|
189 | successful.</para>
|
---|
190 |
|
---|
191 | <para><parameter>--libexecdir=/usr/lib</parameter>: This parameter is used
|
---|
192 | so that the <application>GStreamer</application> internal support programs
|
---|
193 | are installed in the preferred location of <filename
|
---|
194 | class='directory'>/usr/lib/gstreamer-0.10</filename> instead of <filename
|
---|
195 | class='directory'>/usr/libexec/gstreamer-0.10</filename>.</para>
|
---|
196 |
|
---|
197 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
198 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
199 |
|
---|
200 | <para><option>--disable-static</option>: This switch prevents the static
|
---|
201 | libraries from being built.</para>
|
---|
202 |
|
---|
203 | <para><option>--enable-docbook</option>: This parameter is used to build
|
---|
204 | HTML, PDF and PostScript versions of the
|
---|
205 | <application>GStreamer</application> User's Manual, FAQ and Writer's Guide.
|
---|
206 | Note that you must have all the listed dependencies installed.</para>
|
---|
207 |
|
---|
208 | <para><command>chown -v -R root:root ...</command>: The documentation is
|
---|
209 | installed with ownerships of the user who untarred and built the package.
|
---|
210 | This command changes the ownerships of the installed documentation files to
|
---|
211 | root:root and is only executed if the documentation files were built and
|
---|
212 | installed.</para>
|
---|
213 |
|
---|
214 | </sect2>
|
---|
215 |
|
---|
216 | <sect2 role="content">
|
---|
217 | <title>Contents</title>
|
---|
218 |
|
---|
219 | <segmentedlist>
|
---|
220 | <segtitle>Installed Programs</segtitle>
|
---|
221 | <segtitle>Installed Libraries</segtitle>
|
---|
222 | <segtitle>Installed Directories</segtitle>
|
---|
223 |
|
---|
224 | <seglistitem>
|
---|
225 | <seg>gst-feedback, gst-feedback-0.10, gst-inspect, gst-inspect-0.10,
|
---|
226 | gst-launch, gst-launch-0.10, gst-plugin-scanner, gst-typefind,
|
---|
227 | gst-typefind-0.10, gst-xmlinspect, gst-xmlinspect-0.10, gst-xmllaunch,
|
---|
228 | and gst-xmllaunch-0.10</seg>
|
---|
229 | <seg>libgstbase-0.10.{so,a}, libgstcheck-0.10.{so,a},
|
---|
230 | libgstcontroller-0.10.{so,a}, libgstcoreelements.so,
|
---|
231 | libgstcoreindexers.so, libgstdataprotocol-0.10.{so,a},
|
---|
232 | libgstnet-0.10.{so,a}, and libgstreamer-0.10.{so,a}</seg>
|
---|
233 | <seg>/usr/{include/gstreamer-0.10/gst/{base,check,controller,
|
---|
234 | dataprotocol,net},lib/{gstreamer-0.10,gstreamer/gstreamer-0.10},
|
---|
235 | share/{gstreamer-0.10/presets,gtk-doc/html/{gstreamer-0.10,
|
---|
236 | gstreamer-libs-0.10,gstreamer-plugins-0.10}}}</seg>
|
---|
237 | </seglistitem>
|
---|
238 | </segmentedlist>
|
---|
239 |
|
---|
240 | <variablelist>
|
---|
241 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
242 | <?dbfo list-presentation="list"?>
|
---|
243 | <?dbhtml list-presentation="table"?>
|
---|
244 |
|
---|
245 | <varlistentry id="gst-feedback">
|
---|
246 | <term><command>gst-feedback-0.10</command></term>
|
---|
247 | <listitem>
|
---|
248 | <para>generates debug info for <application>GStreamer</application>
|
---|
249 | bug reports.</para>
|
---|
250 | <indexterm zone="gstreamer gst-feedback">
|
---|
251 | <primary sortas="b-gst-feedback">gst-feedback-0.10</primary>
|
---|
252 | </indexterm>
|
---|
253 | </listitem>
|
---|
254 | </varlistentry>
|
---|
255 |
|
---|
256 | <varlistentry id="gst-inspect">
|
---|
257 | <term><command>gst-inspect-0.10</command></term>
|
---|
258 | <listitem>
|
---|
259 | <para>prints information about a
|
---|
260 | <application>GStreamer</application> plugin or element.</para>
|
---|
261 | <indexterm zone="gstreamer gst-inspect">
|
---|
262 | <primary sortas="b-gst-inspect">gst-inspect-0.10</primary>
|
---|
263 | </indexterm>
|
---|
264 | </listitem>
|
---|
265 | </varlistentry>
|
---|
266 |
|
---|
267 | <varlistentry id="gst-launch">
|
---|
268 | <term><command>gst-launch-0.10</command></term>
|
---|
269 | <listitem>
|
---|
270 | <para>is a tool that builds and runs basic
|
---|
271 | <application>GStreamer</application> pipelines.</para>
|
---|
272 | <indexterm zone="gstreamer gst-launch">
|
---|
273 | <primary sortas="b-gst-launch">gst-launch-0.10</primary>
|
---|
274 | </indexterm>
|
---|
275 | </listitem>
|
---|
276 | </varlistentry>
|
---|
277 |
|
---|
278 | <varlistentry id="gst-typefind">
|
---|
279 | <term><command>gst-typefind-0.10</command></term>
|
---|
280 | <listitem>
|
---|
281 | <para>uses the <application>GStreamer</application> type finding
|
---|
282 | system to determine the relevant <application>GStreamer</application>
|
---|
283 | plugin to parse or decode a file, and determine the corresponding
|
---|
284 | MIME type.</para>
|
---|
285 | <indexterm zone="gstreamer gst-typefind">
|
---|
286 | <primary sortas="b-gst-typefind">gst-typefind-0.10</primary>
|
---|
287 | </indexterm>
|
---|
288 | </listitem>
|
---|
289 | </varlistentry>
|
---|
290 |
|
---|
291 | <varlistentry id="gst-xmlinspect">
|
---|
292 | <term><command>gst-xmlinspect-0.10</command></term>
|
---|
293 | <listitem>
|
---|
294 | <para>prints information about a <application>GStreamer</application>
|
---|
295 | plugin or element in XML document format.</para>
|
---|
296 | <indexterm zone="gstreamer gst-xmlinspect">
|
---|
297 | <primary sortas="b-gst-xmlinspect">gst-xmlinspect-0.10</primary>
|
---|
298 | </indexterm>
|
---|
299 | </listitem>
|
---|
300 | </varlistentry>
|
---|
301 |
|
---|
302 | <varlistentry id="gst-xmllaunch">
|
---|
303 | <term><command>gst-xmllaunch-0.10</command></term>
|
---|
304 | <listitem>
|
---|
305 | <para>is used to build and run a basic <application>GStreamer</application>
|
---|
306 | pipeline, loading it from an XML description.</para>
|
---|
307 | <indexterm zone="gstreamer gst-xmllaunch">
|
---|
308 | <primary sortas="b-gst-xmllaunch">gst-xmllaunch-0.10</primary>
|
---|
309 | </indexterm>
|
---|
310 | </listitem>
|
---|
311 | </varlistentry>
|
---|
312 |
|
---|
313 | </variablelist>
|
---|
314 |
|
---|
315 | </sect2>
|
---|
316 |
|
---|
317 | </sect1>
|
---|