source: multimedia/libdriv/gst-plugins.xml@ a1770a7

<?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 gst-plugins-download-http "http://gstreamer.freedesktop.org/src/gst-plugins/gst-plugins-&gst-plugins-version;.tar.bz2">
<!ENTITY gst-plugins-download-ftp  "ftp://ftp.gnome.org/pub/GNOME/sources/gst-plugins/0.8/gst-plugins-&gst-plugins-version;.tar.bz2">
<!ENTITY gst-plugins-md5sum        "4f6e7e730fa674ecd6ec713f937b8acb">
<!ENTITY gst-plugins-size          "2.2 MB">
<!ENTITY gst-plugins-buildsize     "up to 100 MB (depends on what dependencies are installed)">
<!ENTITY gst-plugins-time          "up to 3.0 SBU">
]>

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

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

  <title>Gst-plugins-&gst-plugins-version;</title>

  <indexterm zone="gst-plugins">
    <primary sortas="a-Gst-plugins">Gst-plugins</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Gst-plugins</title>

    <para>The <application>gst-plugins</application> package builds 
    graphics and multimedia CODEC interface modules for the 
    <application>GStreamer</application> package. There are over 160 different 
    modules that can be built, providing <application>GStreamer</application> 
    the capability to create a pipeline for almost every known media stream.</para>

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

    <bridgehead renderas="sect3">Gst-plugins Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para><xref linkend="gstreamer"/></para>

    <bridgehead renderas="sect4">Optional Utilities (Graphics, Compression, Misc.)</bridgehead>
    <para><xref linkend="aalib"/>, 
    <ulink url="http://cairographics.org/">Cairo</ulink>, 
    <xref linkend="cdparanoia"/>, 
    <xref linkend="freetype2"/>, 
    <xref linkend="GConf"/>, 
    <xref linkend="gtk2"/>, 
    <xref linkend="gnome-vfs"/>, 
    <ulink url="http://talinux.fi.tal.org/pub/talinux/sources/Hermes-1.3.3.tar.gz">Hermes</ulink>, 
    <ulink url="http://sam.zoy.org/projects/libcaca/">libcaca</ulink>, 
    <ulink url="http://cvs.sourceforge.net/viewcvs.py/codecs/libcolorspace-pre/">libcolorspace</ulink>, 
    <xref linkend="libjpeg"/> or 
    <ulink url="http://sourceforge.net/projects/mjpeg/">MMX Jpeg</ulink>, 
    <ulink url="http://eetpc20.bd.psu.edu/~rfisher/Research/Libmmx/libmmx.html">libmmx</ulink>, 
    <xref linkend="libmng"/>, 
    <ulink url="http://www.schleef.org/liboil/">liboil</ulink>, 
    <xref linkend="libpng"/>, 
    <xref linkend="NASM"/>, 
    <xref linkend="pango"/>, 
    X (<xref linkend="xfree86"/> or <xref linkend="xorg"/>)</para>

    <bridgehead renderas="sect4">Optional Audio Libraries/Drivers/CODECs</bridgehead>
    <para><xref linkend="alsa"/>, 
    <xref linkend="arts"/>, 
    <xref linkend="audiofile"/>, 
    <ulink url="https://cvs.comedi.org/cgi-bin/viewcvs.cgi/audioresample/">audioresample</ulink>, 
    <xref linkend="esound"/>, 
    <ulink url="http://sourceforge.net/projects/faac">FAAC</ulink>, 
    <ulink url="http://sourceforge.net/projects/faac">FAAD2</ulink>, 
    <xref linkend="flac"/>, 
    <ulink url="http://kbs.cs.tu-berlin.de/~jutta/toast.html">GSM</ulink>, 
    <ulink url="http://jackit.sourceforge.net/">JACK</ulink>, 
    <xref linkend="lame"/>, 
    <xref linkend="liba52"/>, 
    <ulink url="http://libcdaudio.sourceforge.net/">libcdaudio</ulink>, 
    <ulink url="http://www.videolan.org/libdca.html">libdts</ulink>, 
    <xref linkend="libmad"/> (and 
    <ulink url="http://sourceforge.net/projects/mad/">libid3tag</ulink>), 
    <xref linkend="libmikmod"/>, 
    <ulink url="http://www.musepack.net/">libmusepack</ulink> (now known as 
    <application>libmpcdec</application>), 
    <ulink url="http://www.musicbrainz.org/">libmusicbrainz</ulink>, 
    <xref linkend="libogg"/>, 
    <ulink url="http://www.linux1394.org/">libraw1394</ulink> (and 
    <ulink url="http://sourceforge.net/projects/libavc1394/">libavc1394</ulink>), 
    <ulink url="http://www.icecast.org/">libshout</ulink>, 
    <ulink url="http://www.geocities.com/SiliconValley/Lakes/5147/sidplay/">libsidplay</ulink>, 
    <ulink url="http://www.mega-nerd.com/libsndfile/">libsndfile</ulink>, 
    <xref linkend="libvorbis"/>, 
    <ulink url="http://www.ladspa.org/">LADSPA</ulink>, 
    <xref linkend="nas"/>, 
    <ulink url="http://0pointer.de/lennart/projects/polypaudio/">Polypaudio</ulink>, 
    <ulink url="http://www.speex.org/">Speex >= 1.1.6</ulink>, 
    <ulink url="http://www.theora.org/">Theora</ulink>, 
    <ulink url="http://www.xiph.org/ogg/vorbis/index.html">Tremor</ulink></para>

    <bridgehead renderas="sect4">Optional Video Libraries/Drivers/CODECs</bridgehead>
    <para><ulink url="http://sourceforge.net/projects/dirac/">Dirac</ulink>, 
    <ulink url="http://directfb.org/">DirectFB</ulink>, 
    <ulink url="http://www.divx.com/divx/linux/">DivX4Linux</ulink>, 
    <ulink url="http://dxr3.sourceforge.net/">DXR3</ulink>, 
    <xref linkend="libdv"/>, 
    <ulink url="http://sourceforge.net/projects/dvd/">libdvdnav</ulink>, 
    <xref linkend="libdvdread"/>, 
    <xref linkend="libfame"/>, 
    <ulink url="http://libmpeg2.sourceforge.net/">libmpeg2</ulink>, 
    <ulink url="https://cvs.comedi.org/cgi-bin/viewcvs.cgi/librfb/">librfb</ulink>, 
    <ulink url="http://mjpeg.sourceforge.net/">MJPEG Tools</ulink>, 
    <ulink url="http://www.thedirks.org/v4l2/">V4L2</ulink>, 
    <xref linkend="xvid"/></para>

    <bridgehead renderas="sect4">Optional Multimedia Utilities</bridgehead>
    <para><ulink url="http://sourceforge.net/projects/libmms">libmms</ulink>, 
    <ulink url="http://sourceforge.net/projects/libvisual/">libvisual</ulink>, 
    <xref linkend="sdl"/>, 
    <ulink url="http://swfdec.sourceforge.net/">swfdec</ulink> and 
    <xref linkend="xine-lib"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Gst-plugins</title>

    <para>Install <application>gst-plugins</application> by running the following 
    commands:</para>

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc &amp;&amp;
make &amp;&amp;
make install &amp;&amp;
gst-register</userinput></screen>

  </sect2>

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

    <para><option>--with-gconf-schema-file-dir=/etc/gnome/gconf/schemas</option>: 
    Use this option if you have the <application>GNOME-2</application> 
    <application>GConf</application> package installed.</para>

    <para><option>--enable-gdk-pixbuf-loader</option>: Use this option to build 
    the GDK pixbuf loader module if you have 
    <application>GTK+-2</application> installed.</para>

