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
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
#include "analyzer/analyzerkey.h"
#include <QVector>
#include <QtDebug>
#include "analyzer/constants.h"
#if defined __KEYFINDER__
#include "analyzer/plugins/analyzerkeyfinder.h"
#endif
#include "analyzer/plugins/analyzerqueenmarykey.h"
#include "proto/keys.pb.h"
#include "track/keyfactory.h"
#include "track/track.h"
// static
QList<mixxx::AnalyzerPluginInfo> AnalyzerKey::availablePlugins() {
QList<mixxx::AnalyzerPluginInfo> analyzers;
// First one below is the default
analyzers.push_back(mixxx::AnalyzerQueenMaryKey::pluginInfo());
#if defined __KEYFINDER__
analyzers.push_back(mixxx::AnalyzerKeyFinder::pluginInfo());
#endif
return analyzers;
}
// static
mixxx::AnalyzerPluginInfo AnalyzerKey::defaultPlugin() {
DEBUG_ASSERT(availablePlugins().size() > 0);
return availablePlugins().at(0);
}
AnalyzerKey::AnalyzerKey(KeyDetectionSettings keySettings)
: m_keySettings(keySettings),
m_iSampleRate(0),
m_iTotalSamples(0),
m_iMaxSamplesToProcess(0),
m_iCurrentSample(0),
m_bPreferencesKeyDetectionEnabled(true),
m_bPreferencesFastAnalysisEnabled(false),
m_bPreferencesReanalyzeEnabled(false) {
}
bool AnalyzerKey::initialize(TrackPointer tio, int sampleRate, int totalSamples) {
if (totalSamples == 0) {
return false;
}
m_bPreferencesKeyDetectionEnabled = m_keySettings.getKeyDetectionEnabled();
if (!m_bPreferencesKeyDetectionEnabled) {
qDebug() << "Key detection is deactivated";
return false;
}
m_bPreferencesFastAnalysisEnabled = m_keySettings.getFastAnalysis();
m_bPreferencesReanalyzeEnabled = m_keySettings.getReanalyzeWhenSettingsChange();
if (availablePlugins().size() > 0) {
m_pluginId = defaultPlugin().id;
QString pluginId = m_keySettings.getKeyPluginId();
for (const auto& info : availablePlugins()) {
if (info.id == pluginId) {
m_pluginId = pluginId; // configured Plug-In available
break;
}
}
}
qDebug() << "AnalyzerKey preference settings:"
<< "\nPlugin:" << m_pluginId
<< "\nRe-analyze when settings change:" << m_bPreferencesReanalyzeEnabled
<< "\nFast analysis:" << m_bPreferencesFastAnalysisEnabled;
m_iSampleRate = sampleRate;
m_iTotalSamples = totalSamples;
// In fast analysis mode, skip processing after
// kFastAnalysisSecondsToAnalyze seconds are analyzed.
if (m_bPreferencesFastAnalysisEnabled) {
m_iMaxSamplesToProcess = mixxx::kFastAnalysisSecondsToAnalyze * m_iSampleRate * mixxx::kAnalysisChannels;
} else {
m_iMaxSamplesToProcess = m_iTotalSamples;
}
m_iCurrentSample = 0;
// if we can't load a stored track reanalyze it
bool bShouldAnalyze = shouldAnalyze(tio);
DEBUG_ASSERT(!m_pPlugin);
if (bShouldAnalyze) {
if (m_pluginId == mixxx::AnalyzerQueenMaryKey::pluginInfo().id) {
m_pPlugin = std::make_unique<mixxx::AnalyzerQueenMaryKey>();
#if defined __KEYFINDER__
} else if (m_pluginId == mixxx::AnalyzerKeyFinder::pluginInfo().id) {
m_pPlugin = std::make_unique<mixxx::AnalyzerKeyFinder>();
#endif
} else {
// This must not happen, because we have already verified above
// that the PlugInId is valid
DEBUG_ASSERT(false);
}
if (m_pPlugin) {
if (m_pPlugin->initialize(sampleRate)) {
qDebug() << "Key calculation started with plugin" << m_pluginId;
} else {
qDebug() << "Key calculation will not start.";
m_pPlugin.reset();
bShouldAnalyze = false;
}
} else {
bShouldAnalyze = false;
}
}
return bShouldAnalyze;
}
bool AnalyzerKey::shouldAnalyze(TrackPointer tio) const {
bool bPreferencesFastAnalysisEnabled = m_keySettings.getFastAnalysis();
QString pluginID = m_keySettings.getKeyPluginId();
if (pluginID.isEmpty()) {
pluginID = defaultPlugin().id;
}
const Keys keys(tio->getKeys());
if (keys.isValid()) {
QString version = keys.getVersion();
QString subVersion = keys.getSubVersion();
QHash<QString, QString> extraVersionInfo = getExtraVersionInfo(
pluginID, bPreferencesFastAnalysisEnabled);
QString newVersion = KeyFactory::getPreferredVersion();
QString newSubVersion = KeyFactory::getPreferredSubVersion(extraVersionInfo);
if (version == newVersion && subVersion == newSubVersion) {
// If the version and settings have not changed then if the world is
// sane, re-analyzing will do nothing.
qDebug() << "Keys version/sub-version unchanged since previous analysis. Not analyzing.";
return false;
}
if (!m_bPreferencesReanalyzeEnabled) {
qDebug() << "Track has previous key detection result that is not up"
<< "to date with latest settings but user preferences"
<< "indicate we should not re-analyze it.";
return false;
}
}
return true;
}
bool AnalyzerKey::processSamples(const CSAMPLE *pIn, const int iLen) {
VERIFY_OR_DEBUG_ASSERT(m_pPlugin) {
return false;
}
m_iCurrentSample += iLen;
if (m_iCurrentSample > m_iMaxSamplesToProcess) {
return true; // silently ignore remaining samples
}
return m_pPlugin->processSamples(pIn, iLen);
}
void AnalyzerKey::cleanup() {
m_pPlugin.reset();
}
void AnalyzerKey::storeResults(TrackPointer tio) {
VERIFY_OR_DEBUG_ASSERT(m_pPlugin) {
return;
}
if (!m_pPlugin->finalize()) {
qWarning() << "Key detection failed";
return;
}
KeyChangeList key_changes = m_pPlugin->getKeyChanges();
QHash<QString, QString> extraVersionInfo = getExtraVersionInfo(
m_pluginId, m_bPreferencesFastAnalysisEnabled);
Keys track_keys = KeyFactory::makePreferredKeys(
key_changes, extraVersionInfo, m_iSampleRate, m_iTotalSamples);
tio->setKeys(track_keys);
}
// static
QHash<QString, QString> AnalyzerKey::getExtraVersionInfo(
QString pluginId, bool bPreferencesFastAnalysis) {
QHash<QString, QString> extraVersionInfo;
extraVersionInfo["vamp_plugin_id"] = pluginId;
if (bPreferencesFastAnalysis) {
extraVersionInfo["fast_analysis"] = "1";
}
return extraVersionInfo;
}
|
