spessasynth_lib 3.25.0 → 3.25.1

package/synthetizer/worklet_system/main_processor.js

@@ -2,7 +2,11 @@ import { WorkletSequencer } from "../../sequencer/worklet_sequencer/worklet_sequ
 import { SpessaSynthInfo } from "../../utils/loggin.js";
 import { consoleColors } from "../../utils/other.js";
 import { voiceKilling } from "./worklet_methods/stopping_notes/voice_killing.js";
-import { ALL_CHANNELS_OR_DIFFERENT_ACTION, returnMessageType } from "./message_protocol/worklet_message.js";
+import {
+    ALL_CHANNELS_OR_DIFFERENT_ACTION,
+    masterParameterType,
+    returnMessageType
+} from "./message_protocol/worklet_message.js";
 import { stbvorbis } from "../../externals/stbvorbis_sync/stbvorbis_sync.min.js";
 import { VOLUME_ENVELOPE_SMOOTHING_FACTOR } from "./worklet_utilities/volume_envelope.js";
 import { handleMessage } from "./message_protocol/handle_message.js";
@@ -181,7 +185,6 @@ class SpessaSynthProcessor extends AudioWorkletProcessor
      * @type {SynthSystem}
      */
     system = DEFAULT_SYNTH_MODE;
-    
     /**
      * Current total voices amount
      * @type {number}
@@ -300,6 +303,18 @@ class SpessaSynthProcessor extends AudioWorkletProcessor
         return this.masterGain * this.midiVolume;
     }
     
+    /**
+     * @param value {SynthSystem}
+     */
+    setSystem(value)
+    {
+        this.system = value;
+        this.post({
+            messageType: returnMessageType.masterParameterChange,
+            messageData: [masterParameterType.midiSystem, this.system]
+        });
+    }
+    
     /**
      * @param bank {number}
      * @param program {number}

package/synthetizer/worklet_system/message_protocol/handle_message.js

@@ -158,6 +158,9 @@ export function handleMessage(message)
                 case masterParameterType.interpolationType:
                     this.interpolationType = value;
                     break;
+                
+                case masterParameterType.midiSystem:
+                    this.setSystem(value);
             }
             break;
         

package/synthetizer/worklet_system/message_protocol/worklet_message.js

@@ -70,7 +70,8 @@ export const masterParameterType = {
     mainVolume: 0,
     masterPan: 1,
     voicesCap: 2,
-    interpolationType: 3
+    interpolationType: 3,
+    midiSystem: 4
 };
 
 
@@ -110,12 +111,11 @@ export const ALL_CHANNELS_OR_DIFFERENT_ACTION = -1;
  *
  * 0 - channel properties           -> [...<ChannelProperty>] see message_sending.js line 29
  * 1 - event call                   -> {eventName<string>, eventData:<the event's data>}
- * 2 - reported current time        -> currentTime<number>
+ * 2 - master parameter change      -> [parameter<masterParameterType>, value<string|number>]
  * 3 - sequencer specific           -> [messageType<WorkletSequencerReturnMessageType> messageData<any>] note: refer to sequencer_message.js
  * 4 - synthesizer snapshot         -> snapshot<SynthesizerSnapshot> note: refer to synthesizer_snapshot.js
  * 5 - ready                        -> (no data)
  * 6 - soundfontError               -> errorMessage<string>
- * 7 - idenfity                     -> version<string>
  */
 
 /**
@@ -124,10 +124,9 @@ export const ALL_CHANNELS_OR_DIFFERENT_ACTION = -1;
 export const returnMessageType = {
     channelProperties: 0,
     eventCall: 1,
-    reportedCurrentTime: 2,
+    masterParameterChange: 2,
     sequencerSpecific: 3,
     synthesizerSnapshot: 4,
     ready: 5,
-    soundfontError: 6,
-    identify: 7
+    soundfontError: 6
 };

package/synthetizer/worklet_system/snapshot/channel_snapshot.js

@@ -153,7 +153,7 @@ export class ChannelSnapshot
         
         // restore preset and lock
         channelObject.lockPreset = false;
-        channelObject.setBankSelect(channelSnapshot.bank);
+        channelObject.setBankSelect(channelSnapshot.bank, true);
         channelObject.programChange(channelSnapshot.program);
         channelObject.lockPreset = channelSnapshot.lockPreset;
     }

package/synthetizer/worklet_system/snapshot/synthesizer_snapshot.js

@@ -94,7 +94,7 @@ export class SynthesizerSnapshot
     static applySnapshot(workletProcessor, snapshot)
     {
         // restore system
-        workletProcessor.system = snapshot.system;
+        workletProcessor.setSystem(snapshot.system);
         
         // restore pan and volume
         workletProcessor.setMasterGain(snapshot.mainVolume);

package/synthetizer/worklet_system/worklet_methods/controller_control/controller_change.js

@@ -1,9 +1,6 @@
-import { SpessaSynthInfo } from "../../../../utils/loggin.js";
 import { midiControllers } from "../../../../midi_parser/midi_message.js";
 import { computeModulators } from "../../worklet_utilities/worklet_modulator.js";
-import { consoleColors } from "../../../../utils/other.js";
 import { channelConfiguration, dataEntryStates } from "../../worklet_utilities/controller_tables.js";
-import { DEFAULT_PERCUSSION } from "../../../synth_constants.js";
 
 /**
  * @param controllerNumber {number}
@@ -56,144 +53,83 @@ export function controllerChange(controllerNumber, controllerValue, force = fals
     this.midiControllers[controllerNumber] = controllerValue << 7;
     
     // interpret special CCs
-    switch (controllerNumber)
     {
-        case midiControllers.allNotesOff:
-            this.stopAllNotes();
-            break;
-        
-        case midiControllers.allSoundOff:
-            this.stopAllNotes(true);
-            break;
-        
-        // special case: bank select
-        case midiControllers.bankSelect:
-            let bankNr = controllerValue;
-            if (!force)
-            {
-                switch (this.synth.system)
+        switch (controllerNumber)
+        {
+            case midiControllers.allNotesOff:
+                this.stopAllNotes();
+                break;
+            
+            case midiControllers.allSoundOff:
+                this.stopAllNotes(true);
+                break;
+            
+            // special case: bank select
+            case midiControllers.bankSelect:
+                if (!force)
                 {
-                    case "gm":
-                        // gm ignores bank select
-                        SpessaSynthInfo(
-                            `%cIgnoring the Bank Select (${controllerValue}), as the synth is in GM mode.`,
-                            consoleColors.info
-                        );
-                        return;
-                    
-                    case "xg":
-                        // for xg, if msb is 120, 126 or 127, then it's drums
-                        if (bankNr === 120 || bankNr === 126 || bankNr === 127)
-                        {
-                            this.setDrums(true);
-                        }
-                        else
-                        {
-                            // drums shall not be disabled on channel 9
-                            if (this.channelNumber % 16 !== DEFAULT_PERCUSSION)
-                            {
-                                this.setDrums(false);
-                            }
-                        }
-                        break;
-                    
-                    case "gm2":
-                        if (bankNr === 120)
-                        {
-                            this.setDrums(true);
-                        }
-                        else
-                        {
-                            if (this.channelNumber % 16 !== DEFAULT_PERCUSSION)
-                            {
-                                this.setDrums(false);
-                            }
-                        }
+                    this.setBankSelect(controllerValue);
                 }
-                
-                if (this.drumChannel)
+                else
                 {
-                    // 128 for percussion channel
-                    bankNr = 128;
+                    this.bank = controllerValue;
                 }
-                if (bankNr === 128 && !this.drumChannel)
+                break;
+            
+            case midiControllers.lsbForControl0BankSelect:
+                this.setBankSelect(controllerValue, false, true);
+                break;
+            
+            // check for RPN and NPRN and data entry
+            case midiControllers.RPNLsb:
+                this.dataEntryState = dataEntryStates.RPFine;
+                break;
+            
+            case midiControllers.RPNMsb:
+                this.dataEntryState = dataEntryStates.RPCoarse;
+                break;
+            
+            case midiControllers.NRPNMsb:
+                this.dataEntryState = dataEntryStates.NRPCoarse;
+                break;
+            
+            case midiControllers.NRPNLsb:
+                this.dataEntryState = dataEntryStates.NRPFine;
+                break;
+            
+            case midiControllers.dataEntryMsb:
+                this.dataEntryCoarse(controllerValue);
+                break;
+            
+            case midiControllers.lsbForControl6DataEntry:
+                this.dataEntryFine(controllerValue);
+                break;
+            
+            case midiControllers.resetAllControllers:
+                this.resetControllersRP15Compliant();
+                break;
+            
+            case midiControllers.sustainPedal:
+                if (controllerValue >= 64)
                 {
-                    // if a channel is not for percussion, default to bank current
-                    bankNr = this.getBankSelect();
+                    this.holdPedal = true;
                 }
-            }
-            
-            this.setBankSelect(bankNr);
-            break;
-        
-        case midiControllers.lsbForControl0BankSelect:
-            if (this.synth.system === "xg")
-            {
-                if (!this.drumChannel)
+                else
                 {
-                    // some soundfonts use 127 as drums and
-                    // if it's not marked as drums by bank MSB (line 47), then we DO NOT want the drums!
-                    if (controllerValue !== 127)
+                    this.holdPedal = false;
+                    this.sustainedVoices.forEach(v =>
                     {
-                        this.setBankSelect(controllerValue);
-                    }
+                        v.release();
+                    });
+                    this.sustainedVoices = [];
                 }
-            }
-            else if (this.synth.system === "gm2")
-            {
-                this.setBankSelect(controllerValue);
-            }
-            break;
-        
-        // check for RPN and NPRN and data entry
-        case midiControllers.RPNLsb:
-            this.dataEntryState = dataEntryStates.RPFine;
-            break;
-        
-        case midiControllers.RPNMsb:
-            this.dataEntryState = dataEntryStates.RPCoarse;
-            break;
-        
-        case midiControllers.NRPNMsb:
-            this.dataEntryState = dataEntryStates.NRPCoarse;
-            break;
-        
-        case midiControllers.NRPNLsb:
-            this.dataEntryState = dataEntryStates.NRPFine;
-            break;
-        
-        case midiControllers.dataEntryMsb:
-            this.dataEntryCoarse(controllerValue);
-            break;
-        
-        case midiControllers.lsbForControl6DataEntry:
-            this.dataEntryFine(controllerValue);
-            break;
-        
-        case midiControllers.resetAllControllers:
-            this.resetControllersRP15Compliant();
-            break;
-        
-        case midiControllers.sustainPedal:
-            if (controllerValue >= 64)
-            {
-                this.holdPedal = true;
-            }
-            else
-            {
-                this.holdPedal = false;
-                this.sustainedVoices.forEach(v =>
-                {
-                    v.release();
-                });
-                this.sustainedVoices = [];
-            }
-            break;
-        
-        // default: just compute modulators
-        default:
-            this.voices.forEach(v => computeModulators(v, this.midiControllers, 1, controllerNumber));
-            break;
+                break;
+            
+            // default: just compute modulators
+            default:
+                this.voices.forEach(v => computeModulators(v, this.midiControllers, 1, controllerNumber));
+                break;
+        }
     }
     this.synth.callEvent("controllerchange", {
         channel: this.channelNumber,

package/synthetizer/worklet_system/worklet_methods/controller_control/reset_controllers.js

@@ -25,6 +25,7 @@ export function resetAllControllers(log = true)
         SpessaSynthInfo("%cResetting all controllers!", consoleColors.info);
     }
     this.callEvent("allcontrollerreset", undefined);
+    this.setSystem(DEFAULT_SYNTH_MODE);
     for (let channelNumber = 0; channelNumber < this.workletProcessorChannels.length; channelNumber++)
     {
         this.workletProcessorChannels[channelNumber].resetControllers();
@@ -38,7 +39,7 @@ export function resetAllControllers(log = true)
         if (!ch.lockPreset)
         {
             ch.presetUsesOverride = true;
-            ch.setBankSelect(0);
+            ch.setBankSelect(0, true);
             if (channelNumber % 16 === DEFAULT_PERCUSSION)
             {
                 this.workletProcessorChannels[channelNumber].setPreset(this.drumPreset);
@@ -110,7 +111,6 @@ export function resetAllControllers(log = true)
     }
     
     this.setMIDIVolume(1);
-    this.system = DEFAULT_SYNTH_MODE;
 }
 
 /**

package/synthetizer/worklet_system/worklet_methods/system_exclusive.js

@@ -148,17 +148,17 @@ export function systemExclusive(messageData, channelOffset = 0)
                     if (messageData[3] === 0x01)
                     {
                         SpessaSynthInfo("%cGM system on", consoleColors.info);
-                        this.system = "gm";
+                        this.setSystem("gm");
                     }
                     else if (messageData[3] === 0x03)
                     {
                         SpessaSynthInfo("%cGM2 system on", consoleColors.info);
-                        this.system = "gm2";
+                        this.setSystem("gm2");
                     }
                     else
                     {
                         SpessaSynthInfo("%cGM system off, defaulting to GS", consoleColors.info);
-                        this.system = "gs";
+                        this.setSystem("gs");
                     }
                     break;
                 
@@ -312,14 +312,14 @@ export function systemExclusive(messageData, channelOffset = 0)
                         // this is a GS reset
                         SpessaSynthInfo("%cGS Reset received!", consoleColors.info);
                         this.resetAllControllers(false);
-                        this.system = "gs";
+                        this.setSystem("gs");
                     }
                     else if (messageValue === 0x7F)
                     {
                         // GS mode off
                         SpessaSynthInfo("%cGS system off, switching to GM2", consoleColors.info);
                         this.resetAllControllers(false);
-                        this.system = "gm2";
+                        this.setSystem("gm2");
                     }
                     return;
                 }
@@ -606,7 +606,7 @@ export function systemExclusive(messageData, channelOffset = 0)
                         case 0x7E:
                             SpessaSynthInfo("%cXG system on", consoleColors.info);
                             this.resetAllControllers(false);
-                            this.system = "xg";
+                            this.setSystem("xg");
                             break;
                     }
                 }

package/synthetizer/worklet_system/worklet_utilities/worklet_processor_channel.js

@@ -27,6 +27,7 @@ import { channelPressure } from "../worklet_methods/tuning_control/channel_press
 import { pitchWheel } from "../worklet_methods/tuning_control/pitch_wheel.js";
 import { setOctaveTuning } from "../worklet_methods/tuning_control/set_octave_tuning.js";
 import { programChange } from "../worklet_methods/program_change.js";
+import { parseBankSelect } from "../../../utils/xg_hacks.js";
 
 /**
  * This class represents a single MIDI Channel within the synthesizer.
@@ -232,13 +233,45 @@ class WorkletProcessorChannel
     
     /**
      * @param bank {number}
+     * @param force {boolean}
+     * @param isLSB {boolean}
      */
