glfs/shareddeps/audio/alsa-lib.xml
2024-07-06 00:18:52 -06:00

297 lines
8.4 KiB
XML

<?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 alsa-lib-download-http "&alsa-download-http;/lib/alsa-lib-&alsa-lib-version;.tar.bz2">
<!ENTITY alsa-lib-download-ftp " ">
]>
<sect1 id="alsa-lib" xreflabel="alsa-lib-&alsa-lib-version;">
<?dbhtml filename="alsa-lib.html"?>
<title>alsa-lib-&alsa-lib-version;</title>
<indexterm zone="alsa-lib">
<primary sortas="a-alsa-lib">alsa-lib</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to ALSA Library</title>
<para>
The <application>ALSA Library</application> package contains
the ALSA library used by programs (including <application>ALSA
Utilities</application>) requiring access to the ALSA sound
interface.
</para>
&lfs121_checked;
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&alsa-lib-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&alsa-lib-download-ftp;"/>
</para>
</listitem>
</itemizedlist>
<!--
<bridgehead renderas="sect3">Additional Downloads</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Required patch:
<ulink url="&patch-root;/alsa-lib-&alsa-lib-version;-upstream_fixes-1.patch"/>
</para>
</listitem>
</itemizedlist>
-->
<bridgehead renderas="sect3">ALSA Library Dependencies</bridgehead>
<bridgehead renderas="sect4">Recommended (Runtime)</bridgehead>
<para role="runtime">
<ulink url="&lfs-website;/blfs/view/svn/general/elogind.html">
elogind</ulink> if Systemd isn't present
</para>
<note>
<para>
If the recommended runtime dependency is not installed,
add your regular user to the
<systemitem class='groupname'>audio</systemitem> group.
</para>
</note>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<ulink url="&lfs-website;/blfs/view/svn/general/doxygen.html">
Doxygen</ulink>,
<ulink url="&lfs-website;/blfs/view/svn/general/python2.html">
Python</ulink>, and
<ulink url="https://www.alsa-project.org/files/pub/lib/alsa-ucm-conf-&alsa-lib-version;.tar.bz2">alsa-ucm-conf</ulink>
</para>
</sect2>
<sect2 role="kernel" id="alsa-lib-kernel">
<title>Kernel Configuration</title>
<para>
If needed, enable the following options in the kernel
configuration and recompile the kernel:
</para>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="alsa-lib-kernel.xml"/>
<para>
In the Device Drivers &rArr; Sound card support &rArr; Advanced Linux
Sound Architecture section of the kernel configuration, select the
settings and drivers appropriate for your hardware. If necessary,
recompile and install your new kernel.
</para>
<indexterm zone="alsa-lib alsa-lib-kernel">
<primary sortas="d-ALSA">ALSA</primary>
</indexterm>
</sect2>
<sect2 role="installation">
<title>Installation of ALSA Library</title>
<!--
<para>
First, if you are building on a 32-bit system, fix a regression that
causes a segmentation fault when playing audio:
</para>
<screen><userinput>case $(uname -m) in
i?86) patch -Np1 -i ../alsa-lib-&alsa-lib-version;-upstream_fixes-1.patch ;;
esac</userinput></screen>
-->
<para>
Install <application>ALSA Library</application> by
running the following commands:
</para>
<screen><userinput>./configure &amp;&amp;
make</userinput></screen>
<para>
If you have <application>Doxygen</application> installed and you wish to
build the library API documentation, run the following
commands from the top-level directory of the source tree:
</para>
<screen remap="doc"><userinput>make doc</userinput></screen>
<para>
To test the results, issue: <command>make check</command>.
</para>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>make install</userinput></screen>
<para>
To install the API documentation, run the following command as
the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"
remap="doc"><userinput>install -v -d -m755 /usr/share/doc/alsa-lib-&alsa-lib-version;/html/search &amp;&amp;
install -v -m644 doc/doxygen/html/*.* \
/usr/share/doc/alsa-lib-&alsa-lib-version;/html &amp;&amp;
install -v -m644 doc/doxygen/html/search/* \
/usr/share/doc/alsa-lib-&alsa-lib-version;/html/search</userinput></screen>
</sect2>
<sect2 role="installation">
<title>32-bit Installation of ALSA Library</title>
<para>
First clean the directory:
</para>
<screen><userinput>make distclean</userinput></screen>
<para>
Install the 32-bit ALSA Library by running the following commands:
</para>
<screen><userinput>CC="gcc -m32" CXX="g++ -m32" \
./configure --prefix=/usr \
--libdir=/usr/lib32 \
--host=i686-pc-linux-gnu
make</userinput></screen>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>make DESTDIR=$PWD/DESTDIR install
cp -vr DESTDIR/usr/lib32/* /usr/lib32
rm -rf DESTDIR
ldconfig</userinput></screen>
</sect2>
<sect2 role="configuration">
<title>Configuring ALSA Library</title>
<sect3 id="alsa-lib-config">
<title>Config Files</title>
<para>
<filename>~/.asoundrc</filename> and
<filename>/etc/asound.conf</filename>
</para>
<indexterm zone="alsa-lib alsa-lib-config">
<primary sortas="e-AA.asoundrc">~/.asoundrc</primary>
</indexterm>
<indexterm zone="alsa-lib alsa-lib-config">
<primary sortas="e-etc-asound.conf">/etc/asound.conf</primary>
</indexterm>
</sect3>
<sect3>
<title>Configuration Information</title>
<para>
The default <filename>alsa.conf</filename> is adequate for most
installations. For extra functionality and/or advanced control of your
sound device, you may need to create additional configuration files.
For information on the available configuration parameters, visit
<ulink url="https://www.alsa-project.org/main/index.php/Asoundrc"/>.
</para>
</sect3>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Program</segtitle>
<segtitle>Installed Library</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>
aserver
</seg>
<seg>
libasound.so and
libatopology.so
</seg>
<seg>
/usr/include/alsa,
/usr/share/alsa and
/usr/share/doc/alsa-lib-&alsa-lib-version;
</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="aserver">
<term><command>aserver</command></term>
<listitem>
<para>
is the ALSA server
</para>
<indexterm zone="alsa-lib aserver">
<primary sortas="b-aserver">aserver</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libasound">
<term><filename class="libraryfile">libasound.so</filename></term>
<listitem>
<para>
contains the ALSA API functions
</para>
<indexterm zone="alsa-lib libasound">
<primary sortas="c-libasound">libasound.so</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libatopology">
<term><filename class="libraryfile">libatopology.so</filename></term>
<listitem>
<para>
contains API functions for the ALSA topologies
</para>
<indexterm zone="alsa-lib libatopology">
<primary sortas="c-libatopology">libatopology.so</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>