oggenc.1 4.78 KB
Newer Older
Jack Moffitt's avatar
Jack Moffitt committed
1
2
3
.\" Process this file with
.\" groff -man -Tascii oggenc.1
.\"
4
.TH oggenc 1 "2001 August 13" "" "Vorbis Tools release candidate 2"
Jack Moffitt's avatar
Jack Moffitt committed
5
6
7
8
9
10
11

.SH NAME
oggenc \- encode audio into the Ogg Vorbis format

.SH SYNOPSIS
.B oggenc
[
12
.B -hrQ
Jack Moffitt's avatar
Jack Moffitt committed
13
14
]
[
Michael Smith's avatar
   
Michael Smith committed
15
.B -b
16
17
18
19
20
21
22
23
24
25
26
27
28
.I nominal bitrate
]
[
.B -m
.I minimum bitrate
]
[
.B -M
.I maximum bitrate
]
[
.B -q
.I quality
Jack Moffitt's avatar
Jack Moffitt committed
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
]
[
.B -o
.I output_file
]
[
.B -n
.I pattern
]
[
.B -c
.I extra_comment
]
[
.B -a
.I artist
]
[
.B -t
.I title
]
[
.B -l
.I album
]
.I input_files \fR...

.SH DESCRIPTION
.B oggenc
58
reads audio data in either raw, WAV, or AIFF format and encodes it into an
Jack Moffitt's avatar
Jack Moffitt committed
59
60
61
62
63
Ogg Vorbis stream.  If the input file "-" is specified, audio data is
read from
.I stdin
and the Vorbis stream is written to
.I stdout
64
unless the
Jack Moffitt's avatar
Jack Moffitt committed
65
66
67
68
69
70
71
72
73
74
75
76
77
.B -o
option is used to redirect the output.  By default, disk files are
output to Ogg Vorbis files of the same name, with the extension
changed to ".ogg".  This naming convention can be overridden by the
.B -o
option (in the case of one file) or the
.B -n
option (in the case of several files).

.SH OPTIONS
.IP "-h, --help"
Show command help.
.IP "-r, --raw"
78
79
80
81
Assume input data is raw little-endian audio data with no
header information. If other options are not specified, defaults to 44.1kHz
stereo 16 bit. See next three options for how to change this.
.IP "-B n, --raw-bits=n"
82
Sets raw input sample size in bits. Default is 16.
83
.IP "-C n, --raw-chan=n"
84
Sets raw input number of channels. Default is 2.
85
.IP "-R n, --raw-rate=n"
86
Sets raw input samplerate. Default is 44100.
87
.IP "-Q, --quiet"
Jack Moffitt's avatar
Jack Moffitt committed
88
Quiet mode.  No messages are displayed.
Michael Smith's avatar
   
Michael Smith committed
89
.IP "-b n, --bitrate=n"
90
Sets encoding to the bitrate closest to n (in kb/s).
91
.IP "-m n, --min-bitrate=n [unsupported]"
92
Sets minimum bitrate to n (in kb/s).
93
.IP "-M n, --max-bitrate=n [unsupported]"
94
Sets maximum bitrate to n (in kb/s).
95
.IP "-q n, --quality=n     [unsupported]"
96
Sets encoding quality to n, between 0 (low) and 10 (high). This is the default mode of operation.
97
98
.IP "-s, --serial"
Forces a specific serial number in the output stream. This is primarily useful for testing.
Jack Moffitt's avatar
Jack Moffitt committed
99
100
101
102
103
104
105
106
107
108
.IP "-o output_file, --output=output_file"
Write the Ogg Vorbis stream to
.I output_file (only valid if a single input file is specified)

.IP "-n pattern, --names=pattern"
Produce filenames as this string, with %a, %t, %l replaced by artist,
title, album respectively (see below for specifying these). Also, %%
gives a literal %.

.IP "-c comment, --comment comment"
109
Add the string
Jack Moffitt's avatar
Jack Moffitt committed
110
.I comment
111
as an extra comment.  This may be used multiple times, and all
Jack Moffitt's avatar
Jack Moffitt committed
112
113
114
115
116
117
instances will be added to each of the input files specified.

.IP "-a artist, --artist artist"
Set the artist comment field in the comments to
.I artist.

118
119
120
121
122
123
.IP "-d date, --date date"
Sets the date comment field to the given value. This should be the date of recording.

.IP "-N n, --tracknum n"
Sets the track number comment field to the given value.

Jack Moffitt's avatar
Jack Moffitt committed
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
.IP "-t title, --title title"
Set the track title comment field to
.I title.

.IP "-l album, --album album"
Set the album comment field to
.I album.
.PP

Note that the \fB-a\fR, \fB-t\fR, and \fB-l\fR options can be given
multiple times.  They will be applied, one to each file, in the order
given.  If there are fewer album, title, or artist comments given than
there are input files,
.B oggenc
will reuse the final one for the remaining files, and issue a warning
in the case of repeated titles.

.SH EXAMPLES

Simplest version. Produces output as somefile.ogg:
.RS
oggenc somefile.wav
.RE
.PP

Specifying an output filename:
.RS
oggenc somefile.wav -o out.ogg
.RE
.PP

155
Specifying a high-quality encoding averaging 256 kbps.
Jack Moffitt's avatar
Jack Moffitt committed
156
.RS
Michael Smith's avatar
   
Michael Smith committed
157
oggenc infile.wav -b 256 out.ogg
Jack Moffitt's avatar
Jack Moffitt committed
158
159
160
.RE
.PP

161
162
163
164
165
166
167
168
169
170
171
172
Specifying a maximum and average bitrate.
.RS
oggenc infile.wav -b 128 -M 160 out.ogg
.RE
.PP

Specifying quality rather than bitrate (to a very high quality mode)
.RS
oggenc infile.wav -q 9 out.ogg
.RE
.PP

Jack Moffitt's avatar
Jack Moffitt committed
173
174
175
Adding some info about the track:
.RS
oggenc somefile.wav -t "The track title" -a "artist who performed this" -l
176
"name of album" -c
Jack Moffitt's avatar
Jack Moffitt committed
177
178
179
180
181
182
183
"OTHERFIELD=contents of some other field not explictly supported"
.RE
.PP

This encodes the three files, each with the
same artist/album tag, but with different title tags on each one. The
string given as an argument to -n is used to generate filenames, as shown
184
in the section above. This example gives filenames
Jack Moffitt's avatar
Jack Moffitt committed
185
186
like "The Tea Party - Touch.ogg":
.RS
Michael Smith's avatar
   
Michael Smith committed
187
oggenc -b 192 -a "The Tea Party" -l "Triptych" -t "Touch" track01.wav -t
Jack Moffitt's avatar
Jack Moffitt committed
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
"Underground" track02.wav -t "Great Big Lie" track03.wav -n "%a - %t.ogg"
.RE
.PP

Encoding from stdin, to stdout (you can also use the various tagging
options, like -t, -a, -l, etc.):
.RS
oggenc -
.RE
.PP

.SH AUTHORS

.TP
Program Author:
.br
Michael Smith <msmith@labyrinth.net.au>

.TP
Manpage Author:
.br
Stan Seibert <indigo@aztec.asu.edu>

211
212
213
214
.SH BUGS
The min and max bitrate options are not yet implemented
in the vorbis encoder, nor is the -q option.

Jack Moffitt's avatar
Jack Moffitt committed
215
216
217
.SH SEE ALSO

.BR ogg123 (1)