source: multimedia/libdriv/libsndfile.xml@ 73a555a

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/xf86-video-removal
Last change on this file since 73a555a was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 19 months ago

Remove sect1info tags

They only contain a date tag that is nowhere used.

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