-    setBankSelect(bank)
+    setBankSelect(bank, force = false, isLSB = false)
     {
-        if (!this.lockPreset)
+        if (this.lockPreset)
+        {
+            return;
+        }
+        if (force)
         {
             this.bank = bank;
         }
+        else
+        {
+            const bankLogic = parseBankSelect(
+                this.getBankSelect(),
+                bank,
+                this.synth.system,
+                isLSB,
+                this.drumChannel,
+                this.channelNumber
+            );
+            this.bank = bankLogic.newBank;
+            switch (bankLogic.drumsStatus)
+            {
+                default:
+                case 0:
+                    break;
+                
+                case 1:
+                    this.setDrums(false);
+                    break;
+                
+                case 2:
+                    this.setDrums(true);
+                    break;
+            }
+        }
     }
     
     /**

package/utils/sysex_detector.js

@@ -0,0 +1,46 @@
+/**
+ * @param e {MIDIMessage}
+ * @returns boolean
+ */
+export function isXGOn(e)
+{
+    return e.messageData[0] === 0x43 && // Yamaha
+        e.messageData[2] === 0x4C &&    // XG ON
+        e.messageData[5] === 0x7E &&
+        e.messageData[6] === 0x00;
+}
+
+/**
+ * @param e {MIDIMessage}
+ * @returns boolean
+ */
+export function isGSDrumsOn(e)
+{
+    return e.messageData[0] === 0x41 &&     // roland
+        e.messageData[2] === 0x42 &&        // GS
+        e.messageData[3] === 0x12 &&        // GS
+        e.messageData[4] === 0x40 &&        // system parameter
+        (e.messageData[5] & 0x10) !== 0 &&  // part parameter
+        e.messageData[6] === 0x15;          // drum pars
+}
+
+/**
+ * @param e {MIDIMessage}
+ * @returns boolean
+ */
+export function isGSOn(e)
+{
+    return e.messageData[0] === 0x41  // roland
+        && e.messageData[2] === 0x42  // GS
+        && e.messageData[6] === 0x7F; // Mode set
+}
+
+/**
+ * @param e {MIDIMessage}
+ * @returns boolean
+ */
+export function isGMOn(e)
+{
+    return e.messageData[0] === 0x7E  // non realtime
+        && e.messageData[2] === 0x09; // gm system
+}

