otomatalabs/furnace
7
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

partially implement command stream binary mode

Browse source
This commit is contained in:
tildearrow 2022-08-04 18:50:52 -05:00
parent f2b6f854a9
commit 3a18e1e6fc
3 changed files with 181 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
papers/export-tech.md
View file

@ -11,28 +11,16 @@ if it is a 2-byte macro, read a dummy byte.
then read data. then read data.
## pattern data ## binary command stream
read sequentially. read channel, command and values.
first byte determines what to read next: if channel is 80 or higher, then it is a special command:
``` ```
NVI..EEE fb xx xx xx xx: set tick rate
fc xx xx: wait xxxx ticks
N: note fd xx: wait xx ticks
V: volume fe: wait one tick
I: instrument ff: stop
EEE: effect count (0-7)
``` ```
if you read 0, end of pattern.
otherwise read in following order:
1. note
2. volume
3. instrument
4. effect and effect value
then read number of rows until next value, minus 1.

192
src/engine/engine.cpp
View file

@ -235,8 +235,131 @@ double DivEngine::benchmarkSeek() {
return tAvg; return tAvg;
} }
#define WRITE_TICK \
if (!wroteTick) { \
wroteTick=true; \
if (binary) { \
if (tick-lastTick>255) { \
w->writeC(0xfc); \
w->writeS(tick-lastTick); \
} else if (tick-lastTick>1) { \
w->writeC(0xfd); \
w->writeC(tick-lastTick); \
} else { \
w->writeC(0xfe); \
} \
} else { \
w->writeText(fmt::sprintf(">> TICK %d\n",tick)); \
} \
lastTick=tick; \
}
void writePackedCommandValues(SafeWriter* w, const DivCommand& c) {
w->writeC(c.cmd);
switch (c.cmd) {
case DIV_CMD_NOTE_ON:
case DIV_CMD_HINT_LEGATO:
if (c.value==DIV_NOTE_NULL) {
w->writeC(0xff);
} else {
w->writeC(c.value+60);
}
break;
case DIV_CMD_NOTE_OFF:
case DIV_CMD_NOTE_OFF_ENV:
case DIV_CMD_ENV_RELEASE:
break;
case DIV_CMD_INSTRUMENT:
case DIV_CMD_HINT_VIBRATO_RANGE:
case DIV_CMD_HINT_VIBRATO_SHAPE:
case DIV_CMD_HINT_PITCH:
case DIV_CMD_HINT_VOLUME:
case DIV_CMD_SAMPLE_MODE:
case DIV_CMD_SAMPLE_FREQ:
case DIV_CMD_SAMPLE_BANK:
case DIV_CMD_SAMPLE_POS:
case DIV_CMD_SAMPLE_DIR:
case DIV_CMD_FM_HARD_RESET:
case DIV_CMD_FM_LFO:
case DIV_CMD_FM_LFO_WAVE:
case DIV_CMD_FM_FB:
case DIV_CMD_FM_EXTCH:
case DIV_CMD_FM_AM_DEPTH:
case DIV_CMD_FM_PM_DEPTH:
case DIV_CMD_STD_NOISE_FREQ:
case DIV_CMD_STD_NOISE_MODE:
case DIV_CMD_WAVE:
case DIV_CMD_GB_SWEEP_TIME:
case DIV_CMD_GB_SWEEP_DIR:
case DIV_CMD_PCE_LFO_MODE:
case DIV_CMD_PCE_LFO_SPEED:
case DIV_CMD_NES_DMC:
case DIV_CMD_C64_CUTOFF:
case DIV_CMD_C64_RESONANCE:
case DIV_CMD_C64_FILTER_MODE:
case DIV_CMD_C64_RESET_TIME:
case DIV_CMD_C64_RESET_MASK:
case DIV_CMD_C64_FILTER_RESET:
case DIV_CMD_C64_DUTY_RESET:
case DIV_CMD_C64_EXTENDED:
case DIV_CMD_AY_ENVELOPE_SET:
case DIV_CMD_AY_ENVELOPE_LOW:
case DIV_CMD_AY_ENVELOPE_HIGH:
case DIV_CMD_AY_ENVELOPE_SLIDE:
case DIV_CMD_AY_NOISE_MASK_AND:
case DIV_CMD_AY_NOISE_MASK_OR:
case DIV_CMD_AY_AUTO_ENVELOPE:
w->writeC(c.value);
break;
case DIV_CMD_PANNING:
case DIV_CMD_HINT_VIBRATO:
case DIV_CMD_HINT_ARPEGGIO:
case DIV_CMD_HINT_PORTA:
case DIV_CMD_FM_TL:
case DIV_CMD_FM_AM:
case DIV_CMD_FM_AR:
case DIV_CMD_FM_DR:
case DIV_CMD_FM_SL:
case DIV_CMD_FM_D2R:
case DIV_CMD_FM_RR:
case DIV_CMD_FM_DT:
case DIV_CMD_FM_DT2:
case DIV_CMD_FM_RS:
case DIV_CMD_FM_KSR:
case DIV_CMD_FM_VIB:
case DIV_CMD_FM_SUS:
case DIV_CMD_FM_WS:
case DIV_CMD_FM_SSG:
case DIV_CMD_FM_REV:
case DIV_CMD_FM_EG_SHIFT:
case DIV_CMD_FM_MULT:
case DIV_CMD_FM_FINE:
case DIV_CMD_AY_IO_WRITE:
case DIV_CMD_AY_AUTO_PWM:
w->writeC(c.value);
w->writeC(c.value2);
break;
case DIV_CMD_PRE_PORTA:
w->writeC((c.value?0x80:0)|(c.value2?0x40:0));
break;
case DIV_CMD_HINT_VOL_SLIDE:
case DIV_CMD_C64_FINE_DUTY:
case DIV_CMD_C64_FINE_CUTOFF:
w->writeS(c.value);
break;
case DIV_CMD_FM_FIXFREQ:
w->writeS((c.value<<12)|(c.value2&0x7ff));
break;
case DIV_CMD_NES_SWEEP:
w->writeC((c.value?8:0)|(c.value2&0x77));
break;
default:
logW("unimplemented command %s!",cmdName[c.cmd]);
break;
}
}
SafeWriter* DivEngine::saveCommand(bool binary) { SafeWriter* DivEngine::saveCommand(bool binary) {
logI("implement! %d",binary);
stop(); stop();
repeatPattern=false; repeatPattern=false;
setOrder(0); setOrder(0);
@ -252,36 +375,43 @@ SafeWriter* DivEngine::saveCommand(bool binary) {
w->init(); w->init();
// write header // write header
w->writeText("# Furnace Command Stream\n\n"); if (binary) {
w->write("FCS",4);
} else {
w->writeText("# Furnace Command Stream\n\n");
w->writeText("[Information]\n"); w->writeText("[Information]\n");
w->writeText(fmt::sprintf("name: %s\n",song.name)); w->writeText(fmt::sprintf("name: %s\n",song.name));
w->writeText(fmt::sprintf("author: %s\n",song.author)); w->writeText(fmt::sprintf("author: %s\n",song.author));
w->writeText(fmt::sprintf("category: %s\n",song.category)); w->writeText(fmt::sprintf("category: %s\n",song.category));
w->writeText(fmt::sprintf("system: %s\n",song.systemName)); w->writeText(fmt::sprintf("system: %s\n",song.systemName));
w->writeText("\n"); w->writeText("\n");
w->writeText("[SubSongInformation]\n"); w->writeText("[SubSongInformation]\n");
w->writeText(fmt::sprintf("name: %s\n",curSubSong->name)); w->writeText(fmt::sprintf("name: %s\n",curSubSong->name));
w->writeText(fmt::sprintf("tickRate: %f\n",curSubSong->hz)); w->writeText(fmt::sprintf("tickRate: %f\n",curSubSong->hz));
w->writeText("\n"); w->writeText("\n");
w->writeText("[SysDefinition]\n"); w->writeText("[SysDefinition]\n");
// TODO // TODO
w->writeText("\n"); w->writeText("\n");
}
// play the song ourselves // play the song ourselves
bool done=false; bool done=false;
playSub(false); playSub(false);
w->writeText("[Stream]\n"); if (!binary) {
w->writeText("[Stream]\n");
}
int tick=0; int tick=0;
bool oldCmdStreamEnabled=cmdStreamEnabled; bool oldCmdStreamEnabled=cmdStreamEnabled;
cmdStreamEnabled=true; cmdStreamEnabled=true;
double curDivider=divider; double curDivider=divider;
int lastTick=0;
while (!done) { while (!done) {
if (nextTick(false,true) || !playing) { if (nextTick(false,true) || !playing) {
done=true; done=true;
@ -290,11 +420,13 @@ SafeWriter* DivEngine::saveCommand(bool binary) {
bool wroteTick=false; bool wroteTick=false;
if (curDivider!=divider) { if (curDivider!=divider) {
curDivider=divider; curDivider=divider;
if (!wroteTick) { WRITE_TICK;
wroteTick=true; if (binary) {
w->writeText(fmt::sprintf(">> TICK %d\n",tick)); w->writeC(0xfb);
w->writeI((int)(curDivider*65536));
} else {
w->writeText(fmt::sprintf(">> SET_RATE %f\n",curDivider));
} }
w->writeText(fmt::sprintf(">> SET_RATE %f\n",curDivider));
} }
for (DivCommand& i: cmdStream) { for (DivCommand& i: cmdStream) {
switch (i.cmd) { switch (i.cmd) {
@ -314,11 +446,13 @@ SafeWriter* DivEngine::saveCommand(bool binary) {
case DIV_CMD_PRE_NOTE: case DIV_CMD_PRE_NOTE:
break; break;
default: default:
if (!wroteTick) { WRITE_TICK;
wroteTick=true; if (binary) {
w->writeText(fmt::sprintf(">> TICK %d\n",tick)); w->writeC(i.chan);
writePackedCommandValues(w,i);
} else {
w->writeText(fmt::sprintf(" %d: %s %d %d\n",i.chan,cmdName[i.cmd],i.value,i.value2));
} }
w->writeText(fmt::sprintf(" %d: %s %d %d\n",i.chan,cmdName[i.cmd],i.value,i.value2));
break; break;
} }
} }
@ -327,10 +461,14 @@ SafeWriter* DivEngine::saveCommand(bool binary) {
} }
cmdStreamEnabled=oldCmdStreamEnabled; cmdStreamEnabled=oldCmdStreamEnabled;
if (!playing) { if (binary) {
w->writeText(">> END\n"); w->writeC(0xff);
} else { } else {
w->writeText(">> LOOP 0\n"); if (!playing) {
w->writeText(">> END\n");
} else {
w->writeText(">> LOOP 0\n");
}
} }
remainingLoops=-1; remainingLoops=-1;

9
src/main.cpp
View file

@ -64,6 +64,7 @@ bool consoleMode=true;
#endif #endif
bool displayEngineFailError=false; bool displayEngineFailError=false;
bool cmdOutBinary=false;
std::vector<TAParam> params; std::vector<TAParam> params;
@ -115,6 +116,11 @@ TAParamResult pConsole(String val) {
return TA_PARAM_SUCCESS; return TA_PARAM_SUCCESS;
} }
TAParamResult pBinary(String val) {
cmdOutBinary=true;
return TA_PARAM_SUCCESS;
}
TAParamResult pLogLevel(String val) { TAParamResult pLogLevel(String val) {
if (val=="trace") { if (val=="trace") {
logLevel=LOGLEVEL_TRACE; logLevel=LOGLEVEL_TRACE;
@ -273,6 +279,7 @@ void initParams() {
params.push_back(TAParam("o","output",true,pOutput,"<filename>","output audio to file")); params.push_back(TAParam("o","output",true,pOutput,"<filename>","output audio to file"));
params.push_back(TAParam("O","vgmout",true,pVGMOut,"<filename>","output .vgm data")); params.push_back(TAParam("O","vgmout",true,pVGMOut,"<filename>","output .vgm data"));
params.push_back(TAParam("C","cmdout",true,pCmdOut,"<filename>","output command stream")); params.push_back(TAParam("C","cmdout",true,pCmdOut,"<filename>","output command stream"));
params.push_back(TAParam("b","binary",false,pBinary,"","set command stream output format to binary"));
params.push_back(TAParam("L","loglevel",true,pLogLevel,"debug|info|warning|error","set the log level (info by default)")); params.push_back(TAParam("L","loglevel",true,pLogLevel,"debug|info|warning|error","set the log level (info by default)"));
params.push_back(TAParam("v","view",true,pView,"pattern|commands|nothing","set visualization (pattern by default)")); params.push_back(TAParam("v","view",true,pView,"pattern|commands|nothing","set visualization (pattern by default)"));
params.push_back(TAParam("c","console",false,pConsole,"","enable console mode")); params.push_back(TAParam("c","console",false,pConsole,"","enable console mode"));
@ -454,7 +461,7 @@ int main(int argc, char** argv) {
} }
if (outName!="" || vgmOutName!="" || cmdOutName!="") { if (outName!="" || vgmOutName!="" || cmdOutName!="") {
if (cmdOutName!="") { if (cmdOutName!="") {
SafeWriter* w=e.saveCommand(false); SafeWriter* w=e.saveCommand(cmdOutBinary);
if (w!=NULL) { if (w!=NULL) {
FILE* f=fopen(cmdOutName.c_str(),"wb"); FILE* f=fopen(cmdOutName.c_str(),"wb");
if (f!=NULL) { if (f!=NULL) {