source: multimedia/libdriv/soundtouch.xml@ 82066b8

<?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 soundtouch-download-http "http://www.surina.net/soundtouch/soundtouch-&soundtouch-version;.tar.gz">
  <!ENTITY soundtouch-download-ftp  " ">
  <!ENTITY soundtouch-md5sum        "9f5eaf7b767970c2dbc75b7a443ec15a">
  <!ENTITY soundtouch-size          "448 KB">
  <!ENTITY soundtouch-buildsize     "7.7 MB">
  <!ENTITY soundtouch-time          "0.1 SBU">
]>

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

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

  <title>SoundTouch-&soundtouch-version;</title>

  <indexterm zone="soundtouch">
    <primary sortas="a-SoundTouch">SoundTouch</primary>
  </indexterm>

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

    <para>
      The <application>SoundTouch</application> package contains an open-source audio
      processing library that allows changing the sound tempo, pitch and playback
      rate parameters independently from each other.
    </para>

    &lfs83_checked;

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="http://www.openmp.org/">OpenMP</ulink>
    </para>

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

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

    <note>
      <para>
        When extracted, the <application>Soundtouch</application> package
        expands into the directory 
        <filename class='directory'>soundtouch</filename> and not 
        soundtouch-&soundtouch-version;.
      </para>
    </note>

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

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

    <para>
      This package does not come with a test suite.
    </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>
      <option>--enable-openmp</option>: This switch adds support for running
      the algorithms in parallel across several systems using the external 
      OpenMP libraries.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          soundstretch
        </seg>
        <seg>
          libSoundTouch.so
        </seg>
        <seg>
          /usr/include/soundtouch and
          /usr/share/doc/soundtouch-&soundtouch-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="soundstretch">
        <term><command>soundstretch</command></term>
        <listitem>
          <para>
            is a program for processing WAV audio files by modifying
            sound tempo, pitch and playback rate properties independently
            from each other.
          </para>
          <indexterm zone="soundtouch soundstretch">
            <primary sortas="b-soundstretch">soundstretch</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>