source: multimedia/audioutils/vorbistools.xml@ 29c08dc

12.2 lazarus trunk xry111/for-12.3 xry111/spidermonkey128
Last change on this file since 29c08dc was 29c08dc, checked in by Bruce Dubbs <bdubbs@…>, 2 months ago

Fix a gcc14 issue in vorbis-tools .
  • Property mode set to 100644
File size: 7.9 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 vorbistools-download-http "https://downloads.xiph.org/releases/vorbis/vorbis-tools-&vorbistools-version;.tar.gz">
8 <!ENTITY vorbistools-download-ftp " ">
9 <!ENTITY vorbistools-md5sum "998fca293bd4e4bdc2b96fb70f952f4e">
10 <!ENTITY vorbistools-size "1.3 MB">
11 <!ENTITY vorbistools-buildsize "12 MB">
12 <!ENTITY vorbistools-time "0.1 SBU">
13]>
14
15<sect1 id="vorbistools" xreflabel="vorbis-tools-&vorbistools-version;">
16 <?dbhtml filename="vorbistools.html"?>
17
18
19 <title>vorbis-tools-&vorbistools-version;</title>
20
21 <indexterm zone="vorbistools">
22 <primary sortas="a-Vorbis-Tools">Vorbis Tools</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to Vorbis Tools</title>
27
28 <para>
29 The <application>Vorbis Tools</application> package contains
30 command-line tools useful for encoding, playing or editing
31 files using the Ogg CODEC.
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="&vorbistools-download-http;"/>
41 </para>
42 </listitem>
43 <listitem>
44 <para>
45 Download (FTP): <ulink url="&vorbistools-download-ftp;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download MD5 sum: &vorbistools-md5sum;
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download size: &vorbistools-size;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Estimated disk space required: &vorbistools-buildsize;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated build time: &vorbistools-time;
66 </para>
67 </listitem>
68 </itemizedlist>
69
70 <bridgehead renderas="sect3">Vorbis Tools Dependencies</bridgehead>
71
72 <bridgehead renderas="sect4">Required</bridgehead>
73 <para role="required">
74 <xref linkend="libvorbis"/>
75 </para>
76
77 <bridgehead renderas="sect4">Optional (required to build the
78 <command>ogg123</command> program)</bridgehead>
79 <para role="optional">
80 <xref linkend="libao"/>
81 </para>
82
83 <bridgehead renderas="sect4">Optional</bridgehead>
84 <para role="optional">
85 <xref linkend="curl"/>,
86 <xref linkend="flac"/>,
87 <xref linkend="speex"/>, and
88 <ulink url="https://code.google.com/archive/p/libkate/">libkate</ulink>
89 </para>
90
91 </sect2>
92
93 <sect2 role="installation">
94 <title>Installation of Vorbis Tools</title>
95
96 <para>
97 First, apply a sed to fix a gcc-14 issues:
98 </para>
99
100<screen><userinput remap="pre">sed -i '/i18n.h/i #include "utf8.h"' ogginfo/codec_skeleton.c</userinput></screen>
101
102 <para>
103 Install <application>Vorbis Tools</application> by running the
104 following commands:
105 </para>
106
107<screen><userinput>./configure --prefix=/usr \
108 --enable-vcut \
109 --without-curl &amp;&amp;
110make</userinput></screen>
111
112 <para>
113 This package does not come with a test suite.
114 </para>
115
116 <para>
117 Now, as the <systemitem class="username">root</systemitem> user:
118 </para>
119
120<screen role="root"><userinput>make install</userinput></screen>
121
122 </sect2>
123
124 <sect2 role="commands">
125 <title>Command Explanations</title>
126
127 <para>
128 <parameter>--enable-vcut</parameter>: This parameter is used so that
129 the <command>vcut</command> program is built as it is not by default.
130 </para>
131
132 <para>
133 <parameter>--without-curl</parameter>: This parameter disables HTTP
134 streaming in <command>ogg123</command>. Remove this parameter if you have
135 <application>cURL</application> installed.
136 </para>
137
138 </sect2>
139
140 <sect2 role="configuration">
141 <title>Configuring Vorbis Tools</title>
142
143 <sect3 id="vorbistools-config">
144 <title>Config Files</title>
145
146 <para>
147 <filename>/etc/libao.conf</filename>,
148 <filename>~/.libao</filename> and
149 <filename>~/.ogg123rc</filename>
150 </para>
151
152 <indexterm zone="vorbistools vorbistools-config">
153 <primary sortas="e-AA.libao">~/.libao</primary>
154 </indexterm>
155
156 <indexterm zone="vorbistools vorbistools-config">
157 <primary sortas="e-AA.ogg123rc">~/.ogg123rc</primary>
158 </indexterm>
159
160 <indexterm zone="vorbistools vorbistools-config">
161 <primary sortas="e-etc-libao.conf">/etc/libao.conf</primary>
162 </indexterm>
163
164 </sect3>
165
166 <sect3>
167 <title>Configuration Information</title>
168
169 <para>
170 Issue <command>man libao.conf</command> for information
171 about setting the default output device. Also see
172 <filename>/usr/share/doc/vorbis-tools-&vorbistools-version;/ogg123rc-example
173 </filename>.
174 </para>
175
176 </sect3>
177
178 </sect2>
179
180 <sect2 role="content">
181 <title>Contents</title>
182
183 <segmentedlist>
184 <segtitle>Installed Programs</segtitle>
185 <segtitle>Installed Libraries</segtitle>
186 <segtitle>Installed Directory</segtitle>
187
188 <seglistitem>
189 <seg>
190 ogg123, oggdec, oggenc, ogginfo, vcut and vorbiscomment
191 </seg>
192 <seg>
193 None
194 </seg>
195 <seg>
196 /usr/share/doc/vorbis-tools-&vorbistools-version;
197 </seg>
198 </seglistitem>
199 </segmentedlist>
200
201 <variablelist>
202 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
203 <?dbfo list-presentation="list"?>
204 <?dbhtml list-presentation="table"?>
205
206 <varlistentry id="ogg123">
207 <term><command>ogg123</command></term>
208 <listitem>
209 <para>
210 is a command-line audio player for Ogg Vorbis streams
211 </para>
212 <indexterm zone="vorbistools ogg123">
213 <primary sortas="b-ogg123">ogg123</primary>
214 </indexterm>
215 </listitem>
216 </varlistentry>
217
218 <varlistentry id="oggdec">
219 <term><command>oggdec</command></term>
220 <listitem>
221 <para>
222 is a simple decoder which converts Ogg Vorbis files into
223 PCM audio files (WAV or raw)
224 </para>
225 <indexterm zone="vorbistools oggdec">
226 <primary sortas="b-oggdec">oggdec</primary>
227 </indexterm>
228 </listitem>
229 </varlistentry>
230
231 <varlistentry id="oggenc">
232 <term><command>oggenc</command></term>
233 <listitem>
234 <para>
235 is an encoder that turns raw, WAV or
236 AIFF files into an Ogg Vorbis stream
237 </para>
238 <indexterm zone="vorbistools oggenc">
239 <primary sortas="b-oggenc">oggenc</primary>
240 </indexterm>
241 </listitem>
242 </varlistentry>
243
244 <varlistentry id="ogginfo">
245 <term><command>ogginfo</command></term>
246 <listitem>
247 <para>
248 prints information stored in an audio file
249 </para>
250 <indexterm zone="vorbistools ogginfo">
251 <primary sortas="b-ogginfo">ogginfo</primary>
252 </indexterm>
253 </listitem>
254 </varlistentry>
255
256 <varlistentry id="vcut">
257 <term><command>vcut</command></term>
258 <listitem>
259 <para>
260 splits a file into two files at a designated cut point
261 </para>
262 <indexterm zone="vorbistools vcut">
263 <primary sortas="b-vcut">vcut</primary>
264 </indexterm>
265 </listitem>
266 </varlistentry>
267
268 <varlistentry id="vorbiscomment">
269 <term><command>vorbiscomment</command></term>
270 <listitem>
271 <para>
272 is an editor that changes information in the audio file
273 metadata tags
274 </para>
275 <indexterm zone="vorbistools vorbiscomment">
276 <primary sortas="b-vorbiscomment">vorbiscomment</primary>
277 </indexterm>
278 </listitem>
279 </varlistentry>
280
281 </variablelist>
282
283 </sect2>
284
285</sect1>
Note: See TracBrowser for help on using the repository browser.