source: multimedia/libdriv/audiofile.xml@ 3c0e3458

<?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 audiofile-download-http "&gnome-download-http;/audiofile/0.3/audiofile-&audiofile-version;.tar.xz">
  <!ENTITY audiofile-download-ftp  " ">
  <!ENTITY audiofile-md5sum        "235dde14742317328f0109e9866a8008">
  <!ENTITY audiofile-size          "520 KB">
  <!ENTITY audiofile-buildsize     "18 MB">
  <!ENTITY audiofile-time          "0.6 SBU">
]>

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


  <title>AudioFile-&audiofile-version;</title>

  <indexterm zone="audiofile">
    <primary sortas="a-AudioFile">AudioFile</primary>
  </indexterm>

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

    <para>
      The <application>AudioFile</application> package contains the
      audio file libraries and two sound file support programs useful
      to support basic sound file formats.
    </para>

    &lfs120_checked;

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

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="alsa-lib"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="flac"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="asciidoc"/> and
      <xref linkend="valgrind"/>
    </para>

  </sect2>

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

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

<!-- No longer needed with the patch
     CXXFLAGS="${CXXFLAGS:- -O2 -g} -std=c++98" -->

<screen><userinput>patch -Np1 -i ../audiofile-&audiofile-version;-consolidated_patches-1.patch &amp;&amp;
autoreconf -fiv                             &amp;&amp;

./configure --prefix=/usr --disable-static  &amp;&amp;

make</userinput></screen>

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

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

    <para>
      To test the results, issue: <command>make check</command>.
      Note that the tests will fail if the --disable-static
      option is used and tests are executed before
      <command>make install</command>. You have three options:
    </para>

    <para>
     (a) configure without --disable-static, run the tests, but do not
     install, then start a fresh build using --disable-static just for
     installing the package.
    </para>

    <para>
     (b) configure with --disable-static, but only run the tests after the
     package is installed.
    </para>

    <para>
     (c) configure with --disable-static, but only run the tests after a
     DESTDIR install.
    </para>

  </sect2>

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

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

  </sect2>

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

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

      <seglistitem>
        <seg>
          sfconvert and sfinfo
        </seg>
        <seg>
          libaudiofile.so
        </seg>
        <seg>
          None
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="sfinfo">
        <term><command>sfinfo</command></term>
        <listitem>
          <para>
            displays the sound file format, audio encoding, sampling
            rate and duration for audio formats supported by this library
          </para>
          <indexterm zone="audiofile sfinfo">
            <primary sortas="b-sfinfo">sfinfo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sfconvert">
        <term><command>sfconvert</command></term>
        <listitem>
          <para>
            converts sound file formats where the original format and
            destination format are supported by this library
          </para>
          <indexterm zone="audiofile sfconvert">
            <primary sortas="b-sfconvert">sfconvert</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libaudiofile">
        <term><filename class="libraryfile">libaudiofile.so</filename></term>
        <listitem>
          <para>
            contains functions used by programs to support AIFF,
            AIFF-compressed, Sun/NeXT, WAV and BIC audio formats
          </para>
          <indexterm zone="audiofile libaudiofile">
            <primary sortas="c-libaudiofile">libaudiofile.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>