glfs/multimedia/libdriv/gstreamer.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY gstreamer-download-http "http://gstreamer.freedesktop.org/src/gstreamer/gstreamer-&gstreamer-version;.tar.bz2">
  <!ENTITY gstreamer-download-ftp  "&gnome-download-ftp;/gstreamer/0.8/gstreamer-&gstreamer-version;.tar.bz2">
  <!ENTITY gstreamer-md5sum        "3a251cf05b794ebac04e18f71e5b26eb">
  <!ENTITY gstreamer-size          "1.4 MB">
  <!ENTITY gstreamer-buildsize     "81.2 MB">
  <!ENTITY gstreamer-time          "3.2 SBU (includes building docs, additional 0.8 SBU to run the test suite)">
]>

<sect1 id="gstreamer" xreflabel="GStreamer-&gstreamer-version;">
  <?dbhtml filename="gstreamer.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">gstreamer-&gstreamer-version;.tar</keyword>
      <keyword role="ftpdir">gstreamer</keyword>
    </keywordset>
  </sect1info>

  <title>GStreamer-&gstreamer-version;</title>

  <indexterm zone="gstreamer">
    <primary sortas="a-GStreamer">GStreamer</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GStreamer</title>

    <para>The <application>GStreamer</application> package contains a streaming
    media framework that enables applications to share a common set of plugins for
    things like video decoding and encoding, audio encoding and decoding, audio
    and video filters, audio visualisation, Web streaming and anything else that
    streams in real-time or otherwise. It is modelled after research software
    worked on at the Oregon Graduate Institute.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&gstreamer-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&gstreamer-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &gstreamer-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &gstreamer-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &gstreamer-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &gstreamer-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">GStreamer Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="glib2"/>,
    <xref linkend="libxml2"/>, and
    <xref linkend="popt"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="libgnomeui"/>,
    <xref linkend="python"/>, and
    <ulink url="http://valgrind.kde.org/">Valgrind</ulink> (see the note below
    about some versions)</para>

    <bridgehead renderas="sect4">Optional (to Build Documentation)</bridgehead>
    <para role="optional"><xref linkend="libxslt"/>,
    <xref linkend="gtk-doc"/>,
    <xref linkend="tetex"/>,
    <xref linkend="gs"/> or
    <xref linkend="espgs"/>,
    <xref linkend="docbook-utils"/>,
    <ulink url="http://www.xfig.org/">Transfig</ulink>, and
    <ulink url="http://netpbm.sourceforge.net/">Netpbm</ulink></para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/gstreamer"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of GStreamer</title>

    <para>Newer versions of <application>Valgrind</application> are known to
    cause the build to break. If you have <application>Valgrind</application>
    version &gt;= 3.1.0 installed, you should add
    <option>--disable-valgrind</option> to the <command>configure</command>
    command below so the build will complete.</para>

    <para>Install <application>GStreamer</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc \
    --localstatedir=/var &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install &amp;&amp;
