Implement the concept of a 'drum track'

- Drum tracks are not transposed by pattern => transpose

Author: juzzlin

CHANGELOG

@@ -5,6 +5,9 @@ Release date:
 
 New features:
 
+* Implement the concept of a 'drum track'
+  - Drum tracks are not transposed by pattern => transpose
+
 Bug fixes:
 
 Other:

src/application/models/track_settings_model.cpp

@@ -214,6 +214,7 @@ void TrackSettingsModel::setInstrumentData(const Instrument & instrument)
         setBankByteOrderSwapped(instrument.settings().bank->byteOrderSwapped);
     }
     setTranspose(instrument.settings().transpose);
+    setDrumTrack(instrument.settings().drumTrack);
 
     setSendMidiClock(instrument.settings().timing.sendMidiClock.has_value() && *instrument.settings().timing.sendMidiClock);
     setSendTransport(instrument.settings().timing.sendTransport.has_value() && *instrument.settings().timing.sendTransport);
@@ -277,6 +278,7 @@ TrackSettingsModel::InstrumentU TrackSettingsModel::toInstrument() const
     }
 
     settings.transpose = m_instrumentSettings.transpose;
+    settings.drumTrack = m_instrumentSettings.drumTrack;
 
     settings.timing.sendMidiClock = m_timingSettings.sendMidiClock;
     settings.timing.sendTransport = m_timingSettings.sendTransport;
@@ -482,6 +484,21 @@ void TrackSettingsModel::setAutoNoteOffOffsetEnabled(bool enabled)
     }
 }
 
+bool TrackSettingsModel::drumTrack() const
+{
+    return m_instrumentSettings.drumTrack;
+}
+
+void TrackSettingsModel::setDrumTrack(bool enabled)
+{
+    juzzlin::L(TAG).debug() << "Setting drum track: " << static_cast<int>(enabled);
+
+    if (m_instrumentSettings.drumTrack != enabled) {
+        m_instrumentSettings.drumTrack = enabled;
+        emit drumTrackChanged();
+    }
+}
+
 
 void TrackSettingsModel::pushApplyDisabled()
 {

src/application/models/track_settings_model.hpp

@@ -25,7 +25,6 @@
 
 namespace noteahead {
 
-class EditorService;
 class Instrument;
 
 class TrackSettingsModel : public QObject
@@ -57,6 +56,7 @@ class TrackSettingsModel : public QObject
     Q_PROPERTY(int velocityKeyTrackOffset READ velocityKeyTrackOffset WRITE setVelocityKeyTrackOffset NOTIFY velocityKeyTrackOffsetChanged)
     Q_PROPERTY(int autoNoteOffOffset READ autoNoteOffOffset WRITE setAutoNoteOffOffset NOTIFY autoNoteOffOffsetChanged)
     Q_PROPERTY(bool autoNoteOffOffsetEnabled READ autoNoteOffOffsetEnabled WRITE setAutoNoteOffOffsetEnabled NOTIFY autoNoteOffOffsetEnabledChanged)
+    Q_PROPERTY(bool drumTrack READ drumTrack WRITE setDrumTrack NOTIFY drumTrackChanged)
 
     Q_PROPERTY(MidiCcSelectionModel* midiCcModel READ midiCcModel CONSTANT)
 
@@ -129,6 +129,9 @@ class TrackSettingsModel : public QObject
     void setAutoNoteOffOffset(int autoNoteOffOffset);
     bool autoNoteOffOffsetEnabled() const;
     void setAutoNoteOffOffsetEnabled(bool enabled);
+
+    bool drumTrack() const;
+    void setDrumTrack(bool enabled);
 
     MidiCcSelectionModel* midiCcModel() const;
 
@@ -173,6 +176,7 @@ class TrackSettingsModel : public QObject
     void velocityKeyTrackOffsetChanged();
     void autoNoteOffOffsetChanged();
     void autoNoteOffOffsetEnabledChanged();
+    void drumTrackChanged();
 
 private:
     void pushApplyDisabled();
@@ -189,6 +193,7 @@ class TrackSettingsModel : public QObject
         quint8 bankMsb { 0 };
         bool bankByteOrderSwapped { false };
         int transpose { 0 };
+        bool drumTrack { false };
     };
 
     InstrumentSettings m_instrumentSettings;
@@ -226,4 +231,4 @@ class TrackSettingsModel : public QObject
 
 } // namespace noteahead
 
-#endif // TRACK_SETTINGS_MODEL_HPP
+#endif // TRACK_SETTINGS_MODEL_HPP

src/application/service/editor_service.cpp

