source: multimedia/libdriv/speex.xml@ 2696de6

<?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 "https://downloads.xiph.org/releases/speex/speex-&speex-version;.tar.gz">
  <!ENTITY speex-download-ftp  " ">
  <!ENTITY speex-md5sum        "fe7bf610883ff202092b92c72fe0fe3e">
  <!ENTITY speex-size          "1020 KB">
  <!ENTITY speex-buildsize     "7.8 MB">
  <!ENTITY speex-time          "less than 0.1 SBU">

  <!ENTITY speexdsp-download-http "https://downloads.xiph.org/releases/speex/speexdsp-&speexdsp-version;.tar.gz">
  <!ENTITY speexdsp-download-ftp  " ">
  <!ENTITY speexdsp-md5sum        "e6eb5ddef743a362c8018f260b91dca5">
  <!ENTITY speexdsp-size          "904 KB">
  <!ENTITY speexdsp-buildsize     "5.5 MB">
  <!ENTITY speexdsp-time          "less than 0.1 SBU">

]>

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

  <sect1info>
    <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 specifically for speech. It is well-adapted to internet
      applications and provides useful features that are not present in most
      other CODECs.
    </para>

    &lfs112_checked;

    <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">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&speexdsp-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&speexdsp-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &speexdsp-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &speexdsp-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &speexdsp-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &speexdsp-time;
        </para>
      </listitem>
    </itemizedlist>
<!--
   <bridgehead renderas="sect3">Additional Download</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/speexdsp-&speex-version;-build_fixes-1.patch"/>
        </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">
      <xref linkend="valgrind"/>
    </para>

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

  </sect2>

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

    <para>
      This package consists of two separate tarballs.
      They need to be extracted and built independently.
    </para>

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

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

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      As the <systemitem class="username">root</systemitem> user:
    </para>

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

    <para>
      Now extract and install the speexdsp package:
    </para>

<screen><userinput>cd ..                          &amp;&amp;
tar -xf speexdsp-&speexdsp-version;.tar.gz &amp;&amp;
cd speexdsp-&speexdsp-version;             &amp;&amp;

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

    <para>
      Again, 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"/>

<!-- Included by default as of 1.2.1
    <para>
      <option>- -enable-binaries</option>: Builds two binaries to encode and
      decode to and from the speex format.
    </para>
-->

  </sect2>

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

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

      <seglistitem>
        <seg>speexenc and speexdec</seg>
        <seg>libspeex.so and libspeexdsp.so</seg>
        <seg>
          /usr/include/speex and
          /usr/share/doc/speex-&speex-version;
        </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 file 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</filename></term>
        <listitem>
          <para>
            provides functions for the audio encoding/decoding programs
          </para>
          <indexterm zone="speex libspeex">
            <primary sortas="c-libspeex">libspeex.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libspeexdsp">
        <term><filename class="libraryfile">libspeexdsp.so</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</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>