glfs/multimedia/libdriv/gst-plugins-good.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-good-download-http "http://gstreamer.freedesktop.org/src/gst-plugins-good/gst-plugins-good-&gst-plugins-good-version;.tar.bz2">
  <!ENTITY gst-plugins-good-download-ftp  " ">
  <!ENTITY gst-plugins-good-md5sum        "79b086c2dc0e07ae0c8ddc91512bab3a">
  <!ENTITY gst-plugins-good-size          "2.0 MB">
  <!ENTITY gst-plugins-good-buildsize     "61 MB or more (depends on which dependencies are installed), plus 4.2 MB for unit regression tests and 1.8 MB for docs">
  <!ENTITY gst-plugins-good-time          "1.7 SBU or more, plus 1.0 SBU for unit regression tests">
]>

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

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

  <title>GStreamer Good Plug-ins-&gst-plugins-good-version;</title>

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

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

    <para>The <application>GStreamer Good Plug-ins</application> is a set of
    plug-ins considered by the <application>GStreamer</application> developers
    to have good quality code, correct functionality, and the preferred license
    (LGPL for the plug-in code, LGPL or LGPL-compatible for the supporting
    library). A wide range of video and audio decoders, encoders, and filters
    are included. Also see the <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-good-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&gst-plugins-good-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &gst-plugins-good-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &gst-plugins-good-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &gst-plugins-good-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &gst-plugins-good-time;</para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="gst-plugins-base"/></para>

    <bridgehead renderas="sect4">Optional (Required for the
    <application>GStreamer</application> Backend in <xref linkend="totem"/>,
    and Can be Used by Many Other GNOME Applications)</bridgehead>
    <para role="required"><xref linkend="GConf"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="aalib"/>,
    <xref linkend="cairo"/>,
    <ulink url="http://www.gnu.org/software/libcdio/">libcdio</ulink>
    (which can use <xref linkend="cdparanoia"/>,
    <ulink url="http://sourceforge.net/projects/libcddb">libcddb</ulink>, and
    <ulink url="http://www.gnu.org/software/vcdimager/">VCDImager</ulink>),
    <ulink url="http://sourceforge.net/projects/libavc1394/">libavc1394</ulink>
    (requires <ulink url="http://www.linux1394.org/">libraw1394</ulink>),
    <xref linkend="libdv"/>,
    <xref linkend="esound"/>,
    <xref linkend="flac"/>,
    <xref linkend="gtk2"/> (required to build the examples),
    <xref linkend="hal"/>,
    <!-- now obsolete
    <ulink url="http://sourceforge.net/projects/mjpeg/">MMX Jpeg</ulink>
    (will fall back to <xref linkend="libjpeg"/> if not found),
     -->
    <xref linkend="libjpeg"/>,
    <ulink url="http://www.ladspa.org/">LADSPA</ulink>,
    <ulink url="http://sam.zoy.org/projects/libcaca/">libcaca</ulink>,
    <xref linkend="libpng"/>,
    <ulink url="http://www.icecast.org/">libshout</ulink>,
    <xref linkend="speex"/> (version >= <ulink
    url="http://speex.org/downloads/">1.1.6</ulink> is preferred),
    <ulink url="http://www.wavpack.com/">WavPack</ulink>,
    <ulink url="http://developer.kde.org/~wheeler/taglib/">TagLib</ulink>,
    <xref linkend="x-window-system"/>,
    <ulink url="http://pulseaudio.org/">PulseAudio</ulink></para>

    <bridgehead renderas="sect4">Optional, for the unit regression tests</bridgehead>
    <para>To run the tests you need to have compiled gstreamer against libcheck,
    and you can optionally use
    <ulink url="http://www.valgrind.org/">Valgrind</ulink></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-good"/></para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr \
            --sysconfdir=&gnome-etc-dir; &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>

    <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/plugins install-data</userinput></screen>

  </sect2>

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

    <para><parameter>--sysconfdir=&gnome-etc-dir;</parameter>: This parameter
    is used so that the <application>GConf</application> configuration files
    are installed in the system-wide GNOME <application>GConf</application>
    database located in
    <filename class="directory">&gnome-etc-dir;/gconf</filename>
    instead of <filename class="directory">/usr/etc</filename>. You may omit
    this parameter if you don't have <application>GConf</application>
    installed.</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>None</seg>
        <seg>Numerous <application>GStreamer</application> plugins</seg>
        <seg>/usr/share/gtk-doc/html/gst-plugins-good-plugins-0.10</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>