midi: add option to disable channel 9 to drum track

Currently, any channel 9 in a MIDI file is automatically added as a drum
instead of a melodic track. Which generally is the correct thing to do,
as this is how MIDI has it specified and standardized.

This new option allows to disable this behaviour though. Which is
especially useful when using DLS (DownLoadable Sound) as DLS has a per
channel bit to specify if it is a drum or melodic track.

Some extracted DLS files from N64 games, extracted via the
N64 Soundbank Tool (https://github.com/jombo23/N64-Tools/tree/master/N64SoundbankTool)
for instance, use a channel 9 and have the drum bit in DLS unset.
So this option would be needed to play such files
correctly.

The ANMP media player (https://github.com/derselbst/ANMP) has a similar option.

According to a disscussion on the FluidSynth issue tracker there
apparently is no way to detect and fix such a conflict between DLS and MIDI
automatically, hence such a manual option seems needed:
FluidSynth/fluidsynth#1576

Signed-off-by: Linus Lüssing <linus.luessing@c0d3.blue>

Author: T-X

src/appshell/qml/Preferences/ImportPreferencesPage.qml

@@ -121,6 +121,7 @@ PreferencesPage {
         MidiSection {
             shortestNotes: importPreferencesModel.shortestNotes()
             currentShortestNote: importPreferencesModel.currentShortestNote
+            channel9isDrum: importPreferencesModel.currentChannel9isDrum
 
             navigation.section: root.navigationSection
             navigation.order: root.navigationOrderStart + 4
@@ -129,6 +130,10 @@ PreferencesPage {
                 importPreferencesModel.currentShortestNote = note
             }
 
+            onCurrentChannel9isDrumChangeRequested: function(isDrum) {
+                importPreferencesModel.currentChannel9isDrum = isDrum
+	    }
+
             onFocusChanged: {
                 if (activeFocus) {
                     root.ensureContentVisibleRequested(Qt.rect(x, y, width, height))

src/appshell/qml/Preferences/internal/MidiSection.qml

@@ -29,9 +29,11 @@ BaseSection {
     title: qsTrc("appshell/preferences", "MIDI")
 
     property alias shortestNotes: shortestNotesBox.model
+    property alias channel9isDrum: channel9isDrumBox.checked
     property int currentShortestNote: 0
 
     signal currentShortestNoteChangeRequested(int note)
+    signal currentChannel9isDrumChangeRequested(bool isDrum)
 
     ComboBoxWithTitle {
         id: shortestNotesBox
@@ -52,4 +54,19 @@ BaseSection {
             root.currentShortestNoteChangeRequested(newValue)
         }
     }
+
+    CheckBox {
+        id: channel9isDrumBox
+        width: parent.width
+
+        text: qsTrc("appshell/preferences", "Channel 9 is drum")
+
+        navigation.name: "Channel9isDrum"
+        navigation.panel: root.navigation
+        navigation.row: 1
+
+        onClicked: {
+            root.currentChannel9isDrumChangeRequested(!checked)
+        }
+    }
 }

src/appshell/view/preferences/importpreferencesmodel.cpp

@@ -64,6 +64,10 @@ void ImportPreferencesModel::load()
         emit currentShortestNoteChanged(val);
     });
 
+    midiImportExportConfiguration()->midiChannel9isDrumChanged().onReceive(this, [this](bool isDrum) {
+        emit currentChannel9isDrumChanged(isDrum);
+    });
+
     meiConfiguration()->meiImportLayoutChanged().onReceive(this, [this](bool val) {
         emit meiImportLayoutChanged(val);
     });
@@ -155,6 +159,11 @@ int ImportPreferencesModel::currentShortestNote() const
     return midiImportExportConfiguration()->midiShortestNote();
 }
 
+bool ImportPreferencesModel::currentChannel9isDrum() const
+{
+    return midiImportExportConfiguration()->midiChannel9isDrum();
+}
+
 bool ImportPreferencesModel::needAskAboutApplyingNewStyle() const
 {
     return musicXmlConfiguration()->needAskAboutApplyingNewStyle();
@@ -235,6 +244,16 @@ void ImportPreferencesModel::setCurrentShortestNote(int note)
     emit currentShortestNoteChanged(note);
 }
 
+void ImportPreferencesModel::setCurrentChannel9isDrum(bool isDrum)
+{
+    if (isDrum == currentChannel9isDrum()) {
+        return;
+    }
+
+    midiImportExportConfiguration()->setMidiChannel9isDrum(isDrum);
+    emit currentChannel9isDrumChanged(isDrum);
+}
+
 void ImportPreferencesModel::setNeedAskAboutApplyingNewStyle(bool value)
 {
     if (value == needAskAboutApplyingNewStyle()) {

src/appshell/view/preferences/importpreferencesmodel.h

@@ -53,6 +53,8 @@ class ImportPreferencesModel : public QObject, public muse::Injectable, public m
 
     Q_PROPERTY(int currentShortestNote READ currentShortestNote WRITE setCurrentShortestNote NOTIFY currentShortestNoteChanged)
 
+    Q_PROPERTY(bool currentChannel9isDrum READ currentChannel9isDrum WRITE setCurrentChannel9isDrum NOTIFY currentChannel9isDrumChanged)
+
     Q_PROPERTY(
         bool needAskAboutApplyingNewStyle READ needAskAboutApplyingNewStyle WRITE setNeedAskAboutApplyingNewStyle NOTIFY needAskAboutApplyingNewStyleChanged)
 
@@ -83,6 +85,7 @@ class ImportPreferencesModel : public QObject, public muse::Injectable, public m
     bool inferTextType() const;
 
     int currentShortestNote() const;
+    bool currentChannel9isDrum() const;
 
     bool needAskAboutApplyingNewStyle() const;
 
@@ -98,6 +101,7 @@ public slots:
     void setInferTextType(bool value);
 
     void setCurrentShortestNote(int note);
+    void setCurrentChannel9isDrum(bool isDrum);
 
     void setNeedAskAboutApplyingNewStyle(bool value);
 
@@ -111,6 +115,7 @@ public slots:
     void needUseDefaultFontChanged(bool needUseDefaultFont);
     void inferTextTypeChanged(bool inferTextType);
     void currentShortestNoteChanged(int currentShortestNote);
+    void currentChannel9isDrumChanged(bool currentChannel9isDrum);
     void needAskAboutApplyingNewStyleChanged(bool needAskAboutApplyingNewStyle);
     void meiImportLayoutChanged(bool importLayout);
 };

src/importexport/midi/imidiconfiguration.h

@@ -41,6 +41,10 @@ class IMidiImportExportConfiguration : MODULE_EXPORT_INTERFACE
     virtual void setMidiShortestNote(int ticks) = 0;
     virtual muse::async::Channel<int> midiShortestNoteChanged() const = 0;
 
+    virtual bool midiChannel9isDrum() const = 0;
+    virtual void setMidiChannel9isDrum(bool isDrum) = 0;
+    virtual muse::async::Channel<bool> midiChannel9isDrumChanged() const = 0;
+
     virtual void setMidiImportOperationsFile(const std::optional<muse::io::path_t>& filePath) const = 0;
 
     // export

src/importexport/midi/internal/midiconfiguration.cpp

@@ -32,6 +32,7 @@ using namespace muse;
 using namespace mu::iex::midi;
 
 static const Settings::Key SHORTEST_NOTE_KEY("iex_midi", "io/midi/shortestNote");
+static const Settings::Key CHANNEL9_IS_DRUM_KEY("iex_midi", "io/midi/channel9isDrum");
 static const Settings::Key EXPORTRPNS_KEY("iex_midi", "io/midi/exportRPNs");
 static const Settings::Key EXPAND_REPEATS_KEY("iex_midi", "io/midi/expandRepeats");
 
@@ -42,6 +43,11 @@ void MidiConfiguration::init()
         m_midiShortestNoteChanged.send(val.toInt());
     });
 
+    settings()->setDefaultValue(CHANNEL9_IS_DRUM_KEY, Val(true));
+    settings()->valueChanged(CHANNEL9_IS_DRUM_KEY).onReceive(this, [this](const Val& val) {
+        m_midiChannel9isDrumChanged.send(val.toBool());
+    });
+
     settings()->setDefaultValue(EXPAND_REPEATS_KEY, Val(true));
     settings()->setDefaultValue(EXPORTRPNS_KEY, Val(true));
 }
@@ -61,6 +67,21 @@ async::Channel<int> MidiConfiguration::midiShortestNoteChanged() const
     return m_midiShortestNoteChanged;
 }
 
+bool MidiConfiguration::midiChannel9isDrum() const
+{
+    return settings()->value(CHANNEL9_IS_DRUM_KEY).toBool();
+}
+
+void MidiConfiguration::setMidiChannel9isDrum(bool isDrum)
+{
+    settings()->setSharedValue(CHANNEL9_IS_DRUM_KEY, Val(isDrum));
+}
+
+async::Channel<bool> MidiConfiguration::midiChannel9isDrumChanged() const
+{
+    return m_midiChannel9isDrumChanged;
+}
+
 void MidiConfiguration::setMidiImportOperationsFile(const std::optional<muse::io::path_t>& filePath) const
 {
     if (filePath) {

src/importexport/midi/internal/midiconfiguration.h

@@ -37,6 +37,10 @@ class MidiConfiguration : public IMidiImportExportConfiguration, public muse::as
     void setMidiShortestNote(int ticks) override;
     muse::async::Channel<int> midiShortestNoteChanged() const override;
 
+    bool midiChannel9isDrum() const override;
+    void setMidiChannel9isDrum(bool isDrum) override;
+    muse::async::Channel<bool> midiChannel9isDrumChanged() const override;
+
     void setMidiImportOperationsFile(const std::optional<muse::io::path_t>& filePath) const override;
 
     // export
@@ -48,6 +52,7 @@ class MidiConfiguration : public IMidiImportExportConfiguration, public muse::as
 
 private:
     muse::async::Channel<int> m_midiShortestNoteChanged;
+    muse::async::Channel<bool> m_midiChannel9isDrumChanged;
 };
 }
 

src/importexport/midi/internal/midishared/midifile.cpp

@@ -22,6 +22,9 @@
 
 #include "midifile.h"
 
+#include "modularity/ioc.h"
+#include "importexport/midi/imidiconfiguration.h"
+
 #include "containers.h"
 
 #include "log.h"
@@ -676,8 +679,11 @@ bool MidiFile::readEvent(MidiEvent* event)
 
 void MidiTrack::setOutChannel(int n)
 {
+    auto conf = muse::modularity::globalIoc()->resolve<mu::iex::midi::IMidiImportExportConfiguration>("iex_midi");
+
     _outChannel = n;
-    if (_outChannel == 9) {
+
+    if (conf->midiChannel9isDrum() &&_outChannel == 9) {
         _drumTrack = true;
     }
 }