source: multimedia/libdriv/libsndfile.xml

trunk
Last change on this file was 1241ea19, checked in by Bruce Dubbs <bdubbs@…>, 2 months ago

Tag xfce and dependencies

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