spessasynth_lib 3.15.0 → 3.16.0

package/synthetizer/worklet_system/main_processor.js

@@ -3,10 +3,42 @@ import { SoundFont2 } from '../../soundfont/soundfont.js'
 import { WorkletSequencer } from '../../sequencer/worklet_sequencer/worklet_sequencer.js'
 import { SpessaSynthInfo } from '../../utils/loggin.js'
 import { consoleColors } from '../../utils/other.js'
-import { PAN_SMOOTHING_FACTOR } from './worklet_methods/voice_control.js'
+import { PAN_SMOOTHING_FACTOR, releaseVoice, renderVoice, voiceKilling } from './worklet_methods/voice_control.js'
 import { ALL_CHANNELS_OR_DIFFERENT_ACTION, 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'
+import { callEvent, sendChannelProperties } from './message_protocol/message_sending.js'
+import { systemExclusive } from './worklet_methods/system_exclusive.js'
+import { noteOn } from './worklet_methods/note_on.js'
+import { killNote, noteOff, stopAll, stopAllChannels } from './worklet_methods/note_off.js'
+import {
+    channelPressure, pitchWheel,
+    polyPressure, setChannelTuning, setChannelTuningSemitones, setMasterTuning, setModulationDepth, setOctaveTuning,
+    transposeAllChannels,
+    transposeChannel,
+} from './worklet_methods/tuning_control.js'
+import {
+    controllerChange,
+    muteChannel,
+    setMasterGain,
+    setMasterPan,
+    setMIDIVolume,
+} from './worklet_methods/controller_control.js'
+import { disableAndLockVibrato, setVibrato } from './worklet_methods/vibrato_control.js'
+import { dataEntryCoarse, dataEntryFine } from './worklet_methods/data_entry.js'
+import { createWorkletChannel } from './worklet_utilities/worklet_processor_channel.js'
+import { resetAllControllers, resetControllers, resetParameters } from './worklet_methods/reset_controllers.js'
+import {
+    clearSoundFont,
+    getPreset,
+    programChange,
+    reloadSoundFont, sampleDump, sendPresetList,
+    setDrums,
+    setPreset,
+} from './worklet_methods/program_control.js'
+import { applySynthesizerSnapshot, sendSynthesizerSnapshot } from './worklet_methods/snapshot.js'
+import { WorkletSoundfontManager } from './worklet_methods/worklet_soundfont_manager/worklet_soundfont_manager.js'
 
 
 /**
@@ -18,7 +50,7 @@ export const MIN_NOTE_LENGTH = 0.07; // if the note is released faster than that
 
 export const SYNTHESIZER_GAIN = 1.0;
 
-export class SpessaSynthProcessor extends AudioWorkletProcessor
+class SpessaSynthProcessor extends AudioWorkletProcessor
 {
     /**
      * Creates a new worklet synthesis system. contains all channels
@@ -114,9 +146,9 @@ export class SpessaSynthProcessor extends AudioWorkletProcessor
         try
         {
             /**
-             * @type {SoundFont2}
+             * @type {WorkletSoundfontManager}
              */
-            this.soundfont = new SoundFont2(options.processorOptions.soundfont);
+            this.soundfontManager = new WorkletSoundfontManager(options.processorOptions.soundfont, this.postReady.bind(this));
         }
         catch (e)
         {
@@ -186,14 +218,35 @@ export class SpessaSynthProcessor extends AudioWorkletProcessor
         }
 
         stbvorbis.isInitialized.then(() => {
-            this.post({
-                messageType: returnMessageType.ready,
-                messageData: undefined
-            });
+            this.postReady();
             SpessaSynthInfo("%cSpessaSynth is ready!", consoleColors.recognized);
         });
     }
 
+    /**
+     * @param data {WorkletReturnMessage}
+     */
+    post(data)
+    {
+        if(!this.enableEventSystem)
+        {
+            return;
+        }
+        this.port.postMessage(data);
+    }
+
+    postReady()
+    {
+        if(!this.enableEventSystem)
+        {
+            return;
+        }
+        this.port.postMessage({
+            messageType: returnMessageType.ready,
+            messageData: undefined
+        });
+    }
+
     /**
      * @returns {number}
      */
@@ -289,4 +342,74 @@ export class SpessaSynthProcessor extends AudioWorkletProcessor
         }
         return true;
     }
