source: multimedia/audioutils/vorbistools.xml@ de61ab1

lazarus
Last change on this file since de61ab1 was c36ca685, checked in by Bruce Dubbs <bdubbs@…>, 4 weeks ago

Tag Part XII. Multimedia
  • Property mode set to 100644
File size: 8.1 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 &lfs122_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 issue:
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 Next, apply a sed to fix a security vulnerability in 'oggenc':
104 </para>
105
106<screen><userinput remap="pre">sed -i 's/start+1,/start + strspn(start, PATH_SEPS),/' oggenc/platform.c</userinput></screen>
107
108 <para>
109 Install <application>Vorbis Tools</application> by running the
110 following commands:
111 </para>
112
113<screen><userinput>./configure --prefix=/usr --enable-vcut &amp;&amp;
114make</userinput></screen>
115
116 <para>
117 This package does not come with a test suite.
118 </para>
119
120 <para>
121 Now, as the <systemitem class="username">root</systemitem> user:
122 </para>
123
124<screen role="root"><userinput>make install</userinput></screen>
125
126 </sect2>
127
128 <sect2 role="commands">
129 <title>Command Explanations</title>
130
131 <para>
132 <parameter>--enable-vcut</parameter>: This parameter is used so that
133 the <command>vcut</command> program is built as it is not by default.
134 </para>
135
136<!--
137 <para>
138 <parameter>- -without-curl</parameter>: This parameter disables HTTP
139 streaming in <command>ogg123</command>. Remove this parameter if you have
140 <application>cURL</application> installed.
141 </para>
142-->
143
144 </sect2>
145
146 <sect2 role="configuration">
147 <title>Configuring Vorbis Tools</title>
148
149 <sect3 id="vorbistools-config">
150 <title>Config Files</title>
151
152 <para>
153 <filename>/etc/libao.conf</filename>,
154 <filename>~/.libao</filename> and
155 <filename>~/.ogg123rc</filename>
156 </para>
157
158 <indexterm zone="vorbistools vorbistools-config">
159 <primary sortas="e-AA.libao">~/.libao</primary>
160 </indexterm>
161
162 <indexterm zone="vorbistools vorbistools-config">
163 <primary sortas="e-AA.ogg123rc">~/.ogg123rc</primary>
164 </indexterm>
165
166 <indexterm zone="vorbistools vorbistools-config">
167 <primary sortas="e-etc-libao.conf">/etc/libao.conf</primary>
168 </indexterm>
169
170 </sect3>
171
172 <sect3>
173 <title>Configuration Information</title>
174
175 <para>
176 Issue <command>man libao.conf</command> for information
177 about setting the default output device. Also see
178 <filename>/usr/share/doc/vorbis-tools-&vorbistools-version;/ogg123rc-example
179 </filename>.
180 </para>
181
182 </sect3>
183
184 </sect2>
185
186 <sect2 role="content">
187 <title>Contents</title>
188
189 <segmentedlist>
190 <segtitle>Installed Programs</segtitle>
191 <segtitle>Installed Libraries</segtitle>
192 <segtitle>Installed Directory</segtitle>
193
194 <seglistitem>
195 <seg>
196 ogg123, oggdec, oggenc, ogginfo, vcut, and vorbiscomment
197 </seg>
198 <seg>
199 None
200 </seg>
201 <seg>
202 /usr/share/doc/vorbis-tools-&vorbistools-version;
203 </seg>
204 </seglistitem>
205 </segmentedlist>
206
207 <variablelist>
208 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
209 <?dbfo list-presentation="list"?>
210 <?dbhtml list-presentation="table"?>
211
212 <varlistentry id="ogg123">
213 <term><command>ogg123</command></term>
214 <listitem>
215 <para>
216 is a command-line audio player for Ogg Vorbis streams
217 </para>
218 <indexterm zone="vorbistools ogg123">
219 <primary sortas="b-ogg123">ogg123</primary>
220 </indexterm>
221 </listitem>
222 </varlistentry>
223
224 <varlistentry id="oggdec">
225 <term><command>oggdec</command></term>
226 <listitem>
227 <para>
228 is a simple decoder which converts Ogg Vorbis files into
229 PCM audio files (WAV or raw)
230 </para>
231 <indexterm zone="vorbistools oggdec">
232 <primary sortas="b-oggdec">oggdec</primary>
233 </indexterm>
234 </listitem>
235 </varlistentry>
236
237 <varlistentry id="oggenc">
238 <term><command>oggenc</command></term>
239 <listitem>
240 <para>
241 is an encoder that turns raw, WAV or
242 AIFF files into an Ogg Vorbis stream
243 </para>
244 <indexterm zone="vorbistools oggenc">
245 <primary sortas="b-oggenc">oggenc</primary>
246 </indexterm>
247 </listitem>
248 </varlistentry>
249
250 <varlistentry id="ogginfo">
251 <term><command>ogginfo</command></term>
252 <listitem>
253 <para>
254 prints information stored in an audio file
255 </para>
256 <indexterm zone="vorbistools ogginfo">
257 <primary sortas="b-ogginfo">ogginfo</primary>
258 </indexterm>
259 </listitem>
260 </varlistentry>
261
262 <varlistentry id="vcut">
263 <term><command>vcut</command></term>
264 <listitem>
265 <para>
266 splits a file into two files at a designated cut point
267 </para>
268 <indexterm zone="vorbistools vcut">
269 <primary sortas="b-vcut">vcut</primary>
270 </indexterm>
271 </listitem>
272 </varlistentry>
273
274 <varlistentry id="vorbiscomment">
275 <term><command>vorbiscomment</command></term>
276 <listitem>
277 <para>
278 is an editor that changes information in the audio file
279 metadata tags
280 </para>
281 <indexterm zone="vorbistools vorbiscomment">
282 <primary sortas="b-vorbiscomment">vorbiscomment</primary>
283 </indexterm>
284 </listitem>
285 </varlistentry>
286
287 </variablelist>
288
289 </sect2>
290
291</sect1>
Note: See TracBrowser for help on using the repository browser.