feat: support dumping FM channel parameters

Author: rhargreaves

.cursor/rules/ym2612-tips.mdc

@@ -0,0 +1,6 @@
+---
+description:
+globs:
+alwaysApply: true
+---
+- When the YM2612 regs are being changed the Z80 bus is requested. Failing tests which report "No entries for symbol __wrap_Z80_getAndRequestBus" are probably doing so as the YM2612 is being written to. For example, note on, FM parameter change.

src/midi.c

@@ -736,6 +736,65 @@ static void send_preset_data(u8 type, u8 program, const FmPreset* preset)
     midi_tx_send_sysex(sysexData, index);
 }
 
+static void send_channel_data(u8 type, u8 midiChannel, const FmPreset* preset)
+{
+    u8 sysexData[4 + 2 + 4 + (MAX_FM_OPERATORS * 11)];
+    u16 index = 0;
+
+    sysexData[index++] = SYSEX_MANU_EXTENDED;
+    sysexData[index++] = SYSEX_MANU_REGION;
+    sysexData[index++] = SYSEX_MANU_ID;
+    sysexData[index++] = SYSEX_COMMAND_CHANNEL_DATA;
+
+    sysexData[index++] = type;
+    sysexData[index++] = midiChannel;
+
+    sysexData[index++] = preset->algorithm;
+    sysexData[index++] = preset->feedback;
+    sysexData[index++] = preset->ams;
+    sysexData[index++] = preset->fms;
+
+    for (u8 i = 0; i < MAX_FM_OPERATORS; i++) {
+        sysexData[index++] = preset->operators[i].multiple;
+        sysexData[index++] = preset->operators[i].detune;
+        sysexData[index++] = preset->operators[i].attackRate;
+        sysexData[index++] = preset->operators[i].rateScaling;
+        sysexData[index++] = preset->operators[i].decayRate;
+        sysexData[index++] = preset->operators[i].amplitudeModulation;
+        sysexData[index++] = preset->operators[i].sustainLevel;
+        sysexData[index++] = preset->operators[i].sustainRate;
+        sysexData[index++] = preset->operators[i].releaseRate;
+        sysexData[index++] = preset->operators[i].totalLevel;
+        sysexData[index++] = preset->operators[i].ssgEg;
+    }
+
+    midi_tx_send_sysex(sysexData, index);
+}
+
+static void dump_channel_request(const u8* data, u16 length)
+{
+    u8 type = data[0];
+    u8 midiChannel = data[1];
+
+    switch (type) {
+    case STORE_PROGRAM_TYPE_FM: {
+        DeviceChannel* devChan = deviceChannelByMidiChannel(midiChannel);
+        if (devChan == NULL || devChan->ops != &FM_VTable) {
+            log_warn("Ch %d: No FM channel assigned", midiChannel + 1);
+            return;
+        }
+        FmPreset currentPreset;
+        synth_extract_preset(devChan->num, &currentPreset);
+        send_channel_data(type, midiChannel, &currentPreset);
+        log_info("Ch %d: FM %d dumped", midiChannel + 1, devChan->num);
+        break;
+    }
+    default:
+        log_warn("Invalid dump channel request type: %d", type);
+        break;
+    }
+}
+
 static void dump_preset_request(const u8* data, u16 length)
 {
     u8 type = data[0];
@@ -781,6 +840,8 @@ static const SysexCommand SYSEX_COMMANDS[] = {
     { SYSEX_COMMAND_CLEAR_ALL_PROGRAMS, clear_all_programs, 1, true },
     { SYSEX_COMMAND_DUMP_PRESET, dump_preset_request, 2, true },
     { SYSEX_COMMAND_PRESET_DATA, NULL, 0, false },
+    { SYSEX_COMMAND_DUMP_CHANNEL, dump_channel_request, 2, true },
+    { SYSEX_COMMAND_CHANNEL_DATA, NULL, 0, false },
 };
 
 void midi_sysex(const u8* data, u16 length)

src/midi.h

@@ -130,6 +130,8 @@
 #define SYSEX_COMMAND_CLEAR_ALL_PROGRAMS 0x0C
 #define SYSEX_COMMAND_DUMP_PRESET 0x0D
 #define SYSEX_COMMAND_PRESET_DATA 0x0E
+#define SYSEX_COMMAND_DUMP_CHANNEL 0x0F
+#define SYSEX_COMMAND_CHANNEL_DATA 0x10
 
 #define STORE_PROGRAM_TYPE_FM 0x00
 #define STORE_PROGRAM_TYPE_PSG 0x01

tests/system/main.c

@@ -28,6 +28,7 @@ int main(void)
         e2e_test(test_midi_changing_program_retains_pan),
         e2e_test(test_midi_portamento_glides_note),
         e2e_test(test_dump_preset_to_callee),
+        e2e_test(test_dump_channel_parameters_to_callee),
         // WIP: e2e_test(test_midi_pitch_bend_range_configurable_per_channel),
         // clang-format on
     };

