[967a388] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/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">
|
---|
[a68c66aa] | 8 | <!ENTITY gstreamer-download-ftp "&gnome-download-ftp;/gstreamer/0.10/gstreamer-&gstreamer-version;.tar.bz2">
|
---|
| 9 | <!ENTITY gstreamer-md5sum "a094ea86d4cea4f23ef2eb8c6e7bfc10">
|
---|
| 10 | <!ENTITY gstreamer-size "1.6 MB">
|
---|
| 11 | <!ENTITY gstreamer-buildsize "65.3 MB">
|
---|
| 12 | <!ENTITY gstreamer-time "1.6 SBU (includes building manuals, additional 1.1 SBU to rebuild API docs and 0.5 SBU to run the test suite)">
|
---|
[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>
|
---|
[a68c66aa] | 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">
|
---|
| 76 | <ulink url="http://check.sourceforge.net/">Check</ulink>
|
---|
| 77 | (required to run the unit regression tests), and
|
---|
| 78 | <ulink url="http://www.valgrind.org/">Valgrind</ulink>
|
---|
| 79 | (optionally used during the unit regression tests)</para>
|
---|
| 80 |
|
---|
| 81 | <bridgehead renderas="sect4">Optional (Required to Rebuild the API
|
---|
| 82 | Documentation)</bridgehead>
|
---|
| 83 | <para role="optional"><xref linkend="gtk-doc"/> and
|
---|
| 84 | <xref linkend="pyxml"/></para>
|
---|
| 85 |
|
---|
| 86 | <bridgehead renderas="sect4">Optional (Required to Build
|
---|
| 87 | Manuals)</bridgehead>
|
---|
[a747b3c] | 88 | <para role="optional"><xref linkend="libxslt"/>,
|
---|
[520f6b4f] | 89 | <xref linkend="tetex"/>,
|
---|
[33d63e8d] | 90 | <xref linkend="gs"/> or
|
---|
| 91 | <xref linkend="espgs"/>,
|
---|
| 92 | <xref linkend="docbook-utils"/>,
|
---|
[e93d40c5] | 93 | <ulink url="http://www.xfig.org/">Transfig</ulink>, and
|
---|
[a7bd2b6f] | 94 | <ulink url="http://netpbm.sourceforge.net/">Netpbm</ulink></para>
|
---|
| 95 |
|
---|
[0e2aa08] | 96 | <para condition="html" role="usernotes">User Notes:
|
---|
| 97 | <ulink url="&blfs-wiki;/gstreamer"/></para>
|
---|
| 98 |
|
---|
[a7bd2b6f] | 99 | </sect2>
|
---|
| 100 |
|
---|
| 101 | <sect2 role="installation">
|
---|
| 102 | <title>Installation of GStreamer</title>
|
---|
| 103 |
|
---|
[a68c66aa] | 104 | <!-- Commenting as the Valgrind stuff has been fixed, but leaving it in
|
---|
| 105 | here so in case we need it again
|
---|
[e93d40c5] | 106 | <para>Newer versions of <application>Valgrind</application> are known to
|
---|
| 107 | cause the build to break. If you have <application>Valgrind</application>
|
---|
| 108 | version >= 3.1.0 installed, you should add
|
---|
[a68c66aa] | 109 | <option>-disable-valgrind</option> to the <command>configure</command>
|
---|
[e93d40c5] | 110 | command below so the build will complete.</para>
|
---|
[a68c66aa] | 111 | -->
|
---|
[e93d40c5] | 112 |
|
---|
[33d63e8d] | 113 | <para>Install <application>GStreamer</application> by running the following
|
---|
[a7bd2b6f] | 114 | commands:</para>
|
---|
| 115 |
|
---|
[081a9c3] | 116 | <screen><userinput>./configure --prefix=/usr &&
|
---|
[a7bd2b6f] | 117 | make</userinput></screen>
|
---|
[11d6d1ac] | 118 |
|
---|
[a68c66aa] | 119 | <para>To test the results, issue: <command>make check</command>. There are
|
---|
| 120 | many other <filename>Makefile</filename> targets you can specify for
|
---|
| 121 | running the tests, issue <command>make -C tests/check help</command> to see
|
---|
| 122 | the complete list.</para>
|
---|
[e93d40c5] | 123 |
|
---|
[a7bd2b6f] | 124 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[11d6d1ac] | 125 |
|
---|
[a7bd2b6f] | 126 | <screen role="root"><userinput>make install &&
|
---|
[a68c66aa] | 127 | install -v -m755 -d /usr/share/doc/gstreamer-0.10/design &&
|
---|
| 128 | install -v -m644 docs/design/*.txt \
|
---|
| 129 | /usr/share/doc/gstreamer-0.10/design &&
|
---|
| 130 | if [ -d /usr/share/doc/gstreamer-0.10/faq/html ]; then
|
---|
[ec5db802] | 131 | chown -v -R root:root \
|
---|
[a68c66aa] | 132 | /usr/share/doc/gstreamer-0.10/*/html
|
---|
| 133 | fi</userinput></screen>
|
---|
| 134 |
|
---|
| 135 | <para>If you did not rebuild the API documentation by passing
|
---|
| 136 | <option>--enable-gtk-doc</option> to the <command>configure</command>
|
---|
| 137 | script and you wish to install the pre-built documentation, issue the
|
---|
| 138 | following command as the <systemitem class="username">root</systemitem>
|
---|
| 139 | user:</para>
|
---|
| 140 |
|
---|
| 141 | <screen role="root"><userinput>for DOCS in gst libs plugins; do make -C docs/$DOCS install-data; done</userinput></screen>
|
---|
| 142 |
|
---|
| 143 | <sect3>
|
---|
| 144 | <title>Testing the Installation</title>
|
---|
| 145 |
|
---|
| 146 | <para>To test the functionality of the
|
---|
| 147 | <application>GStreamer</application> installation, you can run a simple
|
---|
| 148 | test as an unprivileged user (you may have to run
|
---|
| 149 | <command>ldconfig</command> as the
|
---|
| 150 | <systemitem class="username">root</systemitem> user before attempting
|
---|
| 151 | the test).</para>
|
---|
| 152 |
|
---|
| 153 | <screen><userinput>gst-launch -v fakesrc num_buffers=5 ! fakesink</userinput></screen>
|
---|
| 154 |
|
---|
| 155 | <para>If the command outputs a series of messages from fakesrc and
|
---|
| 156 | fakesink, everything is okay.</para>
|
---|
| 157 |
|
---|
| 158 | </sect3>
|
---|
[a7bd2b6f] | 159 |
|
---|
| 160 | </sect2>
|
---|
| 161 |
|
---|
| 162 | <sect2 role="commands">
|
---|
| 163 | <title>Command Explanations</title>
|
---|
| 164 |
|
---|
[a68c66aa] | 165 | <para><option>--enable-gtk-doc</option>: This parameter is used to rebuild
|
---|
| 166 | and install the API documentation.</para>
|
---|
| 167 |
|
---|
| 168 | <para><option>--enable-docbook</option>: This parameter is used to build
|
---|
| 169 | HTML, PDF and PostScript versions of the
|
---|
| 170 | <application>GStreamer</application> User's Manual, FAQ and Writer's Guide.
|
---|
| 171 | Note that you must have all the listed dependencies installed.</para>
|
---|
| 172 |
|
---|
[33d63e8d] | 173 | <para><command>chown -v -R root:root ...</command>: The documentation is
|
---|
| 174 | installed with ownerships of the user who untarred and built the package.
|
---|
[a7bd2b6f] | 175 | This command changes the ownerships of the installed documentation files to
|
---|
[ec5db802] | 176 | root:root and is only executed if the documentation files were built and
|
---|
| 177 | installed.</para>
|
---|
[a7bd2b6f] | 178 |
|
---|
| 179 | </sect2>
|
---|
| 180 |
|
---|
| 181 | <sect2 role="content">
|
---|
| 182 | <title>Contents</title>
|
---|
| 183 |
|
---|
| 184 | <segmentedlist>
|
---|
| 185 | <segtitle>Installed Programs</segtitle>
|
---|
| 186 | <segtitle>Installed Libraries</segtitle>
|
---|
| 187 | <segtitle>Installed Directories</segtitle>
|
---|
| 188 |
|
---|
| 189 | <seglistitem>
|
---|
[a68c66aa] | 190 | <seg>gst-feedback{,-0.10}, gst-inspect{,-0.10}, gst-launch{,-0.10},
|
---|
| 191 | gst-typefind{,-0.10}, gst-xmllaunch{,-0.10} and
|
---|
| 192 | gst-xmlinspect{,-0.10}</seg>
|
---|
| 193 | <seg>libgstbase-0.10.{so,a}, libgstcheck-0.10.{so,a},
|
---|
| 194 | libgstcontroller-0.10.{so,a}, libgstdataprotocol-0.10.{so,a},
|
---|
| 195 | libgstnet-0.10.{so,a}, libgstreamer-0.10.{so,a}, and
|
---|
[0e2aa08] | 196 | libgst*.{so,a} plugin modules</seg>
|
---|
[a68c66aa] | 197 | <seg>/usr/include/gstreamer-0.10, /usr/lib/gstreamer-0.10,
|
---|
| 198 | /usr/share/doc/gstreamer-0.10,
|
---|
| 199 | /usr/share/gtk-doc/html/gstreamer{,-libs,-plugins}-0.10</seg>
|
---|
[a7bd2b6f] | 200 | </seglistitem>
|
---|
| 201 | </segmentedlist>
|
---|
| 202 |
|
---|
| 203 | <variablelist>
|
---|
| 204 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 205 | <?dbfo list-presentation="list"?>
|
---|
| 206 | <?dbhtml list-presentation="table"?>
|
---|
| 207 |
|
---|
| 208 | <varlistentry id="gst-feedback">
|
---|
[a68c66aa] | 209 | <term><command>gst-feedback-0.10</command></term>
|
---|
[a7bd2b6f] | 210 | <listitem>
|
---|
[d7ecaa6] | 211 | <para>generates debug info for <application>GStreamer</application>
|
---|
[a7bd2b6f] | 212 | bug reports.</para>
|
---|
| 213 | <indexterm zone="gstreamer gst-feedback">
|
---|
[a68c66aa] | 214 | <primary sortas="b-gst-feedback">gst-feedback-0.10</primary>
|
---|
[a7bd2b6f] | 215 | </indexterm>
|
---|
| 216 | </listitem>
|
---|
| 217 | </varlistentry>
|
---|
| 218 |
|
---|
| 219 | <varlistentry id="gst-inspect">
|
---|
[a68c66aa] | 220 | <term><command>gst-inspect-0.10</command></term>
|
---|
[a7bd2b6f] | 221 | <listitem>
|
---|
[33d63e8d] | 222 | <para>prints information about a
|
---|
[a7bd2b6f] | 223 | <application>GStreamer</application> plugin or element.</para>
|
---|
| 224 | <indexterm zone="gstreamer gst-inspect">
|
---|
[a68c66aa] | 225 | <primary sortas="b-gst-inspect">gst-inspect-0.10</primary>
|
---|
[a7bd2b6f] | 226 | </indexterm>
|
---|
| 227 | </listitem>
|
---|
| 228 | </varlistentry>
|
---|
| 229 |
|
---|
| 230 | <varlistentry id="gst-launch">
|
---|
[a68c66aa] | 231 | <term><command>gst-launch-0.10</command></term>
|
---|
[a7bd2b6f] | 232 | <listitem>
|
---|
[33d63e8d] | 233 | <para>is a tool that builds and runs basic
|
---|
[a7bd2b6f] | 234 | <application>GStreamer</application> pipelines.</para>
|
---|
| 235 | <indexterm zone="gstreamer gst-launch">
|
---|
[a68c66aa] | 236 | <primary sortas="b-gst-launch">gst-launch-0.10</primary>
|
---|
[a7bd2b6f] | 237 | </indexterm>
|
---|
| 238 | </listitem>
|
---|
| 239 | </varlistentry>
|
---|
| 240 |
|
---|
| 241 | <varlistentry id="gst-typefind">
|
---|
[a68c66aa] | 242 | <term><command>gst-typefind-0.10</command></term>
|
---|
[a7bd2b6f] | 243 | <listitem>
|
---|
[33d63e8d] | 244 | <para>uses the <application>GStreamer</application> type finding
|
---|
[d7ecaa6] | 245 | system to determine the relevant <application>GStreamer</application>
|
---|
[33d63e8d] | 246 | plugin to parse or decode a file, and determine the corresponding
|
---|
[a7bd2b6f] | 247 | MIME type.</para>
|
---|
| 248 | <indexterm zone="gstreamer gst-typefind">
|
---|
[a68c66aa] | 249 | <primary sortas="b-gst-typefind">gst-typefind-0.10</primary>
|
---|
[a7bd2b6f] | 250 | </indexterm>
|
---|
| 251 | </listitem>
|
---|
| 252 | </varlistentry>
|
---|
| 253 |
|
---|
| 254 | <varlistentry id="gst-xmlinspect">
|
---|
[a68c66aa] | 255 | <term><command>gst-xmlinspect-0.10</command></term>
|
---|
[a7bd2b6f] | 256 | <listitem>
|
---|
[d7ecaa6] | 257 | <para>prints information about a <application>GStreamer</application>
|
---|
[a7bd2b6f] | 258 | plugin or element in XML document format.</para>
|
---|
| 259 | <indexterm zone="gstreamer gst-xmlinspect">
|
---|
[a68c66aa] | 260 | <primary sortas="b-gst-xmlinspect">gst-xmlinspect-0.10</primary>
|
---|
[a7bd2b6f] | 261 | </indexterm>
|
---|
| 262 | </listitem>
|
---|
| 263 | </varlistentry>
|
---|
| 264 |
|
---|
| 265 | <varlistentry id="gst-xmllaunch">
|
---|
[a68c66aa] | 266 | <term><command>gst-xmllaunch-0.10</command></term>
|
---|
[a7bd2b6f] | 267 | <listitem>
|
---|
[d7ecaa6] | 268 | <para>is used to build and run a basic <application>GStreamer</application>
|
---|
[a7bd2b6f] | 269 | pipeline, loading it from an XML description.</para>
|
---|
| 270 | <indexterm zone="gstreamer gst-xmllaunch">
|
---|
[a68c66aa] | 271 | <primary sortas="b-gst-xmllaunch">gst-xmllaunch-0.10</primary>
|
---|
[a7bd2b6f] | 272 | </indexterm>
|
---|
| 273 | </listitem>
|
---|
| 274 | </varlistentry>
|
---|
| 275 |
|
---|
| 276 | </variablelist>
|
---|
| 277 |
|
---|
| 278 | </sect2>
|
---|
[967a388] | 279 |
|
---|
| 280 | </sect1>
|
---|