source: archive/gstreamer.xml

trunk
Last change on this file was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 17 months ago

Remove sect1info tags

They only contain a date tag that is nowhere used.

  • Property mode set to 100644
File size: 10.8 KB
Line 
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 "15389c73e091b1dda915279c388b9cb2">
10 <!ENTITY gstreamer-size "2.9 MB">
11 <!ENTITY gstreamer-buildsize "90 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
19 <title>GStreamer-&gstreamer-version;</title>
20
21 <indexterm zone="gstreamer">
22 <primary sortas="a-GStreamer">GStreamer</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to GStreamer</title>
27<!--
28 <para>
29 <application>GStreamer</application> is a streaming media framework that
30 enables applications to share a common set of plugins for things like
31 video decoding and encoding, audio encoding and decoding, audio and video
32 filters, audio visualisation, Web streaming and anything else that streams
33 in real-time or otherwise. It is modelled after research software worked
34 on at the Oregon Graduate Institute. After installing
35 <application>GStreamer</application>, you'll likely need to install one or
36 more of the <xref linkend="gst-plugins-bad"/>,
37 <xref linkend="gst-plugins-good"/>, <xref linkend="gst-plugins-ugly"/> and
38 <xref linkend="gst-ffmpeg"/> packages.
39 </para>
40-->
41 &lfs77_checked;
42
43 &gst-compat;
44
45 <bridgehead renderas="sect3">Package Information</bridgehead>
46 <itemizedlist spacing="compact">
47 <listitem>
48 <para>
49 Download (HTTP): <ulink url="&gstreamer-download-http;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download (FTP): <ulink url="&gstreamer-download-ftp;"/>
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download MD5 sum: &gstreamer-md5sum;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Download size: &gstreamer-size;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated disk space required: &gstreamer-buildsize;
70 </para>
71 </listitem>
72 <listitem>
73 <para>
74 Estimated build time: &gstreamer-time;
75 </para>
76 </listitem>
77 </itemizedlist>
78
79 <bridgehead renderas="sect3">GStreamer Dependencies</bridgehead>
80
81 <bridgehead renderas="sect4">Required</bridgehead>
82 <para role="required">
83 <xref linkend="glib2"/> and
84 <xref linkend="libxml2"/>
85 </para>
86
87 <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
88 <para role="optional">
89 <xref linkend="gobject-introspection"/>
90 </para>
91
92 <bridgehead renderas="sect4">Optional</bridgehead>
93 <para role="optional">
94 <xref linkend="gsl"/>,
95 <xref linkend="valgrind"/>
96 (optionally used during the unit regression tests)
97 </para>
98
99 <bridgehead renderas="sect4">
100 Optional (Required to rebuild the API Documentation)
101 </bridgehead>
102 <para role="optional">
103 <xref linkend="gtk-doc"/> and
104 <xref linkend="python2"/>
105 </para>
106
107 <bridgehead renderas="sect4">Optional (Required to Build Manuals)</bridgehead>
108 <para role="optional">
109 <xref linkend="docbook-utils"/>,
110 <xref linkend="gs"/>
111 <xref linkend="libxslt"/> and
112 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)
113 </para>
114
115 <para condition="html" role="usernotes">User Notes:
116 <ulink url="&blfs-wiki;/gstreamer"/>
117 </para>
118 </sect2>
119
120 <sect2 role="installation">
121 <title>Installation of GStreamer</title>
122
123 <para>
124 Install <application>GStreamer</application> by running the following
125 commands:
126 </para>
127
128<screen><userinput>sed -i -e '/YYLEX_PARAM/d' \
129 -e '/parse-param.*scanner/i %lex-param { void *scanner }' \
130 gst/parse/grammar.y &amp;&amp;
131
132./configure --prefix=/usr \
133 --disable-static &amp;&amp;
134make</userinput></screen>
135
136 <para>
137 To test the results, issue: <command>make check</command>. There are
138 many other <filename>Makefile</filename> targets you can specify for
139 running the tests, issue <command>make -C tests/check help</command>
140 to see the complete list.
141 </para>
142
143 <para>
144 Now, as the <systemitem class="username">root</systemitem> user:
145 </para>
146
147<screen role="root"><userinput>make install &amp;&amp;
148install -v -m755 -d /usr/share/doc/gstreamer-0.10/design &amp;&amp;
149install -v -m644 docs/design/*.txt \
150 /usr/share/doc/gstreamer-0.10/design &amp;&amp;
151
152if [ -d /usr/share/doc/gstreamer-0.10/faq/html ]; then
153 chown -v -R root:root \
154 /usr/share/doc/gstreamer-0.10/*/html
155fi</userinput></screen>
156
157 <sect3>
158 <title>Testing the Installation</title>
159
160 <para>
161 To test the functionality of the
162 <application>GStreamer</application> installation, you can run a
163 simple test as an unprivileged user (you may have to run
164 <command>ldconfig</command> as the
165 <systemitem class="username">root</systemitem> user before
166 attempting the test).
167 </para>
168
169<screen><userinput>gst-launch -v fakesrc num_buffers=5 ! fakesink</userinput></screen>
170
171 <para>
172 If the command outputs a series of messages from fakesrc and
173 fakesink, everything is okay.
174 </para>
175
176 </sect3>
177
178 </sect2>
179
180 <sect2 role="commands">
181 <title>Command Explanations</title>
182
183 <para>
184 <command>sed ... gst/parse/grammar.y</command>: This command corrects
185 a problem caused by the most recent version of Bison.
186 </para>
187
188 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
189 href="../../xincludes/static-libraries.xml"/>
190
191 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
192 href="../../xincludes/gtk-doc-rebuild.xml"/>
193
194 <para>
195 <option>--enable-docbook</option>: This parameter is used to build
196 HTML, PDF and PostScript versions of the
197 <application>GStreamer</application> User's Manual, FAQ and Writer's
198 Guide. Note that you must have all the listed dependencies installed.
199 </para>
200
201 <para>
202 <command>chown -v -R root:root ...</command>: The documentation is
203 installed with the ownership of the user who untarred and built the
204 package. This command changes the ownership of the installed
205 documentation files to root:root, and is only executed if the
206 documentation files were built and installed.
207 </para>
208
209 </sect2>
210
211 <sect2 role="content">
212 <title>Contents</title>
213
214 <segmentedlist>
215 <segtitle>Installed Programs</segtitle>
216 <segtitle>Installed Libraries</segtitle>
217 <segtitle>Installed Directories</segtitle>
218
219 <seglistitem>
220 <seg>
221 gst-feedback, gst-feedback-0.10, gst-inspect, gst-inspect-0.10,
222 gst-launch, gst-launch-0.10, gst-typefind, gst-typefind-0.10,
223 gst-xmlinspect, gst-xmlinspect-0.10, gst-xmllaunch and
224 gst-xmllaunch-0.10
225 </seg>
226 <seg>
227 libgstbase-0.10.so, libgstcheck-0.10.so, libgstcontroller-0.10.so,
228 libgstdataprotocol-0.10.so, libgstnet-0.10.so and
229 libgstreamer-0.10.so
230 </seg>
231 <seg>
232 /usr/include/gstreamer-0.10,
233 /usr/lib/gstreamer-0.10,
234 /usr/libexec/gstreamer-0.10,
235 /usr/share/gtk-doc/html/gstreamer-0.10,
236 /usr/share/gtk-doc/html/gstreamer-libs-0.10 and
237 /usr/share/gtk-doc/html/gstreamer-plugins-0.10
238 </seg>
239 </seglistitem>
240 </segmentedlist>
241
242 <variablelist>
243 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
244 <?dbfo list-presentation="list"?>
245 <?dbhtml list-presentation="table"?>
246
247 <varlistentry id="gst-feedback">
248 <term><command>gst-feedback-0.10</command></term>
249 <listitem>
250 <para>
251 generates debug info for <application>GStreamer</application>
252 bug reports.
253 </para>
254 <indexterm zone="gstreamer gst-feedback">
255 <primary sortas="b-gst-feedback">gst-feedback-0.10</primary>
256 </indexterm>
257 </listitem>
258 </varlistentry>
259
260 <varlistentry id="gst-inspect">
261 <term><command>gst-inspect-0.10</command></term>
262 <listitem>
263 <para>
264 prints information about a
265 <application>GStreamer</application> plugin or element.
266 </para>
267 <indexterm zone="gstreamer gst-inspect">
268 <primary sortas="b-gst-inspect">gst-inspect-0.10</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="gst-launch">
274 <term><command>gst-launch-0.10</command></term>
275 <listitem>
276 <para>
277 is a tool that builds and runs basic
278 <application>GStreamer</application> pipelines.
279 </para>
280 <indexterm zone="gstreamer gst-launch">
281 <primary sortas="b-gst-launch">gst-launch-0.10</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="gst-typefind">
287 <term><command>gst-typefind-0.10</command></term>
288 <listitem>
289 <para>
290 uses the <application>GStreamer</application> type finding system
291 to determine the relevant <application>GStreamer</application>
292 plugin to parse or decode a file, and determine the corresponding
293 MIME type.
294 </para>
295 <indexterm zone="gstreamer gst-typefind">
296 <primary sortas="b-gst-typefind">gst-typefind-0.10</primary>
297 </indexterm>
298 </listitem>
299 </varlistentry>
300
301 <varlistentry id="gst-xmlinspect">
302 <term><command>gst-xmlinspect-0.10</command></term>
303 <listitem>
304 <para>
305 prints information about a <application>GStreamer</application>
306 plugin or element in XML document format.
307 </para>
308 <indexterm zone="gstreamer gst-xmlinspect">
309 <primary sortas="b-gst-xmlinspect">gst-xmlinspect-0.10</primary>
310 </indexterm>
311 </listitem>
312 </varlistentry>
313
314 <varlistentry id="gst-xmllaunch">
315 <term><command>gst-xmllaunch-0.10</command></term>
316 <listitem>
317 <para>
318 is used to build and run a basic <application>GStreamer</application>
319 pipeline, loading it from an XML description.
320 </para>
321 <indexterm zone="gstreamer gst-xmllaunch">
322 <primary sortas="b-gst-xmllaunch">gst-xmllaunch-0.10</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 </variablelist>
328
329 </sect2>
330
331</sect1>
Note: See TracBrowser for help on using the repository browser.