implement operator mask effect

doc/6-sample/README.md

@@ -61,7 +61,7 @@ if you need to use more samples, you may change the sample bank using effect `EB
 due to limitations in some of those sound chips, some restrictions exist:
 
 - Amiga: maximum frequency is 31469Hz, but anything over 28867 will sound glitchy on hardware. sample lengths and loop will be set to an even number, and your sample can't be longer than 131070.
-- NES: if on DPCM mode, only a limited selection of frequencies is available, and loop position isn't supported (only entire sample).
+- NES: if on DPCM mode, only a limited selection of frequencies is available.
 - SegaPCM: your sample can't be longer than 65535, and the maximum frequency is 31.25KHz.
 - QSound: your sample can't be longer than 65535, and the loop length shall not be greater than 32767.
 - ADPCM-A: no looping supported. your samples will play at around 18.518KHz.

doc/7-systems/genesis.md

@@ -1,65 +0,0 @@
-# Sega Genesis/Mega Drive
-
-a video game console that showed itself as the first true rival to Nintendo's video game market near-monopoly in the US during the '80s.
-
-this console is powered by two sound chips: the [Yamaha YM2612](ym2612.md) and [a derivative of the SN76489](sms.md).
-
-## effects
-
-- `10xy`: **set LFO parameters.**
-  - `x` toggles the LFO.
-  - `y` sets its speed.
-- `11xx`: **set feedback of channel.**
-- `12xx`: **set operator 1 level.**
-- `13xx`: **set operator 2 level.**
-- `14xx`: **set operator 3 level.**
-- `15xx`: **set operator 4 level.**
-- `16xy`: **set multiplier of operator.**
-  - `x` is the operator (1-4).
-  - `y` is the new MULT value..
-- `17xx`: **enable PCM channel.**
-  - this only works on channel 6.
-  - _this effect is here for compatibility reasons!_ it is otherwise recommended to use Sample type instruments (which automatically enable PCM mode when used).
-- `18xx`: **toggle extended channel 3 mode.**
-  - `0` disables it and `1` enables it.
-  - only in extended channel 3 chip.
-- `19xx`: **set attack of all operators.**
-- `1Axx`: **set attack of operator 1.**
-- `1Bxx`: **set attack of operator 2.**
-- `1Cxx`: **set attack of operator 3.**
-- `1Dxx`: **set attack of operator 4.**
-- `20xy`: **set PSG noise mode.**
-  - `x` controls whether to inherit frequency from PSG channel 3.
-    - `0`: use one of 3 preset frequencies (`C`: A-2; `C#`: A-3; `D`: A-4).
-    - `1`: use frequency of PSG channel 3.
-  - `y` controls whether to select noise or thin pulse.
-    - `0`: thin pulse.
-    - `1`: noise.
-
-
-
-## system modes
-
-## extended channel 3
-
-in ExtCh mode, channel 3 is split into one column for each of its four operators. feedback and LFO levels are shared. the frequency of each operator may be controlled independently with notes and effects. this can be used for more polyphony or more complex sounds.
-
-all four operators are still combined according to the algorithm in use. for example, algorithm 7 acts as four independent sine waves. algorithm 4 acts as two independent 2-op sounds. even with algorithm 0, placing a note in any operator triggers that operator alone.
-
-## CSM
-
-CSM is short for "Composite Sinusoidal Modeling". CSM works by sending key-on and key-off commands to channel 3 at a specific frequency, controlled by the added "CSM Timer" channel. this can be used to create vocal formants (speech synthesis!) or other complex effects.
-
-CSM is beyond the scope of this documentation. for more information, see this [brief SSG-EG and CSM video tutorial](https://www.youtube.com/watch?v=IKOR0TUlnWU).
-
-## DualPCM
-
-[info here.](ym2612.md)
-
-## Sega CD
-
-this isn't a mode so much as a chip configuration. it adds the [Ricoh RF5C68](ricoh.md) found in the Sega CD add-on, providing 8 channels of PCM.
-
-## chip config
-
-see [YM2612](ym2612.md) and [SN76489](sms.md) for respective configuration.

doc/7-systems/ym2151.md

@@ -68,6 +68,9 @@ in most arcade boards the chip was used in combination with a PCM chip, like [Se
 - `5Dxx`: **set D2R/SR of operator 2.**
 - `5Exx`: **set D2R/SR of operator 3.**
 - `5Fxx`: **set D2R/SR of operator 4.**
+- `60xx`: **set operator mask.**
+  - `xx` goes from `0` to `F`. it is a bitfield.
+    - each bit corresponds to an operator.
 
 ## info
 

doc/7-systems/ym2203.md

@@ -99,6 +99,9 @@ several variants of this chip were released as well, with more features.
 - `5Dxx`: **set D2R/SR of operator 2.**
 - `5Exx`: **set D2R/SR of operator 3.**
 - `5Fxx`: **set D2R/SR of operator 4.**
+- `60xx`: **set operator mask.**
+  - `xx` goes from `0` to `F`. it is a bitfield.
+    - each bit corresponds to an operator.
 
 ## extended channel 3
 

doc/7-systems/ym2608.md

@@ -99,6 +99,9 @@ the YM2610 (OPNB) and YM2610B chips are very similar to this one, but the built-
 - `5Dxx`: **set D2R/SR of operator 2.**
 - `5Exx`: **set D2R/SR of operator 3.**
 - `5Fxx`: **set D2R/SR of operator 4.**
+- `60xx`: **set operator mask.**
+  - `xx` goes from `0` to `F`. it is a bitfield.
+    - each bit corresponds to an operator.
   
 ## extended channel 3
 

doc/7-systems/ym2610.md

@@ -97,6 +97,9 @@ its soundchip is a 4-in-1: 4ch 4-op FM, YM2149 (AY-3-8910 clone) and [2 differen
 - `5Dxx`: **set D2R/SR of operator 2.**
 - `5Exx`: **set D2R/SR of operator 3.**
 - `5Fxx`: **set D2R/SR of operator 4.**
+- `60xx`: **set operator mask.**
+  - `xx` goes from `0` to `F`. it is a bitfield.
+    - each bit corresponds to an operator.
 
 ## extended channel 2
 

doc/7-systems/ym2610b.md

@@ -96,6 +96,9 @@ it is backward compatible with the original chip.
 - `5Dxx`: **set D2R/SR of operator 2.**
 - `5Exx`: **set D2R/SR of operator 3.**
 - `5Fxx`: **set D2R/SR of operator 4.**
+- `60xx`: **set operator mask.**
+  - `xx` goes from `0` to `F`. it is a bitfield.
+    - each bit corresponds to an operator.
 
 ## extended channel 3
 

doc/7-systems/ym2612.md

@@ -82,6 +82,9 @@ thanks to the Z80 sound CPU, DualPCM can play two samples at once! this mode spl
 - `5Dxx`: **set D2R/SR of operator 2.**
 - `5Exx`: **set D2R/SR of operator 3.**
 - `5Fxx`: **set D2R/SR of operator 4.**
+- `60xx`: **set operator mask.**
+  - `xx` goes from `0` to `F`. it is a bitfield.
+    - each bit corresponds to an operator.
 
 ## info
 

src/engine/dispatch.h

@@ -266,6 +266,8 @@ enum DivDispatchCmds {
 
   DIV_CMD_FDS_MOD_AUTO,
 
+  DIV_CMD_FM_OPMASK, // (mask)
+
   DIV_CMD_MAX
 };
 

src/engine/platform/arcade.cpp

@@ -761,6 +761,12 @@ int DivPlatformArcade::dispatch(DivCommand c) {
       immWrite(0x19,0x80|pmDepth);
       break;
     }
+    case DIV_CMD_FM_OPMASK:
+      chan[c.chan].opMask=c.value&15;
+      if (chan[c.chan].active) {
+        chan[c.chan].opMaskChanged=true;
+      }
+      break;
     case DIV_CMD_FM_HARD_RESET:
       chan[c.chan].hardReset=c.value;
       break;

src/engine/platform/genesis.cpp

@@ -1463,6 +1463,13 @@ int DivPlatformGenesis::dispatch(DivCommand c) {
       }
       break;
     }
+    case DIV_CMD_FM_OPMASK:
+      if (c.chan>=psgChanOffs) break;
+      chan[c.chan].opMask=c.value&15;
+      if (chan[c.chan].active) {
+        chan[c.chan].opMaskChanged=true;
+      }
+      break;
     case DIV_CMD_FM_HARD_RESET:
       if (c.chan>=6) break;
       chan[c.chan].hardReset=c.value;

src/engine/platform/tx81z.cpp

@@ -858,6 +858,9 @@ int DivPlatformTX81Z::dispatch(DivCommand c) {
       immWrite(0x17,0x80|pmDepth);
       break;
     }
+    case DIV_CMD_FM_OPMASK:
+      // TODO: if OPZ supports op mask
+      break;
     case DIV_CMD_FM_HARD_RESET:
       chan[c.chan].hardReset=c.value;
       break;

src/engine/platform/ym2203.cpp

@@ -1004,6 +1004,13 @@ int DivPlatformYM2203::dispatch(DivCommand c) {
       }
       break;
     }
+    case DIV_CMD_FM_OPMASK:
+      if (c.chan>=psgChanOffs) break;
+      chan[c.chan].opMask=c.value&15;
+      if (chan[c.chan].active) {
+        chan[c.chan].opMaskChanged=true;
+      }
+      break;
     case DIV_CMD_FM_HARD_RESET:
       chan[c.chan].hardReset=c.value;
       break;

src/engine/platform/ym2608.cpp

@@ -1537,6 +1537,13 @@ int DivPlatformYM2608::dispatch(DivCommand c) {
       }
       break;
     }
