source: multimedia/libdriv/gst-plugins-base.xml@ 058a3280

<?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 "&gnome-download-http;/gst-plugins-base/0.10/gst-plugins-base-&gst-plugins-base-version;.tar.xz">
  <!ENTITY gst-plugins-base-download-ftp  "&gnome-download-ftp;/gst-plugins-base/0.10/gst-plugins-base-&gst-plugins-base-version;.tar.xz">
  <!ENTITY gst-plugins-base-md5sum        "3d2337841b132fe996e5eb2396ac9438">
  <!ENTITY gst-plugins-base-size          "2.3 MB">
  <!ENTITY gst-plugins-base-buildsize     "105 MB">
  <!ENTITY gst-plugins-base-time          "1.7 SBU">
]>

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

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

  <title>gst-plugins-base-&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-bad"/>, <xref linkend="gst-plugins-good"/>,
      <xref linkend="gst-plugins-ugly"/>, and <xref linkend="gst-ffmpeg"/>
      packages.
    </para>

    &lfs72_checked;

    &gst-compat;

    <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"/> and
      <xref linkend="pango"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="alsa-lib"/>,
      <xref linkend="libogg"/>,
      <xref linkend="libtheora"/>,
      <xref linkend="libvorbis"/>,
      <xref linkend="udev"/> or <xref linkend="udev-extras"/> (for gudev), and
      <xref linkend="xorg7-lib"/>
    </para>

    <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
    <para role="optional">
      <xref linkend="gobject-introspection"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="cdparanoia"/>,
      <xref linkend="gtk3"/> (required to build the examples),
      <ulink url="http://sourceforge.net/projects/libvisual/">libvisual</ulink>,
      <ulink url="http://code.entropywave.com/projects/orc/">ORC</ulink>,
      <xref linkend="check"/> (required to run the unit regression tests), and
      <ulink url="http://www.valgrind.org/">Valgrind</ulink>
      (optionaly 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="python2"/> (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>

    <para>
      To run the unit regression tests, issue: <command>make check</command>.
      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>

  </sect2>

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

    <para>
      <command>sed -i 's/\(.*gtkdoc-rebase --relative.* \)\(;.*\)/\1|| true\2/' \
      docs/libs/Makefile.in</command>: This <command>sed</command> 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>

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

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

  </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>
          libgstapp-0.10.so, libgstaudio-0.10.so, libgstcdda-0.10.so, libgstfft-0.10.so,
          libgstinterfaces-0.10.so, libgstnetbuffer-0.10.so, libgstpbutils-0.10.so,
          libgstriff-0.10.so, libgstrtp-0.10.so, libgstrtsp-0.10.so, libgstsdp-0.10.so,
          libgsttag-0.10.so and libgstvideo-0.10.so
        </seg>
        <seg>
          /usr/include/gstreamer-0.10/gst/{app,audio,cdda,fft,floatcast,interfaces,netbuffer}
          /usr/include/gstreamer-0.10/gst/{pbutils,riff,rtp,rtsp,sdp,tag,video},
          /usr/share/gst-plugins-base,
          /usr/share/gtk-doc/html/gst-plugins-base-libs-0.10 and
          /usr/share/gtk-doc/html/gst-plugins-base-plugins-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>