Print this page
12287 errors in audio utility man pages
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man1/audioconvert.1
+++ new/usr/src/man/man1/audioconvert.1
1 1 '\" te
2 2 .\" Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved
3 3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 -.TH AUDIOCONVERT 1 "Feb 16, 2001"
6 +.TH AUDIOCONVERT 1 "Feb 8, 2020"
7 7 .SH NAME
8 8 audioconvert \- convert audio file formats
9 9 .SH SYNOPSIS
10 -.LP
11 10 .nf
12 11 \fBaudioconvert\fR [\fB-pF\fR] [\fB-f\fR \fIoutfmt\fR] [\fB-o\fR \fIoutfile\fR]
13 12 [ [\fB-i\fR \fIinfmt\fR] [\fIfile\fR]...] ...
14 13 .fi
15 14
16 15 .SH DESCRIPTION
17 -.sp
18 -.LP
19 16 \fBaudioconvert\fR converts audio data between a set of supported audio
20 17 encodings and file formats. It can be used to compress and decompress audio
21 18 data, to add audio file headers to raw audio data files, and to convert between
22 -standard data encodings, such as -law and linear PCM.
19 +standard data encodings, such as u-law and linear PCM.
23 20 .sp
24 21 .LP
25 22 If no filenames are present, \fBaudioconvert\fR reads the data from the
26 23 standard input stream and writes an audio file to the standard output.
27 24 Otherwise, input files are processed in order, concatenated, and written to the
28 25 output file.
29 26 .sp
30 27 .LP
31 28 Input files are expected to contain audio file headers that identify the audio
32 29 data format. If the audio data does not contain a recognizable header, the
33 30 format must be specified with the \fB-i\fR option, using the \fBrate\fR,
34 31 \fBencoding\fR, and \fBchannels\fR keywords to identify the input data format.
35 32 .sp
36 33 .LP
37 34 The output file format is derived by updating the format of the first input
38 35 file with the format options in the \fB-f\fR specification. If \fB-p\fR is not
39 36 specified, all subsequent input files are converted to this resulting format
40 37 and concatenated together. The output file will contain an audio file header,
41 38 unless \fBformat\fR=\fIraw\fR is specified in the output format options.
42 39 .sp
↓ open down ↓ |
10 lines elided |
↑ open up ↑ |
43 40 .LP
44 41 Input files may be converted in place by using the \fB-p\fR option. When
45 42 \fB-p\fR is in effect, the format of each input file is modified according to
46 43 the \fB-f\fR option to determine the output format. The existing files are then
47 44 overwritten with the converted data.
48 45 .sp
49 46 .LP
50 47 The \fBfile\fR(1) command decodes and prints the audio data format of Sun audio
51 48 files.
52 49 .SH OPTIONS
53 -.sp
54 -.LP
55 50 The following options are supported:
56 51 .sp
57 52 .ne 2
58 53 .na
59 54 \fB\fB-p\fR\fR
60 55 .ad
61 56 .RS 14n
62 57 \fIIn Place\fR: The input files are individually converted to the format
63 58 specified by the \fB-f\fR option and rewritten. If a target file is a symbolic
64 59 link, the underlying file will be rewritten. The \fB-o\fR option may not be
65 60 specified with \fB-p\fR.
66 61 .RE
67 62
68 63 .sp
69 64 .ne 2
70 65 .na
71 66 \fB\fB-F\fR\fR
72 67 .ad
73 68 .RS 14n
74 69 \fIForce\fR: This option forces \fBaudioconvert\fR to ignore any file header
75 70 for input files whose format is specified by the \fB-i\fR option. If \fB-F\fR
76 71 is not specified, \fBaudioconvert\fR ignores the \fB-i\fR option for input
77 72 files that contain valid audio file headers.
78 73 .RE
79 74
80 75 .sp
81 76 .ne 2
82 77 .na
83 78 \fB\fB-f\fR \fIoutfmt\fR\fR
84 79 .ad
85 80 .RS 14n
86 81 \fIOutput Format\fR: This option is used to specify the file format and data
87 82 encoding of the output file. Defaults for unspecified fields are derived from
88 83 the input file format. Valid keywords and values are listed in the next
89 84 section.
90 85 .RE
91 86
92 87 .sp
93 88 .ne 2
94 89 .na
95 90 \fB\fB-o\fR \fIoutfile\fR\fR
96 91 .ad
97 92 .RS 14n
98 93 \fIOutput File\fR: All input files are concatenated, converted to the output
99 94 format, and written to the named output file. If \fB-o\fR and \fB-p\fR are not
100 95 specified, the concatenated output is written to the standard output. The
101 96 \fB-p\fR option may not be specified with \fB-o\fR.
102 97 .RE
103 98
104 99 .sp
105 100 .ne 2
106 101 .na
107 102 \fB\fB-i\fR \fIinfmt\fR\fR
108 103 .ad
109 104 .RS 14n
110 105 \fIInput Format\fR: This option is used to specify the data encoding of raw
111 106 input files. Ordinarily, the input data format is derived from the audio file
112 107 header. This option is required when converting audio data that is not preceded
113 108 by a valid audio file header. If \fB-i\fR is specified for an input file that
114 109 contains an audio file header, the input format string will be ignored, unless
115 110 \fB-F\fR is present. The format specification syntax is the same as the
116 111 \fB-f\fR output file format.
117 112 .sp
118 113 Multiple input formats may be specified. An input format describes all input
119 114 files following that specification, until a new input format is specified.
120 115 .RE
121 116
122 117 .sp
123 118 .ne 2
124 119 .na
125 120 \fB\fIfile\fR\fR
126 121 .ad
127 122 .RS 14n
128 123 \fIFile Specification\fR: The named audio files are concatenated, converted to
129 124 the output format, and written out. If no file name is present, or if the
130 125 special file name `\(mi' is specified, audio data is read from the standard
131 126 input.
132 127 .RE
133 128
↓ open down ↓ |
69 lines elided |
↑ open up ↑ |
134 129 .sp
135 130 .ne 2
136 131 .na
137 132 \fB\fB-?\fR\fR
138 133 .ad
139 134 .RS 14n
140 135 \fIHelp\fR: Prints a command line usage message.
141 136 .RE
142 137
143 138 .SS "Format Specification"
144 -.sp
145 -.LP
146 139 The syntax for the input and output format specification is:
147 140 .sp
148 141 .LP
149 142 \fIkeyword\fR=\fIvalue\fR[,\fIkeyword\fR=\fIvalue\fR \|.\|.\|.\|]
150 143 .sp
151 144 .LP
152 145 with no intervening whitespace. Unambiguous values may be used without the
153 146 preceding \fIkeyword\fR=.
154 147 .sp
155 148 .ne 2
156 149 .na
157 150 \fB\fBrate\fR\fR
158 151 .ad
159 152 .RS 12n
160 153 The audio sampling rate is specified in samples per second. If a number is
161 154 followed by the letter \fBk\fR, it is multiplied by 1000 (for example, 44.1k =
162 155 44100). Standard of the commonly used sample rates are: 8k, 16k, 32k, 44.1k,
163 156 and 48k.
164 157 .RE
165 158
166 159 .sp
167 160 .ne 2
168 161 .na
169 162 \fB\fBchannels\fR\fR
170 163 .ad
171 164 .RS 12n
172 165 The number of interleaved channels is specified as an integer. The words
173 166 \fBmono\fR and \fBstereo\fR may also be used to specify one and two channel
174 167 data, respectively.
175 168 .RE
176 169
177 170 .sp
178 171 .ne 2
179 172 .na
180 173 \fB\fBencoding\fR\fR
181 174 .ad
182 175 .RS 12n
↓ open down ↓ |
27 lines elided |
↑ open up ↑ |
183 176 This option specifies the digital audio data representation. Encodings
184 177 determine precision implicitly (\fBulaw\fR implies 8-bit precision) or
185 178 explicitly as part of the name (for example, \fBlinear16\fR). Valid encoding
186 179 values are:
187 180 .sp
188 181 .ne 2
189 182 .na
190 183 \fB\fBulaw\fR\fR
191 184 .ad
192 185 .RS 13n
193 -\fBCCITT G.711\fR -law encoding. This is an 8-bit format primarily used for
186 +\fBCCITT G.711\fR u-law encoding. This is an 8-bit format primarily used for
194 187 telephone quality speech.
195 188 .RE
196 189
197 190 .sp
198 191 .ne 2
199 192 .na
200 193 \fB\fBalaw\fR\fR
201 194 .ad
202 195 .RS 13n
203 196 \fBCCITT G.711\fR A-law encoding. This is an 8-bit format primarily used for
204 197 telephone quality speech in Europe.
205 198 .RE
206 199
207 200 .sp
208 201 .ne 2
209 202 .na
210 203 \fB\fBlinear8\fR,\fR
211 204 .ad
212 205 .br
213 206 .na
214 207 \fB\fBlinear16\fR,\fR
215 208 .ad
216 209 .br
217 210 .na
218 211 \fB\fBlinear32\fR\fR
219 212 .ad
220 213 .RS 13n
221 214 Linear Pulse Code Modulation (PCM) encoding. The name identifies the number of
222 215 bits of precision. \fBlinear16\fR is typically used for high quality audio
223 216 data.
224 217 .RE
225 218
226 219 .sp
227 220 .ne 2
228 221 .na
229 222 \fB\fBpcm\fR\fR
230 223 .ad
231 224 .RS 13n
232 225 Same as \fBlinear16\fR.
↓ open down ↓ |
29 lines elided |
↑ open up ↑ |
233 226 .RE
234 227
235 228 .sp
236 229 .ne 2
237 230 .na
238 231 \fB\fBg721\fR\fR
239 232 .ad
240 233 .RS 13n
241 234 \fBCCITT G.721\fR compression format. This encoding uses Adaptive Delta Pulse
242 235 Code Modulation (ADPCM) with 4-bit precision. It is primarily used for
243 -compressing -law voice data (achieving a 2:1 compression ratio).
236 +compressing u-law voice data (achieving a 2:1 compression ratio).
244 237 .RE
245 238
246 239 .sp
247 240 .ne 2
248 241 .na
249 242 \fB\fBg723\fR\fR
250 243 .ad
251 244 .RS 13n
252 245 \fBCCITT G.723\fR compression format. This encoding uses Adaptive Delta Pulse
253 246 Code Modulation (ADPCM) with 3-bit precision. It is primarily used for
254 -compressing -law voice data (achieving an 8:3 compression ratio). The audio
247 +compressing u-law voice data (achieving an 8:3 compression ratio). The audio
255 248 quality is similar to \fBG.721,\fR but may result in lower quality when used
256 249 for non-speech data.
257 250 .RE
258 251
259 252 The following encoding values are also accepted as shorthand to set the sample
260 253 rate, channels, and encoding:
261 254 .sp
262 255 .ne 2
263 256 .na
264 257 \fB\fBvoice\fR\fR
265 258 .ad
266 259 .RS 9n
267 260 Equivalent to \fBencoding=ulaw,rate=8k,channels=mono\fR.
268 261 .RE
269 262
270 263 .sp
271 264 .ne 2
272 265 .na
273 266 \fB\fBcd\fR\fR
274 267 .ad
275 268 .RS 9n
276 269 Equivalent to \fBencoding=linear16,rate=44.1k,channels=stereo\fR.
277 270 .RE
278 271
279 272 .sp
280 273 .ne 2
281 274 .na
282 275 \fB\fBdat\fR\fR
283 276 .ad
284 277 .RS 9n
285 278 Equivalent to \fBencoding=linear16,rate=48k,channels=stereo\fR.
286 279 .RE
287 280
288 281 .RE
289 282
290 283 .sp
291 284 .ne 2
292 285 .na
293 286 \fB\fBformat\fR\fR
294 287 .ad
295 288 .RS 12n
296 289 This option specifies the audio file format. Valid formats are:
297 290 .sp
298 291 .ne 2
299 292 .na
300 293 \fB\fBsun\fR\fR
301 294 .ad
302 295 .RS 7n
303 296 Sun compatible file format (the default).
304 297 .RE
305 298
306 299 .sp
307 300 .ne 2
308 301 .na
309 302 \fB\fBraw\fR\fR
310 303 .ad
311 304 .RS 7n
312 305 Use this format when reading or writing raw audio data (with no audio header),
313 306 or in conjunction with an \fBoffset\fR to import a foreign audio file format.
314 307 .RE
315 308
316 309 .RE
317 310
318 311 .sp
319 312 .ne 2
↓ open down ↓ |
55 lines elided |
↑ open up ↑ |
320 313 .na
321 314 \fB\fBoffset\fR\fR
322 315 .ad
323 316 .RS 12n
324 317 (\fB-i\fR \fIonly\fR) Specifies a byte offset to locate the start of the audio
325 318 data. This option may be used to import audio data that contains an
326 319 unrecognized file header.
327 320 .RE
328 321
329 322 .SH USAGE
330 -.sp
331 -.LP
332 323 See \fBlargefile\fR(5) for the description of the behavior of
333 -\fBaudioconvert\fR when encountering files greater than or equal to 2 Gbyte (
334 -2^31 bytes).
324 +\fBaudioconvert\fR when encountering files greater than or equal to 2 Gbyte
325 +(2^31 bytes).
335 326 .SH EXAMPLES
336 -.LP
337 327 \fBExample 1 \fRRecording and compressing voice data before storing it
338 328 .sp
339 329 .LP
340 330 Record voice data and compress it before storing it to a file:
341 331
342 332 .sp
343 333 .in +2
344 334 .nf
345 335 example% \fBaudiorecord | audioconvert -f g721 > mydata.au\fR
346 336 .fi
347 337 .in -2
348 338 .sp
349 339
350 340 .LP
351 341 \fBExample 2 \fRConcatenating two audio files
352 342 .sp
353 343 .LP
354 344 Concatenate two Sun format audio files, regardless of their data format, and
355 345 output an 8-bit ulaw, 16 kHz, mono file:
356 346
357 347 .sp
358 348 .in +2
359 349 .nf
360 350 example% \fBaudioconvert -f ulaw,rate=16k,mono -o outfile.au infile1 infile2\fR
361 351 .fi
362 352 .in -2
363 353 .sp
364 354
365 355 .LP
366 356 \fBExample 3 \fRConverting a directory to Sun format
367 357 .sp
368 358 .LP
369 359 Convert a directory containing raw voice data files, in place, to Sun format
↓ open down ↓ |
23 lines elided |
↑ open up ↑ |
370 360 (adds a file header to each file):
371 361
372 362 .sp
373 363 .in +2
374 364 .nf
375 365 example% \fBaudioconvert -p -i voice -f sun *.au\fR
376 366 .fi
377 367 .in -2
378 368 .sp
379 369
380 -.SH ATTRIBUTES
381 -.sp
382 -.LP
383 -See \fBattributes\fR(5) for descriptions of the following attributes:
384 -.sp
385 -
386 -.sp
387 -.TS
388 -box;
389 -c | c
390 -l | l .
391 -ATTRIBUTE TYPE ATTRIBUTE VALUE
392 -_
393 -Architecture SPARC, x86
394 -_
395 -Interface Stability Evolving
396 -.TE
397 -
398 370 .SH SEE ALSO
399 -.sp
400 -.LP
401 -\fBaudioplay\fR(1), \fBaudiorecord\fR(1), \fBfile\fR(1), \fBattributes\fR(5),
371 +\fBaudioplay\fR(1), \fBaudiorecord\fR(1), \fBfile\fR(1),
402 372 \fBlargefile\fR(5)
403 373 .SH NOTES
404 -.sp
405 -.LP
406 374 The algorithm used for converting multi-channel data to mono is implemented by
407 375 simply summing the channels together. If the input data is perfectly in phase
408 376 (as would be the case if a mono file is converted to stereo and back to mono),
409 377 the resulting data may contain some distortion.
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX