early OKI MSM6295 work

CMakeLists.txt

@@ -398,6 +398,7 @@ src/engine/platform/fds.cpp
 src/engine/platform/tia.cpp
 src/engine/platform/saa.cpp
 src/engine/platform/amiga.cpp
+src/engine/platform/msm6295.cpp
 src/engine/platform/pcspkr.cpp
 src/engine/platform/segapcm.cpp
 src/engine/platform/qsound.cpp

src/engine/dispatchContainer.cpp

@@ -21,6 +21,7 @@
 #include "engine.h"
 #include "platform/genesis.h"
 #include "platform/genesisext.h"
+#include "platform/msm6295.h"
 #include "platform/namcowsg.h"
 #include "platform/sms.h"
 #include "platform/opll.h"
@@ -364,6 +365,9 @@ void DivDispatchContainer::init(DivSystem sys, DivEngine* eng, int chanCount, do
     case DIV_SYSTEM_SOUND_UNIT:
       dispatch=new DivPlatformSoundUnit;
       break;
+    case DIV_SYSTEM_MSM6295:
+      dispatch=new DivPlatformMSM6295;
+      break;
     case DIV_SYSTEM_NAMCO:
       dispatch=new DivPlatformNamcoWSG;
       // Pac-Man (TODO: support Pole Position?)

src/engine/platform/msm6295.cpp

@@ -0,0 +1,334 @@
+/**
+ * Furnace Tracker - multi-system chiptune tracker
+ * Copyright (C) 2021-2022 tildearrow and contributors
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include "msm6295.h"
+#include "../engine.h"
+#include "../../ta-log.h"
+#include <string.h>
+#include <math.h>
+
+#define rWrite(v) if (!skipRegisterWrites) {writes.emplace(0,v); if (dumpWrites) {addWrite(0,v);} }
+#define CHIP_DIVIDER 32
+
+const char** DivPlatformMSM6295::getRegisterSheet() {
+  return NULL;
+}
+
+const char* DivPlatformMSM6295::getEffectName(unsigned char effect) {
+  return NULL;
+}
+
+u8 DivMSM6295Interface::read_byte(u32 address) {
+  return adpcmMem[address&0xffff];
+}
+
+void DivPlatformMSM6295::acquire(short* bufL, short* bufR, size_t start, size_t len) {
+  for (size_t h=start; h<start+len; h++) {
+    if (delay<=0) {
+      if (!writes.empty()) {
+        QueuedWrite& w=writes.front();
+        msm->command_w(w.val);
+        writes.pop();
+        delay=64;
+      }
+    } else {
+      delay--;
+    }
+    
+    msm->tick();
+  
+    bufL[h]=msm->out()<<4;
+  }
+}
+
+void DivPlatformMSM6295::tick(bool sysTick) {
+  for (int i=0; i<4; i++) {
+    if (chan[i].furnacePCM) {
+      chan[i].std.next();
+
+      if (chan[i].std.vol.had) {
+        chan[i].outVol=(chan[i].vol*MIN(8,chan[i].std.vol.val))/8;
+      }
+    }
+  }
+}
+
+int DivPlatformMSM6295::dispatch(DivCommand c) {
+  switch (c.cmd) {
+    case DIV_CMD_NOTE_ON: {
+      DivInstrument* ins=parent->getIns(chan[c.chan].ins,DIV_INS_FM);
+      if (ins->type==DIV_INS_AMIGA) {
+        chan[c.chan].furnacePCM=true;
+      } else {
+        chan[c.chan].furnacePCM=false;
+      }
+      if (skipRegisterWrites) break;
+      if (chan[c.chan].furnacePCM) {
+        chan[c.chan].macroInit(ins);
+        if (!chan[c.chan].std.vol.will) {
+          chan[c.chan].outVol=chan[c.chan].vol;
+        }
+        chan[c.chan].sample=ins->amiga.getSample(c.value);
+        if (chan[c.chan].sample>=0 && chan[c.chan].sample<parent->song.sampleLen) {
+          //DivSample* s=parent->getSample(chan[c.chan].sample);
+          if (c.value!=DIV_NOTE_NULL) {
+            chan[c.chan].note=c.value;
+            chan[c.chan].freqChanged=true;
+          }
+          chan[c.chan].active=true;
+          chan[c.chan].keyOn=true;
+          rWrite((8<<c.chan)); // turn off
+          rWrite(0x80|chan[c.chan].sample); // set phrase
+          rWrite((16<<c.chan)|(8-chan[c.chan].outVol)); // turn on
+        } else {
+          break;
+        }
+      } else {
+        chan[c.chan].sample=-1;
+        chan[c.chan].macroInit(NULL);
+        chan[c.chan].outVol=chan[c.chan].vol;
+        if ((12*sampleBank+c.value%12)>=parent->song.sampleLen) {
+          break;
+        }
+        //DivSample* s=parent->getSample(12*sampleBank+c.value%12);
+        chan[c.chan].sample=12*sampleBank+c.value%12;
+        rWrite((8<<c.chan)); // turn off
+        rWrite(0x80|chan[c.chan].sample); // set phrase
+        rWrite((16<<c.chan)|(8-chan[c.chan].outVol)); // turn on
+      }
+      break;
+    }
+    case DIV_CMD_NOTE_OFF:
+      chan[c.chan].keyOff=true;
+      chan[c.chan].keyOn=false;
+      chan[c.chan].active=false;
+      rWrite((8<<c.chan)); // turn off
+      chan[c.chan].macroInit(NULL);
+      break;
+    case DIV_CMD_NOTE_OFF_ENV:
+      chan[c.chan].keyOff=true;
+      chan[c.chan].keyOn=false;
+      chan[c.chan].active=false;
+      chan[c.chan].std.release();
+      break;
+    case DIV_CMD_ENV_RELEASE:
+      chan[c.chan].std.release();
+      break;
+    case DIV_CMD_VOLUME: {
+      chan[c.chan].vol=c.value;
+      if (!chan[c.chan].std.vol.has) {
+        chan[c.chan].outVol=c.value;
+      }
+      break;
+    }
+    case DIV_CMD_GET_VOLUME: {
+      return chan[c.chan].vol;
+      break;
+    }
+    case DIV_CMD_INSTRUMENT:
+      if (chan[c.chan].ins!=c.value || c.value2==1) {
+        chan[c.chan].insChanged=true;
+      }
+      chan[c.chan].ins=c.value;
+      break;
+    case DIV_CMD_PITCH: {
+      if (c.chan==15 && !chan[c.chan].furnacePCM) break;
+      chan[c.chan].pitch=c.value;
+      chan[c.chan].freqChanged=true;
+      break;
+    }
+    case DIV_CMD_NOTE_PORTA: {
+      return 2;
+    }
+    case DIV_CMD_SAMPLE_BANK:
+      sampleBank=c.value;
+      if (sampleBank>(parent->song.sample.size()/12)) {
+        sampleBank=parent->song.sample.size()/12;
+      }
+      iface.sampleBank=sampleBank;
+      break;
+    case DIV_CMD_LEGATO: {
+      break;
+    }
+    case DIV_ALWAYS_SET_VOLUME:
+      return 0;
+      break;
+    case DIV_CMD_GET_VOLMAX:
+      return 8;
+      break;
+    case DIV_CMD_PRE_PORTA:
+      break;
+    case DIV_CMD_PRE_NOTE:
+      break;
+    default:
+      //printf("WARNING: unimplemented command %d\n",c.cmd);
+      break;
+  }
+  return 1;
+}
+
+void DivPlatformMSM6295::muteChannel(int ch, bool mute) {
+  isMuted[ch]=mute;
+}
+
+void DivPlatformMSM6295::forceIns() {
+  for (int i=0; i<4; i++) {
+    chan[i].insChanged=true;
+  }
+}
+
+void* DivPlatformMSM6295::getChanState(int ch) {
+  return &chan[ch];
+}
+
+DivDispatchOscBuffer* DivPlatformMSM6295::getOscBuffer(int ch) {
+  return oscBuf[ch];
+}
+
+unsigned char* DivPlatformMSM6295::getRegisterPool() {
+  return NULL;
+}
+
+int DivPlatformMSM6295::getRegisterPoolSize() {
+  return 0;
+}
+
+void DivPlatformMSM6295::poke(unsigned int addr, unsigned short val) {
+  //immWrite(addr,val);
+}
+
+void DivPlatformMSM6295::poke(std::vector<DivRegWrite>& wlist) {
+  //for (DivRegWrite& i: wlist) immWrite(i.addr,i.val);
+}
+
+void DivPlatformMSM6295::reset() {
+  while (!writes.empty()) writes.pop();
+  msm->reset();
+  if (dumpWrites) {
+    addWrite(0xffffffff,0);
+  }
+  for (int i=0; i<4; i++) {
+    chan[i]=DivPlatformMSM6295::Channel();
+    chan[i].std.setEngine(parent);
+  }
+  for (int i=0; i<4; i++) {
+    chan[i].vol=8;
+    chan[i].outVol=8;
+  }
+
+  sampleBank=0;
+
+  delay=0;
+}
+
+bool DivPlatformMSM6295::keyOffAffectsArp(int ch) {
+  return false;
+}
+
+void DivPlatformMSM6295::notifyInsChange(int ins) {
+  for (int i=0; i<4; i++) {
+    if (chan[i].ins==ins) {
+      chan[i].insChanged=true;
+    }
+  }
+}
+
+void DivPlatformMSM6295::notifyInsDeletion(void* ins) {
+}
+
+const void* DivPlatformMSM6295::getSampleMem(int index) {
+  return index == 0 ? adpcmBMem : NULL;
+}
+
+size_t DivPlatformMSM6295::getSampleMemCapacity(int index) {
+  return index == 0 ? 262144 : 0;
+}
+
+size_t DivPlatformMSM6295::getSampleMemUsage(int index) {
+  return index == 0 ? adpcmBMemLen : 0;
+}
+
+void DivPlatformMSM6295::renderSamples() {
+  memset(adpcmBMem,0,getSampleMemCapacity(0));
+
+  // sample data
+  size_t memPos=128*8;
+  for (int i=0; i<parent->song.sampleLen; i++) {
+    DivSample* s=parent->song.sample[i];
+    int paddedLen=(s->lengthVOX+255)&(~0xff);
+    if ((memPos&0xf00000)!=((memPos+paddedLen)&0xf00000)) {
+      memPos=(memPos+0xfffff)&0xf00000;
+    }
+    if (memPos>=getSampleMemCapacity(0)) {
+      logW("out of ADPCM memory for sample %d!",i);
+      break;
+    }
+    if (memPos+paddedLen>=getSampleMemCapacity(0)) {
+      memcpy(adpcmBMem+memPos,s->dataVOX,getSampleMemCapacity(0)-memPos);
+      logW("out of ADPCM memory for sample %d!",i);
+    } else {
+      memcpy(adpcmBMem+memPos,s->dataVOX,paddedLen);
+    }
+    s->offVOX=memPos;
+    memPos+=paddedLen;
+  }
+  adpcmBMemLen=memPos+256;
+
+  // phrase book
+  for (int i=0; i<parent->song.sampleLen; i++) {
+    DivSample* s=parent->song.sample[i];
+    int endPos=s->offVOX+s->lengthVOX;
+    adpcmBMem[i*8]=(s->offVOX>>16)&0xff;
+    adpcmBMem[1+i*8]=(s->offVOX>>8)&0xff;
+    adpcmBMem[2+i*8]=(s->offVOX)&0xff;
+    adpcmBMem[3+i*8]=(endPos>>16)&0xff;
+    adpcmBMem[4+i*8]=(endPos>>8)&0xff;
+    adpcmBMem[5+i*8]=(endPos)&0xff;
+  }
+}
+
+int DivPlatformMSM6295::init(DivEngine* p, int channels, int sugRate, unsigned int flags) {
+  parent=p;
+  adpcmBMem=new unsigned char[getSampleMemCapacity(0)];
+  adpcmBMemLen=0;
+  iface.adpcmMem=adpcmBMem;
+  iface.sampleBank=0;
+  dumpWrites=false;
+  skipRegisterWrites=false;
+  for (int i=0; i<4; i++) {
+    isMuted[i]=false;
+    oscBuf[i]=new DivDispatchOscBuffer;
+  }
+  chipClock=8000000;
+  rate=chipClock/8;
+  msm=new msm6295_core(iface);
+  reset();
+  return 4;
+}
+
+void DivPlatformMSM6295::quit() {
+  for (int i=0; i<4; i++) {
+    delete oscBuf[i];
+  }
+  delete msm;
+  delete[] adpcmBMem;
+}
+
+DivPlatformMSM6295::~DivPlatformMSM6295() {
+}

src/engine/platform/msm6295.h

@@ -0,0 +1,136 @@
+/**
+ * Furnace Tracker - multi-system chiptune tracker
+ * Copyright (C) 2021-2022 tildearrow and contributors
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifndef _MSM6295_H
+#define _MSM6295_H
+#include "../dispatch.h"
+#include "../macroInt.h"
+#include <queue>
+#include "sound/oki/msm6295.hpp"
+
+class DivMSM6295Interface: public vgsound_emu_mem_intf {
+  public:
+    unsigned char* adpcmMem;
+    int sampleBank;
+    u8 read_byte(u32 address);
+    DivMSM6295Interface(): adpcmMem(NULL), sampleBank(0) {}
+};
+
+class DivPlatformMSM6295: public DivDispatch {
+  protected:
+    const unsigned short chanOffs[6]={
+      0x00, 0x01, 0x02, 0x100, 0x101, 0x102
+    };
+
+    struct Channel {
+      unsigned char freqH, freqL;
+      int freq, baseFreq, pitch, pitch2, portaPauseFreq, note, ins;
+      unsigned char psgMode, autoEnvNum, autoEnvDen;
+      signed char konCycles;
+      bool active, insChanged, freqChanged, keyOn, keyOff, portaPause, inPorta, furnacePCM, hardReset;
+      int vol, outVol;
+      int sample;
+      unsigned char pan;
+      DivMacroInt std;
+      void macroInit(DivInstrument* which) {
+        std.init(which);
+        pitch2=0;
+      }
+      Channel():
+        freqH(0),
+        freqL(0),
+        freq(0),
+        baseFreq(0),
+        pitch(0),
+        pitch2(0),
+        portaPauseFreq(0),
+        note(0),
+        ins(-1),
+        psgMode(1),
+        autoEnvNum(0),
+        autoEnvDen(0),
+        active(false),
+        insChanged(true),
+        freqChanged(false),
+        keyOn(false),
+        keyOff(false),
+        portaPause(false),
+        inPorta(false),
+        furnacePCM(false),
+        hardReset(false),
+        vol(0),
+        outVol(15),
+        sample(-1),
+        pan(3) {}
+    };
+    Channel chan[4];
+    DivDispatchOscBuffer* oscBuf[4];
+    bool isMuted[4];
+    struct QueuedWrite {
+      unsigned short addr;
+      unsigned char val;
+      bool addrOrVal;
+      QueuedWrite(unsigned short a, unsigned char v): addr(a), val(v), addrOrVal(false) {}
+    };
+    std::queue<QueuedWrite> writes;
+    msm6295_core* msm;
+    unsigned char regPool[512];
+    unsigned char lastBusy;
+
+    unsigned char* adpcmBMem;
+    size_t adpcmBMemLen;
+    DivMSM6295Interface iface;
+    unsigned char sampleBank;
+
+    int delay;
+
+    bool extMode;
+  
+    short oldWrites[512];
+    short pendingWrites[512];
+
+    friend void putDispatchChan(void*,int,int);
+  
+  public:
+    void acquire(short* bufL, short* bufR, size_t start, size_t len);
+    int dispatch(DivCommand c);
+    void* getChanState(int chan);
+    DivDispatchOscBuffer* getOscBuffer(int chan);
+    unsigned char* getRegisterPool();
+    int getRegisterPoolSize();
+    void reset();
+    void forceIns();
+    void tick(bool sysTick=true);
+    void muteChannel(int ch, bool mute);
+    bool keyOffAffectsArp(int ch);
+    void notifyInsChange(int ins);
+    void notifyInsDeletion(void* ins);
+    void poke(unsigned int addr, unsigned short val);
+    void poke(std::vector<DivRegWrite>& wlist);
+    const char** getRegisterSheet();
+    const char* getEffectName(unsigned char effect);
+    const void* getSampleMem(int index);
+    size_t getSampleMemCapacity(int index);
+    size_t getSampleMemUsage(int index);
+    void renderSamples();
+    int init(DivEngine* parent, int channels, int sugRate, unsigned int flags);
+    void quit();
+    ~DivPlatformMSM6295();
+};
+#endif

src/engine/platform/sound/oki/util.hpp

@@ -42,7 +42,7 @@ template<typename T> T sign_ext(T in, u8 len)
 }
 
 // convert attenuation decibel value to gain
-f32 dB_to_gain(f32 attenuation)
+inline f32 dB_to_gain(f32 attenuation)
 {
 	return powf(10.0f, attenuation / 20.0f);
 }