package/utils/xg_hacks.js

@@ -0,0 +1,128 @@
+import { SpessaSynthInfo } from "./loggin.js";
+import { consoleColors } from "./other.js";
+import { DEFAULT_PERCUSSION } from "../synthetizer/synth_constants.js";
+
+/**
+ * @param bankNr {number}
+ * @returns {boolean}
+ */
+export function isXGDrums(bankNr)
+{
+    return bankNr === 120 || bankNr === 126 || bankNr === 127;
+}
+
+/**
+ * Bank select hacks abstracted here
+ * @param bankBefore {number} the current bank number
+ * @param bank {number} the cc change bank number
+ * @param system {SynthSystem} MIDI system
+ * @param isLSB {boolean} is bank LSB?
+ * @param isDrums {boolean} is drum channel?
+ * @param channelNumber {number} channel number
+ * @returns {{
+ *     newBank: number,
+ *     drumsStatus: 0|1|2
+ * }} 0 - unchanged, 1 - OFF, 2 - ON
+ */
+export function parseBankSelect(bankBefore, bank, system, isLSB, isDrums, channelNumber)
+{
+    // 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 (!isValidMSB(bank))
+            {
+                out = bank;
+            }
+        }
+        else if (system === "gm2")
+        {
+            out = bank;
+        }
+    }
+    else
+    {
+        let canSetBankSelect = true;
+        switch (system)
+        {
+            case "gm":
+                // gm ignores bank select
+                SpessaSynthInfo(
+                    `%cIgnoring the Bank Select (${bank}), as the synth is in GM mode.`,
+                    consoleColors.info
+                );
+                canSetBankSelect = false;
+                break;
+            
+            case "xg":
+                canSetBankSelect = isValidMSB(bank);
+                // for xg, if msb is 120, 126 or 127, then it's drums
+                if (isXGDrums(bank))
+                {
+                    drumsStatus = 2;
+                }
+                else
+                {
+                    // drums shall not be disabled on channel 9
+                    if (channelNumber % 16 !== DEFAULT_PERCUSSION)
+                    {
+                        drumsStatus = 1;
+                    }
+                }
+                break;
+            
+            case "gm2":
+                if (bank === 120)
+                {
+                    drumsStatus = 2;
+                }
+                else
+                {
+                    if (channelNumber % 16 !== DEFAULT_PERCUSSION)
+                    {
+                        drumsStatus = 1;
+                    }
+                }
+        }
+        
+        if (isDrums)
+        {
+            // 128 for percussion channel
+            bank = 128;
+        }
+        if (bank === 128 && !isDrums)
+        {
+            // if a channel is not for percussion, default to bank current
+            bank = bankBefore;
+        }
+        if (canSetBankSelect)
+        {
+            out = bank;
+        }
+    }
+    return {
+        newBank: out,
+        drumsStatus: drumsStatus
+    };
+}
+
+
+/**
+ * @param msb {number}
+ * @param lsb {number}
+ */
+export function chooseBank(msb, lsb)
+{
+    if (lsb > 0)
+    {
+        if (!isXGDrums(msb) && msb !== 64)
+        {
+            return lsb;
+        }
+    }
+    return msb;
+}