source: multimedia/libdriv/alsa-tools.xml@ 6587e936

<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY alsa-tools-download-http "&alsa-download-http;/tools/alsa-tools-&alsa-tools-version;.tar.bz2">
  <!ENTITY alsa-tools-download-ftp  "&alsa-download-ftp;/tools/alsa-tools-&alsa-tools-version;.tar.bz2">
  <!ENTITY alsa-tools-md5sum        "cf51eccd14e818a9f0be455cedcd52ff">
  <!ENTITY alsa-tools-size          "821 KB">
  <!ENTITY alsa-tools-buildsize     "7-9 MB depending on the tool being built">
  <!ENTITY alsa-tools-time          "0.01-0.06 SBU depending on the tool being built">
]>

<sect1 id="alsa-tools" xreflabel="ALSA Tools-&alsa-tools-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="alsa-tools.html"?>
<title>ALSA Tools-&alsa-tools-version;</title>
<indexterm zone="alsa-tools">
<primary sortas="a-ALSA-Tools">ALSA Tools</primary></indexterm>

<sect2>
<title>Introduction to <application><acronym>ALSA</acronym> 
Tools</application></title>

<para>The <application><acronym>ALSA</acronym> Tools</application> package 
contains advanced tools for certain sound cards.</para>

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

<sect3><title><application><acronym>ALSA</acronym> Tools</application> 
dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="alsa-lib"/></para>
</sect4>

<sect4><title>Optional</title>
<para><xref linkend="GTK"/> (to build <command>echomixer</command>, 
<command>envy24control</command> and <command>rmedigicontrol</command>) and 
<ulink url="http://www.fltk.org/">FLTK</ulink> (to build 
<command>hdspconf</command> and <command>hdspmixer</command>)</para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application><acronym>ALSA</acronym> 
Tools</application></title>

<para>The <command>as10k1</command> program needs a minor change to the 
source code to compile using 
<application><acronym>GCC</acronym></application>-3.4.x. The following 
<command>sed</command> command fixes the problem:</para>

<screen><userinput><command>sed -i -e "s/^next_cli_arg:/&amp;\n\n\tbreak;/" as10k1/as10k1.c</command></userinput></screen>

<para>The <application><acronym>ALSA</acronym> Tools</application> package is 
only needed by those with advanced requirements for their sound card.  The 
tools are not all built together, instead you need to <command>cd</command> 
into the directory of each tool you wish to compile and run the following 
commands:</para>

<screen><userinput><command>./configure --prefix=/usr &amp;&amp;
make</command></userinput></screen>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install</command></userinput></screen>

</sect2>

<sect2>
<title>Contents</title>

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

<seglistitem>
<seg>ac3dec, extract_ac3, as10k1, echomixer, envy24control, hdspconf, 
hdsploader, hdspmixer, mixartloader, pcxhrloader, rmedigicontrol, cspctl, 
sbiload, sscape_ctl, us428control, usx2yloader and vxloader</seg>
<seg>None</seg>
<seg>/usr/share/applications, /usr/share/pixmaps and 
/usr/share/sounds</seg>
</seglistitem>
</segmentedlist>

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