if [ -d /usr/share/doc/gstreamer-&gstreamer-version;/faq/html ]; then
    chown -v -R root:root \
        /usr/share/doc/gstreamer-&gstreamer-version;/*/html
fi &amp;&amp;
gst-register</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>--localstatedir=/var</parameter>: This switch puts
    <command>gst-register</command>'s cache in
    <filename class="directory">/var/cache/gstreamer-0.8</filename>
    instead of
    <filename class="directory">/usr/cache/gstreamer-0.8</filename>.</para>

    <para><parameter>--sysconfdir=/etc</parameter>: This switch puts configuration
    files in <filename class="directory">/etc</filename>
    instead of <filename class="directory">/usr/etc</filename>.</para>

    <para><command>chown -v -R root:root ...</command>: The documentation is
    installed with ownerships of the user who untarred and built the package.
    This command changes the ownerships of the installed documentation files to
    root:root and is only executed if the documentation files were built and
    installed.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>gst-complete, gst-complete-0.8, gst-compprep, gst-compprep-0.8,
        gst-feedback, gst-feedback-0.8, gst-inspect, gst-inspect-0.8, gst-launch,
        gst-launch-0.8, gst-md5sum, gst-md5sum-0.8, gst-register, gst-register-0.8,
        gst-typefind, gst-typefind-0.8, gst-xmllaunch, gst-xmllaunch-0.8,
        gst-xmlinspect, and gst-xmlinspect-0.8</seg>
        <seg>libgstcontrol-0.8.{so,a}, libgstreamer-0.8.{so,a}, and
        libgst*.{so,a} plugin modules</seg>
        <seg>/usr/include/gstreamer-0.8, /usr/lib/gstreamer-0.8,
        /usr/share/doc/gstreamer-&gstreamer-version;,
        /usr/share/gtk-doc/html/gstreamer-0.8,
        /usr/share/gtk-doc/html/gstreamer-libs-0.8, and /var/cache/gstreamer-0.8</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="gst-complete">
        <term><command>gst-complete-0.8</command></term>
        <listitem>
          <para>is a utility enabling <command>bash</command> to provide
          context sensitive tab completion for <command>gst-launch</command>
          command lines.</para>
          <indexterm zone="gstreamer gst-complete">
            <primary sortas="b-gst-complete">gst-complete-0.8</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gst-compprep">
        <term><command>gst-compprep-0.8</command></term>
        <listitem>
          <para>builds a registry of <application>GStreamer</application>
          elements and their features that is used by
          <command>gst-complete</command>.</para>
          <indexterm zone="gstreamer gst-compprep">
            <primary sortas="b-gst-compprep">gst-compprep-0.8</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gst-feedback">
        <term><command>gst-feedback-0.8</command></term>
        <listitem>
          <para>generates debug info for <application>GStreamer</application>
          bug reports.</para>
          <indexterm zone="gstreamer gst-feedback">
            <primary sortas="b-gst-feedback">gst-feedback-0.8</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gst-inspect">
        <term><command>gst-inspect-0.8</command></term>
        <listitem>
          <para>prints information about a
          <application>GStreamer</application> plugin or element.</para>
          <indexterm zone="gstreamer gst-inspect">
            <primary sortas="b-gst-inspect">gst-inspect-0.8</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gst-launch">
        <term><command>gst-launch-0.8</command></term>
        <listitem>
          <para>is a tool that builds and runs basic
          <application>GStreamer</application> pipelines.</para>
          <indexterm zone="gstreamer gst-launch">
            <primary sortas="b-gst-launch">gst-launch-0.8</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gst-md5sum">
        <term><command>gst-md5sum-0.8</command></term>
        <listitem>
          <para>generates MD5 checksums of the data generated by a
          <application>GStreamer</application> pipeline.</para>
          <indexterm zone="gstreamer gst-md5sum">
            <primary sortas="b-gst-md5sum">gst-md5sum-0.8</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gst-register">
        <term><command>gst-register-0.8</command></term>
        <listitem>
          <para>is used to register all the <application>GStreamer</application>
          plugins on the system. It creates a listing of their properties so that when a
          <application>GStreamer</application> based application is started, it
          does not need to load plugins until it needs them.</para>
          <indexterm zone="gstreamer gst-register">
            <primary sortas="b-gst-register">gst-register-0.8</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gst-typefind">
        <term><command>gst-typefind-0.8</command></term>
        <listitem>
          <para>uses the <application>GStreamer</application> type finding
          system to determine the relevant <application>GStreamer</application>
          plugin to parse or decode a file, and determine the corresponding
          MIME type.</para>
          <indexterm zone="gstreamer gst-typefind">
            <primary sortas="b-gst-typefind">gst-typefind-0.8</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gst-xmlinspect">
        <term><command>gst-xmlinspect-0.8</command></term>
        <listitem>
          <para>prints information about a <application>GStreamer</application>
          plugin or element in XML document format.</para>
          <indexterm zone="gstreamer gst-xmlinspect">
            <primary sortas="b-gst-xmlinspect">gst-xmlinspect-0.8</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gst-xmllaunch">
        <term><command>gst-xmllaunch-0.8</command></term>
        <listitem>
          <para>is used to build and run a basic <application>GStreamer</application>
          pipeline, loading it from an XML description.</para>
          <indexterm zone="gstreamer gst-xmllaunch">
            <primary sortas="b-gst-xmllaunch">gst-xmllaunch-0.8</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>