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