source: multimedia/libdriv/libsndfile.xml@ 2d76528

<?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 libsndfile-download-http
    "https://github.com/libsndfile/libsndfile/releases/download/&libsndfile-version;/libsndfile-&libsndfile-version;.tar.bz2">
  <!ENTITY libsndfile-download-ftp  " ">
  <!ENTITY libsndfile-md5sum        "3f3b2a86a032f064ef922a2c8c191f7b">
  <!ENTITY libsndfile-size          "855 KB">
  <!ENTITY libsndfile-buildsize     "13 MB (add 9 MB for tests)">
  <!ENTITY libsndfile-time          "0.3 SBU (add 0.6 SBU for tests)">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>libsndfile-&libsndfile-version;</title>

  <indexterm zone="libsndfile">
    <primary sortas="a-libsndfile">libsndfile</primary>
  </indexterm>

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

    <para>
      <application>Libsndfile</application> is a library of C routines for
      reading and writing files containing sampled audio data.
    </para>

    &lfs111_checked;

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

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

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="flac"/>,
      <xref linkend="opus"/>, and
      <xref linkend="libvorbis"/><!-- brings in libogg -->
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="alsa-lib"/>,
      <xref linkend="speex"/>, and
      <xref linkend="sqlite"/>
    </para>

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

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

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

<screen><userinput>./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/libsndfile-&libsndfile-version; &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</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>

    <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 Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          sndfile-cmp,
          sndfile-concat,
          sndfile-convert,
          sndfile-deinterleave,
          sndfile-info,
          sndfile-interleave,
          sndfile-metadata-get,
          sndfile-metadata-set,
          sndfile-play, and
          sndfile-salvage
        </seg>
        <seg>libsndfile.so</seg>
        <seg>/usr/share/doc/libsndfile-&libsndfile-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="sndfile-cmp">
        <term><command>sndfile-cmp</command></term>
        <listitem>
          <para>
            compares two audio files
          </para>
          <indexterm zone="libsndfile sndfile-cmp">
            <primary sortas="b-sndfile-cmp">sndfile-cmp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sndfile-concat">
        <term><command>sndfile-concat</command></term>
        <listitem>
          <para>
            concatenates two or more audio files
          </para>
          <indexterm zone="libsndfile sndfile-concat">
            <primary sortas="b-sndfile-concat">sndfile-concat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sndfile-convert">
        <term><command>sndfile-convert</command></term>
        <listitem>
          <para>
            converts a sound files from one format to another
          </para>
          <indexterm zone="libsndfile sndfile-convert">
            <primary sortas="b-sndfile-convert">sndfile-convert</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sndfile-deinterleave">
        <term><command>sndfile-deinterleave</command></term>
        <listitem>
          <para>
            splits a multi-channel into multiple single channel files
          </para>
          <indexterm zone="libsndfile sndfile-deinterleave">
            <primary sortas="b-sndfile-deinterleave">sndfile-deinterleave</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sndfile-info">
        <term><command>sndfile-info</command></term>
        <listitem>
          <para>
            displays information about a sound file
          </para>
          <indexterm zone="libsndfile sndfile-info">
            <primary sortas="b-sndfile-info">sndfile-info</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sndfile-interleave">
        <term><command>sndfile-interleave</command></term>
        <listitem>
          <para>
            converts multiple single channel files into a multi-channel file
          </para>
          <indexterm zone="libsndfile sndfile-interleave">
            <primary sortas="b-sndfile-interleave">sndfile-interleave</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sndfile-metadata-get">
        <term><command>sndfile-metadata-get</command></term>
        <listitem>
          <para>
            retrieves metadata from a sound file
          </para>
          <indexterm zone="libsndfile sndfile-metadata-get">
            <primary sortas="b-sndfile-metadata-get">sndfile-metadata-get</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sndfile-metadata-set">
        <term><command>sndfile-metadata-set</command></term>
        <listitem>
          <para>
            sets metadata in a sound file
          </para>
          <indexterm zone="libsndfile sndfile-metadata-set">
            <primary sortas="b-sndfile-metadata-set">sndfile-metadata-set</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sndfile-play">
        <term><command>sndfile-play</command></term>
        <listitem>
          <para>
            plays a sound file
          </para>
          <indexterm zone="libsndfile sndfile-play">
            <primary sortas="b-sndfile-play">sndfile-play</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <!--<varlistentry id="sndfile-regtest">
        <term><command>sndfile-regtest</command></term>
        <listitem>
          <para>
            does this .....
          </para>
          <indexterm zone="libsndfile sndfile-regtest">
            <primary sortas="b-sndfile-regtest">sndfile-regtest</primary>
          </indexterm>
        </listitem>
      </varlistentry>-->

      <varlistentry id="sndfile-salvage">
        <term><command>sndfile-salvage</command></term>
        <listitem>
          <para>
            Salvages the audio data from WAV files which are more than
            4G in length
          </para>
          <indexterm zone="libsndfile sndfile-salvage">
            <primary sortas="b-sndfile-salvage">sndfile-salvage</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libsndfile-lib">
        <term><filename class="libraryfile">libsndfile.so</filename></term>
        <listitem>
          <para>
            contains the <application>libsndfile</application> API functions
          </para>
          <indexterm zone="libsndfile libsndfile-lib">
            <primary sortas="c-libsndfile">libsndfile.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>