.\" Man page generated from reStructuredText.
.
.TH REPLAYGAIN 1 "2016-7-27" "1.3.4" "rgain"
.SH NAME
replaygain \- single file Replay Gain editor
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.nf
\fBreplaygain\fP [\fIoptions\fP] \fIAUDIO_FILE\fP [\fIAUDIO_FILE\fP ...]
\fBreplaygain\fP \-\-help
\fBreplaygain\fP \-\-version
.fi
.sp
.SH DESCRIPTION
.sp
\fBreplaygain\fP applies or displays Replay Gain information for audio files. By
default, all given files be assumed to be part of a single album and album gain
data will be calculated for them.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-\-version
Display the version of the software.
.TP
.B \-h\fP,\fB  \-\-help
Display a short documentation.
.TP
.B \-f\fP,\fB  \-\-force
Recalculate Replay Gain even if the file already contains gain information.
.TP
.B \-d\fP,\fB  \-\-dry\-run
Don\(aqt actually modify any files.
.TP
.BI \-r \ REF\fP,\fB \ \-\-reference\-loudness\fB= REF
Set the reference loudness to REF dB (default: 89 dB)
.TP
.BI \-\-mp3\-format\fB= MP3_FORMAT
Choose the Replay Gain data format for MP3 files. The default setting should
be compatible with most decent software music players, so it is generally
not necessary to mess with this setting. See below for more information.
.TP
.B \-\-no\-album
Don\(aqt write any album gain information.
.TP
.B \-\-show
Don\(aqt calculate anything, simply show Replay Gain information for the
specified files. In this mode, all options other than \fB\-\-mp3\-format\fP
are ignored.
.UNINDENT
.SH MP3 FORMATS
.sp
Proper Replay Gain support for MP3 files is a bit of a
mess: on the one hand, there is the \fBmp3gain\fP application [1] which was
relatively widely used (I don\(aqt know if it still is) \-\- it directly modifies the
audio data which has the advantage that it works with pretty much any player,
but it also means you have to decide ahead of time whether you want track gain
or album gain. Besides, it\(aqs just not very elegant. On the other hand, there are
at least two commonly used ways to store proper Replay Gain information in ID3v2
tags [2].
.sp
Now, in general you don\(aqt have to worry about this when using this package: by
default, \fBreplaygain\fP and \fBcollectiongain\fP will read and write Replay Gain
information in the two most commonly used formats. However, if for whatever
reason you need more control over the MP3 Replay Gain information, you can use
the \fB\-\-mp3\-format\fP option (supported by both programs) to change the
behaviour. Possible choices with this switch are:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fIreplaygain.org\fP (alias: \fIfb2k\fP)
Replay Gain information is stored in ID3v2 TXXX frames. This format is
specified on the replaygain.org website as the recommended format for MP3
files. Notably, this format is also used by the foobar2000 music player for
Windows [3].
.IP \(bu 2
\fIlegacy\fP (alias: \fIql\fP)
Replay Gain information is stored in ID3v2.4 RVA2 frames. This format is
described as "legacy" by replaygain.org; however, it is still the primary
format for at least the Quod Libet music player [4] and possibly others. It
should be noted that this format does not support volume adjustments of more
than 64 dB: if the calculated gain value is smaller than \-64 dB or greater
than or equal to +64 dB, it is clamped to these limit values.
.IP \(bu 2
\fIdefault\fP
This is the default implementation used by both \fBreplaygain\fP and
\fBcollectiongain\fP\&. When writing Replay Gain data, both the \fIreplaygain.org\fP
as well as the \fIlegacy\fP format are written. As for reading, if a file
contains data in both formats, both data sets are read and then compared. If
they match up, that Replay Gain information is returned for the file.
However, if they don\(aqt match, no Replay Gain data is returned to signal that
this file does not contain valid (read: consistent) Replay Gain information.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
[1] \fI\%http://mp3gain.sourceforce.net\fP
.sp
[2] \fI\%http://wiki.hydrogenaudio.org/index.php?title=ReplayGain_specification#ID3v2\fP
.sp
[3] \fI\%http://foobar2000.org\fP
.sp
[4] \fI\%http://code.google.com/p/quodlibet\fP
.SH SEE ALSO
.sp
\fBcollectiongain(1)\fP
.\" Generated by docutils manpage writer.
.