furnace/src/engine/platform/pcspkr.cpp

670 lines
17 KiB
C++

/**
* Furnace Tracker - multi-system chiptune tracker
* Copyright (C) 2021-2023 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 "pcspkr.h"
#include "../engine.h"
#include "../../ta-log.h"
#include <math.h>
#ifdef __linux__
#include <sys/ioctl.h>
#include <sys/select.h>
#include <fcntl.h>
#include <unistd.h>
#ifdef HAVE_LINUX_INPUT
#include <linux/input.h>
#endif
#ifdef HAVE_LINUX_KD
#include <linux/kd.h>
#endif
#include <time.h>
#ifdef HAVE_SYS_IO
#include <sys/io.h>
#endif
#endif
#define PCSPKR_DIVIDER 4
#define CHIP_DIVIDER 1
const char* regCheatSheetPCSpeaker[]={
"Period", "0",
NULL
};
void _pcSpeakerThread(void* inst) {
((DivPlatformPCSpeaker*)inst)->pcSpeakerThread();
}
void DivPlatformPCSpeaker::pcSpeakerThread() {
std::unique_lock<std::mutex> unique(realOutSelfLock);
RealQueueVal r(0,0,0);
logD("starting PC speaker out thread");
while (!realOutQuit) {
realQueueLock.lock();
if (realQueue.empty()) {
realQueueLock.unlock();
realOutCond.wait(unique);
continue;
} else {
r=realQueue.front();
realQueue.pop();
}
realQueueLock.unlock();
#ifdef __linux__
static struct timespec ts, tSleep, rSleep;
if (clock_gettime(CLOCK_MONOTONIC,&ts)<0) {
logW("could not get time!");
tSleep.tv_sec=0;
tSleep.tv_nsec=0;
} else {
tSleep.tv_sec=r.tv_sec-ts.tv_sec;
tSleep.tv_nsec=r.tv_nsec-ts.tv_nsec;
if (tSleep.tv_nsec<0) {
tSleep.tv_sec--;
tSleep.tv_nsec+=1000000000;
}
}
if (tSleep.tv_nsec>0 || tSleep.tv_sec>0) {
nanosleep(&tSleep,&rSleep);
}
if (beepFD>=0) {
switch (realOutMethod) {
#ifdef HAVE_LINUX_INPUT
case 0: { // evdev
static struct input_event ie;
ie.time.tv_sec=r.tv_sec;
ie.time.tv_usec=r.tv_nsec/1000;
ie.type=EV_SND;
ie.code=SND_TONE;
if (r.val>0) {
ie.value=chipClock/r.val;
} else {
ie.value=0;
}
if (write(beepFD,&ie,sizeof(struct input_event))<0) {
logW("error while writing frequency! %s",strerror(errno));
} else {
//logV("writing freq: %d",r.val);
}
break;
}
#endif
#ifdef HAVE_LINUX_KD
case 1: // KIOCSOUND (on tty)
if (ioctl(beepFD,KIOCSOUND,r.val)<0) {
logW("ioctl error! %s",strerror(errno));
}
break;
#endif
case 2: { // /dev/port
unsigned char bOut;
bOut=0;
if (r.val==0) {
lseek(beepFD,0x61,SEEK_SET);
if (read(beepFD,&bOut,1)<1) {
logW("read from 0x61: %s",strerror(errno));
}
bOut&=(~3);
lseek(beepFD,0x61,SEEK_SET);
if (write(beepFD,&bOut,1)<1) {
logW("write to 0x61: %s",strerror(errno));
}
} else {
lseek(beepFD,0x43,SEEK_SET);
bOut=0xb6;
if (write(beepFD,&bOut,1)<1) {
logW("write to 0x43: %s",strerror(errno));
}
lseek(beepFD,0x42,SEEK_SET);
bOut=r.val&0xff;
if (write(beepFD,&bOut,1)<1) {
logW("write to 0x42: %s",strerror(errno));
}
lseek(beepFD,0x42,SEEK_SET);
bOut=r.val>>8;
if (write(beepFD,&bOut,1)<1) {
logW("write to 0x42: %s",strerror(errno));
}
lseek(beepFD,0x61,SEEK_SET);
if (read(beepFD,&bOut,1)<1) {
logW("read from 0x61: %s",strerror(errno));
}
bOut|=3;
lseek(beepFD,0x61,SEEK_SET);
if (write(beepFD,&bOut,1)<1) {
logW("write to 0x61: %s",strerror(errno));
}
}
break;
}
#ifdef HAVE_LINUX_KD
case 3: // KIOCSOUND (on stdout)
if (ioctl(beepFD,KIOCSOUND,r.val)<0) {
logW("ioctl error! %s",strerror(errno));
}
break;
#endif
#ifdef HAVE_SYS_IO
case 4: // outb()
if (r.val==0) {
outb(inb(0x61)&(~3),0x61);
realOutEnabled=false;
} else {
outb(0xb6,0x43);
outb(r.val&0xff,0x42);
outb(r.val>>8,0x42);
if (!realOutEnabled) {
outb(inb(0x61)|3,0x61);
realOutEnabled=true;
}
}
break;
#endif
}
} else {
//logV("not writing because fd is less than 0");
}
#endif
}
logD("stopping PC speaker out thread");
}
const char** DivPlatformPCSpeaker::getRegisterSheet() {
return regCheatSheetPCSpeaker;
}
const float cut=0.05;
const float reso=0.06;
void DivPlatformPCSpeaker::acquire_unfilt(short** buf, size_t len) {
int out=0;
for (size_t i=0; i<len; i++) {
if (on) {
pos-=PCSPKR_DIVIDER;
if (pos>freq) pos=freq;
while (pos<0) {
if (freq<1) {
pos=1;
} else {
pos+=freq;
}
}
out=(pos>(freq>>1) && !isMuted[0])?32767:0;
buf[0][i]=out;
oscBuf->data[oscBuf->needle++]=out;
} else {
buf[0][i]=0;
oscBuf->data[oscBuf->needle++]=0;
}
}
}
void DivPlatformPCSpeaker::acquire_cone(short** buf, size_t len) {
for (size_t i=0; i<len; i++) {
if (on) {
pos-=PCSPKR_DIVIDER;
if (pos>freq) pos=freq;
while (pos<0) {
if (freq<1) {
pos=1;
} else {
pos+=freq;
}
}
float next=(pos>((freq+16)>>1) && !isMuted[0])?1:0;
low+=0.04*band;
band+=0.04*(next-low-band);
float out=(low+band)*0.75;
if (out>1.0) out=1.0;
if (out<-1.0) out=-1.0;
buf[0][i]=out*32767;
oscBuf->data[oscBuf->needle++]=out*32767;
} else {
buf[0][i]=0;
oscBuf->data[oscBuf->needle++]=0;
}
}
}
void DivPlatformPCSpeaker::acquire_piezo(short** buf, size_t len) {
for (size_t i=0; i<len; i++) {
if (on) {
pos-=PCSPKR_DIVIDER;
if (pos>freq) pos=freq;
while (pos<0) {
if (freq<1) {
pos=1;
} else {
pos+=freq;
}
}
float next=(pos>((freq+64)>>1) && !isMuted[0])?1:0;
low+=cut*band;
band+=cut*(next-low-(reso*band));
float out=band*0.15-(next-low)*0.06;
if (out>1.0) out=1.0;
if (out<-1.0) out=-1.0;
buf[0][i]=out*32767;
oscBuf->data[oscBuf->needle++]=out*32767;
} else {
buf[0][i]=0;
oscBuf->data[oscBuf->needle++]=0;
}
}
}
void DivPlatformPCSpeaker::beepFreq(int freq, int delay) {
realQueueLock.lock();
#ifdef __linux__
struct timespec ts;
double addition=1000000000.0*(double)delay/parent->getAudioDescGot().rate;
addition+=1500000000.0*((double)parent->getAudioDescGot().bufsize/parent->getAudioDescGot().rate);
if (clock_gettime(CLOCK_MONOTONIC,&ts)<0) {
ts.tv_sec=0;
ts.tv_nsec=0;
} else {
ts.tv_nsec+=addition;
while (ts.tv_nsec>=1000000000) {
ts.tv_sec++;
ts.tv_nsec-=1000000000;
}
}
realQueue.push(RealQueueVal(ts.tv_sec,ts.tv_nsec,freq));
#else
realQueue.push(RealQueueVal(0,0,freq));
#endif
realQueueLock.unlock();
realOutCond.notify_one();
}
void DivPlatformPCSpeaker::acquire_real(short** buf, size_t len) {
int out=0;
if (lastOn!=on || lastFreq!=freq) {
lastOn=on;
lastFreq=freq;
beepFreq((on && !isMuted[0])?freq:0,parent->getBufferPos());
}
for (size_t i=0; i<len; i++) {
if (on) {
pos-=PCSPKR_DIVIDER;
if (pos>freq) pos=freq;
while (pos<0) {
if (freq<1) {
pos=1;
} else {
pos+=freq;
}
}
out=(pos>(freq>>1) && !isMuted[0])?32767:0;
oscBuf->data[oscBuf->needle++]=out;
} else {
oscBuf->data[oscBuf->needle++]=0;
}
buf[0][i]=0;
}
}
void DivPlatformPCSpeaker::acquire(short** buf, size_t len) {
switch (speakerType) {
case 0:
acquire_unfilt(buf,len);
break;
case 1:
acquire_cone(buf,len);
break;
case 2:
acquire_piezo(buf,len);
break;
case 3:
acquire_real(buf,len);
break;
}
}
void DivPlatformPCSpeaker::tick(bool sysTick) {
for (int i=0; i<1; i++) {
chan[i].std.next();
if (chan[i].std.vol.had) {
chan[i].outVol=(chan[i].vol && chan[i].std.vol.val);
on=chan[i].outVol;
}
if (NEW_ARP_STRAT) {
chan[i].handleArp();
} else if (chan[i].std.arp.had) {
if (!chan[i].inPorta) {
chan[i].baseFreq=NOTE_PERIODIC(parent->calcArp(chan[i].note,chan[i].std.arp.val));
}
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,-32768,32767);
} else {
chan[i].pitch2=chan[i].std.pitch.val;
}
chan[i].freqChanged=true;
}
if (chan[i].freqChanged || chan[i].keyOn || chan[i].keyOff) {
chan[i].freq=parent->calcFreq(chan[i].baseFreq,chan[i].pitch,chan[i].fixedArp?chan[i].baseNoteOverride:chan[i].arpOff,chan[i].fixedArp,true,0,chan[i].pitch2,chipClock,CHIP_DIVIDER)-1;
if (chan[i].freq<0) chan[i].freq=0;
if (chan[i].freq>65535) chan[i].freq=65535;
if (chan[i].keyOn) {
on=true;
}
if (chan[i].keyOff) {
on=false;
}
freq=chan[i].freq;
if (chan[i].keyOn) chan[i].keyOn=false;
if (chan[i].keyOff) chan[i].keyOff=false;
chan[i].freqChanged=false;
}
}
}
int DivPlatformPCSpeaker::dispatch(DivCommand c) {
switch (c.cmd) {
case DIV_CMD_NOTE_ON:
if (c.value!=DIV_NOTE_NULL) {
chan[c.chan].baseFreq=NOTE_PERIODIC(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(parent->getIns(chan[c.chan].ins,DIV_INS_BEEPER));
if (!parent->song.brokenOutVol && !chan[c.chan].std.vol.will) {
chan[c.chan].outVol=chan[c.chan].vol;
}
break;
case DIV_CMD_NOTE_OFF:
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;
}
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;
}
if (chan[c.chan].active) {
on=chan[c.chan].vol;
}
}
break;
case DIV_CMD_GET_VOLUME:
return chan[c.chan].vol;
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_PERIODIC(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_LEGATO:
if (c.chan==3) break;
chan[c.chan].baseFreq=NOTE_PERIODIC(c.value+((HACKY_LEGATO_MESS)?(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));
}
if (!chan[c.chan].inPorta && c.value && !parent->song.brokenPortaArp && chan[c.chan].std.arp.will && !NEW_ARP_STRAT) chan[c.chan].baseFreq=NOTE_PERIODIC(chan[c.chan].note);
chan[c.chan].inPorta=c.value;
break;
case DIV_CMD_GET_VOLMAX:
return 1;
break;
case DIV_CMD_MACRO_OFF:
chan[c.chan].std.mask(c.value,true);
break;
case DIV_CMD_MACRO_ON:
chan[c.chan].std.mask(c.value,false);
break;
case DIV_ALWAYS_SET_VOLUME:
return 1;
break;
default:
break;
}
return 1;
}
void DivPlatformPCSpeaker::muteChannel(int ch, bool mute) {
isMuted[ch]=mute;
}
void DivPlatformPCSpeaker::forceIns() {
for (int i=0; i<1; i++) {
chan[i].insChanged=true;
}
}
void* DivPlatformPCSpeaker::getChanState(int ch) {
return &chan[ch];
}
DivMacroInt* DivPlatformPCSpeaker::getChanMacroInt(int ch) {
return &chan[ch].std;
}
DivDispatchOscBuffer* DivPlatformPCSpeaker::getOscBuffer(int ch) {
return oscBuf;
}
unsigned char* DivPlatformPCSpeaker::getRegisterPool() {
if (on) {
regPool[0]=freq;
regPool[1]=freq>>8;
} else {
regPool[0]=0;
regPool[1]=0;
}
return regPool;
}
int DivPlatformPCSpeaker::getRegisterPoolSize() {
return 2;
}
void DivPlatformPCSpeaker::reset() {
for (int i=0; i<1; i++) {
chan[i]=DivPlatformPCSpeaker::Channel();
chan[i].std.setEngine(parent);
}
if (dumpWrites) {
addWrite(0xffffffff,0);
}
on=false;
lastOn=false;
freq=0;
lastFreq=0;
pos=0;
flip=false;
low=0;
band=0;
//if (speakerType==3) {
#ifdef __linux__
if (beepFD==-1) {
switch (realOutMethod) {
case 0: // evdev
beepFD=open("/dev/input/by-path/platform-pcspkr-event-spkr",O_WRONLY);
break;
case 1: // KIOCSOUND (on tty)
beepFD=open("/dev/tty1",O_WRONLY);
break;
case 2: // /dev/port
beepFD=open("/dev/port",O_WRONLY);
break;
case 3: // KIOCSOUND (on stdout)
beepFD=STDOUT_FILENO;
break;
case 4: // outb()
beepFD=-1;
#ifdef HAVE_SYS_IO
if (ioperm(0x61,8,1)<0) {
logW("ioperm 0x61: %s",strerror(errno));
break;
}
if (ioperm(0x43,8,1)<0) {
logW("ioperm 0x43: %s",strerror(errno));
break;
}
if (ioperm(0x42,8,1)<0) {
logW("ioperm 0x42: %s",strerror(errno));
break;
}
beepFD=STDOUT_FILENO;
#else
errno=ENOSYS;
#endif
break;
}
if (beepFD<0) {
logW("error while opening PC speaker! %s",strerror(errno));
}
}
#endif
beepFreq(0);
/*} else {
beepFreq(0);
}*/
if (realOutThread==NULL) {
realOutThread=new std::thread(_pcSpeakerThread,this);
}
memset(regPool,0,2);
}
bool DivPlatformPCSpeaker::keyOffAffectsArp(int ch) {
return true;
}
void DivPlatformPCSpeaker::setFlags(const DivConfig& flags) {
switch (flags.getInt("clockSel",0)) {
case 1: // PC-98
chipClock=38400*52;
break;
case 2: // PC-98
chipClock=38400*64;
break;
default: // IBM PC
chipClock=COLOR_NTSC/3.0;
break;
}
CHECK_CUSTOM_CLOCK;
rate=chipClock/PCSPKR_DIVIDER;
speakerType=flags.getInt("speakerType",0)&3;
oscBuf->rate=rate;
}
void DivPlatformPCSpeaker::notifyInsDeletion(void* ins) {
for (int i=0; i<1; i++) {
chan[i].std.notifyInsDeletion((DivInstrument*)ins);
}
}
void DivPlatformPCSpeaker::notifyPlaybackStop() {
beepFreq(0);
}
void DivPlatformPCSpeaker::poke(unsigned int addr, unsigned short val) {
// ???
}
void DivPlatformPCSpeaker::poke(std::vector<DivRegWrite>& wlist) {
// ???
}
int DivPlatformPCSpeaker::init(DivEngine* p, int channels, int sugRate, const DivConfig& flags) {
parent=p;
dumpWrites=false;
skipRegisterWrites=false;
beepFD=-1;
realOutQuit=false;
realOutThread=NULL;
realOutMethod=parent->getConfInt("pcSpeakerOutMethod",0);
realOutEnabled=false;
for (int i=0; i<1; i++) {
isMuted[i]=false;
}
oscBuf=new DivDispatchOscBuffer;
setFlags(flags);
reset();
return 5;
}
void DivPlatformPCSpeaker::quit() {
if (speakerType==3) {
beepFreq(0);
}
if (realOutThread!=NULL) {
realOutQuit=true;
realOutCond.notify_one();
realOutThread->join();
delete realOutThread;
}
#ifdef __linux__
if (beepFD>=0 && realOutMethod<3) close(beepFD);
#endif
delete oscBuf;
}
DivPlatformPCSpeaker::~DivPlatformPCSpeaker() {
}