source: multimedia/libdriv/speex.xml@ aa95488

<?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 speex-download-http "http://downloads.us.xiph.org/releases/speex/speex-&speex-version;.tar.gz">
  <!ENTITY speex-download-ftp  " ">
  <!ENTITY speex-md5sum        "c4438b22c08e5811ff10e2b06ee9b9ae">
  <!ENTITY speex-size          "1.0 MB">
  <!ENTITY speex-buildsize     "10 MB">
  <!ENTITY speex-time          "0.2 SBU">
]>

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

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

  <title>Speex-&speex-version;</title>

  <indexterm zone="speex">
    <primary sortas="a-Speex">Speex</primary>
  </indexterm>

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

    <para><application>Speex</application> is an audio compression format
    designed especially for speech. It is well-adapted to Internet applications
    and provides useful features that are not present in most other
    CODECs.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="libogg"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><ulink url="http://valgrind.org/">Valgrind</ulink></para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr &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="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>speexdec and speexenc</seg>
        <seg>libspeex.{so,a} and libspeexdsp.{so,a}</seg>
        <seg>/usr/share/doc/speex</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="speexdec">
        <term><command>speexdec</command></term>
        <listitem>
          <para>decodes a <application>Speex</application> file and
          produces a WAV or raw file.</para>
          <indexterm zone="speex speexdec">
            <primary sortas="b-speexdec">speexdec</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="speexenc">
        <term><command>speexenc</command></term>
        <listitem>
          <para>encodes a WAV or raw files using
          <application>Speex</application>.</para>
          <indexterm zone="speex speexenc">
            <primary sortas="b-speexenc">speexenc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libspeex">
        <term><filename class='libraryfile'>libspeex.{so,a}</filename></term>
        <listitem>
          <para>provides functions for the audio encoding/decoding programs.</para>
          <indexterm zone="speex libspeex">
            <primary sortas="c-libspeex">libspeex.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libspeexdsp">
        <term><filename class='libraryfile'>libspeexdsp.{so,a}</filename></term>
        <listitem>
          <para>is a speech processing library that goes along with the
          <application>Speex</application> codec.</para>
          <indexterm zone="speex libspeexdsp">
            <primary sortas="c-libspeexdsp">libspeexdsp.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>