and here's your ZX beeper

no real hardware yet
specs of this dispatch may change at any time to fit a driver

CMakeLists.txt

@@ -374,6 +374,7 @@ src/engine/platform/lynx.cpp
 src/engine/platform/su.cpp
 src/engine/platform/swan.cpp
 src/engine/platform/vera.cpp
+src/engine/platform/zxbeeper.cpp
 src/engine/platform/bubsyswsg.cpp
 src/engine/platform/n163.cpp
 src/engine/platform/pet.cpp

src/engine/dispatchContainer.cpp

@@ -59,6 +59,7 @@
 #include "platform/scc.h"
 #include "platform/dummy.h"
 #include "../ta-log.h"
+#include "platform/zxbeeper.h"
 #include "song.h"
 
 void DivDispatchContainer::setRates(double gotRate) {
@@ -294,6 +295,9 @@ void DivDispatchContainer::init(DivSystem sys, DivEngine* eng, int chanCount, do
     case DIV_SYSTEM_PCSPKR:
       dispatch=new DivPlatformPCSpeaker;
       break;
+    case DIV_SYSTEM_SFX_BEEPER:
+      dispatch=new DivPlatformZXBeeper;
+      break;
     case DIV_SYSTEM_LYNX:
       dispatch=new DivPlatformLynx;
       break;

src/engine/platform/zxbeeper.cpp

@@ -0,0 +1,332 @@
+/**
+ * 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 "zxbeeper.h"
+#include "../engine.h"
+#include <math.h>
+
+#define CHIP_FREQBASE 8192*6
+
+const char** DivPlatformZXBeeper::getRegisterSheet() {
+  return NULL;
+}
+
+const char* DivPlatformZXBeeper::getEffectName(unsigned char effect) {
+  switch (effect) {
+    case 0x10:
+      return "10xx: Change waveform";
+      break;
+    case 0x11:
+      return "11xx: Toggle noise mode";
+      break;
+    case 0x12:
+      return "12xx: Setup LFO (0: disabled; 1: 1x depth; 2: 16x depth; 3: 256x depth)";
+      break;
+    case 0x13:
+      return "13xx: Set LFO speed";
+      break;
+    case 0x17:
+      return "17xx: Toggle PCM mode";
+      break;
+  }
+  return NULL;
+}
+
+void DivPlatformZXBeeper::acquire(short* bufL, short* bufR, size_t start, size_t len) {
+  for (size_t h=start; h<start+len; h++) {
+    // clock here
+    bool o=false;
+    unsigned short oldPos=chan[curChan].sPosition;
+
+    if (sOffTimer) {
+      sOffTimer--;
+      o=true;
+    }
+    chan[curChan].sPosition+=chan[curChan].freq;
+    if (oldPos>chan[curChan].sPosition) {
+      if (!isMuted[curChan] && chan[curChan].outVol) sOffTimer+=chan[curChan].duty;
+    }
+    if (++curChan>=6) curChan=0;
+    
+    bufL[h]=o?16384:0;
+  }
+}
+
+void DivPlatformZXBeeper::tick(bool sysTick) {
+  for (int i=0; i<6; i++) {
+    chan[i].std.next();
+    if (chan[i].std.vol.had) {
+      chan[i].outVol=((chan[i].vol&1)*MIN(1,chan[i].std.vol.val));
+    }
+    if (chan[i].std.duty.had) {
+      chan[i].duty=chan[i].std.duty.val;
+      chan[i].freqChanged=true;
+    }
+    if (chan[i].std.arp.had) {
+      if (!chan[i].inPorta) {
+        if (chan[i].std.arp.mode) {
+          chan[i].baseFreq=NOTE_FREQUENCY(chan[i].std.arp.val);
+        } else {
+          chan[i].baseFreq=NOTE_FREQUENCY(chan[i].note+chan[i].std.arp.val);
+        }
+      }
+      chan[i].freqChanged=true;
+    } else {
+      if (chan[i].std.arp.mode && chan[i].std.arp.finished) {
+        chan[i].baseFreq=NOTE_FREQUENCY(chan[i].note);
+        chan[i].freqChanged=true;
+      }
+    }
+    if (chan[i].std.pitch.had) {
+      if (chan[i].std.pitch.mode) {
+        chan[i].pitch2+=chan[i].std.pitch.val;
+        CLAMP_VAR(chan[i].pitch2,-2048,2048);
+      } else {
+        chan[i].pitch2=chan[i].std.pitch.val;
+      }
+      chan[i].freqChanged=true;
+    }
+    if (chan[i].freqChanged || chan[i].keyOn || chan[i].keyOff) {
+      if (chan[i].active) {
+        chan[i].freq=parent->calcFreq(chan[i].baseFreq,chan[i].pitch,false,0,chan[i].pitch2,chipClock,CHIP_FREQBASE);
+        if (chan[i].freq>65535) chan[i].freq=65535;
+      }
+      if (chan[i].keyOn) {
+        //rWrite(16+i*5,0x80);
+        //chWrite(i,0x04,0x80|chan[i].vol);
+      }
+      if (chan[i].keyOff) {
+        chan[i].freq=0;
+      }
+      if (chan[i].keyOn) chan[i].keyOn=false;
+      if (chan[i].keyOff) chan[i].keyOff=false;
+      chan[i].freqChanged=false;
+    }
+  }
+}
+
+int DivPlatformZXBeeper::dispatch(DivCommand c) {
+  switch (c.cmd) {
+    case DIV_CMD_NOTE_ON: {
+      DivInstrument* ins=parent->getIns(chan[c.chan].ins,DIV_INS_BEEPER);
+      if (c.value!=DIV_NOTE_NULL) {
+        chan[c.chan].baseFreq=NOTE_FREQUENCY(c.value);
+        chan[c.chan].freqChanged=true;
+        chan[c.chan].note=c.value;
+      }
+      chan[c.chan].active=true;
+      chan[c.chan].keyOn=true;
+      chan[c.chan].macroInit(ins);
+      chan[c.chan].insChanged=false;
+      break;
+    }
+    case DIV_CMD_NOTE_OFF:
+      chan[c.chan].dacSample=-1;
+      if (dumpWrites) addWrite(0xffff0002+(c.chan<<8),0);
+      chan[c.chan].pcm=false;
+      chan[c.chan].active=false;
+      chan[c.chan].keyOff=true;
+      chan[c.chan].macroInit(NULL);
+      break;
+    case DIV_CMD_NOTE_OFF_ENV:
+    case DIV_CMD_ENV_RELEASE:
+      chan[c.chan].std.release();
+      break;
+    case DIV_CMD_INSTRUMENT:
+      if (chan[c.chan].ins!=c.value || c.value2==1) {
+        chan[c.chan].ins=c.value;
+        chan[c.chan].insChanged=true;
+      }
+      break;
+    case DIV_CMD_VOLUME:
+      if (chan[c.chan].vol!=c.value) {
+        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:
+      if (chan[c.chan].std.vol.has) {
+        return chan[c.chan].vol;
+      }
+      return chan[c.chan].outVol;
+      break;
+    case DIV_CMD_PITCH:
+      chan[c.chan].pitch=c.value;
+      chan[c.chan].freqChanged=true;
+      break;
+    case DIV_CMD_NOTE_PORTA: {
+      int destFreq=NOTE_FREQUENCY(c.value2);
+      bool return2=false;
+      if (destFreq>chan[c.chan].baseFreq) {
+        chan[c.chan].baseFreq+=c.value;
+        if (chan[c.chan].baseFreq>=destFreq) {
+          chan[c.chan].baseFreq=destFreq;
+          return2=true;
+        }
+      } else {
+        chan[c.chan].baseFreq-=c.value;
+        if (chan[c.chan].baseFreq<=destFreq) {
+          chan[c.chan].baseFreq=destFreq;
+          return2=true;
+        }
+      }
+      chan[c.chan].freqChanged=true;
+      if (return2) {
+        chan[c.chan].inPorta=false;
+        return 2;
+      }
+      break;
+    }
+    case DIV_CMD_STD_NOISE_MODE:
+      chan[c.chan].duty=c.value;
+      break;
+    case DIV_CMD_SAMPLE_MODE:
+      chan[c.chan].pcm=c.value;
+      break;
+    case DIV_CMD_SAMPLE_BANK:
+      sampleBank=c.value;
+      if (sampleBank>(parent->song.sample.size()/12)) {
+        sampleBank=parent->song.sample.size()/12;
+      }
+      break;
+    case DIV_CMD_LEGATO:
+      chan[c.chan].baseFreq=NOTE_FREQUENCY(c.value+((chan[c.chan].std.arp.will && !chan[c.chan].std.arp.mode)?(chan[c.chan].std.arp.val):(0)));
+      chan[c.chan].freqChanged=true;
+      chan[c.chan].note=c.value;
+      break;
+    case DIV_CMD_PRE_PORTA:
+      if (chan[c.chan].active && c.value2) {
+        if (parent->song.resetMacroOnPorta) chan[c.chan].macroInit(parent->getIns(chan[c.chan].ins,DIV_INS_BEEPER));
+      }
+      chan[c.chan].inPorta=c.value;
+      break;
+    case DIV_CMD_GET_VOLMAX:
+      return 1;
+      break;
+    case DIV_ALWAYS_SET_VOLUME:
+      return 1;
+      break;
+    default:
+      break;
+  }
+  return 1;
+}
+
+void DivPlatformZXBeeper::muteChannel(int ch, bool mute) {
+  isMuted[ch]=mute;
+}
+
+void DivPlatformZXBeeper::forceIns() {
+  for (int i=0; i<6; i++) {
+    chan[i].insChanged=true;
+    chan[i].freqChanged=true;
+  }
+}
+
+void* DivPlatformZXBeeper::getChanState(int ch) {
+  return &chan[ch];
+}
+
+DivDispatchOscBuffer* DivPlatformZXBeeper::getOscBuffer(int ch) {
+  return oscBuf[ch];
+}
+
+unsigned char* DivPlatformZXBeeper::getRegisterPool() {
+  return regPool;
+}
+
+int DivPlatformZXBeeper::getRegisterPoolSize() {
+  return 112;
+}
+
+void DivPlatformZXBeeper::reset() {
+  while (!writes.empty()) writes.pop();
+  memset(regPool,0,128);
+  for (int i=0; i<6; i++) {
+    chan[i]=DivPlatformZXBeeper::Channel();
+    chan[i].std.setEngine(parent);
+  }
+  if (dumpWrites) {
+    addWrite(0xffffffff,0);
+  }
+  lastPan=0xff;
+  memset(tempL,0,32*sizeof(int));
+  memset(tempR,0,32*sizeof(int));
+  cycles=0;
+  curChan=0;
+  sOffTimer=0;
+  sampleBank=0;
+}
+
+bool DivPlatformZXBeeper::keyOffAffectsArp(int ch) {
+  return true;
+}
+
+void DivPlatformZXBeeper::notifyWaveChange(int wave) {
+}
+
+void DivPlatformZXBeeper::notifyInsDeletion(void* ins) {
+  for (int i=0; i<6; i++) {
+    chan[i].std.notifyInsDeletion((DivInstrument*)ins);
+  }
+}
+
+void DivPlatformZXBeeper::setFlags(unsigned int flags) {
+  if (flags&1) { // technically there is no PAL PC Engine but oh well...
+    chipClock=COLOR_PAL*4.0/5.0;
+  } else {
+    chipClock=COLOR_NTSC;
+  }
+  rate=chipClock/4;
+  for (int i=0; i<6; i++) {
+    oscBuf[i]->rate=rate;
+  }
+}
+
+void DivPlatformZXBeeper::poke(unsigned int addr, unsigned short val) {
+
+}
+
+void DivPlatformZXBeeper::poke(std::vector<DivRegWrite>& wlist) {
+
+}
+
+int DivPlatformZXBeeper::init(DivEngine* p, int channels, int sugRate, unsigned int flags) {
+  parent=p;
+  dumpWrites=false;
+  skipRegisterWrites=false;
+  for (int i=0; i<6; i++) {
+    isMuted[i]=false;
+    oscBuf[i]=new DivDispatchOscBuffer;
+  }
+  setFlags(flags);
+  reset();
+  return 6;
+}
+
+void DivPlatformZXBeeper::quit() {
+  for (int i=0; i<6; i++) {
+    delete oscBuf[i];
+  }
+}
+
+DivPlatformZXBeeper::~DivPlatformZXBeeper() {
+}

src/engine/platform/zxbeeper.h

@@ -0,0 +1,108 @@
+/**
+ * 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 _ZXBEEPER_H
+#define _ZXBEEPER_H
+
+#include "../dispatch.h"
+#include <queue>
+#include "../macroInt.h"
+
+class DivPlatformZXBeeper: public DivDispatch {
+  struct Channel {
+    int freq, baseFreq, pitch, pitch2, note;
+    int dacPeriod, dacRate;
+    unsigned int dacPos;
+    int dacSample, ins;
+    bool active, insChanged, freqChanged, keyOn, keyOff, inPorta, noise, pcm, furnaceDac;
+    signed char vol, outVol;
+    unsigned short sPosition;
+    unsigned char duty;
+    DivMacroInt std;
+    void macroInit(DivInstrument* which) {
+      std.init(which);
+      pitch2=0;
+    }
+    Channel():
+      freq(0),
+      baseFreq(0),
+      pitch(0),
+      pitch2(0),
+      note(0),
+      dacPeriod(0),
+      dacRate(0),
+      dacPos(0),
+      dacSample(-1),
+      ins(-1),
+      active(false),
+      insChanged(true),
+      freqChanged(false),
+      keyOn(false),
+      keyOff(false),
+      inPorta(false),
+      noise(false),
+      pcm(false),
+      furnaceDac(false),
+      vol(1),
+      outVol(1),
+      sPosition(0),
+      duty(3) {}
+  };
+  Channel chan[6];
+  DivDispatchOscBuffer* oscBuf[6];
+  bool isMuted[6];
+  struct QueuedWrite {
+      unsigned char addr;
+      unsigned char val;
+      QueuedWrite(unsigned char a, unsigned char v): addr(a), val(v) {}
+  };
+  std::queue<QueuedWrite> writes;
+  unsigned char lastPan;
+
+  int cycles, curChan, sOffTimer, delay;
+  int tempL[32];
+  int tempR[32];
+  unsigned char sampleBank, lfoMode, lfoSpeed;
+  unsigned char regPool[128];
+  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 setFlags(unsigned int flags);
+    void notifyWaveChange(int wave);
+    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);
+    int init(DivEngine* parent, int channels, int sugRate, unsigned int flags);
+    void quit();
+    ~DivPlatformZXBeeper();
+};
+
+#endif

src/engine/sysDef.cpp

@@ -1326,7 +1326,7 @@ void DivEngine::registerSystems() {
     {"Square"},
     {"SQ"},
     {DIV_CH_PULSE},
-    {DIV_INS_STD}
+    {DIV_INS_BEEPER}
   );
 
   sysDefs[DIV_SYSTEM_POKEY]=new DivSysDef(

src/gui/guiConst.cpp

@@ -101,7 +101,7 @@ const char* insTypes[DIV_INS_MAX]={
   "Konami SCC/Bubble System WSG",
   "FM (OPZ)",
   "POKEY",
-  "PC Beeper",
+  "Beeper",
   "WonderSwan",
   "Atari Lynx",
   "VERA",
@@ -831,6 +831,7 @@ const int availableSystems[]={
   DIV_SYSTEM_AY8910,
   DIV_SYSTEM_AMIGA,
   DIV_SYSTEM_PCSPKR,
+  DIV_SYSTEM_SFX_BEEPER,
   DIV_SYSTEM_YMU759,
   DIV_SYSTEM_DUMMY,
   DIV_SYSTEM_SOUND_UNIT,

src/gui/insEdit.cpp

@@ -2874,7 +2874,7 @@ void FurnaceGUI::drawInsEdit() {
           if (ins->type==DIV_INS_GB) {
             volMax=0;
           }
-          if (ins->type==DIV_INS_PET) {
+          if (ins->type==DIV_INS_PET || ins->type==DIV_INS_BEEPER) {
             volMax=1;
           }
           if (ins->type==DIV_INS_FDS) {
@@ -2906,6 +2906,10 @@ void FurnaceGUI::drawInsEdit() {
             dutyLabel="Duty/Int";
             dutyMax=10;
           }
+          if (ins->type==DIV_INS_BEEPER) {
+            dutyLabel="Pulse Width";
+            dutyMax=255;
+          }
           if (ins->type==DIV_INS_AY8930) {
             dutyMax=255;
           }