+    case DIV_CMD_FM_OPMASK:
+      if (c.chan>=psgChanOffs) break;
+      chan[c.chan].opMask=c.value&15;
+      if (chan[c.chan].active) {
+        chan[c.chan].opMaskChanged=true;
+      }
+      break;
     case DIV_CMD_FM_HARD_RESET:
       chan[c.chan].hardReset=c.value;
       break;

src/engine/platform/ym2610.cpp

@@ -1507,6 +1507,13 @@ int DivPlatformYM2610::dispatch(DivCommand c) {
       }
       break;
     }
+    case DIV_CMD_FM_OPMASK:
+      if (c.chan>=psgChanOffs) break;
+      chan[c.chan].opMask=c.value&15;
+      if (chan[c.chan].active) {
+        chan[c.chan].opMaskChanged=true;
+      }
+      break;
     case DIV_CMD_FM_HARD_RESET:
       chan[c.chan].hardReset=c.value;
       break;

src/engine/platform/ym2610b.cpp

@@ -1576,6 +1576,13 @@ int DivPlatformYM2610B::dispatch(DivCommand c) {
       }
       break;
     }
+    case DIV_CMD_FM_OPMASK:
+      if (c.chan>=psgChanOffs) break;
+      chan[c.chan].opMask=c.value&15;
+      if (chan[c.chan].active) {
+        chan[c.chan].opMaskChanged=true;
+      }
+      break;
     case DIV_CMD_FM_HARD_RESET:
       chan[c.chan].hardReset=c.value;
       break;

