source: archive/libfame.xml@ d9cbb3b

<?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 libfame-download-http "&sourceforge-repo;/fame/libfame-&libfame-version;.tar.gz">
  <!ENTITY libfame-download-ftp  "&gentoo-ftp-repo;/libfame-&libfame-version;.tar.gz">
  <!ENTITY libfame-md5sum        "880085761e17a3b4fc41f4f6f198fd3b">
  <!ENTITY libfame-size          "290 KB">
  <!ENTITY libfame-buildsize     "6.6 MB">
  <!ENTITY libfame-time          "0.2 SBU">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>libFAME-&libfame-version;</title>

  <indexterm zone="libfame">
    <primary sortas="a-LibFAME">LibFAME</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libFAME</title>

    <para><application>libFAME</application> is a fast (real-time) MPEG-1 as
    well as MPEG-4 rectangular and arbitrary shaped video encoding library.</para>

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Required Patch: <ulink
        url="&patch-root;/libfame-&libfame-version;-gcc34-1.patch"/></para>
      </listitem>
    </itemizedlist>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/libfame"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of libFAME</title>

    <para>Install <application>libFAME</application> by running
    the following commands:</para>

<screen><userinput>patch -Np1 -i ../libfame-&libfame-version;-gcc34-1.patch &amp;&amp;
sed -i 's/$CC --version/$CC -dumpversion/' configure &amp;&amp;
./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

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

    <para><command>sed -i 's/$CC --version/$CC -dumpversion/'
    configure</command>: This command causes the <command>configure</command>
    script to use a different command to find out the version of the compiler.
    Without this command, the -fstrict-aliasing flag is not added to the
    <envar>CFLAGS</envar> variable in the various
    <filename>Makefile</filename>s.</para>

    <para><option>--enable-sse</option>: This option is off by default and
    should be set on if your machine has SSE capability. One way to find out if
    you have SSE is to issue <command>cat /proc/cpuinfo</command> and see if
    <computeroutput>sse</computeroutput> is listed in the flags.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>libfame-config</seg>
        <seg>libfame.{so,a}</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libfame-config">
        <term><command>libfame-config</command></term>
        <listitem>
          <para>provides configuration information for
          <filename class="libraryfile">libfame</filename>.</para>
          <indexterm zone="libfame libfame-config">
            <primary sortas="b-libfame-config">libfame-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libfame-lib">
        <term><filename class='libraryfile'>libfame.{so,a}</filename></term>
        <listitem>
          <para>provides functions for the video encoding programs.</para>
          <indexterm zone="libfame libfame-lib">
            <primary sortas="c-libfame">libfame.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>