@@ -621,7 +621,7 @@ QString EditorService::trackName(quint64 trackIndex) const
 
 void EditorService::setTrackName(quint64 trackIndex, QString name)
 {
-    if (m_song->trackName(trackIndex) != name.toStdString()) {
+    if (trackName(trackIndex) != name) {
         m_song->setTrackName(trackIndex, name.toStdString());
         emit trackNameChanged();
         setIsModified(true);

src/common/constants.cpp

@@ -214,6 +214,11 @@ QString xmlKeyTranspose()
     return "transpose";
 }
 
+QString xmlKeyDrumTrack()
+{
+    return "drumTrack";
+}
+
 QString xmlKeyVelocityJitter()
 {
     return "velocityJitter";

src/common/constants.hpp

@@ -76,6 +76,7 @@ QString xmlKeyCutoff();
 
 QString xmlKeyDelay();
 QString xmlKeyTranspose();
+QString xmlKeyDrumTrack();
 
     QString xmlKeyVelocityJitter();
     QString xmlKeyVelocityKeyTrack();

src/domain/instrument_settings.cpp

@@ -44,6 +44,7 @@ void InstrumentSettings::serializeToXml(QXmlStreamWriter & writer) const
     }
 
     writer.writeAttribute(Constants::NahdXml::xmlKeyTranspose(), QString::number(transpose));
+    writer.writeAttribute(Constants::NahdXml::xmlKeyDrumTrack(), drumTrack ? Constants::NahdXml::xmlValueTrue() : Constants::NahdXml::xmlValueFalse());
 
     if (timing.sendMidiClock.has_value()) {
         writer.writeAttribute(Constants::NahdXml::xmlKeySendMidiClock(), timing.sendMidiClock.value() ? Constants::NahdXml::xmlValueTrue() : Constants::NahdXml::xmlValueFalse());
@@ -83,6 +84,7 @@ InstrumentSettings::InstrumentSettingsU InstrumentSettings::deserializeFromXml(Q
     }
 
     settings->transpose = Utils::Xml::readIntAttribute(reader, Constants::NahdXml::xmlKeyTranspose(), false).value_or(0);
+    settings->drumTrack = Utils::Xml::readBoolAttribute(reader, Constants::NahdXml::xmlKeyDrumTrack(), false).value_or(false);
 
     // Migration: Read old standard MIDI CC settings and convert to generic MIDI CC settings
     if (const auto cutoff = Utils::Xml::readUIntAttribute(reader, Constants::NahdXml::xmlKeyCutoff(), false)) {

src/domain/instrument_settings.hpp

@@ -48,6 +48,8 @@ class InstrumentSettings : public EventData
 
     int transpose { 0 };
 
+    bool drumTrack = false;
+
     struct TimingSettings
     {
         std::optional<bool> sendMidiClock;

src/domain/pattern.cpp

@@ -22,6 +22,7 @@
 #include "../contrib/SimpleLogger/src/simple_logger.hpp"
 #include "../domain/note_data.hpp"
 #include "column_settings.hpp"
+#include "instrument.hpp"
 #include "track.hpp"
 
 #include <QXmlStreamWriter>
@@ -375,6 +376,9 @@ NoteChangeList Pattern::transposePattern(const Position & position, int semitone
 {
     NoteChangeList changes;
     for (const auto & track : m_trackOrder) {
+        if (track->instrument() && track->instrument()->settings().drumTrack) {
+            continue;
+        }
         auto trackPosition = position;
         trackPosition.track = track->index(); // Need to set track because these positions will be returned back as changed positions.
         auto trackChanges = track->transposeTrack(trackPosition, semitones);

src/unit_tests/song_test/song_test.cpp

@@ -908,6 +908,47 @@ void SongTest::test_renderToEvents_midiSideChain_shouldClampAttackEvents()
     QVERIFY(targetEventFound);
 }
 
+void SongTest::test_transposePattern_drumTrackSet_shouldNotTransposeDrumTrack()
+{
+    Song song;
+    
+    // Setup Track 0 as Drum Track
+    auto drumInstrument = std::make_shared<Instrument>("");
+    auto drumSettings = drumInstrument->settings();
+    drumSettings.drumTrack = true;
+    drumInstrument->setSettings(drumSettings);
+    song.setInstrument(0, drumInstrument);
+    
+    // Setup Track 1 as normal track
+    auto normalInstrument = std::make_shared<Instrument>("");
+    song.setInstrument(1, normalInstrument);
+
+    // Add note to Track 0 (should NOT be transposed)
+    const Position pos0 = { 0, 0, 0, 0, 0 };
+    song.noteDataAtPosition(pos0)->setAsNoteOn(60, 100);
+
+    // Add note to Track 1 (should be transposed)
+    const Position pos1 = { 0, 1, 0, 0, 0 };
+    song.noteDataAtPosition(pos1)->setAsNoteOn(60, 100);
+
+    // Transpose pattern by 1 semitone
+    const auto changes = song.transposePattern({ 0, 0, 0, 0, 0 }, 1);
+
+    // Check results
+    // pos0 (Drum Track) should NOT be in changes
+    const auto it0 = std::find_if(changes.begin(), changes.end(), [&](auto && change) {
+        return change.position == pos0;
+    });
+    QVERIFY(it0 == changes.end());
+
+    // pos1 (Normal Track) SHOULD be in changes
+    const auto it1 = std::find_if(changes.begin(), changes.end(), [&](auto && change) {
+        return change.position == pos1;
+    });
+    QVERIFY(it1 != changes.end());
+    QCOMPARE(it1->newNoteData.note().value(), 61);
+}
+
 void SongTest::test_duration_skippedPattern_shouldReturnCorrectDuration()
 {
     Song song;