From 34f6a303a6dedd692e5d2e69161e2a06399752e9 Mon Sep 17 00:00:00 2001
From: tildearrow <tildearrow@protonmail.com>
Date: Tue, 20 Dec 2022 17:40:45 -0500
Subject: [PATCH] prepare for more CSM

---
 src/engine/platform/fmshared_OPN.h |  4 +-
 src/engine/platform/genesis.cpp    |  8 ++--
 src/engine/platform/genesis.h      |  2 +-
 src/engine/platform/genesisext.cpp | 26 ++++++-------
 src/engine/song.h                  |  7 +++-
 src/engine/sysDef.cpp              | 60 ++++++++++++++++++++++++++++++
 6 files changed, 87 insertions(+), 20 deletions(-)

diff --git a/src/engine/platform/fmshared_OPN.h b/src/engine/platform/fmshared_OPN.h
index a8ec67723..769a1814b 100644
--- a/src/engine/platform/fmshared_OPN.h
+++ b/src/engine/platform/fmshared_OPN.h
@@ -147,17 +147,19 @@ class DivPlatformOPN: public DivPlatformFMBase {
     double fmFreqBase;
     unsigned int fmDivBase;
     unsigned int ayDiv;
+    unsigned char csmChan;
     bool extSys;
 
     DivConfig ayFlags;
 
     friend void putDispatchChip(void*,int);
     friend void putDispatchChan(void*,int,int);
-    DivPlatformOPN(double f=9440540.0, unsigned int d=72, unsigned int a=32, bool isExtSys=false):
+    DivPlatformOPN(double f=9440540.0, unsigned int d=72, unsigned int a=32, bool isExtSys=false, unsigned char cc=255):
       DivPlatformFMBase(),
       fmFreqBase(f),
       fmDivBase(d),
       ayDiv(a),
+      csmChan(cc),
       extSys(isExtSys) {}
 
 };