tests/system/test_e2e.c

@@ -10,6 +10,7 @@
 #include "mocks/mock_comm.h"
 #include "mocks/mock_sgdk.h"
 #include "mocks/mock_psg.h"
+#include "mocks/mock_log.h"
 #include "ym2612_regs.h"
 #include "test_helpers.h"
 
@@ -476,3 +477,40 @@ void test_dump_preset_to_callee(void** state)
 
     midi_rx_read();
 }
+
+void test_dump_channel_parameters_to_callee(void** state)
+{
+    stub_everdrive_as_present();
+
+    const u8 midiChannel = 0;
+
+    // Change the algorithm via CC
+    expect_ym2612_write_reg(YM_CH1, YM_REG(YM_BASE_ALGORITHM_FEEDBACK, YM_CH1), 7);
+    stub_usb_receive_cc(MIDI_CHANNEL_1, CC_GENMDM_FM_ALGORITHM, 127);
+    midi_rx_read();
+
+    // Change the feedback via CC
+    expect_ym2612_write_reg(YM_CH1, YM_REG(YM_BASE_ALGORITHM_FEEDBACK, YM_CH1), 0x3F);
+    stub_usb_receive_cc(MIDI_CHANNEL_1, CC_GENMDM_FM_FEEDBACK, 127);
+    midi_rx_read();
+
+    const u8 dumpChannelRequestSeq[] = { SYSEX_START, SYSEX_MANU_EXTENDED, SYSEX_MANU_REGION,
+        SYSEX_MANU_ID, 0x0F, STORE_PROGRAM_TYPE_FM, midiChannel, SYSEX_END };
+
+    for (u16 i = 0; i < sizeof(dumpChannelRequestSeq); i++) {
+        stub_usb_receive_byte(dumpChannelRequestSeq[i]);
+    }
+
+    // Expect MDMI to send back the channel data with command 0x10
+    const u8 dumpChannelResponseSeq[] = { SYSEX_START, SYSEX_MANU_EXTENDED, SYSEX_MANU_REGION,
+        SYSEX_MANU_ID, 0x10, STORE_PROGRAM_TYPE_FM, midiChannel, 0x07, 0x07, 0x00, 0x00, 0x01, 0x00,
+        0x1A, 0x01, 0x07, 0x00, 0x07, 0x04, 0x01, 0x27, 0x00, 0x02, 0x07, 0x1F, 0x03, 0x17, 0x00,
+        0x09, 0x0F, 0x01, 0x04, 0x00, 0x04, 0x06, 0x18, 0x01, 0x09, 0x00, 0x06, 0x09, 0x07, 0x24,
+        0x00, 0x01, 0x03, 0x1B, 0x02, 0x04, 0x00, 0x0A, 0x04, 0x06, 0x02, 0x00, SYSEX_END };
+
+    for (u16 i = 0; i < sizeof(dumpChannelResponseSeq); i++) {
+        expect_usb_sent_byte(dumpChannelResponseSeq[i]);
+    }
+
+    midi_rx_read();
+}

tests/system/test_e2e.h

@@ -23,3 +23,4 @@ void test_midi_portamento_glides_note(void** state);
 void test_pitch_bends_ch3_special_mode_operators(void** state);
 void test_midi_pitch_bend_range_configurable_per_channel(void** state);
 void test_dump_preset_to_callee(void** state);
+void test_dump_channel_parameters_to_callee(void** state);