Migrate to a more versatile common player loop that handles delayed DMA on/off. Add two variants with different execution order, one for TFMX v1, that remain compatible with the macro state flag and effects mode flag. Flag Quik'n'Silva accordingly. Implement the rare DMA on with arg. // fixes #21 fixes #19 related to #15

Author: mschwendt

src/Chris/ByChecksum.cpp

@@ -52,7 +52,7 @@ void tfmxaudiodecoder::TFMXDecoder::traitsByChecksum() {
     // Turrican II (1991) ingame music requires a special player variant
     // with different execution order of macros and effects.
     if (T2_checksums.count(crc1) >= 1) {
-        variant.styleT2 = true;
+        variant.execOrder = MOD_MAC_SEQ;
     }
     // Turrican (1990) is a TFMXv1 variant and strictly requires old
     // features such as non-scaled vibrato/portamento.
@@ -83,6 +83,10 @@ void tfmxaudiodecoder::TFMXDecoder::traitsByChecksum() {
         setTFMXv1();
         variant.macroLoopExtraWait = true;
     }
+    // The Adventures of Quik & Silva.
+    else if (crc1 == 0x04f469a6 || crc1 == 0xd37c9008 ) {
+        variant.execOrder = MAC_MOD_SEQ;
+    }
     // Rock'n'Roll (1989). No checksum based adjustments required, because
     // it uses the unique header tag that was specific to TFMX before v1.
     // Except for the intro.

src/Chris/Macro.cpp

@@ -175,13 +175,34 @@ void TFMXDecoder::macroFunc_StartSample(VoiceVars& voice) {
     // There are variants of the "DMAon" macro command, which
     // are not needed because we don't emulate access to Amiga
     // custom chip registers like DMACON, INTENA and INTREQ.
-    if (variant.styleT2) {
-        voice.macro.delayedOn = true;
+    if ( variant.noDelayedDMAon ) {
+        voice.ch->on();
     }
     else {
-        voice.ch->on();
-        voice.effectsMode = (sbyte)cmd.bb;
+        voice.macro.delayedOn = true;
+    }
+
+    // Variants of the player can set the macro wait value here.
+    // The high byte (in cmd.aa) is set to zero early, so only the
+    // low byte (in cmd.bb) would matter. However, as the low byte
+    // is 0 for all but a very few TFMX files, the resulting wait
+    // value would stay at 0, which would be pointless.
+    //
+    // Furthermore, of the existing files that run a subsequent Wait
+    // command, that wait value would take precedence. It can be
+    // assumed that setting the wait value here is not the real goal.
+    //
+    // Instead, of the few remaining files that set the first parameter
+    // to 1, they want the player to run sound synthesis via the effects
+    // processor a first time before turning on the audio channel.
+    if (cmd.bb != 0) {
+        voice.effectsMode = 1;
+        if (variant.execOrder == MOD_MAC_SEQ) {
+            processModulation(voice);
+            return;
+        }
     }
+
     voice.macro.step++;
     macroEvalAgain = true;
 }

src/Chris/TFMXDecoder.cpp

@@ -303,8 +303,9 @@ bool TFMXDecoder::init(void *data, udword length, int songNumber) {
     variant.macroLoopExtraWait = false;
     variant.bpmSpeed5 = false;
     variant.noAddBeginCount = false;
+    variant.noDelayedDMAon = false;
     variant.noTrackMute = false;
-    variant.styleT2 = false;
+    variant.execOrder = MAC_MOD_SEQ;
 
     PattCmdFuncs[0] = &TFMXDecoder::pattCmd_End;
     PattCmdFuncs[1] = &TFMXDecoder::pattCmd_Loop;
@@ -506,6 +507,8 @@ void TFMXDecoder::setTFMXv1() {
     variant.portaOverride = true;
     variant.setNoteV1 = true;
     variant.extraWaitV1 = true;
+    variant.noDelayedDMAon = true;
+    variant.execOrder = SEQ_MOD_MAC;
     MacroDefs[0xd] = &macroDef_AddVolume;
     // max. macro cmd = $19
     for (ubyte m = 0x1a; m<0x40; m++) {
@@ -746,12 +749,7 @@ int TFMXDecoder::run() {
 #if defined(DEBUG_RUN)
     dumpTimestamp(songPosCurrent);
 #endif
-    if (variant.styleT2) {
-        playerStyleT2();
-    }
-    else {
-        playerCommon();
-    }
+    playerCommon();
     tickFPadd += tickFP;
     int tick = tickFPadd>>8;
     tickFPadd &= 0xff;
@@ -766,39 +764,35 @@ void TFMXDecoder::playerCommon() {
     if ( !songEnd || loopMode ) {
         handleWaitOnPaulaDone();
         handleDelayedDMAoff();
-        for (ubyte v=0; v<voices; v++) {
-            VoiceVars& voice = voiceVars[v];
-            processMacroMain( voice );
-            processModulation( voice );
-            voice.ch->paula.period = voice.outputPeriod;
-        }
-        runMain();
-    }
-}
 
-// Note: This is not final yet. In variants of the TFMX player, order of
-// execution and usage of macro state/skip flag, effects mode flag and
-// extra wait is all over the place.
-void TFMXDecoder::playerStyleT2() {
-#if defined(DEBUG_RUN)
-    cout << "  playerStyleT2()" << endl;
-#endif
-    if ( !songEnd || loopMode ) {
-        handleWaitOnPaulaDone();
-        handleDelayedDMAoff();
-        for (ubyte v=0; v<voices; v++) {
-            VoiceVars& voice = voiceVars[v];
-            if (voice.macro.state <= 0) {
+        if (variant.execOrder == MOD_MAC_SEQ) {
+            for (ubyte v=0; v<voices; v++) {
+                VoiceVars& voice = voiceVars[v];
                 processModulation( voice );
                 processMacroMain( voice );
+                voice.ch->paula.period = voice.outputPeriod;
             }
-            else if (voice.macro.state > 0) {
+            runMain();
+        }
+        else if (variant.execOrder == SEQ_MOD_MAC) {
+            runMain();
+            for (ubyte v=0; v<voices; v++) {
+                VoiceVars& voice = voiceVars[v];
+                processModulation( voice );
+                processMacroMain( voice );
+                voice.ch->paula.period = voice.outputPeriod;
+            }
+        }
+        else {  // if (variant.execOrder == MAC_MOD_SEQ) {
+            for (ubyte v=0; v<voices; v++) {
+                VoiceVars& voice = voiceVars[v];
                 processMacroMain( voice );
-                voice.effectsMode = 1;  // force to ON for this player variant
+                processModulation( voice );
+                voice.ch->paula.period = voice.outputPeriod;
             }
-            voice.ch->paula.period = voice.outputPeriod;
+            runMain();
         }
-        runMain();
+
         handleDelayedDMAon();
     }
 }
@@ -840,12 +834,7 @@ void TFMXDecoder::noteCmd() {
         v.note = cmd.aa;
         v.keyUp = false;
         v.macro.offset = getMacroOffset(cmd.bb & 0x7f);
-        if (variant.styleT2) {
-            v.macro.state = 1;
-        }
-        else {
-            initMacro(v);
-        }
+        v.macro.state = 1;
     }
     else {  // cmd.aa >= $c0   portamento note
         v.portamento.count = cmd.bb;

src/Chris/TFMXDecoder.h

@@ -85,6 +85,15 @@ class TFMXDecoder : public Decoder {
         udword trackTableEnd;
     } offsets;
 
+    enum ExecOrder {
+        // SEQ : sequencer
+        // MAC : macro processing
+        // MOD : modulation/effects processing
+        SEQ_MOD_MAC,
+        MOD_MAC_SEQ,
+        MAC_MOD_SEQ
+    };
+
     struct Admin {
         sword speed, count;  // speed and speed count
         int startSpeed, startSong;
@@ -250,7 +259,6 @@ class TFMXDecoder : public Decoder {
     void runMain();
     void processPTTR(Track&);
     void playerCommon();
-    void playerStyleT2();
 
     void processModulation(VoiceVars&);
     void addBegin(VoiceVars&);
@@ -556,8 +564,10 @@ class TFMXDecoder : public Decoder {
         bool macroLoopExtraWait;
         bool bpmSpeed5;
         bool noAddBeginCount;
+        bool noDelayedDMAon;
         bool noTrackMute;
-        bool styleT2;
+        // Main player order of execution.
+        ExecOrder execOrder;
     } variant;
 
     struct {