source: multimedia/libdriv/libsndfile.xml@ 3b342a1

11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/soup3 xry111/xf86-video-removal
Last change on this file since 3b342a1 was 3b342a1, checked in by Bruce Dubbs <bdubbs@…>, 2 years ago

Update to libsndfile-1.1.0.

  • Property mode set to 100644
File size: 9.1 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.xz">
9 <!ENTITY libsndfile-download-ftp " ">
10 <!ENTITY libsndfile-md5sum "e63dead2b4f0aaf323687619d007ee6a">
11 <!ENTITY libsndfile-size "716 KB">
12 <!ENTITY libsndfile-buildsize "12 MB (add 9 MB for tests)">
13 <!ENTITY libsndfile-time "0.1 SBU (add 0.2 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 &lfs111_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 --docdir=/usr/share/doc/libsndfile-&libsndfile-version; &amp;&amp;
104make</userinput></screen>
105
106 <para>
107 To test the results, issue: <command>make check</command>.
108 </para>
109
110 <para>
111 Now, as the <systemitem class="username">root</systemitem> user:
112 </para>
113
114<screen role="root"><userinput>make install</userinput></screen>
115 </sect2>
116<!--
117 <sect2 role="commands">
118 <title>Command Explanations</title>
119
120 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
121 href="../../xincludes/static-libraries.xml"/>
122
123 </sect2>
124-->
125 <sect2 role="content">
126 <title>Contents</title>
127
128 <segmentedlist>
129 <segtitle>Installed Programs</segtitle>
130 <segtitle>Installed Library</segtitle>
131 <segtitle>Installed Directory</segtitle>
132
133 <seglistitem>
134 <seg>
135 sndfile-cmp,
136 sndfile-concat,
137 sndfile-convert,
138 sndfile-deinterleave,
139 sndfile-info,
140 sndfile-interleave,
141 sndfile-metadata-get,
142 sndfile-metadata-set,
143 sndfile-play, and
144 sndfile-salvage
145 </seg>
146 <seg>libsndfile.so</seg>
147 <seg>/usr/share/doc/libsndfile-&libsndfile-version;</seg>
148 </seglistitem>
149 </segmentedlist>
150
151 <variablelist>
152 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
153 <?dbfo list-presentation="list"?>
154 <?dbhtml list-presentation="table"?>
155
156 <varlistentry id="sndfile-cmp">
157 <term><command>sndfile-cmp</command></term>
158 <listitem>
159 <para>
160 compares two audio files
161 </para>
162 <indexterm zone="libsndfile sndfile-cmp">
163 <primary sortas="b-sndfile-cmp">sndfile-cmp</primary>
164 </indexterm>
165 </listitem>
166 </varlistentry>
167
168 <varlistentry id="sndfile-concat">
169 <term><command>sndfile-concat</command></term>
170 <listitem>
171 <para>
172 concatenates two or more audio files
173 </para>
174 <indexterm zone="libsndfile sndfile-concat">
175 <primary sortas="b-sndfile-concat">sndfile-concat</primary>
176 </indexterm>
177 </listitem>
178 </varlistentry>
179
180 <varlistentry id="sndfile-convert">
181 <term><command>sndfile-convert</command></term>
182 <listitem>
183 <para>
184 converts a sound files from one format to another
185 </para>
186 <indexterm zone="libsndfile sndfile-convert">
187 <primary sortas="b-sndfile-convert">sndfile-convert</primary>
188 </indexterm>
189 </listitem>
190 </varlistentry>
191
192 <varlistentry id="sndfile-deinterleave">
193 <term><command>sndfile-deinterleave</command></term>
194 <listitem>
195 <para>
196 splits a multi-channel into multiple single channel files
197 </para>
198 <indexterm zone="libsndfile sndfile-deinterleave">
199 <primary sortas="b-sndfile-deinterleave">sndfile-deinterleave</primary>
200 </indexterm>
201 </listitem>
202 </varlistentry>
203
204 <varlistentry id="sndfile-info">
205 <term><command>sndfile-info</command></term>
206 <listitem>
207 <para>
208 displays information about a sound file
209 </para>
210 <indexterm zone="libsndfile sndfile-info">
211 <primary sortas="b-sndfile-info">sndfile-info</primary>
212 </indexterm>
213 </listitem>
214 </varlistentry>
215
216 <varlistentry id="sndfile-interleave">
217 <term><command>sndfile-interleave</command></term>
218 <listitem>
219 <para>
220 converts multiple single channel files into a multi-channel file
221 </para>
222 <indexterm zone="libsndfile sndfile-interleave">
223 <primary sortas="b-sndfile-interleave">sndfile-interleave</primary>
224 </indexterm>
225 </listitem>
226 </varlistentry>
227
228 <varlistentry id="sndfile-metadata-get">
229 <term><command>sndfile-metadata-get</command></term>
230 <listitem>
231 <para>
232 retrieves metadata from a sound file
233 </para>
234 <indexterm zone="libsndfile sndfile-metadata-get">
235 <primary sortas="b-sndfile-metadata-get">sndfile-metadata-get</primary>
236 </indexterm>
237 </listitem>
238 </varlistentry>
239
240 <varlistentry id="sndfile-metadata-set">
241 <term><command>sndfile-metadata-set</command></term>
242 <listitem>
243 <para>
244 sets metadata in a sound file
245 </para>
246 <indexterm zone="libsndfile sndfile-metadata-set">
247 <primary sortas="b-sndfile-metadata-set">sndfile-metadata-set</primary>
248 </indexterm>
249 </listitem>
250 </varlistentry>
251
252 <varlistentry id="sndfile-play">
253 <term><command>sndfile-play</command></term>
254 <listitem>
255 <para>
256 plays a sound file
257 </para>
258 <indexterm zone="libsndfile sndfile-play">
259 <primary sortas="b-sndfile-play">sndfile-play</primary>
260 </indexterm>
261 </listitem>
262 </varlistentry>
263
264 <!--<varlistentry id="sndfile-regtest">
265 <term><command>sndfile-regtest</command></term>
266 <listitem>
267 <para>
268 does this .....
269 </para>
270 <indexterm zone="libsndfile sndfile-regtest">
271 <primary sortas="b-sndfile-regtest">sndfile-regtest</primary>
272 </indexterm>
273 </listitem>
274 </varlistentry>-->
275
276 <varlistentry id="sndfile-salvage">
277 <term><command>sndfile-salvage</command></term>
278 <listitem>
279 <para>
280 Salvages the audio data from WAV files which are more than
281 4G in length
282 </para>
283 <indexterm zone="libsndfile sndfile-salvage">
284 <primary sortas="b-sndfile-salvage">sndfile-salvage</primary>
285 </indexterm>
286 </listitem>
287 </varlistentry>
288
289 <varlistentry id="libsndfile-lib">
290 <term><filename class="libraryfile">libsndfile.so</filename></term>
291 <listitem>
292 <para>
293 contains the <application>libsndfile</application> API functions
294 </para>
295 <indexterm zone="libsndfile libsndfile-lib">
296 <primary sortas="c-libsndfile">libsndfile.so</primary>
297 </indexterm>
298 </listitem>
299 </varlistentry>
300
301 </variablelist>
302
303 </sect2>
304
305</sect1>
Note: See TracBrowser for help on using the repository browser.