nullsound: retrigger FX

Also add the missing nsstool features for the cut and delay refactoring
from the previous commit

Author: dciabrin

nullsound/fx-trigger.s

@@ -41,7 +41,7 @@ trigger_delay_init::
         inc     hl
 
         ;; configure trigger FX for delay
-        ld      TRIGGER_DELAY(ix), a
+        ld      TRIGGER_CUR(ix), a
         xor     a
         set     BIT_TRIGGER_ACTION_DELAY, a
         ld      TRIGGER_ACTION(ix), a
@@ -62,8 +62,8 @@ trigger_cut_init::
         inc     a
         inc     hl
 
-        ;; configure trigger FX for delay
-        ld      TRIGGER_CUT(ix), a
+        ;; configure trigger FX for cut
+        ld      TRIGGER_CUR(ix), a
         xor     a
         set     BIT_TRIGGER_ACTION_CUT, a
         ld      TRIGGER_ACTION(ix), a
@@ -72,6 +72,27 @@ trigger_cut_init::
         ret
 
 
+;;; Enable another note trigger after a defined number of steps
+;;; ------
+;;;   ix  : state for channel
+;;; [ hl ]: delay
+;;; [ hl modified ]
+trigger_retrigger_init::
+        ;; a: delay
+        ld      a, (hl)
+        inc     hl
+
+        ;; configure trigger FX for retrigger
+        ld      TRIGGER_ARG(ix), a
+        ld      TRIGGER_CUR(ix), a
+        xor     a
+        set     BIT_TRIGGER_ACTION_RETRIGGER, a
+        ld      TRIGGER_ACTION(ix), a
+        set     BIT_FX_TRIGGER, FX(ix)
+
+        ret
+
+
 ;;; Call an function from the action lookup table
 ;;; ------
 ;;; hl: function lookup table
@@ -103,26 +124,42 @@ _trigger_post_action:
 ;;; hl: function lookup table for the current channel
 ;;; [hl, bc, de modified]
 eval_trigger_step::
-        ;; is the trigger a delay?
-        bit     BIT_TRIGGER_ACTION_DELAY, TRIGGER_ACTION(ix)
-        jr      z, _trigger_post_delay
-        ;; check whether delay is reached
-        dec     TRIGGER_DELAY(ix)
+        ;; if this is a retrigger, check whether we reached the last tick
+        ;; for this row, and stop it after this eval
+        bit     BIT_TRIGGER_ACTION_RETRIGGER, TRIGGER_ACTION(ix)
+        jr      z, _trigger_post_retrigger_check
+        ld      a, (state_timer_ticks_per_row)
+        ld      b, a
+        ld      a, (state_timer_ticks_count)
+        inc     a
+        sub     b
+        jr      c, _trigger_post_retrigger_check
+        res     BIT_FX_TRIGGER, FX(ix)
+_trigger_post_retrigger_check:
+
+        ;; check whether delay is reached for trigger action
+        dec     TRIGGER_CUR(ix)
         jr      nz, _trigger_end
+        ;; if so, run the configured action
+        bit     BIT_TRIGGER_ACTION_DELAY, TRIGGER_ACTION(ix)
+        jr      z, _trigger_not_a_delay
         jr      _trigger_load_and_clear
-_trigger_post_delay:
-
-        ;; is the trigger a cut?
+_trigger_not_a_delay:
         bit     BIT_TRIGGER_ACTION_CUT, TRIGGER_ACTION(ix)
-        jr      z, _trigger_post_cut
-        ;; check whether delay is reached
-        dec     TRIGGER_CUT(ix)
-        jr      nz, _trigger_end
+        jr      z, _trigger_not_a_cut
         jr      _trigger_cut_note
-_trigger_post_cut:
+_trigger_not_a_cut:
+        ;; is the trigger a cut?
+        bit     BIT_TRIGGER_ACTION_RETRIGGER, TRIGGER_ACTION(ix)
+        jr      z, _trigger_not_a_retrigger
+        jr      _trigger_retrigger_note
+_trigger_not_a_retrigger:
+
 _trigger_end:
         ret
 
+
+;;; trigger: load delayed note/vol
 _trigger_load_and_clear:
         ;; load new note?
         bit     BIT_TRIGGER_LOAD_NOTE, TRIGGER_ACTION(ix)