-}
+}
+
+// include other methods
+// voice related
+SpessaSynthProcessor.prototype.renderVoice = renderVoice;
+SpessaSynthProcessor.prototype.releaseVoice = releaseVoice;
+SpessaSynthProcessor.prototype.voiceKilling = voiceKilling;
+
+// message port related
+SpessaSynthProcessor.prototype.handleMessage = handleMessage;
+SpessaSynthProcessor.prototype.sendChannelProperties = sendChannelProperties;
+SpessaSynthProcessor.prototype.callEvent = callEvent;
+
+// system exlcusive related
+SpessaSynthProcessor.prototype.systemExclusive = systemExclusive;
+
+// note messages related
+SpessaSynthProcessor.prototype.noteOn = noteOn;
+SpessaSynthProcessor.prototype.noteOff = noteOff;
+SpessaSynthProcessor.prototype.polyPressure = polyPressure;
+SpessaSynthProcessor.prototype.killNote = killNote;
+SpessaSynthProcessor.prototype.stopAll = stopAll;
+SpessaSynthProcessor.prototype.stopAllChannels = stopAllChannels;
+SpessaSynthProcessor.prototype.muteChannel = muteChannel;
+
+// custom vibrato related
+SpessaSynthProcessor.prototype.setVibrato = setVibrato;
+SpessaSynthProcessor.prototype.disableAndLockVibrato = disableAndLockVibrato;
+
+// data entry related
+SpessaSynthProcessor.prototype.dataEntryCoarse = dataEntryCoarse;
+SpessaSynthProcessor.prototype.dataEntryFine = dataEntryFine;
+
+// channel related
+SpessaSynthProcessor.prototype.createWorkletChannel = createWorkletChannel;
+SpessaSynthProcessor.prototype.controllerChange = controllerChange;
+SpessaSynthProcessor.prototype.channelPressure = channelPressure;
+SpessaSynthProcessor.prototype.resetAllControllers = resetAllControllers;
+SpessaSynthProcessor.prototype.resetControllers = resetControllers;
+SpessaSynthProcessor.prototype.resetParameters = resetParameters;
+
+// master parameter related
+SpessaSynthProcessor.prototype.setMasterGain = setMasterGain;
+SpessaSynthProcessor.prototype.setMasterPan = setMasterPan;
+SpessaSynthProcessor.prototype.setMIDIVolume = setMIDIVolume;
+
+// tuning related
+SpessaSynthProcessor.prototype.transposeAllChannels = transposeAllChannels;
+SpessaSynthProcessor.prototype.transposeChannel = transposeChannel;
+SpessaSynthProcessor.prototype.setChannelTuning = setChannelTuning;
+SpessaSynthProcessor.prototype.setChannelTuningSemitones = setChannelTuningSemitones;
+SpessaSynthProcessor.prototype.setMasterTuning = setMasterTuning;
+SpessaSynthProcessor.prototype.setModulationDepth = setModulationDepth;
+SpessaSynthProcessor.prototype.pitchWheel = pitchWheel;
+SpessaSynthProcessor.prototype.setOctaveTuning = setOctaveTuning;
+
+// program related
+SpessaSynthProcessor.prototype.programChange = programChange;
+SpessaSynthProcessor.prototype.getPreset = getPreset;
+SpessaSynthProcessor.prototype.setPreset = setPreset;
+SpessaSynthProcessor.prototype.setDrums = setDrums;
+SpessaSynthProcessor.prototype.reloadSoundFont = reloadSoundFont;
+SpessaSynthProcessor.prototype.clearSoundFont = clearSoundFont;
+SpessaSynthProcessor.prototype.sampleDump = sampleDump;
+SpessaSynthProcessor.prototype.sendPresetList = sendPresetList;
+
+// snapshot related
+SpessaSynthProcessor.prototype.sendSynthesizerSnapshot = sendSynthesizerSnapshot;
+SpessaSynthProcessor.prototype.applySynthesizerSnapshot = applySynthesizerSnapshot;
+
+export { SpessaSynthProcessor }

package/synthetizer/worklet_system/message_protocol/handle_message.js

