source: multimedia/libdriv/gst-plugins-ugly.xml@ 4c2be438

<?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-ugly-download-http "http://gstreamer.freedesktop.org/src/gst-plugins-ugly/gst-plugins-ugly-&gst-plugins-ugly-version;.tar.xz">
  <!ENTITY gst-plugins-ugly-download-ftp  " ">
  <!-- <!ENTITY gst-plugins-ugly-download-ftp  "&gnome-download-ftp;/gst-plugins-ugly/0.10/gst-plugins-ugly-&gst-plugins-ugly-version;.tar.bz2"> -->
  <!ENTITY gst-plugins-ugly-md5sum        "ba26045c8c8c91f0d48d327ccf53ac0c">
  <!ENTITY gst-plugins-ugly-size          "864 KB">
  <!ENTITY gst-plugins-ugly-buildsize     "20 MB">
  <!ENTITY gst-plugins-ugly-time          "0.3 SBU">
]>

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

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

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

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

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

    <para>The <application>GStreamer Ugly Plug-ins</application> is a set of
    plug-ins considered by the <application>GStreamer</application> developers
    to have good quality and correct functionality, but distributing them might
    pose problems. The license on either the plug-ins or the supporting
    libraries might not be how the <application>GStreamer</application>
    developers would like. The code might be widely known to present patent
    problems. Also see the <xref linkend="gst-plugins-good"/>, <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>

    &lfs70_checked;

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

    <bridgehead renderas="sect3">GStreamer Ugly 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="lame"/>,
      <xref linkend="libdvdnav"/> and
      <xref linkend="libdvdread"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="liba52"/>,
      <ulink url="http://www.gnu.org/software/libcdio/">libcdio</ulink>,
      <xref linkend="libmad"/>,
      <xref linkend="libmpeg2"/>,
      <ulink url="http://packages.debian.org/source/sid/libsidplay">
      libsidplay</ulink>,
      <ulink url="http://sourceforge.net/projects/opencore-amr/">
      OpenCore AMR</ulink>,
      <ulink url="http://code.entropywave.com/projects/orc/">ORC</ulink>,
      <ulink url="http://sourceforge.net/projects/twolame/">TwoLAME</ulink> and
      <ulink url="http://www.videolan.org/developers/x264.html">x264</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 optionaly 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-ugly"/></para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

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

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

      <seglistitem>
        <seg>None</seg>
        <seg>Several <application>GStreamer</application> plugins</seg>
        <seg>/usr/share/gtk-doc/html/gst-plugins-ugly-plugins-0.10</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>