source: multimedia/libdriv/flac.xml@ faa80ab

<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY flac-download-http "http://prdownloads.sourceforge.net/flac/flac-&flac-version;.tar.gz">
  <!ENTITY flac-download-ftp  " ">
  <!ENTITY flac-size          "1.4 MB">
  <!ENTITY flac-buildsize     "33 MB">
  <!ENTITY flac-time          "0.71 SBU">
]>

<sect1 id="flac" xreflabel="FLAC-&flac-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="flac.html"?>
<title>FLAC-&flac-version;</title>

<sect2>
<title>Introduction to <application><acronym>FLAC</acronym></application></title>

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

<sect3><title>Package information</title>
<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 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>
</sect3>

<sect3><title><application><acronym>FLAC</acronym></application> 
dependencies</title>
<sect4><title>Optional</title>
<para><xref linkend="libogg"/>, 
<xref linkend="xmms"/>, 
<xref linkend="id3lib"/>, 
<xref linkend="NASM"/>, 
<xref linkend="doxygen"/> and 
<ulink url="http://valgrind.kde.org/">Valgrind</ulink></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application><acronym>FLAC</acronym></application>
</title>

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

<screen><userinput><command>LIBS=-lm ./configure --prefix=/usr &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>

<!-- <para><filename class="libraryfile">libFLAC</filename> uses a function
from the math library but is not linked with <filename
class="libraryfile">libm</filename>. Simply adding
<parameter>-lm</parameter> to <varname>LIBS</varname> variable in the relevant
<filename>Makefile</filename> corrects this problem.</para>

<screen><userinput><command>sed -i "s/^LIBS = /LIBS = -lm/" src/libFLAC/Makefile</command></userinput></screen>

<para>Continue with the installation:</para> -->

<note><para>If you run the <command>make check</command> tests, it will take a 
<emphasis>very</emphasis> long time (about 38 SBUs) and use about 80 MB of
disk space.</para></note>

</sect2>

<sect2><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>

</sect2>

<sect2>
<title>Contents</title>

<para>The <acronym>FLAC</acronym> package contains
<command>flac</command>, 
<command>metaflac</command>,
<filename class="libraryfile">libFLAC</filename>,
<filename class="libraryfile">libFLAC++</filename>,
<filename class="libraryfile">libOggFLAC</filename>,
<filename class="libraryfile">libOggFLAC++</filename> and
<filename class="libraryfile">libxmms-flac</filename>.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>flac</title>
<para><command>flac</command> is a command-line utility for
encoding, decoding and converting <acronym>FLAC</acronym>
files.</para></sect3>

<sect3><title>metaflac</title>
<para><command>metaflac</command> is a program for listing, adding,
removing, or editing metadata in one or more <acronym>FLAC</acronym>
files.</para></sect3>

<sect3><title>libFLAC, libFLAC++, libOggFLAC and libOggFLAC++</title>
<para>These libraries provide native
<acronym>FLAC</acronym> and Ogg <acronym>FLAC</acronym> C/C++
<acronym>API</acronym>s for programs utilizing
<acronym>FLAC</acronym>.</para></sect3>

<sect3><title>libxmms-flac</title>
<para><filename class="libraryfile">libxmms-flac</filename> is a plugin
for <application><acronym>XMMS</acronym></application>.</para></sect3>

</sect2>

</sect1>