spessasynth_lib 3.25.22 → 3.26.0

package/synthetizer/audio_engine/message_protocol/README.md

@@ -1,13 +0,0 @@
-# About the message protocol
-Since spessasynth runs in the audioWorklet thread, here is an explanation of how it works:
-
-There's one processor per synthesizer, with a `MessagePort` for communication.
-Each processor has a single `WorkletSequencer` instance that is idle by default.
-
-The `Synthetizer`, 
-`Sequencer` and `SoundFontManager` classes are all interfaces 
-that do not do anything except sending the commands to te processor.
-
-The synthesizer sends the commands (note on, off, etc.) directly to the processor where they are processed and executed.
-
-The sequencer sends the commands through the connected synthesizer's messagePort, which then get processed as sequencer messages and routed

package/synthetizer/audio_engine/message_protocol/message_sending.js

@@ -1,22 +0,0 @@
-import { returnMessageType } from "./worklet_message.js";
-
-/**
- * Calls synth event from the worklet side
- * @param eventName {EventTypes} the event name
- * @param eventData {EventCallbackData}
- * @this {SpessaSynthProcessor}
- */
-export function callEvent(eventName, eventData)
-{
-    if (!this.enableEventSystem)
-    {
-        return;
-    }
-    this.post({
-        messageType: returnMessageType.eventCall,
-        messageData: {
-            eventName: eventName,
-            eventData: eventData
-        }
-    });
-}

package/synthetizer/audio_engine/message_protocol/worklet_message.js

@@ -1,107 +0,0 @@
-/**
- * @enum {number}
- * // NOTE: Every message needs a channel number (if not relevant or all, set to -1)
- * @property {number} midiMessage                - 0  -> [messageData<Uint8Array>, channelOffset<number>, force<boolean>, options<SynthMethodOptions>]
- * @property {number} ccReset                    - 7  -> (no data) note: if channel is -1 then reset all channels
- * @property {number} setChannelVibrato          - 8  -> {frequencyHz: number, depthCents: number, delaySeconds: number} note: if channel is -1 then stop all channels note 2: if rate is -1, it means locking
- * @property {number} soundFontManager           - 9  -> [messageType<WorkletSoundfontManagerMessageType> messageData<any>] note: refer to sfman_message.js
- * @property {number} stopAll                    - 10  -> force<number> (0 false, 1 true) note: if channel is -1 then stop all channels
- * @property {number} killNotes                  - 11  -> amount<number>
- * @property {number} muteChannel                - 12 -> isMuted<boolean>
- * @property {number} addNewChannel              - 13 -> (no data)
- * @property {number} customCcChange             - 14 -> [ccNumber<number>, ccValue<number>]
- * @property {number} debugMessage               - 15 -> (no data)
- * @property {number} setMasterParameter         - 17 -> [parameter<masterParameterType>, value<number>]
- * @property {number} setDrums                   - 18 -> isDrums<boolean>
- * @property {number} transpose                  - 19 -> [semitones<number>, force<boolean>] note: if channel is -1 then transpose all channels
- * @property {number} highPerformanceMode        - 20 -> isOn<boolean>
- * @property {number} lockController             - 21 -> [controllerNumber<number>, isLocked<boolean>]
- * @property {number} sequencerSpecific          - 22 -> [messageType<SpessaSynthSequencerMessageType> messageData<any>] note: refer to sequencer_message.js
- * @property {number} requestSynthesizerSnapshot - 23 -> (no data)
- * @property {number} setLogLevel                - 24 -> [enableInfo<boolean>, enableWarning<boolean>, enableGroup<boolean>, enableTable<boolean>]
- * @property {number} keyModifier                - 25 -> [messageType<workletKeyModifierMessageType> messageData<any>]
- * @property {number} setEffectsGain             - 26 -> [reverbGain<number>, chorusGain<number>]
- * @property {number} destroyWorklet             - 27 -> (no data)
- */
-export const workletMessageType = {
-    midiMessage: 0,
-    // free 6 slots here, use when needed instead of adding new ones
-    ccReset: 7,
-    setChannelVibrato: 8,
-    soundFontManager: 9,
-    stopAll: 10,
-    killNotes: 11,
-    muteChannel: 12,
-    addNewChannel: 13,
-    customcCcChange: 14,
-    debugMessage: 15,
-    // free slot here
-    setMasterParameter: 17,
-    setDrums: 18,
-    transpose: 19,
-    highPerformanceMode: 20,
-    lockController: 21,
-    sequencerSpecific: 22,
-    requestSynthesizerSnapshot: 23,
-    setLogLevel: 24,
-    keyModifierManager: 25,
-    setEffectsGain: 26,
-    destroyWorklet: 27
-};
-
-
-export const ALL_CHANNELS_OR_DIFFERENT_ACTION = -1;
-/**
- * @typedef {{
- *     channelNumber: number
- *     messageType: (workletMessageType|number),
- *     messageData: (
- *     boolean|
- *     (number|Uint8Array|object)[]
- *     |undefined
- *     |boolean[]
- *     |boolean
- *     |Voice[]
- *     |number
- *     |{rate: number, depth: number, delay: number}
- *     |ArrayBuffer
- *     |{messageType: SpessaSynthSequencerMessageType, messageData: any}
- *     |{messageType: workletKeyModifierMessageType, messageData: any}
- *     )
- * }} WorkletMessage
- */
-
-/**
- * @typedef {Object} WorkletReturnMessage
- * @property {returnMessageType} messageType - the message's type
- * @property {{
- *     eventName: string,
- *     eventData: any
- * }|ChannelProperty
- * |{presetName: string, bank: number, program: number}[]
- * |string
- * |{messageType: SpessaSynthSequencerReturnMessageType, messageData: any}
- * |SynthesizerSnapshot
- * |[WorkletSoundfontManagerMessageType, any]} messageData - the message's data
- *
- * 0 - channel property change      -> [channel<number>, property<ChannelProperty>] see message_sending.js line 29
- * 1 - event call                   -> {eventName<string>, eventData:<the event's data>}
- * 2 - master parameter change      -> [parameter<masterParameterType>, value<string|number>]
- * 3 - sequencer specific           -> [messageType<SpessaSynthSequencerReturnMessageType> messageData<any>] note: refer to sequencer_message.js
- * 4 - synthesizer snapshot         -> snapshot<SynthesizerSnapshot> note: refer to synthesizer_snapshot.js
- * 5 - isFullyInitialized           -> (no data)
- * 6 - soundfontError               -> errorMessage<string>
- */
-
-/**
- * @enum {number}
- */
-export const returnMessageType = {
-    channelPropertyChange: 0,
-    eventCall: 1,
-    masterParameterChange: 2,
-    sequencerSpecific: 3,
-    synthesizerSnapshot: 4,
-    isFullyInitialized: 5,
-    soundfontError: 6
-};

