MT32 device & basic MIDI driver (#258)

* mt32 midi driver init

* MT32 MIDI basic driver playback and example

* fix build

* fix test suite

* code rev

* MT32 Report Handler

* code rev

* code rev

* code rev

* mt32 sysex lcd message

* code rev

* sonarcloud code rev

* code rev

* update version

Author: Raffaello

CMakeLists.txt

@@ -5,7 +5,7 @@ if(DEFINED ENV{VCPKG_ROOT} AND NOT DEFINED CMAKE_TOOLCHAIN_FILE)
 endif()
 
 
-project ("sdl2-hyper-sonic-drivers" VERSION 0.11.0 DESCRIPTION "SDL2 based Hyper-Sonic Drivers for emulating old soundcards")
+project ("sdl2-hyper-sonic-drivers" VERSION 0.12.0 DESCRIPTION "SDL2 based Hyper-Sonic Drivers for emulating old soundcards")
 include (TestBigEndian)
 TEST_BIG_ENDIAN(IS_BIG_ENDIAN)
 if(IS_BIG_ENDIAN)

sdl2-hyper-sonic-drivers/CMakeLists.txt

@@ -116,6 +116,8 @@ target_sources(${LIB_NAME} PRIVATE
     ${CMAKE_CURRENT_SOURCE_DIR}/src/HyperSonicDrivers/drivers/midi/opl/OplChannel.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/src/HyperSonicDrivers/drivers/midi/opl/OplVoice.cpp
 
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/HyperSonicDrivers/drivers/midi/mt32/MT32Driver.cpp
+
     ${CMAKE_CURRENT_SOURCE_DIR}/src/HyperSonicDrivers/drivers/opl/OplWriter.cpp
     # --- #
     ${CMAKE_CURRENT_SOURCE_DIR}/src/HyperSonicDrivers/files/File.cpp
@@ -158,6 +160,7 @@ target_sources(${LIB_NAME} PRIVATE
     ${CMAKE_CURRENT_SOURCE_DIR}/src/HyperSonicDrivers/hardware/opl/woody/WoodyEmuOPL.cpp
     # --- #
     ${CMAKE_CURRENT_SOURCE_DIR}/src/HyperSonicDrivers/hardware/mt32/MT32.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/HyperSonicDrivers/hardware/mt32/MT32ReportHandler.cpp
     # --- #
     ${CMAKE_CURRENT_SOURCE_DIR}/src/HyperSonicDrivers/hardware/PCSpeaker.cpp
     # --- #

sdl2-hyper-sonic-drivers/examples/CMakeLists.txt

@@ -119,3 +119,13 @@ macro_example(
       "../test/fixtures/GENMIDI.OP2"
     NONE
 )
+
+macro_example(
+    EXE MT32example
+    FILE "mt32-example.cpp"
+    DEPS hyper-sonic-drivers-static
+    LINKS ${LIB_SDL2main} hyper-sonic-drivers-static spdlog::spdlog
+    FIXTURES 
+      "../test/fixtures/MI_intro.mid"
+    NONE
+)

sdl2-hyper-sonic-drivers/examples/mt32-example.cpp

@@ -0,0 +1,51 @@
+#include <HyperSonicDrivers/audio/sdl2/Mixer.hpp>
+#include <HyperSonicDrivers/drivers/MIDDriver.hpp>
+#include <HyperSonicDrivers/files/MIDFile.hpp>
+#include <HyperSonicDrivers/devices/MT32.hpp>
+#include <HyperSonicDrivers/utils/algorithms.hpp>
+
+#include <memory>
+#include <spdlog/spdlog.h>
+#include <fmt/chrono.h>
+#include <fmt/color.h>
+#include <map>
+
+#include <HyperSonicDrivers/utils/ILogger.hpp>
+
+using namespace HyperSonicDrivers;
+
+int main(int argc, char* argv[])
+{
+    using audio::mixer::eChannelGroup;
+
+    utils::ILogger::instance->setLevelAll(utils::ILogger::eLevel::Trace);
+    spdlog::warn("MT32 requires 2 ROMs files not included in this example");
+    spdlog::warn("the ROM filenames assumed to be fund in the current working directory are:");
+    spdlog::warn("MT32_CONTROL.ROM  --- MT32_PCM.ROM");
+
+    auto mixer = audio::make_mixer<audio::sdl2::Mixer>(8, 44100, 1024);
+    if (!mixer->init())
+    {
+        spdlog::error("can't init mixer");
+        return 1;
+    }
+
+    auto mt32 = devices::make_device<devices::MT32>(mixer, "MT32_CONTROL.ROM", "MT32_PCM.ROM");
+
+    if (!mt32->init())
+    {
+        spdlog::error("can't init MT32 device");
+        return 2;
+    }
+
+    auto midFile = std::make_shared<files::MIDFile>("MI_intro.mid");
+    auto midi = midFile->getMIDI();
+
+    drivers::MIDDriver middrv(mt32, eChannelGroup::Music);
+    middrv.setMidi(midi);
+    middrv.play(0);
+    while (middrv.isPlaying())
+    {
+        utils::delayMillis(100);
+    }
+}

sdl2-hyper-sonic-drivers/src/HyperSonicDrivers/devices/IDevice.cpp

@@ -2,8 +2,8 @@
 
 namespace HyperSonicDrivers::devices
 {
-    IDevice::IDevice(const std::shared_ptr<audio::IMixer>& mixer, const bool isOpl) :
-        m_mixer(mixer), m_isOpl(isOpl)
+    IDevice::IDevice(const std::shared_ptr<audio::IMixer>& mixer, const eDeviceType type) :
+        type(type), m_mixer(mixer)
     {
     }
 

sdl2-hyper-sonic-drivers/src/HyperSonicDrivers/devices/IDevice.hpp

@@ -7,6 +7,7 @@
 #include <HyperSonicDrivers/drivers/IMusicDriver.hpp>
 #include <HyperSonicDrivers/drivers/midi/IMidiDriver.hpp>
 #include <HyperSonicDrivers/hardware/IHardware.hpp>
+#include <HyperSonicDrivers/devices/types.hpp>
 
 namespace HyperSonicDrivers::devices
 {
@@ -17,7 +18,7 @@ namespace HyperSonicDrivers::devices
     class IDevice
     {
     public:
-        IDevice(const std::shared_ptr<audio::IMixer>& mixer, const bool isOpl = false);
+        IDevice(const std::shared_ptr<audio::IMixer>& mixer, const eDeviceType type);
         virtual ~IDevice() = default;
 
         virtual bool init() noexcept = 0;
@@ -38,14 +39,13 @@ namespace HyperSonicDrivers::devices
         void setVolumePan(const uint8_t volume, const uint8_t pan);
 
         inline std::shared_ptr<audio::IMixer> getMixer() const noexcept { return m_mixer; };
-        inline bool isOpl() const noexcept { return m_isOpl; };
         virtual hardware::IHardware* getHardware() const noexcept { return m_hardware; };
+        const eDeviceType type;
     protected:
         bool m_init = false;
         std::shared_ptr<audio::IMixer> m_mixer;
-        hardware::IHardware* m_hardware;
+        hardware::IHardware* m_hardware = nullptr;
     private:
-        bool m_isOpl = false;
         // TODO: remove the atomic when removing the thread in MIDDrv
         std::atomic<bool> m_acquired = false;
         std::atomic<drivers::IMusicDriver*> m_owner = nullptr;

sdl2-hyper-sonic-drivers/src/HyperSonicDrivers/devices/MT32.cpp

@@ -4,103 +4,41 @@
 
 namespace HyperSonicDrivers::devices
 {
-    // test
-    static audio::midi::MIDIEvent MT32SysEx(uint32_t addr, const uint8_t* data, uint32_t dataSize)
-    {
-        //typedef uint8_t byte;
-        //uint32_t dataSize = 0;
-        //uint8_t* data = nullptr;
-        //uint32_t addr = 0x1FC000;
-        static const uint8_t header[] = { 0x41, 0x10, 0x16, 0x12 };
-
-        uint8_t* msg = new uint8_t[sizeof(header) + 4 + dataSize];
-        memcpy(msg, header, sizeof(header));
-        uint8_t* dst = msg + sizeof(header);
-        const uint8_t* src = dst;
-
-        *dst++ = (addr >> 14) & 0x7F;
-        *dst++ = (addr >> 7) & 0x7F;
-        *dst++ = addr & 0x7F;
-
-        while (dataSize) {
-            *dst++ = *data++;
-            --dataSize;
-        }
-
-        uint8_t checkSum = 0;
-        while (src < dst)
-            checkSum -= *src++;
-
-        *dst++ = checkSum & 0x7F;
-
-        dataSize = dst - msg;
-        audio::midi::MIDIEvent e;
-        for (int i = 0; i < sizeof(header) + 4 + dataSize; i++)
-            e.data.push_back(msg[i]);
-
-        delete[] msg;
-
-        return e;
-    }
-
-
     MT32::MT32(
         const std::shared_ptr<audio::IMixer>& mixer,
         const std::filesystem::path& control_rom_file,
         const std::filesystem::path& pcm_rom_file) :
-        IDevice(mixer, false)
+        IDevice(mixer, eDeviceType::Mt32)
     {
         m_mt32 = std::make_shared<hardware::mt32::MT32>(control_rom_file, pcm_rom_file, mixer);
-        if (!m_mt32->init())
-        {
-            utils::throwLogC<std::runtime_error>(std::format("Can't init device MT32"));
-        }
-
-        m_mt32->start(nullptr);
-
-        // test
-
-        // reset MT32
-        //m_mt32->m_service.playSysex(MT32SysEx(0x1FC000, 0, 0));
-        utils::delayMillis(250);
+        m_hardware = m_mt32.get();
+    }
 
-        // Setup master tune, reverb mode, reverb time, reverb level, channel mapping, partial reserve and master volume
-        static const uint8_t initSysex1[] = "\x40\x00\x04\x04\x04\x04\x04\x04\x04\x04\x04\x04\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x64";
-        //sendSysEx(MT32SysEx(0x40000, initSysex1, sizeof(initSysex1) - 1));
-        utils::delayMillis(40);
-        // Map percussion to notes 24 - 34 without reverb. It still happens in the DOTT driver, but not in the SAMNMAX one.
-        static const uint8_t initSysex2[] = "\x40\x64\x07\x00\x4a\x64\x06\x00\x41\x64\x07\x00\x4b\x64\x08\x00\x45\x64\x06\x00\x44\x64"
-            "\x0b\x00\x51\x64\x05\x00\x43\x64\x08\x00\x50\x64\x07\x00\x42\x64\x03\x00\x4c\x64\x07\x00";
-        //sendSysEx(MT32SysEx(0xC090, initSysex2, sizeof(initSysex2) - 1));
-        utils::delayMillis(40);
+    bool MT32::init() noexcept
+    {
+        // TODO: it can be bring up into the parent class using IHardware check if not nullptr
+        if (isInit())
+            return true;
 
+        m_init = m_mt32->init();
 
-        const uint8_t pbRange = 0x10;
-        for (int i = 0; i < 128; ++i) {
-            //sendSysEx(MT32SysEx(0x014004 + (i << 3), &pbRange, 1));
-            utils::delayMillis(5);
-        }
+        return m_init;
     }
 
-   /* void MidiMT32::sendEvent(const audio::midi::MIDIEvent& e) const noexcept
+    bool MT32::shutdown() noexcept
     {
-        m_mt32->m_service.playMsg(e.toUint32());
+        // TODO: it can be bring up into the parent class using iHardware checkin if not nullptr
+        m_mt32->stop();
+        return false;
     }
 
-    void MidiMT32::sendMessage(const uint8_t msg[], const uint8_t size) const noexcept
+    void MT32::lcd_message(const std::string& msg) noexcept
     {
+        m_mt32->sysEx(
+            hardware::mt32::mt32_sysex_addr_LCD,
+            std::bit_cast<const uint8_t*>(msg.c_str()),
+            //reinterpret_cast<const uint8_t*>(msg.c_str()),
+            static_cast<uint32_t>(msg.size())
+        );
     }
-
-    void MidiMT32::sendSysEx(const audio::midi::MIDIEvent& e) const noexcept
-    {
-        m_mt32->m_service.playSysex(e.data.data(), e.data.size());
-    }*/
-
-    //void MT32::pause() const noexcept
-    //{
-    //}
-
-    //void MT32::resume() const noexcept
-    //{
-    //}
 }

sdl2-hyper-sonic-drivers/src/HyperSonicDrivers/devices/MT32.hpp

@@ -3,6 +3,7 @@
 #include <cstdint>
 #include <memory>
 #include <filesystem>
+#include <string>
 #include <HyperSonicDrivers/audio/IMixer.hpp>
 #include <HyperSonicDrivers/audio/midi/MIDIEvent.hpp>
 #include <HyperSonicDrivers/devices/IDevice.hpp>
@@ -20,9 +21,12 @@ namespace HyperSonicDrivers::devices
         );
         ~MT32() override = default;
 
-        virtual bool init() noexcept = 0;
-        virtual bool shutdown() noexcept = 0;
+        bool init() noexcept override;
+        bool shutdown() noexcept override;
 
+        inline std::shared_ptr<hardware::mt32::MT32> getMt32() const noexcept { return m_mt32; };
+
+        void lcd_message(const std::string& msg) noexcept;
     private:
         std::shared_ptr<hardware::mt32::MT32> m_mt32;
     };

sdl2-hyper-sonic-drivers/src/HyperSonicDrivers/devices/Opl.cpp

@@ -15,7 +15,7 @@ namespace HyperSonicDrivers::devices
         const hardware::opl::OplEmulator emulator,
         const hardware::opl::OplType type,
         const uint8_t volume, const uint8_t pan) :
-        IDevice(mixer, true)
+        IDevice(mixer, eDeviceType::Opl)
     {
         using hardware::opl::OPLFactory;
         using utils::logC;
@@ -26,6 +26,7 @@ namespace HyperSonicDrivers::devices
 
     bool Opl::init() noexcept
     {
+        // TODO can be put in the parent class using IHardware*
         if (isInit())
             return true;
 
@@ -41,6 +42,7 @@ namespace HyperSonicDrivers::devices
 
     bool Opl::shutdown() noexcept
     {
+        // TODO: can be put in the parent calss using iHardware*
         if (m_opl != nullptr)
             m_opl->stop();
 

sdl2-hyper-sonic-drivers/src/HyperSonicDrivers/devices/types.hpp

@@ -0,0 +1,10 @@
+#pragma once
+
+namespace HyperSonicDrivers::devices
+{
+    enum class eDeviceType
+    {
+        Opl = 0,
+        Mt32,
+    };
+}