[967a388] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[967a388] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[a7bd2b6f] | 7 | <!ENTITY gstreamer-download-http "http://gstreamer.freedesktop.org/src/gstreamer/gstreamer-&gstreamer-version;.tar.bz2">
|
---|
[ba6f749] | 8 | <!ENTITY gstreamer-download-ftp "&gnome-download-ftp;/gstreamer/0.10/gstreamer-&gstreamer-version;.tar.bz2">
|
---|
[6f3e2f8] | 9 | <!ENTITY gstreamer-md5sum "88544e034a051baf472983791d233076">
|
---|
| 10 | <!ENTITY gstreamer-size "2.9 MB">
|
---|
| 11 | <!ENTITY gstreamer-buildsize "82 MB">
|
---|
| 12 | <!ENTITY gstreamer-time "2.4 SBU">
|
---|
[967a388] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="gstreamer" xreflabel="GStreamer-&gstreamer-version;">
|
---|
[a7bd2b6f] | 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 |
|
---|
[33d63e8d] | 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
|
---|
[c866109] | 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"/>, <ulink
|
---|
| 41 | url="http://gstreamer.freedesktop.org/modules/gst-plugins-bad.html">GStreamer
|
---|
| 42 | Bad Plug-ins</ulink> and <ulink
|
---|
| 43 | url="http://gstreamer.freedesktop.org/modules/gst-ffmpeg.html">GStreamer
|
---|
| 44 | FFmpeg plug-in</ulink> packages.</para>
|
---|
[a7bd2b6f] | 45 |
|
---|
| 46 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 47 | <itemizedlist spacing="compact">
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>Download (HTTP): <ulink url="&gstreamer-download-http;"/></para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Download (FTP): <ulink url="&gstreamer-download-ftp;"/></para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Download MD5 sum: &gstreamer-md5sum;</para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>Download size: &gstreamer-size;</para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>Estimated disk space required: &gstreamer-buildsize;</para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>Estimated build time: &gstreamer-time;</para>
|
---|
| 65 | </listitem>
|
---|
| 66 | </itemizedlist>
|
---|
| 67 |
|
---|
[ab5b06b] | 68 | <bridgehead renderas="sect3">GStreamer Dependencies</bridgehead>
|
---|
[a7bd2b6f] | 69 |
|
---|
| 70 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[6f3e2f8] | 71 | <para role="required"><xref linkend="glib2"/>, and
|
---|
| 72 | <xref linkend="libxml2"/></para>
|
---|
[a7bd2b6f] | 73 |
|
---|
| 74 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[a68c66aa] | 75 | <para role="optional">
|
---|
[6f3e2f8] | 76 | <ulink url="http://www.gnu.org/software/gsl/">GSL</ulink>,
|
---|
[a68c66aa] | 77 | <ulink url="http://check.sourceforge.net/">Check</ulink>
|
---|
[cc60178] | 78 | (required to run the unit regression tests and also enables
|
---|
| 79 | <filename class='libraryfile'>libgstcheck-0.10</filename>), and
|
---|
[a68c66aa] | 80 | <ulink url="http://www.valgrind.org/">Valgrind</ulink>
|
---|
| 81 | (optionally used during the unit regression tests)</para>
|
---|
| 82 |
|
---|
[cc60178] | 83 | <!-- exceptionally, there seems no way to install the shipped
|
---|
| 84 | API docs, so they have to be built, not rebuilt.-->
|
---|
| 85 | <bridgehead renderas="sect4">Optional (Required to build the API
|
---|
[a68c66aa] | 86 | Documentation)</bridgehead>
|
---|
| 87 | <para role="optional"><xref linkend="gtk-doc"/> and
|
---|
[cc60178] | 88 | <xref linkend="python"/> (compiled against an XML Parser such as
|
---|
| 89 | <xref linkend="expat"/>). Alternatively, developers can access
|
---|
| 90 | the online API docs at <ulink
|
---|
| 91 | url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/api-index-full.html">freedesktop.org</ulink>
|
---|
| 92 | </para>
|
---|
[a68c66aa] | 93 |
|
---|
| 94 | <bridgehead renderas="sect4">Optional (Required to Build
|
---|
| 95 | Manuals)</bridgehead>
|
---|
[a747b3c] | 96 | <para role="optional"><xref linkend="libxslt"/>,
|
---|
[520f6b4f] | 97 | <xref linkend="tetex"/>,
|
---|
[33d63e8d] | 98 | <xref linkend="docbook-utils"/>,
|
---|
[cc60178] | 99 | <ulink url="http://www.xfig.org/">Transfig</ulink> (all needed
|
---|
| 100 | to build the HTML manual), plus
|
---|
[aa8ef3bc] | 101 | <xref linkend="gs"/>, and <!-- or
|
---|
| 102 | <xref linkend="espgs"/>, and -->
|
---|
[cc60178] | 103 | <ulink url="http://netpbm.sourceforge.net/">Netpbm</ulink>
|
---|
| 104 | to build the postscript and PDF manuals.
|
---|
| 105 | Alternatively, developers can access the online manual at <ulink
|
---|
| 106 | url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/index.html">freedesktop.org</ulink>
|
---|
| 107 | </para>
|
---|
[a7bd2b6f] | 108 |
|
---|
[0e2aa08] | 109 | <para condition="html" role="usernotes">User Notes:
|
---|
| 110 | <ulink url="&blfs-wiki;/gstreamer"/></para>
|
---|
| 111 |
|
---|
[a7bd2b6f] | 112 | </sect2>
|
---|
| 113 |
|
---|
| 114 | <sect2 role="installation">
|
---|
| 115 | <title>Installation of GStreamer</title>
|
---|
| 116 |
|
---|
[a68c66aa] | 117 | <!-- Commenting as the Valgrind stuff has been fixed, but leaving it in
|
---|
| 118 | here so in case we need it again
|
---|
[e93d40c5] | 119 | <para>Newer versions of <application>Valgrind</application> are known to
|
---|
| 120 | cause the build to break. If you have <application>Valgrind</application>
|
---|
| 121 | version >= 3.1.0 installed, you should add
|
---|
[a68c66aa] | 122 | <option>-disable-valgrind</option> to the <command>configure</command>
|
---|
[e93d40c5] | 123 | command below so the build will complete.</para>
|
---|
[a68c66aa] | 124 | -->
|
---|
[e93d40c5] | 125 |
|
---|
[33d63e8d] | 126 | <para>Install <application>GStreamer</application> by running the following
|
---|
[a7bd2b6f] | 127 | commands:</para>
|
---|
| 128 |
|
---|
[cc60178] | 129 | <screen><userinput>sed -i 's/\(.*gtkdoc-rebase --relative.* \)\(;.*\)/\1|| true\2/' \
|
---|
| 130 | docs/{gst,libs}/Makefile.in &&
|
---|
| 131 | ./configure --prefix=/usr &&
|
---|
[a7bd2b6f] | 132 | make</userinput></screen>
|
---|
[11d6d1ac] | 133 |
|
---|
[a68c66aa] | 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>
|
---|
[e93d40c5] | 138 |
|
---|
[a7bd2b6f] | 139 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[11d6d1ac] | 140 |
|
---|
[a7bd2b6f] | 141 | <screen role="root"><userinput>make install &&
|
---|
[a68c66aa] | 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 &&
|
---|
[ba6f749] | 145 |
|
---|
[a68c66aa] | 146 | if [ -d /usr/share/doc/gstreamer-0.10/faq/html ]; then
|
---|
[ec5db802] | 147 | chown -v -R root:root \
|
---|
[a68c66aa] | 148 | /usr/share/doc/gstreamer-0.10/*/html
|
---|
| 149 | fi</userinput></screen>
|
---|
| 150 |
|
---|
[ba6f749] | 151 | <!-- Gtk-Docs are now installed by default, even without building them
|
---|
[a68c66aa] | 152 | <para>If you did not rebuild the API documentation by passing
|
---|
[ba6f749] | 153 | <option>-enable-gtk-doc</option> to the <command>configure</command>
|
---|
[a68c66aa] | 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>
|
---|
[ba6f749] | 159 | -->
|
---|
[a68c66aa] | 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>
|
---|
[a7bd2b6f] | 177 |
|
---|
| 178 | </sect2>
|
---|
| 179 |
|
---|
| 180 | <sect2 role="commands">
|
---|
| 181 | <title>Command Explanations</title>
|
---|
| 182 |
|
---|
[e05cd03f] | 183 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[ba6f749] | 184 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
[a68c66aa] | 185 |
|
---|
[a41f643] | 186 | <para><option>sed -i 's/\(.*gtkdoc-rebase --relative.* \)\(;.*\)/\1|| true\2/' \
|
---|
[cc60178] | 187 | docs/{gst,libs}/Makefile.in</option>: Two of the Makefiles test if
|
---|
| 188 | <command>gtkdoc-rebase</command> is present, and only use it if it is,
|
---|
| 189 | but the test <command>which gtk-doc</command> is interpreted as an error by
|
---|
| 190 | <command>make</command> if <command>gtkdoc-rebase</command> is not present. The
|
---|
| 191 | <command>sed</command> command ensures the command is always regarded as
|
---|
| 192 | successful.</para>
|
---|
| 193 |
|
---|
| 194 | <para><option>--disable-static</option>: This switch prevents the static
|
---|
| 195 | libraries from being built.</para>
|
---|
| 196 |
|
---|
[a68c66aa] | 197 | <para><option>--enable-docbook</option>: This parameter is used to build
|
---|
| 198 | HTML, PDF and PostScript versions of the
|
---|
| 199 | <application>GStreamer</application> User's Manual, FAQ and Writer's Guide.
|
---|
| 200 | Note that you must have all the listed dependencies installed.</para>
|
---|
| 201 |
|
---|
[33d63e8d] | 202 | <para><command>chown -v -R root:root ...</command>: The documentation is
|
---|
| 203 | installed with ownerships of the user who untarred and built the package.
|
---|
[a7bd2b6f] | 204 | This command changes the ownerships of the installed documentation files to
|
---|
[ec5db802] | 205 | root:root and is only executed if the documentation files were built and
|
---|
| 206 | installed.</para>
|
---|
[a7bd2b6f] | 207 |
|
---|
| 208 | </sect2>
|
---|
| 209 |
|
---|
| 210 | <sect2 role="content">
|
---|
| 211 | <title>Contents</title>
|
---|
| 212 |
|
---|
| 213 | <segmentedlist>
|
---|
| 214 | <segtitle>Installed Programs</segtitle>
|
---|
| 215 | <segtitle>Installed Libraries</segtitle>
|
---|
| 216 | <segtitle>Installed Directories</segtitle>
|
---|
| 217 |
|
---|
| 218 | <seglistitem>
|
---|
[a68c66aa] | 219 | <seg>gst-feedback{,-0.10}, gst-inspect{,-0.10}, gst-launch{,-0.10},
|
---|
[6f3e2f8] | 220 | gst-typefind{,-0.10}, gst-xmlinspect{,-0.10} and
|
---|
| 221 | gst-xmllaunch{,-0.10}</seg>
|
---|
[a68c66aa] | 222 | <seg>libgstbase-0.10.{so,a}, libgstcheck-0.10.{so,a},
|
---|
| 223 | libgstcontroller-0.10.{so,a}, libgstdataprotocol-0.10.{so,a},
|
---|
| 224 | libgstnet-0.10.{so,a}, libgstreamer-0.10.{so,a}, and
|
---|
[0e2aa08] | 225 | libgst*.{so,a} plugin modules</seg>
|
---|
[a68c66aa] | 226 | <seg>/usr/include/gstreamer-0.10, /usr/lib/gstreamer-0.10,
|
---|
| 227 | /usr/share/doc/gstreamer-0.10,
|
---|
| 228 | /usr/share/gtk-doc/html/gstreamer{,-libs,-plugins}-0.10</seg>
|
---|
[a7bd2b6f] | 229 | </seglistitem>
|
---|
| 230 | </segmentedlist>
|
---|
| 231 |
|
---|
| 232 | <variablelist>
|
---|
| 233 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 234 | <?dbfo list-presentation="list"?>
|
---|
| 235 | <?dbhtml list-presentation="table"?>
|
---|
| 236 |
|
---|
| 237 | <varlistentry id="gst-feedback">
|
---|
[a68c66aa] | 238 | <term><command>gst-feedback-0.10</command></term>
|
---|
[a7bd2b6f] | 239 | <listitem>
|
---|
[d7ecaa6] | 240 | <para>generates debug info for <application>GStreamer</application>
|
---|
[a7bd2b6f] | 241 | bug reports.</para>
|
---|
| 242 | <indexterm zone="gstreamer gst-feedback">
|
---|
[a68c66aa] | 243 | <primary sortas="b-gst-feedback">gst-feedback-0.10</primary>
|
---|
[a7bd2b6f] | 244 | </indexterm>
|
---|
| 245 | </listitem>
|
---|
| 246 | </varlistentry>
|
---|
| 247 |
|
---|
| 248 | <varlistentry id="gst-inspect">
|
---|
[a68c66aa] | 249 | <term><command>gst-inspect-0.10</command></term>
|
---|
[a7bd2b6f] | 250 | <listitem>
|
---|
[33d63e8d] | 251 | <para>prints information about a
|
---|
[a7bd2b6f] | 252 | <application>GStreamer</application> plugin or element.</para>
|
---|
| 253 | <indexterm zone="gstreamer gst-inspect">
|
---|
[a68c66aa] | 254 | <primary sortas="b-gst-inspect">gst-inspect-0.10</primary>
|
---|
[a7bd2b6f] | 255 | </indexterm>
|
---|
| 256 | </listitem>
|
---|
| 257 | </varlistentry>
|
---|
| 258 |
|
---|
| 259 | <varlistentry id="gst-launch">
|
---|
[a68c66aa] | 260 | <term><command>gst-launch-0.10</command></term>
|
---|
[a7bd2b6f] | 261 | <listitem>
|
---|
[33d63e8d] | 262 | <para>is a tool that builds and runs basic
|
---|
[a7bd2b6f] | 263 | <application>GStreamer</application> pipelines.</para>
|
---|
| 264 | <indexterm zone="gstreamer gst-launch">
|
---|
[a68c66aa] | 265 | <primary sortas="b-gst-launch">gst-launch-0.10</primary>
|
---|
[a7bd2b6f] | 266 | </indexterm>
|
---|
| 267 | </listitem>
|
---|
| 268 | </varlistentry>
|
---|
| 269 |
|
---|
| 270 | <varlistentry id="gst-typefind">
|
---|
[a68c66aa] | 271 | <term><command>gst-typefind-0.10</command></term>
|
---|
[a7bd2b6f] | 272 | <listitem>
|
---|
[33d63e8d] | 273 | <para>uses the <application>GStreamer</application> type finding
|
---|
[d7ecaa6] | 274 | system to determine the relevant <application>GStreamer</application>
|
---|
[33d63e8d] | 275 | plugin to parse or decode a file, and determine the corresponding
|
---|
[a7bd2b6f] | 276 | MIME type.</para>
|
---|
| 277 | <indexterm zone="gstreamer gst-typefind">
|
---|
[a68c66aa] | 278 | <primary sortas="b-gst-typefind">gst-typefind-0.10</primary>
|
---|
[a7bd2b6f] | 279 | </indexterm>
|
---|
| 280 | </listitem>
|
---|
| 281 | </varlistentry>
|
---|
| 282 |
|
---|
| 283 | <varlistentry id="gst-xmlinspect">
|
---|
[a68c66aa] | 284 | <term><command>gst-xmlinspect-0.10</command></term>
|
---|
[a7bd2b6f] | 285 | <listitem>
|
---|
[d7ecaa6] | 286 | <para>prints information about a <application>GStreamer</application>
|
---|
[a7bd2b6f] | 287 | plugin or element in XML document format.</para>
|
---|
| 288 | <indexterm zone="gstreamer gst-xmlinspect">
|
---|
[a68c66aa] | 289 | <primary sortas="b-gst-xmlinspect">gst-xmlinspect-0.10</primary>
|
---|
[a7bd2b6f] | 290 | </indexterm>
|
---|
| 291 | </listitem>
|
---|
| 292 | </varlistentry>
|
---|
| 293 |
|
---|
| 294 | <varlistentry id="gst-xmllaunch">
|
---|
[a68c66aa] | 295 | <term><command>gst-xmllaunch-0.10</command></term>
|
---|
[a7bd2b6f] | 296 | <listitem>
|
---|
[d7ecaa6] | 297 | <para>is used to build and run a basic <application>GStreamer</application>
|
---|
[a7bd2b6f] | 298 | pipeline, loading it from an XML description.</para>
|
---|
| 299 | <indexterm zone="gstreamer gst-xmllaunch">
|
---|
[a68c66aa] | 300 | <primary sortas="b-gst-xmllaunch">gst-xmllaunch-0.10</primary>
|
---|
[a7bd2b6f] | 301 | </indexterm>
|
---|
| 302 | </listitem>
|
---|
| 303 | </varlistentry>
|
---|
| 304 |
|
---|
| 305 | </variablelist>
|
---|
| 306 |
|
---|
| 307 | </sect2>
|
---|
[967a388] | 308 |
|
---|
| 309 | </sect1>
|
---|