package/synthetizer/audio_engine/snapshot/apply_synthesizer_snapshot.js

@@ -1,14 +0,0 @@
-import { SpessaSynthInfo } from "../../../utils/loggin.js";
-import { consoleColors } from "../../../utils/other.js";
-import { SynthesizerSnapshot } from "./synthesizer_snapshot.js";
-
-/**
- * Applies the snapshot to the synth
- * @param snapshot {SynthesizerSnapshot}
- * @this {SpessaSynthProcessor}
- */
-export function applySynthesizerSnapshot(snapshot)
-{
-    SynthesizerSnapshot.applySnapshot(this, snapshot);
-    SpessaSynthInfo("%cFinished applying snapshot!", consoleColors.info);
-}

package/synthetizer/audio_engine/snapshot/channel_snapshot.js

@@ -1,175 +0,0 @@
-/**
- * Represents a snapshot of a single channel's state in the synthesizer.
- */
-export class ChannelSnapshot
-{
-    /**
-     * The channel's MIDI program number.
-     * @type {number}
-     */
-    program;
-    
-    /**
-     * The channel's bank number.
-     * @type {number}
-     */
-    bank;
-    
-    /**
-     * If the bank is LSB. For restoring.
-     * @type {boolean}
-     */
-    isBankLSB;
-    
-    /**
-     * The name of the patch currently loaded in the channel.
-     * @type {string}
-     */
-    patchName;
-    
-    /**
-     * Indicates whether the channel's program change is disabled.
-     * @type {boolean}
-     */
-    lockPreset;
-    
-    /**
-     * Indicates the MIDI system when the preset was locked
-     * @type {SynthSystem}
-     */
-    lockedSystem;
-    
-    /**
-     * The array of all MIDI controllers (in 14-bit values) with the modulator sources at the end.
-     * @type {Int16Array}
-     */
-    midiControllers;
-    
-    /**
-     * An array of booleans, indicating if the controller with a current index is locked.
-     * @type {boolean[]}
-     */
-    lockedControllers;
-    
-    /**
-     * Array of custom (not SF2) control values such as RPN pitch tuning, transpose, modulation depth, etc.
-     * @type {Float32Array}
-     */
-    customControllers;
-    
-    /**
-     * Indicates whether the channel vibrato is locked.
-     * @type {boolean}
-     */
-    lockVibrato;
-    
-    /**
-     * The channel's vibrato settings.
-     * @type {Object}
-     * @property {number} depth - Vibrato depth, in gain.
-     * @property {number} delay - Vibrato delay from note on in seconds.
-     * @property {number} rate - Vibrato rate in Hz.
-     */
-    channelVibrato;
-    
-    /**
-     * Key shift for the channel.
-     * @type {number}
-     */
-    channelTransposeKeyShift;
-    
-    /**
-     * The channel's octave tuning in cents.
-     * @type {Int8Array}
-     */
-    channelOctaveTuning;
-    
-    /**
-     * Indicates whether the channel is muted.
-     * @type {boolean}
-     */
-    isMuted;
-    
-    /**
-     * Overrides velocity if greater than 0, otherwise disabled.
-     * @type {number}
-     */
-    velocityOverride;
-    
-    /**
-     * Indicates whether the channel is a drum channel.
-     * @type {boolean}
-     */
-    drumChannel;
-    
-    /**
-     * Creates a snapshot of a single channel's state in the synthesizer.
-     * @param workletProcessor {SpessaSynthProcessor}
-     * @param channelNumber {number}
-     * @returns {ChannelSnapshot}
-     */
-    static getChannelSnapshot(workletProcessor, channelNumber)
-    {
-        const channelObject = workletProcessor.midiAudioChannels[channelNumber];
-        const channelSnapshot = new ChannelSnapshot();
-        // program data
-        channelSnapshot.program = channelObject.preset.program;
-        channelSnapshot.bank = channelObject.getBankSelect();
-        channelSnapshot.isBankLSB = channelSnapshot.bank !== channelObject.bank;
-        channelSnapshot.lockPreset = channelObject.lockPreset;
-        channelSnapshot.lockedSystem = channelObject.lockedSystem;
-        channelSnapshot.patchName = channelObject.preset.presetName;
-        
-        // controller data
-        channelSnapshot.midiControllers = channelObject.midiControllers;
-        channelSnapshot.lockedControllers = channelObject.lockedControllers;
-        channelSnapshot.customControllers = channelObject.customControllers;
-        
-        // vibrato data
-        channelSnapshot.channelVibrato = channelObject.channelVibrato;
-        channelSnapshot.lockVibrato = channelObject.lockGSNRPNParams;
-        
-        // tuning and transpose data
-        channelSnapshot.channelTransposeKeyShift = channelObject.channelTransposeKeyShift;
-        channelSnapshot.channelOctaveTuning = channelObject.channelOctaveTuning;
-        
-        // other data
-        channelSnapshot.isMuted = channelObject.isMuted;
-        channelSnapshot.velocityOverride = channelObject.velocityOverride;
-        channelSnapshot.drumChannel = channelObject.drumChannel;
-        return channelSnapshot;
-    }
-    
-    /**
-     * Applies the snapshot to the specified channel.
-     * @param workletProcessor {SpessaSynthProcessor}
-     * @param channelNumber {number}
-     * @param channelSnapshot {ChannelSnapshot}
-     */
-    static applyChannelSnapshot(workletProcessor, channelNumber, channelSnapshot)
-    {
-        const channelObject = workletProcessor.midiAudioChannels[channelNumber];
-        channelObject.muteChannel(channelSnapshot.isMuted);
-        channelObject.setDrums(channelSnapshot.drumChannel);
-        
-        // restore controllers
-        channelObject.midiControllers = channelSnapshot.midiControllers;
-        channelObject.lockedControllers = channelSnapshot.lockedControllers;
-        channelObject.customControllers = channelSnapshot.customControllers;
-        channelObject.updateChannelTuning();
-        
-        // restore vibrato and transpose
-        channelObject.channelVibrato = channelSnapshot.channelVibrato;
-        channelObject.lockGSNRPNParams = channelSnapshot.lockVibrato;
-        channelObject.channelTransposeKeyShift = channelSnapshot.channelTransposeKeyShift;
-        channelObject.channelOctaveTuning = channelSnapshot.channelOctaveTuning;
-        channelObject.velocityOverride = channelSnapshot.velocityOverride;
-        
-        // restore preset and lock
-        channelObject.setPresetLock(false);
-        channelObject.setBankSelect(channelSnapshot.bank, channelSnapshot.isBankLSB);
-        channelObject.programChange(channelSnapshot.program);
-        channelObject.setPresetLock(channelSnapshot.lockPreset);
-        channelObject.lockedSystem = channelSnapshot.lockedSystem;
-    }
-}

