blob: 9c943e828ccade3475b528b4512b9540728d16b0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
#pragma once
#include "util/types.h"
namespace mixxx {
// DTO for storing replay gain information.
//
// Parsing & Formatting
// --------------------
// This class includes functions for formatting and parsing replay gain
// metadata according to the ReplayGain 1.0/2.0 specification:
// http://wiki.hydrogenaud.io/index.php?title=ReplayGain_1.0_specification
// http://wiki.hydrogenaud.io/index.php?title=ReplayGain_2.0_specification
//
// Normalization
// -------------
// Formatting a floating point value as a string and parsing it later
// might cause rounding errors. In order to avoid "jittering" caused
// by subsequently formatting and parsing a floating point value the
// ratio and peak values need to be normalized before writing them
// as a string into file tags.
class ReplayGain final {
public:
static constexpr double kRatioUndefined = 0.0;
static constexpr double kRatioMin = 0.0; // lower bound (exclusive)
static constexpr double kRatio0dB = 1.0;
static constexpr CSAMPLE kPeakUndefined = -CSAMPLE_PEAK;
static constexpr CSAMPLE kPeakMin = CSAMPLE_ZERO; // lower bound (inclusive)
static constexpr CSAMPLE kPeakClip = CSAMPLE_PEAK; // upper bound (inclusive) represents digital full scale without clipping
static_assert(ReplayGain::kPeakClip == 1.0,
"http://wiki.hydrogenaud.io/index.php"
"?title=ReplayGain_2.0_specification#Peak_amplitude: "
"The maximum peak amplitude value is stored as a floating number, "
"where 1.0 represents digital full scale");
ReplayGain()
: ReplayGain(kRatioUndefined, kPeakUndefined) {
}
ReplayGain(double ratio, CSAMPLE peak)
: m_ratio(ratio)
, m_peak(peak) {
}
static bool isValidRatio(double ratio) {
return kRatioMin < ratio;
}
bool hasRatio() const {
return isValidRatio(m_ratio);
}
double getRatio() const {
return m_ratio;
}
void setRatio(double ratio) {
m_ratio = ratio;
}
void resetRatio() {
m_ratio = kRatioUndefined;
}
// Parsing and formatting of gain values according to the
// ReplayGain 1.0/2.0 specification.
static double ratioFromString(const QString& dBGain, bool* pValid = 0);
static QString ratioToString(double ratio);
static double normalizeRatio(double ratio);
// The peak amplitude of the track or signal.
static bool isValidPeak(CSAMPLE peak) {
return kPeakMin <= peak;
}
bool hasPeak() const {
return isValidPeak(m_peak);
}
CSAMPLE getPeak() const {
return m_peak;
}
void setPeak(CSAMPLE peak) {
m_peak = peak;
}
void resetPeak() {
m_peak = kPeakUndefined;
}
// Parsing and formatting of peak amplitude values according to
// the ReplayGain 1.0/2.0 specification.
static CSAMPLE peakFromString(const QString& strPeak, bool* pValid = 0);
static QString peakToString(CSAMPLE peak);
static CSAMPLE normalizePeak(CSAMPLE peak);
// Adjusts floating-point values to match their string representation
// in file tags to account for rounding errors.
void normalizeBeforeExport() {
m_ratio = normalizeRatio(m_ratio);
m_peak = normalizePeak(m_peak);
}
private:
double m_ratio;
CSAMPLE m_peak;
};
inline
bool operator==(const ReplayGain& lhs, const ReplayGain& rhs) {
return (lhs.getRatio() == rhs.getRatio()) && (lhs.getPeak() == rhs.getPeak());
}
inline
bool operator!=(const ReplayGain& lhs, const ReplayGain& rhs) {
return !(lhs == rhs);
}
inline
QDebug operator<<(QDebug dbg, const ReplayGain& arg) {
return dbg << "ratio =" << arg.getRatio() << "/" << "peak =" << arg.getPeak();
}
}
Q_DECLARE_TYPEINFO(mixxx::ReplayGain, Q_MOVABLE_TYPE);
Q_DECLARE_METATYPE(mixxx::ReplayGain)
|
