~ubuntu-branches/ubuntu/utopic/normalize-audio/utopic

« back to all changes in this revision

Viewing changes to doc/normalize.1

  • Committer: Package Import Robot
  • Author(s): Joachim Reichel
  • Date: 2012-04-15 16:23:36 UTC
  • mfrom: (7.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20120415162336-vn3xg71e66e2sxea
Tags: 0.7.7-9
* Change packaging format to "3.0 (quilt)" (Closes: #668782).
* Use new minimal debian/rules file and debhelper compat level 9.
* Use DEP5 format for debian/copyright.
* Update Standards-Version to 3.9.3 (no changes needed).

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
4
4
.\" Please send any bug reports, improvements, comments, patches, 
5
5
.\" etc. to Steve Cheng <steve@ggi-project.org>.
6
 
.TH "NORMALIZE" "1" "14 September 2005" "" ""
 
6
.TH "NORMALIZE\-AUDIO" "1" "14 September 2005" "" ""
7
7
 
8
8
.SH NAME
9
 
normalize \- adjusts volume levels of audio files.
 
9
normalize\-audio \- adjusts volume levels of audio files.
10
10
.SH SYNOPSIS
11
11
 
12
 
\fBnormalize\fR [ \fB\fIoptions\fB\fR ] [ \fB--\fR ] \fB\fIfile\fB\fR\fI ...\fR
 
12
\fBnormalize\-audio\fR [ \fB\fIoptions\fB\fR ] [ \fB\-\-\fR ] \fB\fIfile\fB\fR\fI ...\fR
13
13
 
14
14
.SH "DESCRIPTION"
15
15
.PP
16
 
\fBnormalize\fR is used to adjust the volume of wav audio
 
16
\fBnormalize\-audio\fR is used to adjust the volume of wav audio
17
17
files to a standard volume level.  This is useful for things like
18
18
creating mp3 mixes, where different recording levels on different
19
19
albums can cause the volume to vary greatly from song to song.
20
20
.PP
21
 
\fBnormalize\fR operates in two phases.  In the first phase, it
 
21
\fBnormalize\-audio\fR operates in two phases.  In the first phase, it
22
22
analyzes the specified files as wav audio files, and computes the
23
23
volume of each file.  In the second phase, it applies a volume
24
24
adjustment to each file to set each file's volume to a standard level.
25
25
.SH "OPTIONS"
26
26
.TP
27
 
\fB-a, --amplitude=\fIAMPLITUDE\fB\fR
 
27
\fB\-a, \-\-amplitude=\fIAMPLITUDE\fB\fR
28
28
Adjust the RMS volume to the target amplitude AMPLITUDE; must be
29
29
between 0.0 and 1.0.  If a number suffixed by "dB" or "dBFS" is
30
30
specified, the amplitude is assumed to be in decibels from full scale.
31
 
The default is -12dBFS.
 
31
The default is \-12dBFS.
32
32
.TP
33
 
\fB-b, --batch\fR
 
33
\fB\-b, \-\-batch\fR
34
34
Enable batch mode: see BATCH MODE, below.
35
35
.TP
36
 
\fB-c, --compression\fR
 
36
\fB\-c, \-\-compression\fR
37
37
\fBDeprecated\fR\&.  In previous versions, this enabled
38
38
the limiter, but now the limiter is enabled by default.
39
39
.TP
40
 
\fB--clipping\fR
 
40
\fB\-\-clipping\fR
41
41
Disable the limiter, and just clip any samples that are too large.
42
 
Same effect as -l 0dBFS.
 
42
Same effect as \-l 0dBFS.
43
43
.TP
44
 
\fB--fractions\fR
 
44
\fB\-\-fractions\fR
45
45
Display all values as decimal fractions instead of in decibels.  By
46
46
default, volume adjustments are shown in decibels, and volume levels
47
47
in dBFS, where 0 dBFS is the level of a square wave of maximum
48
48
amplitude.
49
49
.TP
50
 
\fB-g, --gain=\fIGAIN\fB\fR
 
50
\fB\-g, \-\-gain=\fIGAIN\fB\fR
51
51
Skip the volume computation phase: don't compute the volume adjustment
52
52
from the current volumes of the files.  Instead, just apply the given
53
53
gain as a volume adjustment to all files.  As a plain number this is
54
54
just a multiplier applied to all samples, If a number suffixed by "dB"
55
55
is specified, all volumes are adjusted by that many decibels.
56
56
.TP
57
 
\fB--id3-compat\fR
 
57
\fB\-\-id3\-compat\fR
58
58
Use this option when adjusting MPEG audio files if your MP3 player
59
59
does not recognize ID3v2.4 tags.  See MPEG
60
60
AUDIO ADJUSTMENT, below, for details.
61
61
.TP
62
 
\fB--id3-unsync\fR
 
62
\fB\-\-id3\-unsync\fR
63
63
Use this option when adjusting MPEG audio files if your MP3 player
64
64
does not recognize ID3v2 tags and has trouble playing some ID3v2
65
65
tagged MP3 files.  See MPEG AUDIO
66
66
ADJUSTMENT, below, for details.
67
67
.TP
68
 
\fB-l, --limiter=\fILEVEL\fB\fR
 
68
\fB\-l, \-\-limiter=\fILEVEL\fB\fR
69
69
This controls the behavior of the limiter.  By default, all samples
70
 
above -6dBFS (0.5) are limited, but this option sets the limiting
 
70
above \-6dBFS (0.5) are limited, but this option sets the limiting
71
71
level to \fILEVEL\fR\&. Setting
72
72
\fILEVEL\fR to 1 (or 0dBFS) does no limiting
73
73
(clipping is done instead); setting \fILEVEL\fR
74
74
to 0 does limiting on all samples.  The default value is recommended
75
75
unless you know what you're doing.
76
76
.TP
77
 
\fB-m, --mix\fR
 
77
\fB\-m, \-\-mix\fR
78
78
Enable mix mode: see MIX MODE, below.
79
79
Batch mode and mix mode are mutually exclusive.
80
80
.TP
81
 
\fB-n, --no-adjust\fR
 
81
\fB\-n, \-\-no\-adjust\fR
82
82
Compute and output the volume adjustment that would set the volume to
83
83
the target, but don't apply it to any of the files (i.e. skip the
84
84
second phase).  If you use this option, your files will not be altered
85
85
in any way.
86
86
.TP
87
 
\fB--no-progress\fR
 
87
\fB\-\-no\-progress\fR
88
88
Don't print any progress information.  All other messages are printed
89
89
as normal according to the verbosity level.
90
90
.TP
91
 
\fB--peak\fR
 
91
\fB\-\-peak\fR
92
92
Adjust using peak levels instead of RMS levels.  Each file will be
93
93
adjusted so that its maximum sample is at full scale.  This just gives
94
94
a file the maximum volume possible without clipping; no normalization
95
95
is done.
96
96
.TP
97
 
\fB-q, --quiet\fR
 
97
\fB\-q, \-\-quiet\fR
98
98
Don't output progress information.  Only error messages are printed.
99
99
.TP
100
 
\fB-t, --average-threshold=\fITHRESHOLD\fB\fR
 
100
\fB\-t, \-\-average\-threshold=\fITHRESHOLD\fB\fR
101
101
When averaging volume levels for batch mode or mix mode, throw out any
102
102
volumes that are more than \fITHRESHOLD\fR
103
103
decibels from the average.  A high value here (say, 50) will make sure
104
104
that the volumes of all files are considered in the average.
105
105
.TP
106
 
\fB-T, --adjust-threshold=\fITHRESHOLD\fB\fR
 
106
\fB\-T, \-\-adjust\-threshold=\fITHRESHOLD\fB\fR
107
107
If an adjustment to be made to a file is smaller than
108
108
\fITHRESHOLD\fR decibels, consider the file
109
109
already normalized and don't do the adjustment.  This is 0.125 by
110
 
default, or 0 if the \fB-g\fR option is given.
 
110
default, or 0 if the \fB\-g\fR option is given.
111
111
.TP
112
 
\fB-v, --verbose\fR
 
112
\fB\-v, \-\-verbose\fR
113
113
Increase verbosity.  This option can be repeated for more messages.
114
114
.TP
115
 
\fB-w, --output-bitwidth\fR
 
115
\fB\-w, \-\-output\-bitwidth\fR
116
116
Force output files to have samples that are W bits wide.  This option
117
117
is ignored when adjusting MP3 files.
118
118
.TP
119
 
\fB-h, --help\fR
 
119
\fB\-h, \-\-help\fR
120
120
Display usage information and exit.
121
121
.TP
122
 
\fB-V, --version\fR
 
122
\fB\-V, \-\-version\fR
123
123
Print version information and exit.
124
124
.TP
125
 
\fB--\fR
 
125
\fB\-\-\fR
126
126
Terminate option list.
127
127
.SH "MIX MODE"
128
128
.PP
167
167
tag with the same format as an RVA2 tag.  This isn't a native frame,
168
168
but since it starts with an "X", it's considered experimental and
169
169
therefore legal, according to the ID3 spec.  The
170
 
\fB--id3-compat\fR option turns on this behavior.
 
170
\fB\-\-id3\-compat\fR option turns on this behavior.
171
171
The disadvantage of the first method is that your MP3 player may no
172
172
longer read the ID3 tags on your files.  Bug the author of your
173
173
favorite MP3 player to support ID3v2.4 tags!
174
174
.PP
175
175
The disadvantage of the second method is that the XRVA frame is only
176
 
recognized by the xmms-rva plugin that is packaged with normalize.  On
 
176
recognized by the xmms\-rva plugin that is packaged with normalize.  On
177
177
the other hand, I don't know of any MP3 players that recognize the
178
178
RVA2 frame, either, so it may not make any difference.
179
179
.PP
180
180
The other option related to ID3 tags,
181
 
\fB--id3-unsync\fR, is only necessary for
 
181
\fB\-\-id3\-unsync\fR, is only necessary for
182
182
compatibility with old MP3 players that don't recognize ID3v2 tags at
183
183
all.  If your MP3 player complains of garbage at the start of tagged
184
184
files, or is unable to play the files at all, turn this option on.
186
186
ID3v2 tags, you don't need it.
187
187
.SH "CAVEATS"
188
188
.PP
189
 
Note that your version of \fBnormalize\fR must be
 
189
Note that your version of \fBnormalize\-audio\fR must be
190
190
compiled with MAD library support to analyze MP3 file volume levels.
191
191
.SH "AUTHOR"
192
192
.PP