Mp3InfoReplayGain.GainField
class Mp3InfoReplayGain.GainField
A gain field can store one gain adjustment with name and originator metadata.
Summary
Nested types |
|---|
@DocumentedThe name of a gain field. |
@DocumentedThe originator of a gain field. |
Constants |
|
|---|---|
const Int |
NAME_AUDIOPHILE = 2A gain adjustment that represents the ideal listening gain for each track. |
const Int |
NAME_RADIO = 1A gain adjustment that makes all the tracks sound equally loud. |
const Int |
This gain adjustment was manually determined by the artist. |
const Int |
This gain adjustment was automatically determined by the ReplayGain algorithm. |
const Int |
This gain adjustment was automatically determined by a simple RMS algorithm. |
const Int |
ORIGINATOR_UNSET = 0The origin of this gain adjustment is not set. |
const Int |
ORIGINATOR_USER = 2This gain adjustment was manually determined by the user. |
Public properties |
|
|---|---|
Float |
Absolute gain adjustment in decibels. |
Int |
Name/type of the gain field. |
Int |
Originator of the gain field, i.e. who determined the value / in what way it was determined. |
Constants
NAME_AUDIOPHILE
const val NAME_AUDIOPHILE = 2: Int
A gain adjustment that represents the ideal listening gain for each track.
The problem with NAME_RADIO is that tracks which should be quiet will be brought up to the level of all the rest.
To solve this problem, the "Audiophile" setting represents the ideal listening gain for each track. ReplayGain can have a good guess at this too, by reading the entire CD, and calculating a single gain adjustment for the whole disc. This works because quiet tracks then stay quieter than the rest, since the gain won't be changed for each track. It still solves the basic problem (annoying, unwanted level differences between discs) because quiet or loud discs are still adjusted overall.
Where ReplayGain will fail is if you have an entire CD of quiet music. It will bring it up to an average level. This is why the "Audiophile" Replay Gain adjustment must be user adjustable. The ReplayGain whole disc value represents a good guess, and should be stored in the file. Later, the user can tweak it if required. If the file has originated from the artist, then the "Audiophile" setting can be specified by the artist. Naturally, the user is free to change the value if they desire.
NAME_RADIO
const val NAME_RADIO = 1: Int
A gain adjustment that makes all the tracks sound equally loud.
This behaves like tracks do on the radio, hence the name. If the ReplayGain is calculated on a track-by-track basis (i.e. an individual ReplayGain calculation is carried out for each track), this will be the result.
ORIGINATOR_ARTIST
const val ORIGINATOR_ARTIST = 1: Int
This gain adjustment was manually determined by the artist.
ORIGINATOR_REPLAYGAIN
const val ORIGINATOR_REPLAYGAIN = 3: Int
This gain adjustment was automatically determined by the ReplayGain algorithm.
ORIGINATOR_SIMPLE_RMS
const val ORIGINATOR_SIMPLE_RMS = 4: Int
This gain adjustment was automatically determined by a simple RMS algorithm.
ORIGINATOR_USER
const val ORIGINATOR_USER = 2: Int
This gain adjustment was manually determined by the user.
Public functions
Public properties
gain
val gain: Float
Absolute gain adjustment in decibels.
Positive values mean the signal should be amplified, negative values mean it should be attenuated.
Due to limitations of the storage format, this is only accurate to the first decimal place.
originator
@Mp3InfoReplayGain.GainField.Originator
val originator: Int
Originator of the gain field, i.e. who determined the value / in what way it was determined.
Either a human (user / artist) set the value according to their preferences, or an algorithm like ReplayGain or simple RMS average was used to determine it.