| 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
|---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
|---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
|---|
| 5 | %general-entities;
|
|---|
| 6 |
|
|---|
| 7 | <!ENTITY libsndfile-download-http
|
|---|
| 8 | "http://www.mega-nerd.com/libsndfile/files/libsndfile-&libsndfile-version;.tar.gz">
|
|---|
| 9 | <!ENTITY libsndfile-download-ftp " ">
|
|---|
| 10 | <!ENTITY libsndfile-md5sum "646b5f98ce89ac60cdb060fcd398247c">
|
|---|
| 11 | <!ENTITY libsndfile-size "1.1 MB">
|
|---|
| 12 | <!ENTITY libsndfile-buildsize "34 MB (with tests)">
|
|---|
| 13 | <!ENTITY libsndfile-time "0.6 SBU (with tests)">
|
|---|
| 14 | ]>
|
|---|
| 15 |
|
|---|
| 16 | <sect1 id="libsndfile" xreflabel="libsndfile-&libsndfile-version;">
|
|---|
| 17 | <?dbhtml filename="libsndfile.html"?>
|
|---|
| 18 |
|
|---|
| 19 | <sect1info>
|
|---|
| 20 | <othername>$LastChangedBy$</othername>
|
|---|
| 21 | <date>$Date$</date>
|
|---|
| 22 | </sect1info>
|
|---|
| 23 |
|
|---|
| 24 | <title>libsndfile-&libsndfile-version;</title>
|
|---|
| 25 |
|
|---|
| 26 | <indexterm zone="libsndfile">
|
|---|
| 27 | <primary sortas="a-libsndfile">libsndfile</primary>
|
|---|
| 28 | </indexterm>
|
|---|
| 29 |
|
|---|
| 30 | <sect2 role="package">
|
|---|
| 31 | <title>Introduction to libsndfile</title>
|
|---|
| 32 |
|
|---|
| 33 | <para>
|
|---|
| 34 | <application>Libsndfile</application> is a library of C routines for
|
|---|
| 35 | reading and writing files containing sampled audio data.
|
|---|
| 36 | </para>
|
|---|
| 37 |
|
|---|
| 38 | &lfs84_checked;
|
|---|
| 39 |
|
|---|
| 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
|---|
| 41 | <itemizedlist spacing="compact">
|
|---|
| 42 | <listitem>
|
|---|
| 43 | <para>Download (HTTP): <ulink url="&libsndfile-download-http;"/></para>
|
|---|
| 44 | </listitem>
|
|---|
| 45 | <listitem>
|
|---|
| 46 | <para>Download (FTP): <ulink url="&libsndfile-download-ftp;"/></para>
|
|---|
| 47 | </listitem>
|
|---|
| 48 | <listitem>
|
|---|
| 49 | <para>Download MD5 sum: &libsndfile-md5sum;</para>
|
|---|
| 50 | </listitem>
|
|---|
| 51 | <listitem>
|
|---|
| 52 | <para>Download size: &libsndfile-size;</para>
|
|---|
| 53 | </listitem>
|
|---|
| 54 | <listitem>
|
|---|
| 55 | <para>Estimated disk space required: &libsndfile-buildsize;</para>
|
|---|
| 56 | </listitem>
|
|---|
| 57 | <listitem>
|
|---|
| 58 | <para>Estimated build time: &libsndfile-time;</para>
|
|---|
| 59 | </listitem>
|
|---|
| 60 | </itemizedlist>
|
|---|
| 61 |
|
|---|
| 62 | <bridgehead renderas="sect3">libsndfile Dependencies</bridgehead>
|
|---|
| 63 |
|
|---|
| 64 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
|---|
| 65 | <para role="recommended">
|
|---|
| 66 | <xref linkend="flac"/>,
|
|---|
| 67 | <xref linkend="libogg"/>, and
|
|---|
| 68 | <xref linkend="libvorbis"/>
|
|---|
| 69 | </para>
|
|---|
| 70 |
|
|---|
| 71 | <bridgehead renderas="sect4">Optional</bridgehead>
|
|---|
| 72 | <para role="optional">
|
|---|
| 73 | <xref linkend="alsa-lib"/> and
|
|---|
| 74 | <xref linkend="sqlite"/>
|
|---|
| 75 | </para>
|
|---|
| 76 |
|
|---|
| 77 | <para condition="html" role="usernotes">
|
|---|
| 78 | User Notes: <ulink url="&blfs-wiki;/libsndfile"/>
|
|---|
| 79 | </para>
|
|---|
| 80 | </sect2>
|
|---|
| 81 |
|
|---|
| 82 | <sect2 role="installation">
|
|---|
| 83 | <title>Installation of libsndfile</title>
|
|---|
| 84 |
|
|---|
| 85 | <para>
|
|---|
| 86 | Install <application>libsndfile</application> by running the following
|
|---|
| 87 | commands:
|
|---|
| 88 | </para>
|
|---|
| 89 |
|
|---|
| 90 | <screen><userinput>./configure --prefix=/usr \
|
|---|
| 91 | --disable-static \
|
|---|
| 92 | --docdir=/usr/share/doc/libsndfile-&libsndfile-version; &&
|
|---|
| 93 | make</userinput></screen>
|
|---|
| 94 |
|
|---|
| 95 | <para>To test the results, issue: <command>make check</command>.</para>
|
|---|
| 96 |
|
|---|
| 97 | <para>
|
|---|
| 98 | Now, as the <systemitem class="username">root</systemitem> user:
|
|---|
| 99 | </para>
|
|---|
| 100 |
|
|---|
| 101 | <screen role="root"><userinput>make install</userinput></screen>
|
|---|
| 102 | </sect2>
|
|---|
| 103 |
|
|---|
| 104 | <sect2 role="commands">
|
|---|
| 105 | <title>Command Explanations</title>
|
|---|
| 106 |
|
|---|
| 107 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
|---|
| 108 | href="../../xincludes/static-libraries.xml"/>
|
|---|
| 109 |
|
|---|
| 110 | </sect2>
|
|---|
| 111 |
|
|---|
| 112 | <sect2 role="content">
|
|---|
| 113 | <title>Contents</title>
|
|---|
| 114 |
|
|---|
| 115 | <segmentedlist>
|
|---|
| 116 | <segtitle>Installed Programs</segtitle>
|
|---|
| 117 | <segtitle>Installed Library</segtitle>
|
|---|
| 118 | <segtitle>Installed Directory</segtitle>
|
|---|
| 119 |
|
|---|
| 120 | <seglistitem>
|
|---|
| 121 | <seg>
|
|---|
| 122 | sndfile-cmp,
|
|---|
| 123 | sndfile-concat,
|
|---|
| 124 | sndfile-convert,
|
|---|
| 125 | sndfile-deinterleave,
|
|---|
| 126 | sndfile-info,
|
|---|
| 127 | sndfile-interleave,
|
|---|
| 128 | sndfile-metadata-get,
|
|---|
| 129 | sndfile-metadata-set,
|
|---|
| 130 | sndfile-play,
|
|---|
| 131 | sndfile-regtest and
|
|---|
| 132 | sndfile-salvage
|
|---|
| 133 | </seg>
|
|---|
| 134 | <seg>libsndfile.so</seg>
|
|---|
| 135 | <seg>/usr/share/doc/libsndfile-&libsndfile-version;</seg>
|
|---|
| 136 | </seglistitem>
|
|---|
| 137 | </segmentedlist>
|
|---|
| 138 |
|
|---|
| 139 | <variablelist>
|
|---|
| 140 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 141 | <?dbfo list-presentation="list"?>
|
|---|
| 142 | <?dbhtml list-presentation="table"?>
|
|---|
| 143 |
|
|---|
| 144 | <varlistentry id="sndfile-cmp">
|
|---|
| 145 | <term><command>sndfile-cmp</command></term>
|
|---|
| 146 | <listitem>
|
|---|
| 147 | <para>compares two audio files.</para>
|
|---|
| 148 | <indexterm zone="libsndfile sndfile-cmp">
|
|---|
| 149 | <primary sortas="b-sndfile-cmp">sndfile-cmp</primary>
|
|---|
| 150 | </indexterm>
|
|---|
| 151 | </listitem>
|
|---|
| 152 | </varlistentry>
|
|---|
| 153 |
|
|---|
| 154 | <varlistentry id="sndfile-concat">
|
|---|
| 155 | <term><command>sndfile-concat</command></term>
|
|---|
| 156 | <listitem>
|
|---|
| 157 | <para>concatenates two or more audio files.</para>
|
|---|
| 158 | <indexterm zone="libsndfile sndfile-concat">
|
|---|
| 159 | <primary sortas="b-sndfile-concat">sndfile-concat</primary>
|
|---|
| 160 | </indexterm>
|
|---|
| 161 | </listitem>
|
|---|
| 162 | </varlistentry>
|
|---|
| 163 |
|
|---|
| 164 | <varlistentry id="sndfile-convert">
|
|---|
| 165 | <term><command>sndfile-convert</command></term>
|
|---|
| 166 | <listitem>
|
|---|
| 167 | <para>converts a sound files from one format to another.</para>
|
|---|
| 168 | <indexterm zone="libsndfile sndfile-convert">
|
|---|
| 169 | <primary sortas="b-sndfile-convert">sndfile-convert</primary>
|
|---|
| 170 | </indexterm>
|
|---|
| 171 | </listitem>
|
|---|
| 172 | </varlistentry>
|
|---|
| 173 |
|
|---|
| 174 | <varlistentry id="sndfile-deinterleave">
|
|---|
| 175 | <term><command>sndfile-deinterleave</command></term>
|
|---|
| 176 | <listitem>
|
|---|
| 177 | <para>splits a multi-channel into multiple single channel files.</para>
|
|---|
| 178 | <indexterm zone="libsndfile sndfile-deinterleave">
|
|---|
| 179 | <primary sortas="b-sndfile-deinterleave">sndfile-deinterleave</primary>
|
|---|
| 180 | </indexterm>
|
|---|
| 181 | </listitem>
|
|---|
| 182 | </varlistentry>
|
|---|
| 183 |
|
|---|
| 184 | <varlistentry id="sndfile-info">
|
|---|
| 185 | <term><command>sndfile-info</command></term>
|
|---|
| 186 | <listitem>
|
|---|
| 187 | <para>displays information about a sound file.</para>
|
|---|
| 188 | <indexterm zone="libsndfile sndfile-info">
|
|---|
| 189 | <primary sortas="b-sndfile-info">sndfile-info</primary>
|
|---|
| 190 | </indexterm>
|
|---|
| 191 | </listitem>
|
|---|
| 192 | </varlistentry>
|
|---|
| 193 |
|
|---|
| 194 | <varlistentry id="sndfile-interleave">
|
|---|
| 195 | <term><command>sndfile-interleave</command></term>
|
|---|
| 196 | <listitem>
|
|---|
| 197 | <para>converts multiple single channel files into a multi-channel
|
|---|
| 198 | file.</para>
|
|---|
| 199 | <indexterm zone="libsndfile sndfile-interleave">
|
|---|
| 200 | <primary sortas="b-sndfile-interleave">sndfile-interleave</primary>
|
|---|
| 201 | </indexterm>
|
|---|
| 202 | </listitem>
|
|---|
| 203 | </varlistentry>
|
|---|
| 204 |
|
|---|
| 205 | <varlistentry id="sndfile-metadata-get">
|
|---|
| 206 | <term><command>sndfile-metadata-get</command></term>
|
|---|
| 207 | <listitem>
|
|---|
| 208 | <para>retrieves metadata from a sound file.</para>
|
|---|
| 209 | <indexterm zone="libsndfile sndfile-metadata-get">
|
|---|
| 210 | <primary sortas="b-sndfile-metadata-get">sndfile-metadata-get</primary>
|
|---|
| 211 | </indexterm>
|
|---|
| 212 | </listitem>
|
|---|
| 213 | </varlistentry>
|
|---|
| 214 |
|
|---|
| 215 | <varlistentry id="sndfile-metadata-set">
|
|---|
| 216 | <term><command>sndfile-metadata-set</command></term>
|
|---|
| 217 | <listitem>
|
|---|
| 218 | <para>sets metadata in a sound file.</para>
|
|---|
| 219 | <indexterm zone="libsndfile sndfile-metadata-set">
|
|---|
| 220 | <primary sortas="b-sndfile-metadata-set">sndfile-metadata-set</primary>
|
|---|
| 221 | </indexterm>
|
|---|
| 222 | </listitem>
|
|---|
| 223 | </varlistentry>
|
|---|
| 224 |
|
|---|
| 225 | <varlistentry id="sndfile-play">
|
|---|
| 226 | <term><command>sndfile-play</command></term>
|
|---|
| 227 | <listitem>
|
|---|
| 228 | <para>plays a sound file.</para>
|
|---|
| 229 | <indexterm zone="libsndfile sndfile-play">
|
|---|
| 230 | <primary sortas="b-sndfile-play">sndfile-play</primary>
|
|---|
| 231 | </indexterm>
|
|---|
| 232 | </listitem>
|
|---|
| 233 | </varlistentry>
|
|---|
| 234 |
|
|---|
| 235 | <!--<varlistentry id="sndfile-regtest">
|
|---|
| 236 | <term><command>sndfile-regtest</command></term>
|
|---|
| 237 | <listitem>
|
|---|
| 238 | <para>does this .....</para>
|
|---|
| 239 | <indexterm zone="libsndfile sndfile-regtest">
|
|---|
| 240 | <primary sortas="b-sndfile-regtest">sndfile-regtest</primary>
|
|---|
| 241 | </indexterm>
|
|---|
| 242 | </listitem>
|
|---|
| 243 | </varlistentry>
|
|---|
| 244 |
|
|---|
| 245 | <varlistentry id="sndfile-salvage">
|
|---|
| 246 | <term><command>sndfile-salvage</command></term>
|
|---|
| 247 | <listitem>
|
|---|
| 248 | <para>does this .....</para>
|
|---|
| 249 | <indexterm zone="libsndfile sndfile-salvage">
|
|---|
| 250 | <primary sortas="b-sndfile-salvage">sndfile-salvage</primary>
|
|---|
| 251 | </indexterm>
|
|---|
| 252 | </listitem>
|
|---|
| 253 | </varlistentry>-->
|
|---|
| 254 |
|
|---|
| 255 | <varlistentry id="libsndfile-lib">
|
|---|
| 256 | <term><filename class='libraryfile'>libsndfile.so</filename></term>
|
|---|
| 257 | <listitem>
|
|---|
| 258 | <para>contains the <application>libsndfile</application> API
|
|---|
| 259 | functions.</para>
|
|---|
| 260 | <indexterm zone="libsndfile libsndfile-lib">
|
|---|
| 261 | <primary sortas="c-libsndfile">libsndfile.so</primary>
|
|---|
| 262 | </indexterm>
|
|---|
| 263 | </listitem>
|
|---|
| 264 | </varlistentry>
|
|---|
| 265 |
|
|---|
| 266 | </variablelist>
|
|---|
| 267 |
|
|---|
| 268 | </sect2>
|
|---|
| 269 |
|
|---|
| 270 | </sect1>
|
|---|
