~ubuntu-branches/ubuntu/gutsy/vorbis-tools/gutsy

« back to all changes in this revision

Viewing changes to oggenc/man/oggenc.1

  • Committer: Bazaar Package Importer
  • Author(s): Jesus Climent
  • Date: 2005-04-10 09:22:24 UTC
  • mfrom: (2.1.1 warty)
  • Revision ID: james.westby@ubuntu.com-20050410092224-xtukpa3qghghhjje
Tags: 1.0.1-1.3
* Authorized NMU.
* Modified alsa to mention alsa09 (although the device might be nowadays
  alsa, back, since alsa1.0 has been already released). (Closes: #258286)
* Modified the manpage/help message for vorbiscomment to make it a bit more
  userfiendly: Closes: #252531.
* Added oggdec to the long description field, so that it triggers apt-cache
  searches: Closes: #274894.
* Typos in manpages: Closes: #302150.
* Escaped dashes in manpage: Closes: #264365.
* Quiet option is actually with -Q, not -q (Closes: #211289) Reported
  upstream but patched for Debian.
* Change input.wav with inputfile, since we accept flac-formated files:
  Closes: #262509.
* Translation bits:
  * Updated translation hu.po: Closes: #272037.
  * French translation correction: Encodage -> Codage (Closes: #248431).
  * debian/rules: remove .gmo's to avoid clash with uploaded tarball.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
.\" Process this file with
2
2
.\" groff -man -Tascii oggenc.1
3
3
.\"
4
 
.TH oggenc 1 "2001 August 13" "" "Vorbis Tools release candidate 2"
 
4
.TH oggenc 1 "2003 September 1" "Xiph.org Foundation" "Vorbis Tools"
5
5
 
6
6
.SH NAME
7
7
oggenc \- encode audio into the Ogg Vorbis format
9
9
.SH SYNOPSIS
10
10
.B oggenc
11
11
[
12
 
.B -hrQ
 
12
.B \-hrQ
13
13
]
14
14
[
15
 
.B -B
 
15
.B \-B
16
16
.I raw input sample size
17
17
]
18
18
[
19
 
.B -C
 
19
.B \-C
20
20
.I raw input number of channels
21
21
]
22
22
[
23
 
.B -R
 
23
.B \-R
24
24
.I raw input samplerate
25
25
]
26
26
[
27
 
.B -b
 
27
.B \-b
28
28
.I nominal bitrate
29
29
]
30
30
[
31
 
.B -m
 
31
.B \-m
32
32
.I minimum bitrate
33
33
]
34
34
[
35
 
.B -M
 
35
.B \-M
36
36
.I maximum bitrate
37
37
]
38
38
[
39
 
.B -q
 
39
.B \-q
40
40
.I quality
41
41
]
42
42
[
43
 
.B -s
 
43
.B \-\-resample 
 
44
.I frequency
 
45
]
 
46
[
 
47
.B \-\-downmix 
 
48
]
 
49
[
 
50
.B \-s
44
51
.I serial
45
52
]
46
53
[
47
 
.B -o
 
54
.B \-o
48
55
.I output_file
49
56
]
50
57
[
51
 
.B -n
 
58
.B \-n
52
59
.I pattern
53
60
]
54
61
[
55
 
.B -c
 
62
.B \-c
56
63
.I extra_comment
57
64
]
58
65
[
59
 
.B -a
 
66
.B \-a
60
67
.I artist
61
68
]
62
69
[
63
 
.B -t
 
70
.B \-t
64
71
.I title
65
72
]
66
73
[
67
 
.B -l
 
74
.B \-l
68
75
.I album
69
76
]
70
77
[
71
 
.B -G
 
78
.B \-G
72
79
.I genre
73
80
]
74
81
.I input_files \fR...
76
83
.SH DESCRIPTION
77
84
.B oggenc
78
85
reads audio data in either raw, WAV, or AIFF format and encodes it into an
79
 
Ogg Vorbis stream.  If the input file "-" is specified, audio data is
 
86
Ogg Vorbis stream.
 
87
.B oggenc
 
88
may also read audio data from FLAC and Ogg FLAC files depending upon compile-time options.  If the input file "-" is specified, audio data is
80
89
read from
81
90
.I stdin
82
91
and the Vorbis stream is written to
83
92
.I stdout
84
93
unless the
85
 
.B -o
 
94
.B \-o
86
95
option is used to redirect the output.  By default, disk files are
87
96
output to Ogg Vorbis files of the same name, with the extension
88
97
changed to ".ogg".  This naming convention can be overridden by the
89
 
.B -o
 
98
.B \-o
90
99
option (in the case of one file) or the
91
 
.B -n
92
 
option (in the case of several files).
 
100
.B \-n
 
101
option (in the case of several files). Finally, if none of these
 
102
are available, the output filename will be the input filename with the
 
103
extension (that part after the final dot) replaced with ogg, so file.wav
 
104
will become file.ogg
93
105
 
94
106
.SH OPTIONS
95
 
.IP "-h, --help"
 
107
.IP "\-h, \-\-help"
96
108
Show command help.
97
 
.IP "-r, --raw"
98
 
Assume input data is raw little-endian audio data with no
 
109
.IP "\-r, \-\-raw"
 
110
Assume input data is raw little\-endian audio data with no
99
111
header information. If other options are not specified, defaults to 44.1kHz
100
112
stereo 16 bit. See next three options for how to change this.
101
 
.IP "-B n, --raw-bits=n"
102
 
Sets raw input sample size in bits. Default is 16.
103
 
.IP "-C n, --raw-chan=n"
104
 
Sets raw input number of channels. Default is 2.
105
 
.IP "-R n, --raw-rate=n"
106
 
Sets raw input samplerate. Default is 44100.
107
 
.IP "-Q, --quiet"
 
113
.IP "\-B n, \-\-raw\-bits=n"
 
114
Sets raw mode input sample size in bits. Default is 16.
 
115
.IP "\-C n, \-\-raw\-chan=n"
 
116
Sets raw mode input number of channels. Default is 2.
 
117
.IP "\-R n, \-\-raw\-rate=n"
 
118
Sets raw mode input samplerate. Default is 44100.
 
119
.IP "\-\-raw\-endianness n
 
120
Sets raw mode endianness to big endian (1) or little endian (0). Default is
 
121
little endian.
 
122
.IP "\-Q, \-\-quiet"
108
123
Quiet mode.  No messages are displayed.
109
 
.IP "-b n, --bitrate=n"
 
124
.IP "\-b n, \-\-bitrate=n"
110
125
Sets encoding to the bitrate closest to n (in kb/s).
111
 
.IP "-m n, --min-bitrate=n"
 
126
.IP "\-m n, \-\-min\-bitrate=n"
112
127
Sets minimum bitrate to n (in kb/s).
113
 
.IP "-M n, --max-bitrate=n"
 
128
.IP "\-M n, \-\-max\-bitrate=n"
114
129
Sets maximum bitrate to n (in kb/s).
115
 
.IP "-q n, --quality=n"
116
 
Sets encoding quality to n, between 0 (low) and 10 (high). This is the default mode of operation.
117
 
.IP "-s, --serial"
 
130
.IP "\-\-managed"
 
131
Set bitrate management mode. This turns off the normal VBR encoding, but allows
 
132
hard or soft bitrate constraints to be enforced by the encoder. This mode is
 
133
much slower, and may also be lower quality. It is primarily useful for creating
 
134
files for streaming.
 
135
.IP "\-q n, \-\-quality=n"
 
136
Sets encoding quality to n, between \-1 (low) and 10 (high). This is the default mode of operation, with a default quality level of 3. Fractional quality levels such as 2.5 are permitted. Normal quality range is 0 \- 10.
 
137
.IP "\-\-resample n"
 
138
Resample input to the given sample rate (in Hz) before encoding. Primarily
 
139
useful for downsampling for lower\-bitrate encoding.
 
140
.IP "\-\-downmix"
 
141
Downmix input from stereo to mono (has no effect on non\-stereo streams). Useful
 
142
for lower\-bitrate encoding.
 
143
.IP "\-\-advanced\-encode\-option optionname=value"
 
144
Sets an advanced option. See the Advanced Options section for details.
 
145
.IP "\-s, \-\-serial"
118
146
Forces a specific serial number in the output stream. This is primarily useful for testing.
119
 
.IP "-o output_file, --output=output_file"
 
147
.IP "\-\-discard\-comments"
 
148
Prevents comments in FLAC and Ogg FLAC files from being copied to the
 
149
output Ogg Vorbis file.
 
150
.IP "\-o output_file, \-\-output=output_file"
120
151
Write the Ogg Vorbis stream to
121
 
.I output_file (only valid if a single input file is specified)
122
 
 
123
 
.IP "-n pattern, --names=pattern"
124
 
Produce filenames as this string, with %a, %t, %l, %G replaced by artist,
125
 
title, album respectively (see below for specifying these). Also, %%
126
 
gives a literal %.
127
 
 
128
 
.IP "-c comment, --comment comment"
 
152
.I output_file
 
153
(only valid if a single input file is specified).
 
154
 
 
155
.IP "\-n pattern, \-\-names=pattern"
 
156
Produce filenames as this string, with %g, %a, %l, %n, %t, %d replaced by
 
157
genre, artist, album, track number, title, and date, respectively (see below
 
158
for specifying these). Also, %% gives a literal %.
 
159
 
 
160
.IP "\-c comment, \-\-comment comment"
129
161
Add the string
130
162
.I comment
131
163
as an extra comment.  This may be used multiple times, and all
132
 
instances will be added to each of the input files specified.
 
164
instances will be added to each of the input files specified. The argument
 
165
should be in the form "tag=value".
133
166
 
134
 
.IP "-a artist, --artist artist"
 
167
.IP "\-a artist, \-\-artist artist"
135
168
Set the artist comment field in the comments to
136
169
.I artist.
137
170
 
138
 
.IP "-G genre, --genre genre"
 
171
.IP "\-G genre, \-\-genre genre"
139
172
Set the genre comment field in the comments to
140
173
.I genre.
141
174
 
142
 
.IP "-d date, --date date"
 
175
.IP "\-d date, \-\-date date"
143
176
Sets the date comment field to the given value. This should be the date of recording.
144
177
 
145
 
.IP "-N n, --tracknum n"
 
178
.IP "\-N n, \-\-tracknum n"
146
179
Sets the track number comment field to the given value.
147
180
 
148
 
.IP "-t title, --title title"
 
181
.IP "\-t title, \-\-title title"
149
182
Set the track title comment field to
150
183
.I title.
151
184
 
152
 
.IP "-l album, --album album"
 
185
.IP "\-l album, \-\-album album"
153
186
Set the album comment field to
154
187
.I album.
155
188
.PP
156
189
 
157
 
Note that the \fB-a\fR, \fB-t\fR, and \fB-l\fR options can be given
 
190
Note that the \fB\-a\fR, \fB\-t\fR, and \fB\-l\fR options can be given
158
191
multiple times.  They will be applied, one to each file, in the order
159
192
given.  If there are fewer album, title, or artist comments given than
160
193
there are input files,
162
195
will reuse the final one for the remaining files, and issue a warning
163
196
in the case of repeated titles.
164
197
 
 
198
.SH ADVANCED ENCODER OPTIONS
 
199
 
 
200
Oggenc allows you to set a number of advanced encoder options using the
 
201
.B \-\-advanced\-encode\-option
 
202
option. These are intended for very advanced users only, and should be
 
203
approached with caution. They may significantly degrade audio quality
 
204
if misused. Not all these options are currently documented.
 
205
 
 
206
.IP "bitrate_average_window=NN"
 
207
Set the managed bitrate window to NN seconds. The bitrate will be forced
 
208
to the specified average over a floating window of this length. May be
 
209
fractional (e.g. 3.5)
 
210
.IP "lowpass_frequency=NN"
 
211
Set the lowpass frequency to NN kHz. 
 
212
 
 
213
 
165
214
.SH EXAMPLES
166
215
 
167
216
Simplest version. Produces output as somefile.ogg:
172
221
 
173
222
Specifying an output filename:
174
223
.RS
175
 
oggenc somefile.wav -o out.ogg
176
 
.RE
177
 
.PP
178
 
 
179
 
Specifying a high-quality encoding averaging 256 kbps.
180
 
.RS
181
 
oggenc infile.wav -b 256 out.ogg
182
 
.RE
183
 
.PP
184
 
 
185
 
Specifying a maximum and average bitrate.
186
 
.RS
187
 
oggenc infile.wav -b 128 -M 160 out.ogg
 
224
oggenc somefile.wav \-o out.ogg
 
225
.RE
 
226
.PP
 
227
 
 
228
Specifying a high\-quality encoding averaging 256 kbps (but still VBR).
 
229
.RS
 
230
oggenc infile.wav \-b 256 out.ogg
 
231
.RE
 
232
.PP
 
233
 
 
234
Specifying a maximum and average bitrate, and enforcing these.
 
235
.RS
 
236
oggenc infile.wav \-\-managed \-b 128 \-M 160 out.ogg
188
237
.RE
189
238
.PP
190
239
 
191
240
Specifying quality rather than bitrate (to a very high quality mode)
192
241
.RS
193
 
oggenc infile.wav -q 9 out.ogg
 
242
oggenc infile.wav \-q 6 out.ogg
 
243
.RE
 
244
.PP
 
245
 
 
246
Downsampling and downmixing to 11 kHz mono before encoding.
 
247
.RS
 
248
oggenc \-\-resample 11025 \-\-downmix infile.wav \-q 1 out.ogg
194
249
.RE
195
250
.PP
196
251
 
197
252
Adding some info about the track:
198
253
.RS
199
 
oggenc somefile.wav -t "The track title" -a "artist who performed this" -l
200
 
"name of album" -c
201
 
"OTHERFIELD=contents of some other field not explictly supported"
 
254
oggenc somefile.wav \-t "The track title" \-a "artist who performed this" \-l
 
255
"name of album" \-c
 
256
"OTHERFIELD=contents of some other field not explicitly supported"
202
257
.RE
203
258
.PP
204
259
 
205
260
This encodes the three files, each with the
206
261
same artist/album tag, but with different title tags on each one. The
207
 
string given as an argument to -n is used to generate filenames, as shown
 
262
string given as an argument to \-n is used to generate filenames, as shown
208
263
in the section above. This example gives filenames
209
 
like "The Tea Party - Touch.ogg":
 
264
like "The Tea Party \- Touch.ogg":
210
265
.RS
211
 
oggenc -b 192 -a "The Tea Party" -l "Triptych" -t "Touch" track01.wav -t
212
 
"Underground" track02.wav -t "Great Big Lie" track03.wav -n "%a - %t.ogg"
 
266
oggenc \-b 192 \-a "The Tea Party" \-l "Triptych" \-t "Touch" track01.wav \-t
 
267
"Underground" track02.wav \-t "Great Big Lie" track03.wav \-n "%a \- %t.ogg"
213
268
.RE
214
269
.PP
215
270
 
216
271
Encoding from stdin, to stdout (you can also use the various tagging
217
 
options, like -t, -a, -l, etc.):
 
272
options, like \-t, \-a, \-l, etc.):
218
273
.RS
219
 
oggenc -
 
274
oggenc \-
220
275
.RE
221
276
.PP
222
277
 
225
280
.TP
226
281
Program Author:
227
282
.br
228
 
Michael Smith <msmith@labyrinth.net.au>
 
283
Michael Smith <msmith@xiph.org>
229
284
 
230
285
.TP
231
286
Manpage Author:
233
288
Stan Seibert <indigo@aztec.asu.edu>
234
289
 
235
290
.SH BUGS
236
 
Options -m, -M, and -q for for flexible bitrate/quality selection exist, but are not
237
 
implemented in the vorbis encoder, and so are not documented here yet.
 
291
Reading type 3 wav files (floating point samples) probably doesn't work other than on intel (or other 32 bit, little endian machines). 
238
292
 
239
293
.SH SEE ALSO
240
294