source: multimedia/libdriv/flac.xml@ 086d326

<?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 flac-download-http "http://downloads.sourceforge.net/flac/flac-&flac-version;.tar.gz">
  <!ENTITY flac-download-ftp  " ">
  <!ENTITY flac-md5sum        "3958cbd5b6ed8c14966792538e44223b">
  <!ENTITY flac-size          "1.8 MB">
  <!ENTITY flac-buildsize     "136 MB (includes running the test suite)">
  <!ENTITY flac-time          "0.6 SBU (additional 1.8 SBU to run the test suite)">
]>

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

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

  <title>FLAC-&flac-version;</title>

  <indexterm zone="flac">
    <primary sortas="a-FLAC">FLAC</primary>
  </indexterm>

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

    <para><application>FLAC</application> is an audio CODEC similar to
    MP3, but lossless, meaning that audio is compressed without losing any
    information.</para>

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

    <!-- <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/flac-&flac-version;-xmms_plugin_fix-1.patch"/></para>
      </listitem>
    </itemizedlist> -->

    <bridgehead renderas="sect3">FLAC Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="libogg"/>,
    <xref linkend="xmms"/>,
    <xref linkend="NASM"/>,
    <xref linkend="docbook-utils"/>,
    <xref linkend="doxygen"/> and
    <ulink url="http://valgrind.kde.org/">Valgrind</ulink></para>

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

  </sect2>

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

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

<screen><userinput>sed -i 's/^FLaC__INLINE/static\n&amp;/' src/libFLAC/md5.c &amp;&amp;
./configure --prefix=/usr --disable-thorough-tests &amp;&amp;
make</userinput></screen>

    <para>If you have <application>Valgrind</application> version 3.0.0 or
    higher installed and you plan on running the test suites after passing the
    <option>--enable-valgrind-testing</option> parameter to
    <command>configure</command>, you need to issue the following command to
    change some test scripts:</para>

<screen><userinput>sed -i -e "s/logfile-fd/log-fd/" `grep -lr logfile-fd test/*sh`</userinput></screen>

    <para>To test the results, issue: <command>make check</command>. Note that
    if you passed the <option>--enable-exhaustive-tests</option> and
    <option>--enable-valgrind-testing</option> parameters to
    <command>configure</command> and then run the test suite, it will take a
    <emphasis>very</emphasis> long time (up to 300 SBUs) and use about 375 MB
    of disk space.</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>LIBS=-lm ./configure -prefix=/usr</command>:
    <filename class="libraryfile">libFLAC</filename> uses a function from the math
    library but is not linked with <filename class="libraryfile">libm</filename>.
    Passing the environment variable to <command>configure</command> satisfies
    this dependency.</para> -->

    <para><command>sed -i 's/.../' src/libFLAC/md5.c</command>: This command
    is used so that the byteswap symbol is not global.</para>

    <para><parameter>--disable-thorough-tests</parameter>: This parameter is
    used so that the test suite will complete in a reasonable amount of time.
    Remove it if you desire more extensive tests.</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>flac and metaflac</seg>
        <seg>libFLAC.{so,a}, libFLAC++.{so,a} and libxmms-flac.{so,a}</seg>
        <seg>/usr/include/FLAC, /usr/include/FLAC++ and
        /usr/share/doc/flac-&flac-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="flac-prog">
        <term><command>flac</command></term>
        <listitem>
          <para>is a command-line utility for encoding, decoding and
          converting FLAC files.</para>
          <indexterm zone="flac flac-prog">
            <primary sortas="b-flac">flac</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="metaflac">
        <term><command>metaflac</command></term>
        <listitem>
          <para>is a program for listing, adding, removing, or editing
          metadata in one or more FLAC files.</para>
          <indexterm zone="flac metaflac">
            <primary sortas="b-metaflac">metaflac</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libflac">
        <term><filename class='libraryfile'>libFLAC{,++}.{so,a}</filename></term>
        <listitem>
          <para>these libraries provide native FLAC and Ogg FLAC C/C++ APIs
          for programs utilizing FLAC.</para>
          <indexterm zone="flac libflac">
            <primary sortas="c-libFLAC">lib{,Ogg}FLAC{,++}.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libxmms-flac">
        <term><filename class='libraryfile'>libxmms-flac.{so,a}</filename></term>
        <listitem>
          <para>is a plugin for <application>XMMS</application>.</para>
          <indexterm zone="flac libxmms-flac">
            <primary sortas="c-libxmms-flac">libxmms-flac.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>