source: multimedia/libdriv/gst-plugins-good.xml@ c9ad670

<?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
    "&gnome-download-http;/gst-plugins-good/0.10/gst-plugins-good-&gst-plugins-good-version;.tar.xz">
  <!ENTITY gst-plugins-good-download-ftp
    "&gnome-download-ftp;/gst-plugins-good/0.10/gst-plugins-good-&gst-plugins-good-version;.tar.xz">
  <!ENTITY gst-plugins-good-md5sum        "555845ceab722e517040bab57f9ace95">
  <!ENTITY gst-plugins-good-size          "2.6 MB">
  <!ENTITY gst-plugins-good-buildsize     "110 MB">
  <!ENTITY gst-plugins-good-time          "1.2 SBU">
]>

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

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

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

    &lfs71_checked;

    <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">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="cairo"/>,
      <xref linkend="flac"/>,
      <xref linkend="libjpeg"/>,
      <xref linkend="libpng"/> and
      <xref linkend="xorg7-lib"/>
    </para>

    <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
    <para role="optional">
      <xref linkend="GConf"/> and
      <xref linkend="libsoup"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="aalib"/>,
      <xref linkend="gtk3"/> (required to build the examples),
      <ulink url="http://www.jackaudio.org">JACK</ulink>,
      <ulink url="http://sourceforge.net/projects/libavc1394/">libavc1394</ulink>
      (requires
      <ulink url="http://www.kernel.org/pub/linux/libs/ieee1394/"> libraw1394</ulink>),
      <ulink url="http://sam.zoy.org/projects/libcaca/">libcaca</ulink>,
      <ulink url="http://www.gnu.org/software/libcdio/">libcdio</ulink>,
      <xref linkend="libdv"/>,
      <ulink url="http://www.kernel.org/pub/linux/libs/ieee1394/">libiec61883</ulink>,
      <ulink url="http://downloads.us.xiph.org/releases/libshout/">libshout</ulink>,
      <ulink url="http://code.entropywave.com/projects/orc/">ORC</ulink>,
      <xref linkend="pulseaudio"/>,
      <xref linkend="speex"/>,
      <xref linkend="taglib"/>,
      <ulink url="http://linuxtv.org/downloads/v4l-utils/">Video4Linux</ulink> and
      <ulink url="http://www.wavpack.com/">WavPack</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="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-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=/etc \
            --with-gtk=3.0 &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>

    <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 Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          Numerous <application>GStreamer</application> plugins
        </seg>
        <seg>
          /usr/share/gtk-doc/html/gst-plugins-good-plugins-0.10
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>