source: archive/gst-plugins-ugly.xml@ acb648f

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

    &lfs77_checked;

    &gst-compat;

    <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">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/gst-plugins-ugly-&gst-plugins-ugly-version;-libcdio_fixes-1.patch"/>
        </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"/>,
      <xref linkend="libcdio"/>,
      <xref linkend="libmad"/>,
      <xref linkend="libmpeg2"/>,
      <xref linkend="x264"/>,
      <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>, and
      <ulink url="http://sourceforge.net/projects/twolame/">TwoLAME</ulink>
    </para>

    <bridgehead renderas="sect4">Optional, for the unit regression tests</bridgehead>
    <para>
      <xref linkend="valgrind"/>
    </para>

    <bridgehead renderas="sect4">
      Optional (Required to Rebuild the API Documentation)
    </bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/> and
      <xref linkend="python2"/>
    </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>

    <note><para>If you need a plugin for a given dependency, that dependency
      needs to be installed before this application.
    </para></note>

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

<screen><userinput>patch -Np1 -i ../gst-plugins-ugly-&gst-plugins-ugly-version;-libcdio_fixes-1.patch &amp;&amp;
./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="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 Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

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

  </sect2>

</sect1>