source: multimedia/libdriv/sbc.xml@ 6ff67392

<?xml version="1.0" encoding="UTF-8"?>
<!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 sbc-download-http "&kernel-dl;/linux/bluetooth/sbc-&sbc-version;.tar.xz">
  <!ENTITY sbc-download-ftp  " ">
  <!ENTITY sbc-md5sum        "5613357181daeffd71e971c6f8470f8d">
  <!ENTITY sbc-size          "268 KB">
  <!ENTITY sbc-buildsize     "2.8 MB">
  <!ENTITY sbc-time          "less than 0.1 SBU">
]>

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


  <title>SBC-&sbc-version;</title>

  <indexterm zone="sbc">
    <primary sortas="a-SBC">SBC</primary>
  </indexterm>

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

    <para>
      The <application>SBC</application> package is a digital audio encoder and
      decoder used to transfer data to Bluetooth audio output devices like
      headphones or loudspeakers.
    </para>

    &lfs122_checked;

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="libsndfile"/>
    </para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --disable-static --disable-tester &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>
      <parameter>--disable-tester</parameter>: This disables
      the SBC tester. Remove it if you have installed
      <xref linkend="libsndfile"/>.
    </para>

    <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>
          sbcdec, sbcenc, and sbcinfo
        </seg>
        <seg>
          libsbc.so
        </seg>
        <seg>
          /usr/include/sbc
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="sbcdec">
        <term><command>sbcdec</command></term>
        <listitem>
          <para>
            is a SBC decoder utility
          </para>
          <indexterm zone="sbc sbcdec">
            <primary sortas="b-sbcdec">sbcdec</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sbcenc">
        <term><command>sbcenc</command></term>
        <listitem>
          <para>
            is a SBC encoder utility
          </para>
          <indexterm zone="sbc sbcenc">
            <primary sortas="b-sbcenc">sbcenc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sbcinfo">
        <term><command>sbcinfo</command></term>
        <listitem>
          <para>
            is a subband codec (SBC) analyzer
          </para>
          <indexterm zone="sbc sbcinfo">
            <primary sortas="b-sbcinfo">sbcinfo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>