src/engine/playback.cpp

@@ -264,7 +264,9 @@ const char* cmdName[]={
   "BIFURCATOR_STATE_LOAD",
   "BIFURCATOR_PARAMETER",
 
-  "FDS_MOD_AUTO"
+  "FDS_MOD_AUTO",
+
+  "FM_OPMASK"
 };
 
 static_assert((sizeof(cmdName)/sizeof(void*))==DIV_CMD_MAX,"update cmdName!");

src/engine/sysDef.cpp

@@ -504,6 +504,7 @@ void DivEngine::registerSystems() {
     {0x5d, {DIV_CMD_FM_D2R, _("5Dxx: Set decay 2 of operator 2 (0 to 1F)"), constVal<1>, effectValAnd<31>}},
     {0x5e, {DIV_CMD_FM_D2R, _("5Exx: Set decay 2 of operator 3 (0 to 1F)"), constVal<2>, effectValAnd<31>}},
     {0x5f, {DIV_CMD_FM_D2R, _("5Fxx: Set decay 2 of operator 4 (0 to 1F)"), constVal<3>, effectValAnd<31>}},
+    {0x60, {DIV_CMD_FM_OPMASK, _("60xx: Set operator mask (bits 0-3)")}},
   };
 
   EffectHandlerMap fmOPMPostEffectHandlerMap(fmOPNPostEffectHandlerMap);
@@ -514,6 +515,7 @@ void DivEngine::registerSystems() {
     {0x1e, {DIV_CMD_FM_AM_DEPTH, _("1Exx: Set AM depth (0 to 7F)"), effectValAnd<127>}},
     {0x1f, {DIV_CMD_FM_PM_DEPTH, _("1Fxx: Set PM depth (0 to 7F)"), effectValAnd<127>}},
     {0x55, {DIV_CMD_FM_SSG, _("55xy: Set detune 2 (x: operator from 1 to 4 (0 for all ops); y: detune from 0 to 3)"), effectOpVal<4>, effectValAnd<3>}},
+    {0x60, {DIV_CMD_FM_OPMASK, _("60xx: Set operator mask (bits 0-3)")}},
   });
 
   EffectHandlerMap fmOPZPostEffectHandlerMap(fmOPMPostEffectHandlerMap);