<!-- This module is currently broken
<para><option>-enable-xine</option>: Use this option to build the 
<application>Xine</application> wrapper module if you have 
<application>xine-libs</application> installed.</para>
 -->

    <para><option>-enable-xine</option>: Using this option to build the 
    <application>Xine</application> wrapper module will break the build if you 
    have <application>xine-libs</application>-&xine-lib-version; installed.</para>

    <para><option>--disable-musepack</option>: Use this option if you have 
    <application>libmusepack</application>-1.1.1 installed, as this version
    of <application>libmusepack</application> breaks the build.</para>

    <para>Note: all other modules are built if the <command>configure</command> 
    script discovers the required package. To prevent a module from being built, 
    pass <option>--disable-<replaceable>[module]</replaceable></option> to 
    <command>configure</command>. Run <command>configure --help</command> 
    for all the available module names.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>gst-launch-ext-0.8 and gst-visualise-0.8</seg>
        <seg>libgst*.[so,a], numerous <application>GStreamer</application> plugins,
        and a <application>Gstreamer</application> GDK pixbuf loader module</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gst-launch-ext">
        <term><command>gst-launch-ext-0.8</command></term>
        <listitem>
          <para>is used to run a basic predefined 
          <application>GStreamer</application> pipeline as a quick test to ensure 
          proper working of codecs and <application>GStreamer</application>.</para>
          <indexterm zone="gst-plugins gst-launch-ext">
            <primary sortas="b-gst-launch-ext">gst-launch-ext-0.8</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gst-visualise">
        <term><command>gst-visualise-0.8</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 gst-visualise">
            <primary sortas="b-gst-visualise">gst-visualise-0.8</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>