spessasynth_lib 3.25.1 → 3.25.3

package/utils/xg_hacks.js

@@ -2,6 +2,19 @@ import { SpessaSynthInfo } from "./loggin.js";
 import { consoleColors } from "./other.js";
 import { DEFAULT_PERCUSSION } from "../synthetizer/synth_constants.js";
 
+export const XG_SFX_VOICE = 64;
+
+const GM2_DEFAULT_BANK = 121;
+
+/**
+ * @param sys {SynthSystem}
+ * @returns {number}
+ */
+export function getDefaultBank(sys)
+{
+    return sys === "gm2" ? GM2_DEFAULT_BANK : 0;
+}
+
 /**
  * @param bankNr {number}
  * @returns {boolean}
@@ -11,6 +24,15 @@ export function isXGDrums(bankNr)
     return bankNr === 120 || bankNr === 126 || bankNr === 127;
 }
 
+/**
+ * @param bank {number}
+ * @returns {boolean}
+ */
+export function isValidXGMSB(bank)
+{
+    return isXGDrums(bank) || bank === XG_SFX_VOICE || bank === GM2_DEFAULT_BANK;
+}
+
 /**
  * Bank select hacks abstracted here
  * @param bankBefore {number} the current bank number
@@ -29,12 +51,11 @@ export function parseBankSelect(bankBefore, bank, system, isLSB, isDrums, channe
     // 64 means SFX in MSB, so it is allowed
     let out = bankBefore;
     let drumsStatus = 0;
-    const isValidMSB = b => isXGDrums(b) || b === 64;
     if (isLSB)
     {
-        if (system === "xg")
+        if (isSystemXG(system))
         {
-            if (!isValidMSB(bank))
+            if (!isValidXGMSB(bank))
             {
                 out = bank;
             }
@@ -59,7 +80,7 @@ export function parseBankSelect(bankBefore, bank, system, isLSB, isDrums, channe
                 break;
             
             case "xg":
-                canSetBankSelect = isValidMSB(bank);
+                canSetBankSelect = isValidXGMSB(bank);
                 // for xg, if msb is 120, 126 or 127, then it's drums
                 if (isXGDrums(bank))
                 {
@@ -112,17 +133,61 @@ export function parseBankSelect(bankBefore, bank, system, isLSB, isDrums, channe
 
 
 /**
+ * Chooses a bank number according to spessasynth logic
+ * That is:
+ * for GS, bank MSB if not drum, otherwise 128
+ * for XG: bank MSB if drum and MSB is valid, 128 othewise, bank MSB if it is SFX voice, LSB otherwise
  * @param msb {number}
  * @param lsb {number}
+ * @param isDrums {boolean}
+ * @param isXG {boolean}
+ * @returns {number}
  */
-export function chooseBank(msb, lsb)
+export function chooseBank(msb, lsb, isDrums, isXG)
 {
-    if (lsb > 0)
+    if (isXG)
     {
-        if (!isXGDrums(msb) && msb !== 64)
+        if (isDrums)
+        {
+            if (isXGDrums(msb))
+            {
+                return msb;
+            }
+            else
+            {
+                return 128;
+            }
+        }
+        else
         {
-            return lsb;
+            // check for SFX
+            if (isValidXGMSB(msb))
+            {
+                return msb;
+            }
+            // if lsb is 0 and msb is not, use that
+            if (lsb === 0 && msb !== 0)
+            {
+                return msb;
+            }
+            if (!isValidXGMSB(lsb))
+            {
+                return lsb;
+            }
+            return 0;
         }
     }
-    return msb;
+    else
+    {
+        return isDrums ? 128 : msb;
+    }
+}
+
+/**
+ * @param system {SynthSystem}
+ * @returns boolean
+ */
+export function isSystemXG(system)
+{
+    return system === "gm2" || system === "xg";
 }