@@ -131,28 +168,33 @@ _trigger_load_and_clear:
         ld      bc, #TRIGGER_LOAD_NOTE_FUNC
         call    trigger_action_function
 _trigger_post_load_note:
-
         ;; load new vol?
         bit     BIT_TRIGGER_LOAD_VOL, TRIGGER_ACTION(ix)
         jr      z, _trigger_post_load_vol
         ld      a, TRIGGER_VOL(ix)
         ld      bc, #TRIGGER_LOAD_VOL_FUNC
         call    trigger_action_function
 _trigger_post_load_vol:
-
-        ;; trigger is finished
-        xor     a
-        ld      TRIGGER_ACTION(ix), a
+        res     BIT_TRIGGER_ACTION_DELAY, TRIGGER_ACTION(ix)
         res     BIT_FX_TRIGGER, FX(ix)
-
         ret
 
+
+;;; trigger: cut current note
 _trigger_cut_note:
         ld      bc, #TRIGGER_STOP_NOTE_FUNC
         call    trigger_action_function
-        xor     a
-        ld      TRIGGER_ACTION(ix), a
+        res     BIT_TRIGGER_ACTION_DELAY, TRIGGER_ACTION(ix)
         res     BIT_FX_TRIGGER, FX(ix)
+        ret
+
 
+;;; trigger: restart current note
+_trigger_retrigger_note:
+        ld      bc, #TRIGGER_LOAD_NOTE_FUNC
+        call    trigger_action_function
+        ;; rearm trigger for the next step
+        ld      a, TRIGGER_ARG(ix)
+        ld      TRIGGER_CUR(ix), a
         ret
 

nullsound/nss-adpcm-a.s

@@ -605,3 +605,14 @@ adpcm_a_cut::
 
         ld      a, #1
         ret
+
+
+;;; ADPCM_A_RETRIGGER
+;;; Enable another trigger of the current note after a number of steps
+;;; ------
+;;; [ hl ]: delay
+adpcm_a_retrigger::
+        call    trigger_retrigger_init
+
+        ld      a, #1
+        ret

nullsound/stream.s

@@ -525,6 +525,7 @@ nss_opcodes:
         .nss_op adpcm_a_cut
         .nss_op adpcm_b_cut
         .nss_op adpcm_b_delay
+        .nss_op adpcm_a_retrigger
 
 
 

nullsound/struct-fx.inc

@@ -27,7 +27,7 @@
         .area   struct
 
         .local  pipeline, fx_fx, fx_trigger, fx_vol_slide, fx_slide, fx_vibrato
-        .local  _trigger_action, _trigger_note, _trigger_vol, _trigger_cut, _trigger_delay, _trigger_size
+        .local  _trigger_action, _trigger_note, _trigger_vol, _trigger_arg, _trigger_cur, _trigger_size
         .local  _vol_slide_inc16, _vol_slide_pos16, _vol_slide_end, _vol_slide_size
         .local  _slide_speed, _slide_depth, _slide_inc16, _slide_pos16, _slide_portamento, _slide_end, _slide_size
         .local _vibrato_speed, _vibrato_depth, _vibrato_pos, _vibrato_pos16, _vibrato_size
@@ -37,11 +37,11 @@ pipeline:               .blkb 1
 ;;; enabled FX. This must be the second field of a channel's state
 fx_fx:                  .blkb 1
 fx_trigger:
-_trigger_action:        .blkb 1
-_trigger_note:          .blkb 1
-_trigger_vol:           .blkb 1
-_trigger_cut:           .blkb 1
-_trigger_delay:         .blkb 1
+_trigger_action:        .blkb 1         ; trigger action (cut, delay, retrigger)
+_trigger_note:          .blkb 1         ; trigger delayed note
+_trigger_vol:           .blkb 1         ; trigger delayed volume
+_trigger_arg:           .blkb 1         ; per-action argument
+_trigger_cur:           .blkb 1         ; per-action current accumulator
 _trigger_size:
 ;;; FX: volume slide
 fx_vol_slide:
@@ -75,8 +75,8 @@ _vibrato_size:
         .lclequ TRIGGER_ACTION, (_trigger_action - pipeline)
         .lclequ TRIGGER_NOTE,   (_trigger_note - pipeline)
         .lclequ TRIGGER_VOL,    (_trigger_vol - pipeline)
