source: multimedia/audioutils/lame.xml@ bead691

<?xml version="1.0" encoding="UTF-8"?>
<!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-dl;/lame/lame-&lame-version;.tar.gz">
  <!ENTITY lame-download-ftp  " ">
  <!ENTITY lame-md5sum        "83e260acbe4389b54fe08e0bdbf7cddb">
  <!ENTITY lame-size          "1.5 MB">
  <!ENTITY lame-buildsize     "9.7 MB">
  <!ENTITY lame-time          "0.1 SBU">
]>

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


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

    &lfs122_checked;

    <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">
      <ulink url="https://dmalloc.com/">Dmalloc</ulink>,
      <ulink url="https://linux.softpedia.com/get/Programming/Debuggers/Electric-Fence-3305.shtml/">Electric Fence</ulink>,
      <xref linkend="libsndfile"/> and
      <xref linkend="nasm"/>
    </para>

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

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

    <!-- Taken from Fedora -->
    <para>
      Prevent the source code directory from being mistakenly hardcoded as a
      shared library search path in the installed programs:
    </para>

<screen><userinput>sed -i -e 's/^\(\s*hardcode_libdir_flag_spec\s*=\).*/\1/' configure</userinput></screen>

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

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

    <para>
      To test the results, issue:
      <command>LD_LIBRARY_PATH=libmp3lame/.libs make test</command>.
    </para>

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

<screen role="root"><userinput>make pkghtmldir=/usr/share/doc/lame-&lame-version; install</userinput></screen>

  </sect2>

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

    <para>
      <parameter>--enable-mp3rtp</parameter>: This switch enables building
      the encode-to-RTP program.
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

    <para>
      <option>--enable-nasm</option>: This option enables the use of
      <xref linkend="nasm"/> to compile optimized assembly routines for
      32-bit x86. Note that this has no effect on x86_64.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          lame and mp3rtp
        </seg>
        <seg>
          libmp3lame.so
        </seg>
        <seg>
          /usr/include/lame and
          /usr/share/doc/lame-&lame-version;
        </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="libmp3lame">
        <term><filename class="libraryfile">libmp3lame.so</filename></term>
        <listitem>
          <para>
            provides the functions necessary to convert raw PCM and WAV files
            to MP3 files
          </para>
          <indexterm zone="lame libmp3lame">
            <primary sortas="c-libmp3lame">libmp3lame.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>