package/synthetizer/audio_engine/snapshot/synthesizer_snapshot.js

@@ -1,122 +0,0 @@
-import { SpessaSynthInfo } from "../../../utils/loggin.js";
-import { consoleColors } from "../../../utils/other.js";
-import { ChannelSnapshot } from "./channel_snapshot.js";
-import { masterParameterType } from "../engine_methods/controller_control/master_parameters.js";
-
-/**
- * Represents a snapshot of the synthesizer's state.
- */
-export class SynthesizerSnapshot
-{
-    /**
-     * The individual channel snapshots.
-     * @type {ChannelSnapshot[]}
-     */
-    channelSnapshots;
-    
-    /**
-     * Key modifiers.
-     * @type {KeyModifier[][]}
-     */
-    keyMappings;
-    
-    /**
-     * Main synth volume (set by MIDI), from 0 to 1.
-     * @type {number}
-     */
-    mainVolume;
-    
-    /**
-     * Master stereo panning, from -1 to 1.
-     * @type {number}
-     */
-    pan;
-    
-    /**
-     * The synth's interpolation type.
-     * @type {interpolationTypes}
-     */
-    interpolation;
-    
-    /**
-     * The synth's system. Values can be "gs", "gm", "gm2" or "xg".
-     * @type {SynthSystem}
-     */
-    system;
-    
-    /**
-     * The current synth transposition in semitones. Can be a float.
-     * @type {number}
-     */
-    transposition;
-    
-    /**
-     * The effect configuration object.
-     * @type {SynthConfig}
-     */
-    effectsConfig;
-    
-    
-    /**
-     * Creates a snapshot of the synthesizer's state.
-     * @param workletProcessor {SpessaSynthProcessor}
-     * @returns {SynthesizerSnapshot}
-     */
-    static createSynthesizerSnapshot(workletProcessor)
-    {
-        const snapshot = new SynthesizerSnapshot();
-        // channel snapshots
-        snapshot.channelSnapshots =
-            workletProcessor.midiAudioChannels.map((_, i) =>
-                ChannelSnapshot.getChannelSnapshot(workletProcessor, i));
-        
-        // key mappings
-        snapshot.keyMappings = workletProcessor.keyModifierManager.getMappings();
-        // pan and volume
-        snapshot.mainVolume = workletProcessor.midiVolume;
-        snapshot.pan = workletProcessor.pan;
-        
-        // others
-        snapshot.system = workletProcessor.system;
-        snapshot.interpolation = workletProcessor.interpolationType;
-        snapshot.transposition = workletProcessor.transposition;
-        
-        // effect config is stored on the main thread, leave it empty
-        snapshot.effectsConfig = {};
-        return snapshot;
-        
-    }
-    
-    /**
-     * Applies the snapshot to the synthesizer.
-     * @param workletProcessor {SpessaSynthProcessor}
-     * @param snapshot {SynthesizerSnapshot}
-     */
-    static applySnapshot(workletProcessor, snapshot)
-    {
-        // restore system
-        workletProcessor.setSystem(snapshot.system);
-        
-        // restore pan and volume
-        workletProcessor.setMasterParameter(masterParameterType.mainVolume, snapshot.mainVolume);
-        workletProcessor.setMasterParameter(masterParameterType.masterPan, snapshot.pan);
-        workletProcessor.transposeAllChannels(snapshot.transposition);
-        workletProcessor.interpolationType = snapshot.interpolation;
-        workletProcessor.keyModifierManager.setMappings(snapshot.keyMappings);
-        
-        // add channels if more needed
-        while (workletProcessor.midiAudioChannels.length < snapshot.channelSnapshots.length)
-        {
-            workletProcessor.createWorkletChannel();
-        }
-        
-        // restore channels
-        snapshot.channelSnapshots.forEach((channelSnapshot, index) =>
-        {
-            ChannelSnapshot.applyChannelSnapshot(workletProcessor, index, channelSnapshot);
-        });
-        
-        SpessaSynthInfo("%cFinished restoring controllers!", consoleColors.info);
-    }
-}
-

package/synthetizer/synth_constants.js

@@ -1,20 +0,0 @@
-/**
- * Synthesizer's default voice cap
- * @type {number}
- */
-export const VOICE_CAP = 350;
-/**
- * Default MIDI drum channel
- * @type {number}
- */
-export const DEFAULT_PERCUSSION = 9;
-/**
- * MIDI channel count
- * @type {number}
- */
-export const MIDI_CHANNEL_COUNT = 16;
-/**
- * Default bank select and SysEx mode
- * @type {string}
- */
-export const DEFAULT_SYNTH_MODE = "gs";