<varlistentry id="ac3dec">
<term><command>ac3dec</command></term>
<listitem><para>is a free AC-3 stream decoder.</para>
<indexterm zone="alsa-tools ac3dec">
<primary sortas="b-ac3dec">ac3dec</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="extract_ac3">
<term><command>extract_ac3</command></term>
<listitem><para>will take an <acronym>MPEG</acronym>-2 stream and produce 
AC-3 audio to stdout if it exists.</para>
<indexterm zone="alsa-tools extract_ac3">
<primary sortas="b-extract_ac3">extract_ac3</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="as10k1">
<term><command>as10k1</command></term>
<listitem><para>is an assembler for the emu10k1 <acronym>DSP</acronym> chip 
present in the Creative <acronym>SB</acronym> Live, <acronym>PCI</acronym> 
512, and emu <acronym>APS</acronym> sound cards. It is used to make audio 
effects such as a flanger, chorus or reverb.</para>
<indexterm zone="alsa-tools as10k1">
<primary sortas="b-as10k1">as10k1</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="echomixer">
<term><command>echomixer</command></term>
<listitem><para>is the Linux equivalent of the Echoaudio console application 
from Echoaudio. It is a tool to control all the features of any Echoaudio 
soundcard. This includes clock sources, input and output gains, mixers, 
etc.</para>
<indexterm zone="alsa-tools echomixer">
<primary sortas="b-echomixer">echomixer</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="envy24control">
<term><command>envy24control</command></term>
<listitem><para>is a control tool for Envy24 (ice1712) based sound 
cards.</para>
<indexterm zone="alsa-tools envy24control">
<primary sortas="b-envy24control">envy24control</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="hdspconf">
<term><command>hdspconf</command></term>
<listitem><para>is a <acronym>GUI</acronym> to control the Hammerfall 
HDSP Alsa Settings. Up to four hdsp cards are supported.</para>
<indexterm zone="alsa-tools hdspconf">
<primary sortas="b-hdspconf">hdspconf</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="hdsploader">
<term><command>hdsploader</command></term>
<listitem><para>is used to load the firmware required by the Hammerfall 
HDSP sound cards.</para>
<indexterm zone="alsa-tools hdsploader">
<primary sortas="b-hdsploader">hdsploader</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="hdspmixer">
<term><command>hdspmixer</command></term>
<listitem><para>is the Linux equivalent of the Totalmix application from RME. 
It is a tool to control the advanced routing features of the RME Hammerfall 
DSP soundcard series.</para>
<indexterm zone="alsa-tools hdspmixer">
<primary sortas="b-hdspmixer">hdspmixer</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="mixartloader">
<term><command>mixartloader</command></term>
<listitem><para>is a helper program to load the firmware binaries onto the 
Digigram's miXart board sound drivers. The following modules require this 
program: snd-mixart. These drivers don't work properly at all until the 
certain firmwares are loaded, i.e. no PCM nor mixer devices will 
appear.</para>
<indexterm zone="alsa-tools mixartloader">
<primary sortas="b-mixartloader">mixartloader</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="pcxhrloader">
<term><command>pcxhrloader</command></term>
<listitem><para>is a helper program to load the firmware binaries onto 
Digigram's pcxhr compatible board sound drivers. The following modules 
require this program: snd-pcxhr. These drivers don't work properly at all 
until the certain firmwares are loaded, i.e. no PCM nor mixer devices will 
appear.</para>
<indexterm zone="alsa-tools pcxhrloader">
<primary sortas="b-pcxhrloader">pcxhrloader</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="rmedigicontrol">
<term><command>rmedigicontrol</command></term>
<listitem><para>is a control tool for RME Digi32 and RME Digi96 sound cards. 
It provides a graphical frontend for all the sound card controls and 
switches.</para>
<indexterm zone="alsa-tools rmedigicontrol">
<primary sortas="b-rmedigicontrol">rmedigicontrol</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="cspctl">
<term><command>cspctl</command></term>
<listitem><para>is an SB16/AWE32 Creative Signal Processor
(<acronym>ASP</acronym>/<acronym>CSP</acronym>) control program.</para>
<indexterm zone="alsa-tools cspctl">
<primary sortas="b-cspctl">cspctl</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="sbiload">
<term><command>sbiload</command></term>
<listitem><para>is an <acronym>OPL</acronym>2/3 FM instrument loader for the 
<acronym>ALSA</acronym> sequencer.</para>
<indexterm zone="alsa-tools sbiload">
<primary sortas="b-sbiload">sbiload</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="sscape_ctl">
<term><command>sscape_ctl</command></term>
<listitem><para>is an <acronym>ALSA</acronym> SoundScape control 
utility.</para>
<indexterm zone="alsa-tools sscape_ctl">
<primary sortas="b-sscape_ctl">sscape_ctl</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="us428control">
<term><command>us428control</command></term>
<listitem><para>is a Tascam US-428 control program.</para>
<indexterm zone="alsa-tools us428control">
<primary sortas="b-us428control">us428control</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="usx2yloader">
<term><command>usx2yloader</command></term>
<listitem><para>is a helper program to load the 2nd Phase firmware binaries 
onto the Tascam USX2Y USB sound cards. It has proven to work so far for the 
US122, US224 and US428. The snd-usb-usx2y module requires this program.</para>
<indexterm zone="alsa-tools usx2yloader">
<primary sortas="b-usx2yloader">usx2yloader</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="vxloader">
<term><command>vxloader</command></term>
<listitem><para>is a helper program to load the firmware binaries onto the 
Digigram's VX-board sound drivers. The following modules require this program: 
snd-vx222, snd-vxpocket, snd-vxp440. These drivers don't work properly at all 
until the certain firmwares are loaded, i.e. no PCM nor mixer devices will 
appear.</para>
<indexterm zone="alsa-tools vxloader">
<primary sortas="b-vxloader">vxloader</primary>
</indexterm></listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>