source: multimedia/audioutils/lame.xml@ 1ade38d

<?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 lame-download-http "&sourceforge-repo;/lame/lame-&lame-version;.tar.gz">
  <!ENTITY lame-download-ftp  " ">
  <!ENTITY lame-md5sum        "719dae0ee675d0c16e0e89952930ed35">
  <!ENTITY lame-size          "1.3 MB">
  <!ENTITY lame-buildsize     "11.2 MB (without optional dependencies)">
  <!ENTITY lame-time          "0.4 SBU">
]>

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

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

  <title>LAME-&lame-version;</title>

  <indexterm zone="lame">
    <primary sortas="a-LAME">LAME</primary>
  </indexterm>

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

    <para>The <application>LAME</application> package contains
    an MP3 encoder and optionally, an MP3 frame analyzer. This is useful
    for creating and analyzing compressed audio files.</para>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="GTK"/>,
    <xref linkend="NASM"/>,
    <ulink url="http://www.mega-nerd.com/libsndfile/">libsndfile</ulink>
    (support is currently broken),
    <ulink url="http://perens.com/FreeSoftware/">Electric Fence</ulink> and
    <ulink url="http://dmalloc.com/">Dmalloc</ulink></para>

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

  </sect2>

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

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

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

    <para>To test the results, issue: <command>make test</command>.</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><parameter>--enable-mp3rtp</parameter>: Builds the
    encode-to-RTP program.</para>

    <para><option>--enable-mp3x</option>: Builds the <command>mp3x</command>
    frame analyzer program (requires <application>GTK+</application>).</para>

    <para><parameter>--disable-static</parameter>: prevent static libraries
    being built and installed.</para>

    <para><parameter>--enable-nasm</parameter>: Enable the use of 
    <xref linkend="NASM"/> to compile optimized assembly routines.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>lame, mp3rtp, and optionally, mp3x</seg>
        <seg>libmp3lame.{so,a}</seg>
        <seg>/usr/include/lame and /usr/share/doc/lame</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="lame-prog">
        <term><command>lame</command></term>
        <listitem>
          <para>creates MP3 audio files from raw
          PCM or <filename>.wav</filename> data.</para>
          <indexterm zone="lame lame-prog">
            <primary sortas="b-lame">lame</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mp3rtp">
        <term><command>mp3rtp</command></term>
        <listitem>
          <para>is used to encode MP3 with RTP streaming of the output.</para>
          <indexterm zone="lame mp3rtp">
            <primary sortas="b-mp3rtp">mp3rtp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mp3x">
        <term><command>mp3x</command></term>
        <listitem>
          <para>is a <application>GTK</application> based graphical MP3
          frame analyzer used for debugging, development and studying MP3
          frames produced by any encoder.</para>
          <indexterm zone="lame mp3x">
            <primary sortas="b-mp3x">mp3x</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libmp3lame">
        <term><filename class='libraryfile'>libmp3lame.{so,a}</filename></term>
        <listitem>
          <para>libraries provide the functions necessary to convert
          raw PCM and WAV files to MP3 files.</para>
          <indexterm zone="lame libmp3lame">
            <primary sortas="c-libmp3lame">libmp3lame.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>