glfs/shareddeps/audio/libsndfile.xml
Zeckmathederg a5a5f0f785 Removed all unstable notes on all packages.
Important: Added a section about stability.

Also fixed a build failure with last commit (missing ending para tag).
2024-10-18 12:39:05 -06:00

300 lines
8.8 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 libsndfile-download-http
"https://github.com/libsndfile/libsndfile/releases/download/&libsndfile-version;/libsndfile-&libsndfile-version;.tar.xz">
<!ENTITY libsndfile-download-ftp " ">
]>
<sect1 id="libsndfile" xreflabel="libsndfile-&libsndfile-version;">
<?dbhtml filename="libsndfile.html"?>
<title>libsndfile-&libsndfile-version;</title>
<indexterm zone="libsndfile">
<primary sortas="a-libsndfile">libsndfile</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to libsndfile</title>
<para>
<application>Libsndfile</application> is a library of C routines for
reading and writing files containing sampled audio data.
</para>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&libsndfile-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&libsndfile-download-ftp;"/>
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">libsndfile Dependencies</bridgehead>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended">
<xref linkend="flac"/>,
<xref linkend="opus"/>, and
<xref linkend="libvorbis"/><!-- brings in libogg -->
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="alsa-lib"/>,
<ulink url="&blfs-svn;/multimedia/lame.html">LAME</ulink>,
<ulink url="&blfs-svn;/multimedia/mpg123.html">mgp123</ulink>,
<ulink url="&blfs-svn;/multimedia/speex.html">Speex</ulink>, and
<ulink url="&blfs-svn;/server/sqlite.html">SQLite</ulink>
</para>
</sect2>
<sect2 role="installation">
<title>Installation of libsndfile</title>
<para>
Install <application>libsndfile</application> by running the following
commands:
</para>
<screen><userinput>./configure --prefix=/usr \
--docdir=/usr/share/doc/libsndfile-&libsndfile-version; &amp;&amp;
make</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>
</sect2>
<sect2 role="installation">
<title>32-bit Installation of libsndfile</title>
<para>
First clean the directory:
</para>
<screen><userinput>make distclean</userinput></screen>
<para>
Install lib32-<application>libsndfile</application> by running the following
commands:
</para>
<screen><userinput>CC="gcc -m32" CXX="g++ -m32" \
PKG_CONFIG_PATH=/usr/lib32/pkgconfig \
./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="commands">
<title>Command Explanations</title>
<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>
sndfile-cmp,
sndfile-concat,
sndfile-convert,
sndfile-deinterleave,
sndfile-info,
sndfile-interleave,
sndfile-metadata-get,
sndfile-metadata-set,
sndfile-play, and
sndfile-salvage
</seg>
<seg>libsndfile.so</seg>
<seg>/usr/share/doc/libsndfile-&libsndfile-version;</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="sndfile-cmp">
<term><command>sndfile-cmp</command></term>
<listitem>
<para>
compares two audio files
</para>
<indexterm zone="libsndfile sndfile-cmp">
<primary sortas="b-sndfile-cmp">sndfile-cmp</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-concat">
<term><command>sndfile-concat</command></term>
<listitem>
<para>
concatenates two or more audio files
</para>
<indexterm zone="libsndfile sndfile-concat">
<primary sortas="b-sndfile-concat">sndfile-concat</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-convert">
<term><command>sndfile-convert</command></term>
<listitem>
<para>
converts a sound file from one format to another
</para>
<indexterm zone="libsndfile sndfile-convert">
<primary sortas="b-sndfile-convert">sndfile-convert</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-deinterleave">
<term><command>sndfile-deinterleave</command></term>
<listitem>
<para>
splits a multi-channel into multiple single channel files
</para>
<indexterm zone="libsndfile sndfile-deinterleave">
<primary sortas="b-sndfile-deinterleave">sndfile-deinterleave</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-info">
<term><command>sndfile-info</command></term>
<listitem>
<para>
displays information about a sound file
</para>
<indexterm zone="libsndfile sndfile-info">
<primary sortas="b-sndfile-info">sndfile-info</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-interleave">
<term><command>sndfile-interleave</command></term>
<listitem>
<para>
converts multiple single channel files into a multi-channel file
</para>
<indexterm zone="libsndfile sndfile-interleave">
<primary sortas="b-sndfile-interleave">sndfile-interleave</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-metadata-get">
<term><command>sndfile-metadata-get</command></term>
<listitem>
<para>
retrieves metadata from a sound file
</para>
<indexterm zone="libsndfile sndfile-metadata-get">
<primary sortas="b-sndfile-metadata-get">sndfile-metadata-get</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-metadata-set">
<term><command>sndfile-metadata-set</command></term>
<listitem>
<para>
sets metadata in a sound file
</para>
<indexterm zone="libsndfile sndfile-metadata-set">
<primary sortas="b-sndfile-metadata-set">sndfile-metadata-set</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-play">
<term><command>sndfile-play</command></term>
<listitem>
<para>
plays a sound file
</para>
<indexterm zone="libsndfile sndfile-play">
<primary sortas="b-sndfile-play">sndfile-play</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-salvage">
<term><command>sndfile-salvage</command></term>
<listitem>
<para>
salvages the audio data from WAV files which are more than
4GB in size
</para>
<indexterm zone="libsndfile sndfile-salvage">
<primary sortas="b-sndfile-salvage">sndfile-salvage</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libsndfile-lib">
<term><filename class="libraryfile">libsndfile.so</filename></term>
<listitem>
<para>
contains the <application>libsndfile</application> API functions
</para>
<indexterm zone="libsndfile libsndfile-lib">
<primary sortas="c-libsndfile">libsndfile.so</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>