glfs/multimedia/libdriv/gst-plugins-base.xml

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

  <!ENTITY gst-plugins-base-download-http "http://gstreamer.freedesktop.org/src/gst-plugins-base/gst-plugins-base-&gst-plugins-base-version;.tar.bz2">
  <!ENTITY gst-plugins-base-download-ftp  "&gnome-download-ftp;/gst-plugins-base/0.10/gst-plugins-base-&gst-plugins-base-version;.tar.bz2">
  <!ENTITY gst-plugins-base-md5sum        "d29669dd79276c5cd94e1613c03cd9ab">
  <!ENTITY gst-plugins-base-size          "2.1 MB">
  <!ENTITY gst-plugins-base-buildsize     "75 MB">
  <!ENTITY gst-plugins-base-time          "1.6 SBU">
]>

<sect1 id="gst-plugins-base"
       xreflabel="GStreamer Base Plug-ins-&gst-plugins-base-version;">
  <?dbhtml filename="gst-plugins-base.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>GStreamer Base Plug-ins-&gst-plugins-base-version;</title>

  <indexterm zone="gst-plugins-base">
    <primary sortas="a-GStreamer-Base-Plug-ins">GStreamer Base Plug-ins</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GStreamer Base Plug-ins</title>

    <para>The <application>GStreamer Base Plug-ins</application> is a
    well-groomed and well-maintained collection of
    <application>GStreamer</application> plug-ins and elements, spanning the
    range of possible types of elements one would want to write for
    <application>GStreamer</application>. It also contains helper libraries
    and base classes useful for writing elements. A wide range of video and
    audio decoders, encoders, and filters are included. Also see the
    <xref linkend="gst-plugins-good"/>, <xref linkend="gst-plugins-ugly"/>,
    <ulink url="http://gstreamer.freedesktop.org/modules/gst-plugins-bad.html">
    GStreamer Bad Plug-ins</ulink> and <ulink
    url="http://gstreamer.freedesktop.org/modules/gst-ffmpeg.html">GStreamer
    FFmpeg plug-in</ulink> packages.</para>

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

    <bridgehead renderas="sect3">GStreamer Base Plug-ins Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gstreamer"/>,
      <xref linkend="liboil"/>, and
      <xref linkend="pango"/></para>
    
    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="alsa-lib"/>,
      <xref linkend="cdparanoia"/>,
      <xref linkend="ffmpeg"/>,
      <xref linkend="gnome-vfs"/>,
      <xref linkend="gtk2"/> (required to build the examples),
      <xref linkend="libogg"/>,
      <xref linkend="libtheora"/>,
      <ulink url="http://sourceforge.net/projects/libvisual/">libvisual</ulink>,
      <xref linkend="libvorbis"/>,
      <xref linkend="speex"/>,
      <xref linkend="udev"/> (gudev),
      <xref linkend="x-window-system"/>,
      <xref linkend="check"/> (required to run the unit regression tests), and
      <ulink url="http://www.valgrind.org/">Valgrind</ulink>
         (optionally used during the unit regression tests)
    </para>

    <bridgehead renderas="sect4">Optional (Required to Rebuild the API
    Documentation)</bridgehead>
    <para role="optional"><xref linkend="gtk-doc"/> and
    <xref linkend="python"/> (compiled against an XML parser such as
    <xref linkend=" expat"/>).</para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of GStreamer Base Plug-ins</title>

    <para>Install <application>GStreamer Base Plug-ins</application> by running
    the following commands:</para>

<screen><userinput>sed -i 's/\(.*gtkdoc-rebase --relative.* \)\(;.*\)/\1|| true\2/' \
  docs/libs/Makefile.in &amp;&amp;
./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <!-- without libcheck, 'make check' is pointless -->
    <para>To run the unit regression tests, issue: <command>make check</command>.
    There is one failure, in elements/subparse. There are
    many other <filename>Makefile</filename> targets you can specify for
    running the tests, issue <command>make -C tests/check help</command> to see
    the complete list.</para>

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

<screen role="root"><userinput>make install</userinput></screen>

    <!-- Docs are installed now
    <para>If you did not rebuild the API documentation by passing
    <option>-enable-gtk-doc</option> to the <command>configure</command>
    script and you wish to install the pre-built documentation, issue the
    following command as the <systemitem class="username">root</systemitem>
    user:</para>

<screen role="root"><userinput>make -C docs/libs install-data &amp;&amp;
make -C docs/plugins install-data</userinput></screen>-->

  </sect2>

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

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gtk-doc-rebuild.xml"/>

    <para><option>sed -i 's/\(.*gtkdoc-rebase --relative.* \)\(;.*\)/\1|| true\2/' \
    docs/libs/Makefile.in</option>: This Makefile tests if
    <command>gtkdoc-rebase</command> is present, and only uses it if it is,
    but the test <command>which gtk-doc</command> is interpreted as an error by
    <command>make</command> if <command>gtkdoc-rebase</command> is not present.  The
    <command>sed</command> command ensures the command is always regarded as
    successful.</para>

    <para><option>--disable-static</option>: This switch prevents the static
    libraries from being built.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>gst-visualise-0.10</seg>
        <seg>libgst*.{so,a} and numerous <application>GStreamer</application>
        plugins</seg>
        <seg>/usr/include/gstreamer-0.10/gst/{too numerous to list} and
        /usr/share/gtk-doc/html/gst-plugins-base-libs-0.10</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gst-visualise">
        <term><command>gst-visualise-0.10</command></term>
        <listitem>
          <para>is used to run a basic <application>GStreamer</application>
          pipeline to display a graphical visualisation of an audio stream.</para>
          <indexterm zone="gst-plugins-base gst-visualise">
            <primary sortas="b-gst-visualise">gst-visualise-0.10</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>