Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AnalyzerPlugin: Use class instead of simple struct #3874

Merged
merged 2 commits into from
May 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/analyzer/analyzerbeats.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@ bool AnalyzerBeats::initialize(TrackPointer pTrack, int sampleRate, int totalSam

const auto plugins = availablePlugins();
if (!plugins.isEmpty()) {
m_pluginId = defaultPlugin().id;
m_pluginId = defaultPlugin().id();
QString pluginId = m_bpmSettings.getBeatPluginId();
for (const auto& info : plugins) {
if (info.id == pluginId) {
if (info.id() == pluginId) {
m_pluginId = pluginId; // configured Plug-In available
break;
}
Expand Down Expand Up @@ -100,9 +100,9 @@ bool AnalyzerBeats::initialize(TrackPointer pTrack, int sampleRate, int totalSam

DEBUG_ASSERT(!m_pPlugin);
if (bShouldAnalyze) {
if (m_pluginId == mixxx::AnalyzerQueenMaryBeats::pluginInfo().id) {
if (m_pluginId == mixxx::AnalyzerQueenMaryBeats::pluginInfo().id()) {
m_pPlugin = std::make_unique<mixxx::AnalyzerQueenMaryBeats>();
} else if (m_pluginId == mixxx::AnalyzerSoundTouchBeats::pluginInfo().id) {
} else if (m_pluginId == mixxx::AnalyzerSoundTouchBeats::pluginInfo().id()) {
m_pPlugin = std::make_unique<mixxx::AnalyzerSoundTouchBeats>();
} else {
// This must not happen, because we have already verified above
Expand Down Expand Up @@ -134,7 +134,7 @@ bool AnalyzerBeats::shouldAnalyze(TrackPointer pTrack) const {

QString pluginID = m_bpmSettings.getBeatPluginId();
if (pluginID.isEmpty()) {
pluginID = defaultPlugin().id;
pluginID = defaultPlugin().id();
}

// If the track already has a Beats object then we need to decide whether to
Expand All @@ -159,7 +159,7 @@ bool AnalyzerBeats::shouldAnalyze(TrackPointer pTrack) const {
}

if (subVersion.isEmpty() && pBeats->findNextBeat(0) <= 0.0 &&
m_pluginId != mixxx::AnalyzerSoundTouchBeats::pluginInfo().id) {
m_pluginId != mixxx::AnalyzerSoundTouchBeats::pluginInfo().id()) {
// This happens if the beat grid was created from the metadata BPM value.
qDebug() << "First beat is 0 for grid so analyzing track to find first beat.";
return true;
Expand Down
10 changes: 5 additions & 5 deletions src/analyzer/analyzerkey.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@ bool AnalyzerKey::initialize(TrackPointer tio, int sampleRate, int totalSamples)

const auto plugins = availablePlugins();
if (!plugins.isEmpty()) {
m_pluginId = defaultPlugin().id;
m_pluginId = defaultPlugin().id();
QString pluginId = m_keySettings.getKeyPluginId();
for (const auto& info : plugins) {
if (info.id == pluginId) {
if (info.id() == pluginId) {
m_pluginId = pluginId; // configured Plug-In available
break;
}
Expand Down Expand Up @@ -88,10 +88,10 @@ bool AnalyzerKey::initialize(TrackPointer tio, int sampleRate, int totalSamples)

DEBUG_ASSERT(!m_pPlugin);
if (bShouldAnalyze) {
if (m_pluginId == mixxx::AnalyzerQueenMaryKey::pluginInfo().id) {
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) {
} else if (m_pluginId == mixxx::AnalyzerKeyFinder::pluginInfo().id()) {
m_pPlugin = std::make_unique<mixxx::AnalyzerKeyFinder>();
#endif
} else {
Expand Down Expand Up @@ -119,7 +119,7 @@ bool AnalyzerKey::shouldAnalyze(TrackPointer tio) const {
bool bPreferencesFastAnalysisEnabled = m_keySettings.getFastAnalysis();
QString pluginID = m_keySettings.getKeyPluginId();
if (pluginID.isEmpty()) {
pluginID = defaultPlugin().id;
pluginID = defaultPlugin().id();
}

const Keys keys(tio->getKeys());
Expand Down
43 changes: 31 additions & 12 deletions src/analyzer/plugins/analyzerplugin.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,53 @@

namespace mixxx {

struct AnalyzerPluginInfo {
class AnalyzerPluginInfo {
public:
AnalyzerPluginInfo(const QString& id,
const QString& author,
const QString& name,
bool isConstantTempoSupported)
: id(id),
author(author),
name(name),
constantTempoSupported(isConstantTempoSupported) {
: m_id(id),
m_author(author),
m_name(name),
m_isConstantTempoSupported(isConstantTempoSupported) {
}

const QString& id() const {
return m_id;
}

const QString& author() const {
return m_author;
}
QString id;
QString author;
QString name;
bool constantTempoSupported;

const QString& name() const {
return m_name;
}

bool isConstantTempoSupported() const {
return m_isConstantTempoSupported;
}

private:
QString m_id;
QString m_author;
QString m_name;
bool m_isConstantTempoSupported;
};

class AnalyzerPlugin {
public:
virtual ~AnalyzerPlugin() = default;

virtual QString id() const {
return info().id;
return info().id();
}
virtual QString author() const {
return info().author;
return info().author();
}
virtual QString name() const {
return info().name;
return info().name();
}
virtual AnalyzerPluginInfo info() const = 0;

Expand Down
12 changes: 6 additions & 6 deletions src/preferences/dialog/dlgprefbeats.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ DlgPrefBeats::DlgPrefBeats(QWidget* parent, UserSettingsPointer pConfig)

m_availablePlugins = AnalyzerBeats::availablePlugins();
for (const auto& info : qAsConst(m_availablePlugins)) {
comboBoxBeatPlugin->addItem(info.name, info.id);
comboBoxBeatPlugin->addItem(info.name(), info.id());
}

loadSettings();
Expand Down Expand Up @@ -68,7 +68,7 @@ void DlgPrefBeats::loadSettings() {

void DlgPrefBeats::slotResetToDefaults() {
if (m_availablePlugins.size() > 0) {
m_selectedAnalyzerId = m_availablePlugins[0].id;
m_selectedAnalyzerId = m_availablePlugins[0].id();
}
m_bAnalyzerEnabled = m_bpmSettings.getBpmDetectionEnabledDefault();
m_bFixedTempoEnabled = m_bpmSettings.getFixedTempoAssumptionDefault();
Expand All @@ -82,7 +82,7 @@ void DlgPrefBeats::pluginSelected(int i) {
if (i == -1) {
return;
}
m_selectedAnalyzerId = m_availablePlugins[i].id;
m_selectedAnalyzerId = m_availablePlugins[i].id();
slotUpdate();
}

Expand Down Expand Up @@ -113,18 +113,18 @@ void DlgPrefBeats::slotUpdate() {
bool found = false;
for (int i = 0; i < m_availablePlugins.size(); ++i) {
const auto& info = m_availablePlugins.at(i);
if (info.id == m_selectedAnalyzerId) {
if (info.id() == m_selectedAnalyzerId) {
found = true;
comboBoxBeatPlugin->setCurrentIndex(i);
if (!m_availablePlugins[i].constantTempoSupported) {
if (!m_availablePlugins[i].isConstantTempoSupported()) {
checkBoxFixedTempo->setEnabled(false);
}
break;
}
}
if (!found) {
comboBoxBeatPlugin->setCurrentIndex(0);
m_selectedAnalyzerId = m_availablePlugins[0].id;
m_selectedAnalyzerId = m_availablePlugins[0].id();
}
}

Expand Down
10 changes: 5 additions & 5 deletions src/preferences/dialog/dlgprefkey.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ DlgPrefKey::DlgPrefKey(QWidget* parent, UserSettingsPointer pConfig)

m_availablePlugins = AnalyzerKey::availablePlugins();
for (const auto& info : qAsConst(m_availablePlugins)) {
plugincombo->addItem(info.name, info.id);
plugincombo->addItem(info.name(), info.id());
}

m_pKeyNotation = new ControlProxy(ConfigKey("[Library]", "key_notation"), this);
Expand Down Expand Up @@ -142,7 +142,7 @@ void DlgPrefKey::slotResetToDefaults() {
m_bFastAnalysisEnabled = m_keySettings.getFastAnalysisDefault();
m_bReanalyzeEnabled = m_keySettings.getReanalyzeWhenSettingsChangeDefault();
if (m_availablePlugins.size() > 0) {
m_selectedAnalyzerId = m_availablePlugins[0].id;
m_selectedAnalyzerId = m_availablePlugins[0].id();
}

KeyUtils::KeyNotation notation_type;
Expand All @@ -169,7 +169,7 @@ void DlgPrefKey::pluginSelected(int i) {
if (i == -1) {
return;
}
m_selectedAnalyzerId = m_availablePlugins[i].id;
m_selectedAnalyzerId = m_availablePlugins[i].id();
slotUpdate();
}

Expand Down Expand Up @@ -252,15 +252,15 @@ void DlgPrefKey::slotUpdate() {
bool found = false;
for (int i = 0; i < m_availablePlugins.size(); ++i) {
const auto& info = m_availablePlugins.at(i);
if (info.id == m_selectedAnalyzerId) {
if (info.id() == m_selectedAnalyzerId) {
plugincombo->setCurrentIndex(i);
found = true;
break;
}
}
if (!found) {
plugincombo->setCurrentIndex(0);
m_selectedAnalyzerId = m_availablePlugins[0].id;
m_selectedAnalyzerId = m_availablePlugins[0].id();
}
}
}
Expand Down