@@ -3,7 +3,7 @@ import { SpessaSynthLogging, SpessaSynthWarn } from '../../../utils/loggin.js'
 
 /**
  * @this {SpessaSynthProcessor}
- * @param message
+ * @param message {WorkletMessage}
  */
 export function handleMessage(message)
 {
@@ -95,10 +95,6 @@ export function handleMessage(message)
             }
             break;
 
-        case workletMessageType.reloadSoundFont:
-            this.reloadSoundFont(data);
-            break;
-
         case workletMessageType.stopAll:
             if(channel === ALL_CHANNELS_OR_DIFFERENT_ACTION)
             {
@@ -182,6 +178,11 @@ export function handleMessage(message)
             this.sequencer.processMessage(data.messageType, data.messageData);
             break;
 
+        case workletMessageType.soundFontManager:
+            this.soundfontManager.handleMessage(data[0], data[1]);
+            this.clearSoundFont(true, false);
+            break;
+
         case workletMessageType.requestSynthesizerSnapshot:
             this.sendSynthesizerSnapshot();
             break;

package/synthetizer/worklet_system/message_protocol/message_sending.js

@@ -23,19 +23,6 @@ export function callEvent(eventName, eventData)
     })
 }
 
-/**
- * @param data {WorkletReturnMessage}
- * @this {SpessaSynthProcessor}
- */
-export function post(data)
-{
-    if(!this.enableEventSystem)
-    {
-        return;
-    }
-    this.port.postMessage(data);
-}
-
 /**
  * @typedef {Object} ChannelProperty
  * @property {number} voicesAmount

package/synthetizer/worklet_system/message_protocol/worklet_message.js

@@ -10,7 +10,7 @@
  * @property {number} killNote                   - 6  -> midiNote<number>
  * @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} reloadSoundFont            - 9  -> (no data)
+ * @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>
@@ -38,7 +38,7 @@ export const workletMessageType = {
     killNote:                   6,
     ccReset:                    7,
     setChannelVibrato:          8,
-    reloadSoundFont:            9,
+    soundFontManager:           9,
     stopAll:                    10,
     killNotes:                  11,
     muteChannel:                12,
@@ -96,7 +96,8 @@ export const ALL_CHANNELS_OR_DIFFERENT_ACTION = -1;
  * |PresetListElement[]
  * |string
  * |{messageType: WorkletSequencerReturnMessageType, messageData: any}
- * |SynthesizerSnapshot} messageData - the message's data
+ * |SynthesizerSnapshot
+ * |[WorkletSoundfontManagerMessageType, any]} messageData - the message's data
  *
  * 0 - channel properties           -> [...<ChannelProperty>] see message_sending.js line 29
  * 1 - event call                   -> {eventName<string>, eventData:<the event's data>}

package/synthetizer/worklet_system/worklet_methods/note_off.js

@@ -15,7 +15,8 @@ export function noteOff(channel, midiNote)
         SpessaSynthWarn(`Received a noteOn for note`, midiNote, "Ignoring.");
         return;
     }
-    midiNote += this.workletProcessorChannels[channel].channelTransposeKeyShift;
+    const channelObject = this.workletProcessorChannels[channel];
+    const actualNote = midiNote + channelObject.channelTransposeKeyShift;
 
     // if high performance mode, kill notes instead of stopping them
     if(this.highPerformanceMode)
@@ -23,14 +24,14 @@ export function noteOff(channel, midiNote)
         // if the channel is percussion channel, do not kill the notes
         if(!this.workletProcessorChannels[channel].drumChannel)
         {
-            this.killNote(channel, midiNote);
+            this.killNote(channel, actualNote);
             return;
         }
     }
 
     const channelVoices = this.workletProcessorChannels[channel].voices;
     channelVoices.forEach(v => {
-        if(v.midiNote !== midiNote || v.isInRelease === true)
+        if(v.midiNote !== actualNote || v.isInRelease === true)
         {
             return;
         }
@@ -44,7 +45,7 @@ export function noteOff(channel, midiNote)
         }
     });
     this.callEvent("noteoff", {
-        midiNote: midiNote - this.workletProcessorChannels[channel].channelTransposeKeyShift,
+        midiNote: midiNote,
         channel: channel
     });
 }

package/synthetizer/worklet_system/worklet_methods/note_on.js

@@ -57,7 +57,6 @@ export function noteOn(channel, midiNote, velocity, enableDebugging = false, sen
             data.sampleData
         ),
         channelObject.cachedVoices,
-        channelObject.presetUsesOverride ? this.soundfont.samples.length : 0, // this is done to prevent samples overlapping
         enableDebugging
     );
 

package/synthetizer/worklet_system/worklet_methods/program_control.js

@@ -43,21 +43,21 @@ export function programChange(channel, programNumber, userChange=false)
         if(this.soundfontBankOffset === 0)
         {
             preset = this.overrideSoundfont.getPreset(0, programNumber);
+            sentBank = preset.bank;
         }
         else
         {
-            preset = this.soundfont.getPreset(bank, programNumber);
+            preset = this.soundfontManager.getPreset(bank, programNumber);
             sentBank = preset.bank;
             channelObject.presetUsesOverride = false;
         }
     }
     else
     {
-        preset = this.soundfont.getPreset(bank, programNumber);
+        preset = this.soundfontManager.getPreset(bank, programNumber);
         sentBank = preset.bank;
         channelObject.presetUsesOverride = false;
     }
-
     this.setPreset(channel, preset);
     this.callEvent("programchange",{
         channel: channel,
@@ -90,7 +90,7 @@ export function getPreset(bank, program)
             return this.overrideSoundfont.getPreset(0, program);
         }
     }
-    return this.soundfont.getPreset(bank, program);
+    return this.soundfontManager.getPreset(bank, program);
 }
 
 
@@ -159,9 +159,10 @@ export function setDrums(channel, isDrum)
  */
 export function sendPresetList()
 {
-    const mainFont =  this.soundfont.presets.map(p => {
-        return {presetName: p.presetName, bank: p.bank, program: p.program};
-    });
+    /**
+     * @type {{bank: number, presetName: string, program: number}[]}
+     */
+    const mainFont = this.soundfontManager.getPresetList();
     if(this.overrideSoundfont !== undefined)
     {
         this.overrideSoundfont.presets.forEach(p => {
@@ -223,23 +224,17 @@ export function clearSoundFont(sendPresets = true, clearOverride = true)
 export function reloadSoundFont(buffer, isOverride = false)
 {
     this.clearSoundFont(false, isOverride);
-    if(!isOverride)
-    {
-        delete this.soundfont.dataArray;
-        this.soundfont.samples.length = 0;
-        this.soundfont.instruments.length = 0;
-        this.soundfont.presets.length = 0;
-        delete this.soundfont;
-    }
     try
     {
         if(isOverride)
         {
             this.overrideSoundfont = new SoundFont2(buffer);
+            // assign sample offset
+            this.overrideSoundfont.setSampleIDOffset(this.soundfontManager.totalSoundfontOffset)
         }
         else
         {
-            this.soundfont = new SoundFont2(buffer);
+            this.soundfontManager.reloadManager(buffer);
         }
     }
     catch (e)

package/synthetizer/worklet_system/worklet_methods/voice_control.js

@@ -58,36 +58,37 @@ export function renderVoice(
     let targetKey = voice.targetKey;
 
     // calculate tuning
-    let cents = voice.modulatedGenerators[generatorTypes.fineTune]
-        + channel.customControllers[customControllers.channelTuning]
-        + channel.customControllers[customControllers.channelTransposeFine]
-        + channel.customControllers[customControllers.masterTuning]
-        + channel.channelOctaveTuning[voice.midiNote % 12];
-    let semitones = voice.modulatedGenerators[generatorTypes.coarseTune]
-        + channel.customControllers[customControllers.channelTuningSemitones];
+    let cents = voice.modulatedGenerators[generatorTypes.fineTune]             // soundfont fine tune
+        + channel.customControllers[customControllers.channelTuning]           // RPN channel fine tuning
+        + channel.customControllers[customControllers.channelTransposeFine]    // custom tuning (synth.transpose)
+        + channel.customControllers[customControllers.masterTuning]            // master tuning, set by sysEx
+        + channel.channelOctaveTuning[voice.midiNote % 12];                    // MTS octave tuning
+    let semitones = voice.modulatedGenerators[generatorTypes.coarseTune]       // soundfont coarse tuning
+        + channel.customControllers[customControllers.channelTuningSemitones]; // RPN channel coarse tuning
 
     // midi tuning standard
     const tuning = this.tunings[channel.preset.program]?.[targetKey];
     if(tuning?.midiNote >= 0)
     {
+        // override key
         targetKey = tuning.midiNote;
+        // add microtonal tuning
         cents += tuning.centTuning;
     }
 
-    // calculate tuning by key
+    // calculate tuning by key using soundfont's scale tuning
     cents += (targetKey - voice.sample.rootKey) * voice.modulatedGenerators[generatorTypes.scaleTuning];
 
     // vibrato LFO
     const vibratoDepth = voice.modulatedGenerators[generatorTypes.vibLfoToPitch];
     if(vibratoDepth !== 0)
     {
+        // calculate start time and lfo value
         const vibStart = voice.startTime + timecentsToSeconds(voice.modulatedGenerators[generatorTypes.delayVibLFO]);
         const vibFreqHz = absCentsToHz(voice.modulatedGenerators[generatorTypes.freqVibLFO]);
         const lfoVal = getLFOValue(vibStart, vibFreqHz, currentTime);
-        if(lfoVal)
-        {
-            cents += lfoVal * (vibratoDepth * channel.customControllers[customControllers.modulationMultiplier]);
-        }
+        // use modulation multiplier (RPN modulation depth)
+        cents += lfoVal * (vibratoDepth * channel.customControllers[customControllers.modulationMultiplier]);
     }
 
     // lowpass frequency
@@ -100,17 +101,22 @@ export function renderVoice(
     let modLfoCentibels = 0;
     if(modPitchDepth + modFilterDepth + modVolDepth !== 0)
     {
+        // calculate start time and lfo value
         const modStart = voice.startTime + timecentsToSeconds(voice.modulatedGenerators[generatorTypes.delayModLFO]);
         const modFreqHz = absCentsToHz(voice.modulatedGenerators[generatorTypes.freqModLFO]);
         const modLfoValue = getLFOValue(modStart, modFreqHz, currentTime);
+        // use modulation multiplier (RPN modulation depth)
         cents += modLfoValue * (modPitchDepth * channel.customControllers[customControllers.modulationMultiplier]);
+        // volenv volume offset
         modLfoCentibels = modLfoValue * modVolDepth;
+        // lowpass frequency
         lowpassCents += modLfoValue * modFilterDepth;
     }
 
     // channel vibrato (GS NRPN)
     if(channel.channelVibrato.depth > 0)
     {
+        // same as others
         const channelVibrato = getLFOValue(voice.startTime + channel.channelVibrato.delay, channel.channelVibrato.rate, currentTime);
         if(channelVibrato)
         {
@@ -122,6 +128,7 @@ export function renderVoice(
     const modEnvPitchDepth = voice.modulatedGenerators[generatorTypes.modEnvToPitch];
     const modEnvFilterDepth = voice.modulatedGenerators[generatorTypes.modEnvToFilterFc];
     const modEnv = getModEnvValue(voice, currentTime);
+    // apply values
     lowpassCents += modEnv * modEnvFilterDepth;
     cents += modEnv * modEnvPitchDepth;
 
@@ -152,6 +159,7 @@ export function renderVoice(
     voice.currentPan += (pan - voice.currentPan) * this.panSmoothingFactor; // smooth out pan to prevent clicking
     const panLeft = Math.cos(HALF_PI * voice.currentPan) * this.panLeft;
     const panRight = Math.sin(HALF_PI * voice.currentPan) *  this.panRight;
+    // disable reverb and chorus in one output mode
     const reverb = this.oneOutputMode ? 0 : voice.modulatedGenerators[generatorTypes.reverbEffectsSend];
     const chorus = this.oneOutputMode ? 0 : voice.modulatedGenerators[generatorTypes.chorusEffectsSend];
     panVoice(

package/synthetizer/worklet_system/worklet_methods/worklet_soundfont_manager/sfman_message.js

@@ -0,0 +1,9 @@
+/**
+ * @enum {number}
+ */
+export const WorkletSoundfontManagerMessageType = {
+    reloadSoundFont: 0,      // buffer<ArrayBuffer>
+    addNewSoundFont: 2,      // [buffer<ArrayBuffer>, id<string>, bankOffset<number>]
+    deleteSoundFont: 3,      // id<string>
+    rearrangeSoundFonts: 4, // newOrder<string[]> // where string is the id
+}