-        .lclequ TRIGGER_CUT,    (_trigger_cut - pipeline)
-        .lclequ TRIGGER_DELAY,  (_trigger_delay - pipeline)
+        .lclequ TRIGGER_ARG,    (_trigger_arg - pipeline)
+        .lclequ TRIGGER_CUR,    (_trigger_cur - pipeline)
         .lclequ TRIGGER_SIZE,   (_trigger_size - fx_trigger)
         .lclequ VOL_SLIDE,      (fx_vol_slide - pipeline)
         .lclequ VOL_SLIDE_INC16, (_vol_slide_inc16 - pipeline)
@@ -109,5 +109,6 @@ _vibrato_size:
 
         .lclequ BIT_TRIGGER_ACTION_DELAY,       0
         .lclequ BIT_TRIGGER_ACTION_CUT,         1
+        .lclequ BIT_TRIGGER_ACTION_RETRIGGER,   2
         .lclequ BIT_TRIGGER_LOAD_NOTE,          4
         .lclequ BIT_TRIGGER_LOAD_VOL,           5

tools/nsstool.py

@@ -282,6 +282,13 @@ def register_nss_ops():
         ("b_porta", ["speed"]),
         ("s_pitch_slide_d", ["speed"]),
         ("s_porta", ["speed"]),
+        ("fm_cut",   ["delay"]),
+        ("s_cut",    ["delay"]),
+        ("a_cut",    ["delay"]),
+        # 0x60
+        ("b_cut",    ["delay"]),
+        ("b_delay",  ["delay"]),
+        ("a_retrigger", ["delay"]),
         # reserved opcodes
         ("nss_label", ["pat"])
     )
@@ -371,6 +378,8 @@ def convert_fm_row(row, channel):
                 opcodes.append(fm_pitch_slide_u(fxval))
             elif fx == 0x03:  # portamento
                 opcodes.append(fm_porta(fxval))
+            elif fx == 0xec:  # cut
+                opcodes.append(fm_cut(fxval))
             else:
                 add_unknown_fx('FM', fx)
 
@@ -457,6 +466,8 @@ def convert_s_row(row, channel):
                 opcodes.append(s_pitch_slide_d(fxval))
             elif fx == 0x03:  # pitch slide down
                 opcodes.append(s_porta(fxval))
+            elif fx == 0xec:  # cut
+                opcodes.append(s_cut(fxval))
             else:
                 add_unknown_fx('SSG', fx)
 
@@ -498,8 +509,12 @@ def convert_a_row(row, channel):
                 jmp_to_order = 256
             elif fx == 0xff:  # Stop song
                 jmp_to_order = 257
+            elif fx == 0x0c:  # retrigger
+                opcodes.append(a_retrigger(fxval))
             elif fx == 0x0f:  # Speed
                 opcodes.append(speed(fxval))
+            elif fx == 0xec:  # cut
+                opcodes.append(a_cut(fxval))
             else:
                 add_unknown_fx('ADPCM-A', fx)
 
@@ -516,6 +531,10 @@ def convert_b_row(row, channel):
     jmp_to_order = -1
     opcodes = []
     if not is_empty(row):
+        # pre note/vol/instrument effects
+        for fx, fxval in row.fx:
+            if fx == 0xed:  # note delay
+                opcodes.append(b_delay(fxval))
         # instrument
         if row.ins != -1:
             opcodes.append(b_instr(row.ins))
@@ -526,6 +545,8 @@ def convert_b_row(row, channel):
         for fx, fxval in row.fx:
             if fx == -1:      # empty fx
                 pass
+            elif fx in [0xed]: # pre-instrument FX
+                pass
             elif fx == 0x0b:  # Jump to order
                 jmp_to_order = fxval
             elif fx == 0x0d:  # Jump to next order
@@ -540,6 +561,8 @@ def convert_b_row(row, channel):
                 opcodes.append(b_pitch_slide_u(fxval))
             elif fx == 0x03:  # portamento
                 opcodes.append(b_porta(fxval))
+            elif fx == 0xec:  # cut
+                opcodes.append(b_cut(fxval))
             else:
                 add_unknown_fx('ADPCM-B', fx)