source: multimedia/libdriv/libsndfile.xml@ a455c16

10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since a455c16 was a455c16, checked in by Xi Ruoyao <xry111@…>, 8 months ago

libsndfile: add a missed comma

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@24189 af4574ff-66df-0310-9fd7-8a98e5e911e0

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