diff --git a/src/engine/platform/genesis.cpp b/src/engine/platform/genesis.cpp
index 288218da7..c375e51ff 100644
--- a/src/engine/platform/genesis.cpp
+++ b/src/engine/platform/genesis.cpp
@@ -554,7 +554,7 @@ int DivPlatformGenesis::dispatch(DivCommand c) {
   switch (c.cmd) {
     case DIV_CMD_NOTE_ON: {
       DivInstrument* ins=parent->getIns(chan[c.chan].ins,DIV_INS_FM);
-      if (c.chan==7 && extMode && softPCM) { // CSM
+      if (c.chan==csmChan && extMode && softPCM) { // CSM
         chan[c.chan].macroInit(ins);
         chan[c.chan].insChanged=false;
 
@@ -686,7 +686,7 @@ int DivPlatformGenesis::dispatch(DivCommand c) {
       break;
     }
     case DIV_CMD_NOTE_OFF:
-      if (c.chan>=5 && c.chan<7) {
+      if (c.chan>=5 && c.chan<csmChan) {
         chan[c.chan].dacSample=-1;
         if (dumpWrites) addWrite(0xffff0002,0);
         if (parent->song.brokenDACMode) {
@@ -781,7 +781,7 @@ int DivPlatformGenesis::dispatch(DivCommand c) {
         }
         break;
       }
-      if (c.chan==7) {
+      if (c.chan==csmChan) {
         int destFreq=NOTE_PERIODIC(c.value2);
         bool return2=false;
         if (destFreq>chan[c.chan].baseFreq) {
@@ -850,7 +850,7 @@ int DivPlatformGenesis::dispatch(DivCommand c) {
       break;
     }
     case DIV_CMD_LEGATO: {
-      if (c.chan==7) {
+      if (c.chan==csmChan) {
         chan[c.chan].baseFreq=NOTE_PERIODIC(c.value);
       } else if (c.chan>=5 && chan[c.chan].furnaceDac && chan[c.chan].dacMode) {
         chan[c.chan].baseFreq=parent->calcBaseFreq(1,1,c.value,false);
diff --git a/src/engine/platform/genesis.h b/src/engine/platform/genesis.h
index bd5d9afff..a6b7eec61 100644
--- a/src/engine/platform/genesis.h
+++ b/src/engine/platform/genesis.h
@@ -128,7 +128,7 @@ class DivPlatformGenesis: public DivPlatformOPN {
     int init(DivEngine* parent, int channels, int sugRate, const DivConfig& flags);
     void quit();
     DivPlatformGenesis():
-      DivPlatformOPN(9440540.0, 72, 32) {}
+      DivPlatformOPN(9440540.0, 72, 32, false, 7) {}
     ~DivPlatformGenesis();
 };
 #endif
diff --git a/src/engine/platform/genesisext.cpp b/src/engine/platform/genesisext.cpp
index 6bf151a0c..6443729ff 100644
--- a/src/engine/platform/genesisext.cpp
+++ b/src/engine/platform/genesisext.cpp
@@ -454,7 +454,7 @@ void DivPlatformGenesisExt::tick(bool sysTick) {
       }
     }
     if (writeSomething) {
-      if (chan[7].active) { // CSM
+      if (chan[csmChan].active) { // CSM
         writeMask^=0xf0;
       }
       /*printf(
@@ -589,17 +589,17 @@ void DivPlatformGenesisExt::tick(bool sysTick) {
   }
 
   if (extMode && softPCM) {
-    if (chan[7].freqChanged) {
-      chan[7].freq=parent->calcFreq(chan[7].baseFreq,chan[7].pitch,chan[7].fixedArp?chan[7].baseNoteOverride:chan[7].arpOff,chan[7].fixedArp,true,0,chan[7].pitch2,chipClock,CHIP_DIVIDER);
-      if (chan[7].freq<1) chan[7].freq=1;
-      if (chan[7].freq>1024) chan[7].freq=1024;
-      int wf=0x400-chan[7].freq;
+    if (chan[csmChan].freqChanged) {
+      chan[csmChan].freq=parent->calcFreq(chan[csmChan].baseFreq,chan[csmChan].pitch,chan[csmChan].fixedArp?chan[csmChan].baseNoteOverride:chan[csmChan].arpOff,chan[csmChan].fixedArp,true,0,chan[csmChan].pitch2,chipClock,CHIP_DIVIDER);
+      if (chan[csmChan].freq<1) chan[csmChan].freq=1;
+      if (chan[csmChan].freq>1024) chan[csmChan].freq=1024;
+      int wf=0x400-chan[csmChan].freq;
       immWrite(0x24,wf>>2);
       immWrite(0x25,wf&3);
-      chan[7].freqChanged=false;
+      chan[csmChan].freqChanged=false;
     }
 
-    if (chan[7].keyOff || chan[7].keyOn) {
+    if (chan[csmChan].keyOff || chan[csmChan].keyOn) {
       writeNoteOn=true;
       for (int i=0; i<4; i++) {
         writeMask|=opChan[i].active<<(4+i);
@@ -608,7 +608,7 @@ void DivPlatformGenesisExt::tick(bool sysTick) {
   }
 
   if (writeNoteOn) {
-    if (chan[7].active) { // CSM
+    if (chan[csmChan].active) { // CSM
       writeMask^=0xf0;
     }
     /*printf(
@@ -622,13 +622,13 @@ void DivPlatformGenesisExt::tick(bool sysTick) {
   }
 
   if (extMode && softPCM) {
-    if (chan[7].keyOn) {
+    if (chan[csmChan].keyOn) {
       immWrite(0x27,0x81);
-      chan[7].keyOn=false;
+      chan[csmChan].keyOn=false;
     }
-    if (chan[7].keyOff) {
+    if (chan[csmChan].keyOff) {
       immWrite(0x27,0x40);
-      chan[7].keyOff=false;
+      chan[csmChan].keyOff=false;
     }
   }
 }
diff --git a/src/engine/song.h b/src/engine/song.h
index cd2d59d0b..d564f3dac 100644
--- a/src/engine/song.h
+++ b/src/engine/song.h
@@ -119,7 +119,12 @@ enum DivSystem {
   DIV_SYSTEM_GA20,
   DIV_SYSTEM_PCM_DAC,
   DIV_SYSTEM_PONG,
-  DIV_SYSTEM_DUMMY
+  DIV_SYSTEM_DUMMY,
+  DIV_SYSTEM_YM2612_CSM,
+  DIV_SYSTEM_YM2610_CSM,
+  DIV_SYSTEM_YM2610B_CSM,
+  DIV_SYSTEM_OPN_CSM,
+  DIV_SYSTEM_PC98_CSM
 };
 
 struct DivSubSong {
diff --git a/src/engine/sysDef.cpp b/src/engine/sysDef.cpp
index bfade1f00..359a46486 100644
--- a/src/engine/sysDef.cpp
+++ b/src/engine/sysDef.cpp
@@ -1030,6 +1030,18 @@ void DivEngine::registerSystems() {
     fmOPNPostEffectHandlerMap
   );
 
+  sysDefs[DIV_SYSTEM_OPN_CSM]=new DivSysDef(
+    "Yamaha YM2203 (OPN) CSM", NULL, 0xc3, 0, 10, true, true, 0x151, false, 1U<<DIV_SAMPLE_DEPTH_8BIT,
+    "cost-reduced version of the OPM with a different register layout and no stereo...\n...but it has a built-in AY-3-8910! (actually an YM2149)\nCSM blah blah",
+    {"FM 1", "FM 2", "FM 3 OP1", "FM 3 OP2", "FM 3 OP3", "FM 3 OP4", "CSM Timer", "PSG 1", "PSG 2", "PSG 3"},
+    {"F1", "F2", "O1", "O2", "O3", "O4", "CSM", "S1", "S2", "S3"},
+    {DIV_CH_FM, DIV_CH_FM, DIV_CH_OP, DIV_CH_OP, DIV_CH_OP, DIV_CH_OP, DIV_CH_NOISE, DIV_CH_PULSE, DIV_CH_PULSE, DIV_CH_PULSE},
+    {DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_AY, DIV_INS_AY, DIV_INS_AY},
+    {},
+    fmEffectHandlerMap,
+    fmOPNPostEffectHandlerMap
+  );
+
   sysDefs[DIV_SYSTEM_PC98]=new DivSysDef(
     "Yamaha YM2608 (OPNA)", NULL, 0x8e, 0, 16, true, true, 0x151, false, (1U<<DIV_SAMPLE_DEPTH_ADPCM_B)|(1U<<DIV_SAMPLE_DEPTH_8BIT),
     "OPN but twice the FM channels, stereo makes a come-back and has rhythm and ADPCM channels.",
@@ -1054,6 +1066,18 @@ void DivEngine::registerSystems() {
     fmOPNAPostEffectHandlerMap
   );
 
+  sysDefs[DIV_SYSTEM_PC98_CSM]=new DivSysDef(
+    "Yamaha YM2608 (OPNA) CSM", NULL, 0xc4, 0, 20, true, true, 0x151, false, (1U<<DIV_SAMPLE_DEPTH_ADPCM_B)|(1U<<DIV_SAMPLE_DEPTH_8BIT),
+    "OPN but twice the FM channels, stereo makes a come-back and has rhythm and ADPCM channels.\nCSM blah blah",
+    {"FM 1", "FM 2", "FM 3 OP1", "FM 3 OP2", "FM 3 OP3", "FM 3 OP4", "FM 4", "FM 5", "FM 6", "CSM Timer", "Square 1", "Square 2", "Square 3", "Kick", "Snare", "Top", "HiHat", "Tom", "Rim", "ADPCM"},
+    {"F1", "F2", "O1", "O2", "O3", "O4", "F4", "F5", "F6", "CSM", "S1", "S2", "S3", "BD", "SD", "TP", "HH", "TM", "RM", "P"},
+    {DIV_CH_FM, DIV_CH_FM, DIV_CH_OP, DIV_CH_OP, DIV_CH_OP, DIV_CH_OP, DIV_CH_FM, DIV_CH_FM, DIV_CH_FM, DIV_CH_NOISE, DIV_CH_PULSE, DIV_CH_PULSE, DIV_CH_PULSE, DIV_CH_NOISE, DIV_CH_NOISE, DIV_CH_NOISE, DIV_CH_NOISE, DIV_CH_NOISE, DIV_CH_NOISE, DIV_CH_PCM},
+    {DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_AY, DIV_INS_AY, DIV_INS_AY, DIV_INS_ADPCMA, DIV_INS_ADPCMA, DIV_INS_ADPCMA, DIV_INS_ADPCMA, DIV_INS_ADPCMA, DIV_INS_ADPCMA, DIV_INS_ADPCMB},
+    {DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_AMIGA},
+    fmEffectHandlerMap,
+    fmOPNAPostEffectHandlerMap
+  );
+
   sysDefs[DIV_SYSTEM_OPL]=new DivSysDef(
     "Yamaha YM3526 (OPL)", NULL, 0x8f, 0, 9, true, false, 0x151, false, 0,
     "OPN, but what if you only had two operators, no stereo, no detune and a lower ADSR parameter range?",
@@ -1262,6 +1286,18 @@ void DivEngine::registerSystems() {
     fmOPN2PostEffectHandlerMap
   );
 
+  sysDefs[DIV_SYSTEM_YM2612_CSM]=new DivSysDef(
+    "Yamaha YM2612 (OPN2) CSM", NULL, 0xc1, 0, 10, true, false, 0x150, false, 1U<<DIV_SAMPLE_DEPTH_8BIT,
+    "this chip is mostly known for being in the Sega Genesis (but it also was on the FM Towns computer).\nthis one includes CSM mode control for special effects on Channel 3.",
+    {"FM 1", "FM 2", "FM 3 OP1", "FM 3 OP2", "FM 3 OP3", "FM 3 OP4", "FM 4", "FM 5", "FM 6", "CSM Timer"},
+    {"F1", "F2", "O1", "O2", "O3", "O4", "F4", "F5", "F6", "CSM"},
+    {DIV_CH_FM, DIV_CH_FM, DIV_CH_OP, DIV_CH_OP, DIV_CH_OP, DIV_CH_OP, DIV_CH_FM, DIV_CH_FM, DIV_CH_FM, DIV_CH_NOISE},
+    {DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM},
+    {DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_AMIGA, DIV_INS_NULL},
+    fmOPN2EffectHandlerMap,
+    fmOPN2PostEffectHandlerMap
+  );
+
   sysDefs[DIV_SYSTEM_SCC]=new DivSysDef(
     "Konami SCC", NULL, 0xa1, 0, 5, false, true, 0x161, false, 0,
     "a wavetable chip made by Konami for use with the MSX.\nthe last channel shares its wavetable with the previous one though.",
@@ -1333,6 +1369,18 @@ void DivEngine::registerSystems() {
     fmOPNAPostEffectHandlerMap
   );
 
+  sysDefs[DIV_SYSTEM_YM2610_CSM]=new DivSysDef(
+    "Yamaha YM2610 (OPNB) CSM", NULL, 0xc2, 0, 18, true, false, 0x151, false, (1U<<DIV_SAMPLE_DEPTH_ADPCM_A)|(1U<<DIV_SAMPLE_DEPTH_ADPCM_B)|(1U<<DIV_SAMPLE_DEPTH_8BIT),
+    "this chip was used in SNK's Neo Geo arcade board and video game console.\nit's like OPNA but the rhythm channels are ADPCM channels and two FM channels went missing.\nthis one includes CSM mode control for special effects on Channel 2.",
+    {"FM 1", "FM 2 OP1", "FM 2 OP2", "FM 2 OP3", "FM 2 OP4", "FM 3", "FM 4", "CSM Timer", "PSG 1", "PSG 2", "PSG 3", "ADPCM-A 1", "ADPCM-A 2", "ADPCM-A 3", "ADPCM-A 4", "ADPCM-A 5", "ADPCM-A 6", "ADPCM-B"},
+    {"F1", "O1", "O2", "O3", "O4", "F3", "F4", "CSM", "S1", "S2", "S3", "P1", "P2", "P3", "P4", "P5", "P6", "B"},
+    {DIV_CH_FM, DIV_CH_OP, DIV_CH_OP, DIV_CH_OP, DIV_CH_OP, DIV_CH_FM, DIV_CH_FM, DIV_CH_NOISE, DIV_CH_PULSE, DIV_CH_PULSE, DIV_CH_PULSE, DIV_CH_PCM, DIV_CH_PCM, DIV_CH_PCM, DIV_CH_PCM, DIV_CH_PCM, DIV_CH_PCM, DIV_CH_PCM},
+    {DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_AY, DIV_INS_AY, DIV_INS_AY, DIV_INS_ADPCMA, DIV_INS_ADPCMA, DIV_INS_ADPCMA, DIV_INS_ADPCMA, DIV_INS_ADPCMA, DIV_INS_ADPCMA, DIV_INS_ADPCMB},
+    {DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_AMIGA, DIV_INS_AMIGA, DIV_INS_AMIGA, DIV_INS_AMIGA, DIV_INS_AMIGA, DIV_INS_AMIGA, DIV_INS_AMIGA},
+    fmEffectHandlerMap,
+    fmOPNAPostEffectHandlerMap
+  );
+
   sysDefs[DIV_SYSTEM_OPLL_DRUMS]=new DivSysDef(
     "Yamaha YM2413 (OPLL) with drums", NULL, 0xa7, 0, 11, true, false, 0x150, false, 0,
     "the OPLL chips but with drums mode turned on.",
@@ -1410,6 +1458,18 @@ void DivEngine::registerSystems() {
     fmOPNAPostEffectHandlerMap
   );
 
+  sysDefs[DIV_SYSTEM_YM2610B_CSM]=new DivSysDef(
+    "Yamaha YM2610B (OPNB2) CSM", NULL, 0xc5, 0, 20, true, false, 0x151, false, (1U<<DIV_SAMPLE_DEPTH_ADPCM_A)|(1U<<DIV_SAMPLE_DEPTH_ADPCM_B)|(1U<<DIV_SAMPLE_DEPTH_8BIT),
+    "so Taito asked Yamaha if they could get the two missing FM channels back, and Yamaha gladly provided them with this chip.\nCSM blah blah",
+    {"FM 1", "FM 2", "FM 3 OP1", "FM 3 OP2", "FM 3 OP3", "FM 3 OP4", "FM 4", "FM 5", "FM 6", "CSM Timer", "PSG 1", "PSG 2", "PSG 3", "ADPCM-A 1", "ADPCM-A 2", "ADPCM-A 3", "ADPCM-A 4", "ADPCM-A 5", "ADPCM-A 6", "ADPCM-B"},
+    {"F1", "F2", "O1", "O2", "O3", "O4", "F4", "F5", "F6", "CSM", "S1", "S2", "S3", "P1", "P2", "P3", "P4", "P5", "P6", "B"},
+    {DIV_CH_FM, DIV_CH_FM, DIV_CH_OP, DIV_CH_OP, DIV_CH_OP, DIV_CH_OP, DIV_CH_FM, DIV_CH_FM, DIV_CH_FM, DIV_CH_NOISE, DIV_CH_PULSE, DIV_CH_PULSE, DIV_CH_PULSE, DIV_CH_PCM, DIV_CH_PCM, DIV_CH_PCM, DIV_CH_PCM, DIV_CH_PCM, DIV_CH_PCM, DIV_CH_PCM},
+    {DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_FM, DIV_INS_AY, DIV_INS_AY, DIV_INS_AY, DIV_INS_ADPCMA, DIV_INS_ADPCMA, DIV_INS_ADPCMA, DIV_INS_ADPCMA, DIV_INS_ADPCMA, DIV_INS_ADPCMA, DIV_INS_ADPCMB},
+    {DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_NULL, DIV_INS_AMIGA, DIV_INS_AMIGA, DIV_INS_AMIGA, DIV_INS_AMIGA, DIV_INS_AMIGA, DIV_INS_AMIGA, DIV_INS_AMIGA},
+    fmEffectHandlerMap,
+    fmOPNAPostEffectHandlerMap
+  );
+
   sysDefs[DIV_SYSTEM_SEGAPCM_COMPAT]=new DivSysDef(
     "SegaPCM (compatible 5-channel mode)", NULL, 0xa9, 0, 5, false, true, 0x151, false, 1U<<DIV_SAMPLE_DEPTH_8BIT,
     "this is the same thing as SegaPCM, but only exposes 5 of the channels for compatibility with DefleMask.",