spessasynth_core 3.26.0 → 3.26.1

package/README.md

@@ -1,4 +1,7 @@
-# spessasynth_core
+<!--suppress HtmlDeprecatedAttribute, HtmlRequiredAltAttribute, HtmlExtraClosingTag -->
+<p align='center'>
+<img src='https://raw.githubusercontent.com/spessasus/SpessaSynth/refs/heads/master/src/website/spessasynth_logo_rounded.png' width='300' alt='SpessaSynth logo'>
+</p>
 
 **A powerful SF2/DLS/MIDI JavaScript library. It works with any modern JS environment that supports WebAssembly.**
 
@@ -11,12 +14,12 @@ npm install --save spessasynth_core
 
 ### [Project site (consider giving it a star!)](https://github.com/spessasus/SpessaSynth)
 
-### [Demo (using the spessasynth_lib wrapper)](https://spessasus.github.io/spessasynth_core)
+### [Demo (using the spessasynth_lib wrapper)](https://spessasus.github.io/SpessaSynth)
 
 ### [Documentation (in progress!)](https://github.com/spessasus/spessasynth_core/wiki/Home)
 
 
-> Note: This is the new heart of the spessasynth_core library, after the repository has been split.
+> Note: This is the new heart of the SpessaSynth library, after the repository has been split.
 
 ### 
 ```js
@@ -84,9 +87,9 @@ process.exit();
 
 ### Easy Integration
 - **Modular design:** *Easy integration into other projects (load what you need)*
-- **[Detailed documentation:](https://github.com/spessasus/spessasynth_core/wiki/Home)** *With [examples!](https://github.com/spessasus/spessasynth_core/wiki/Usage-As-Library#examples)*
+- **[Detailed documentation:](https://github.com/spessasus/spessasynth_core/wiki/Home)** *With [examples!](https://github.com/spessasus/spessasynth_core/wiki/Getting-Started#examples)*
 - **Flexible:** *It's not just a MIDI player!*
-- **Easy to Use:** *Basic setup is just [two lines of code!](https://github.com/spessasus/spessasynth_core/wiki/Usage-As-Library#minimal-setup)*
+- **Easy to Use:** *Basic setup is just [two lines of code!](https://github.com/spessasus/spessasynth_core/wiki/Getting-Started#minimal-setup)*
 - **No dependencies:** *Batteries included!*
 
 ### Powerful MIDI Synthesizer

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spessasynth_core",
-  "version": "3.26.0",
+  "version": "3.26.1",
   "description": "MIDI and SoundFont2/DLS library with no compromises",
   "main": "index.js",
   "type": "module",

package/src/midi/midi_tools/used_keys_loaded.js

@@ -8,7 +8,7 @@ import { isGSDrumsOn, isXGOn } from "../../utils/sysex_detector.js";
 /**
  * Gets the used programs and keys for this MIDI file with a given sound bank
  * @this {BasicMIDI}
- * @param soundfont {BasicSoundBank|WorkletSoundfontManager} - the sound bank
+ * @param soundfont {BasicSoundBank|SoundFontManager} - the sound bank
  * @returns {Object<string, Set<string>>} Object<bank:program, Set<key-velocity>>
  */
 export function getUsedProgramsAndKeys(soundfont)

package/src/sequencer/process_event.js

@@ -160,6 +160,6 @@ export function _addNewMidiPort()
 {
     for (let i = 0; i < 16; i++)
     {
-        this.synth.createWorkletChannel(true);
+        this.synth.createMidiChannel(true);
     }
 }

package/src/synthetizer/audio_engine/engine_components/key_modifier_manager.js

@@ -42,6 +42,7 @@ export class KeyModifierManager
 {
     /**
      * The velocity override mappings for MIDI keys
+     * stored as [channelNumber][midiNote]
      * @type {KeyModifier[][]}
      * @private
      */

package/src/synthetizer/audio_engine/engine_components/lowpass_filter.js

@@ -22,7 +22,7 @@ export const FILTER_SMOOTHING_FACTOR = 0.1;
  * @property {number} a4 - Filter coefficient 5
  */
 
-export class WorkletLowpassFilter
+export class LowpassFilter
 {
     /**
      * Cached coefficient calculations
@@ -175,7 +175,7 @@ export class WorkletLowpassFilter
         {
             filter.lastTargetCutoff = targetCutoff;
             filter.resonanceCb = modulatedResonance;
-            WorkletLowpassFilter.calculateCoefficients(filter, targetCutoff);
+            LowpassFilter.calculateCoefficients(filter, targetCutoff);
         }
         
         // filter the input
@@ -200,7 +200,7 @@ export class WorkletLowpassFilter
     }
     
     /**
-     * @param filter {WorkletLowpassFilter}
+     * @param filter {LowpassFilter}
      * @param cutoffCents {number}
      */
     static calculateCoefficients(filter, cutoffCents)
@@ -208,7 +208,7 @@ export class WorkletLowpassFilter
         cutoffCents = ~~cutoffCents; // Math.floor
         const qCb = filter.resonanceCb;
         // check if these coefficients were already cached
-        const cached = WorkletLowpassFilter.cachedCoefficients?.[qCb]?.[cutoffCents];
+        const cached = LowpassFilter.cachedCoefficients?.[qCb]?.[cutoffCents];
         if (cached !== undefined)
         {
             filter.a0 = cached.a0;
@@ -263,20 +263,20 @@ export class WorkletLowpassFilter
         filter.a3 = toCache.a3;
         filter.a4 = toCache.a4;
         
-        if (WorkletLowpassFilter.cachedCoefficients[qCb] === undefined)
+        if (LowpassFilter.cachedCoefficients[qCb] === undefined)
         {
-            WorkletLowpassFilter.cachedCoefficients[qCb] = [];
+            LowpassFilter.cachedCoefficients[qCb] = [];
         }
-        WorkletLowpassFilter.cachedCoefficients[qCb][cutoffCents] = toCache;
+        LowpassFilter.cachedCoefficients[qCb][cutoffCents] = toCache;
     }
 }
 
 // precompute all the cutoffs for 0q (most common)
-const dummy = new WorkletLowpassFilter(44100);
+const dummy = new LowpassFilter(44100);
 dummy.resonanceCb = 0;
 // sfspec section 8.1.3: initialFilterFc ranges from 1500 to 13,500 cents
 for (let i = 1500; i < 13500; i++)
 {
     dummy.currentInitialFc = i;
-    WorkletLowpassFilter.calculateCoefficients(dummy, i);
+    LowpassFilter.calculateCoefficients(dummy, i);
 }

package/src/synthetizer/audio_engine/engine_components/soundfont_manager.js

@@ -9,10 +9,10 @@ import { isXGDrums } from "../../../utils/xg_hacks.js";
  * @property {number} bankOffset - the soundfont's bank offset
  */
 
-export class WorkletSoundfontManager
+export class SoundFontManager
 {
     /**
-     * Creates a new instance of worklet soundfont manager (worklet scope)
+     * Creates a new instance of soundfont manager
      * @param initialSoundFontBuffer {ArrayBuffer} Array buffer of the soundfont. This soudfont always has the id "main"
      */
     constructor(initialSoundFontBuffer)

package/src/synthetizer/audio_engine/engine_components/stereo_panner.js

@@ -7,8 +7,8 @@ import { generatorTypes } from "../../../soundfont/basic_soundfont/generator.js"
 
 export const PAN_SMOOTHING_FACTOR = 0.05;
 
-export const WORKLET_SYSTEM_REVERB_DIVIDER = 4600;
-export const WORKLET_SYSTEM_CHORUS_DIVIDER = 2000;
+export const REVERB_DIVIDER = 4600;
+export const CHORUS_DIVIDER = 2000;
 const HALF_PI = Math.PI / 2;
 
 const MIN_PAN = -500;
@@ -78,7 +78,7 @@ export function panVoice(voice,
         if (reverbSend > 0)
         {
             // reverb is mono so we need to multiply by gain
-            const reverbGain = this.synth.reverbGain * gain * (reverbSend / WORKLET_SYSTEM_REVERB_DIVIDER);
+            const reverbGain = this.synth.reverbGain * gain * (reverbSend / REVERB_DIVIDER);
             for (let i = 0; i < inputBuffer.length; i++)
             {
                 reverbLeft[i] += reverbGain * inputBuffer[i];
@@ -91,7 +91,7 @@ export function panVoice(voice,
         if (chorusSend > 0)
         {
             // chorus is stereo so we do not need to
-            const chorusGain = this.synth.chorusGain * chorusSend / WORKLET_SYSTEM_CHORUS_DIVIDER;
+            const chorusGain = this.synth.chorusGain * chorusSend / CHORUS_DIVIDER;
             const chorusLeftGain = gainLeft * chorusGain;
             const chorusRightGain = gainRight * chorusGain;
             for (let i = 0; i < inputBuffer.length; i++)

package/src/synthetizer/audio_engine/engine_components/voice.js

@@ -1,11 +1,10 @@
 /**
  * voice.js
- * purpose: prepares Voices from sample and generator data and manages sample dumping
- * note: sample dumping means sending it over to the AudioWorkletGlobalScope
+ * purpose: prepares Voices from sample and generator data
  */
 import { MIN_EXCLUSIVE_LENGTH, MIN_NOTE_LENGTH } from "../main_processor.js";
 import { SpessaSynthWarn } from "../../../utils/loggin.js";
-import { WorkletLowpassFilter } from "./lowpass_filter.js";
+import { LowpassFilter } from "./lowpass_filter.js";
 import { VolumeEnvelope } from "./volume_envelope.js";
 import { ModulationEnvelope } from "./modulation_envelope.js";
 import { addAndClampGenerator, generatorTypes } from "../../../soundfont/basic_soundfont/generator.js";
@@ -122,7 +121,7 @@ class Voice
     
     /**
      * Lowpass filter applied to the voice.
-     * @type {WorkletLowpassFilter}
+     * @type {LowpassFilter}
      */
     filter;
     
@@ -270,7 +269,7 @@ class Voice
     /**
      * Creates a Voice
      * @param sampleRate {number}
-     * @param workletSample {AudioSample}
+     * @param audioSample {AudioSample}
      * @param midiNote {number}
      * @param velocity {number}
      * @param channel {number}
@@ -282,7 +281,7 @@ class Voice
      */
     constructor(
         sampleRate,
-        workletSample,
+        audioSample,
         midiNote,
         velocity,
         channel,
@@ -293,12 +292,12 @@ class Voice
         modulators
     )
     {
-        this.sample = workletSample;
+        this.sample = audioSample;
         this.generators = generators;
         this.exclusiveClass = this.generators[generatorTypes.exclusiveClass];
         this.modulatedGenerators = new Int16Array(generators);
         this.modulators = modulators;
-        this.filter = new WorkletLowpassFilter(sampleRate);
+        this.filter = new LowpassFilter(sampleRate);
         
         this.velocity = velocity;
         this.midiNote = midiNote;
@@ -461,11 +460,11 @@ export function getVoices(channel,
             let loopEnd = sampleAndGenerators.sample.sampleLoopEndIndex;
             let loopingMode = generators[generatorTypes.sampleModes];
             /**
-             * create the worklet sample
+             * create the sample
              * offsets are calculated at note on time (to allow for modulation of them)
              * @type {AudioSample}
              */
-            const workletSample = new AudioSample(
+            const audioSample = new AudioSample(
                 sampleAndGenerators.sample.sampleData,
                 (sampleAndGenerators.sample.sampleRate / this.sampleRate) * Math.pow(
                     2,
@@ -492,14 +491,14 @@ export function getVoices(channel,
             //     Velocity: velocity,
             //     TargetKey: targetKey,
             //     MidiNote: midiNote,
-            //     AudioSample: workletSample
+            //     AudioSample: audioSample
             // }]);
             
             
             voices.push(
                 new Voice(
                     this.sampleRate,
-                    workletSample,
+                    audioSample,
                     midiNote,
                     velocity,
                     channel,

package/src/synthetizer/audio_engine/engine_methods/render_voice.js

@@ -5,7 +5,7 @@ import { customControllers } from "../engine_components/controller_tables.js";
 import { absCentsToHz, timecentsToSeconds } from "../engine_components/unit_converter.js";
 import { getLFOValue } from "../engine_components/lfo.js";
 import { WavetableOscillator } from "../engine_components/wavetable_oscillator.js";
-import { WorkletLowpassFilter } from "../engine_components/lowpass_filter.js";
+import { LowpassFilter } from "../engine_components/lowpass_filter.js";
 import { interpolationTypes } from "../engine_components/enums.js";
 
 /**
@@ -181,7 +181,7 @@ export function renderVoice(
     }
     
     // low pass filter
-    WorkletLowpassFilter.apply(voice, bufferOut, lowpassExcursion, this.synth.filterSmoothingFactor);
+    LowpassFilter.apply(voice, bufferOut, lowpassExcursion, this.synth.filterSmoothingFactor);
     
     // vol env
     VolumeEnvelope.apply(voice, bufferOut, modLfoCentibels, this.synth.volumeEnvelopeSmoothingFactor);

package/src/synthetizer/audio_engine/engine_methods/tuning_control/set_master_tuning.js

@@ -1,7 +1,7 @@
 import { customControllers } from "../../engine_components/controller_tables.js";
 
 /**
- * Sets the worklet's primary tuning
+ * Sets the synth's primary tuning
  * @this {SpessaSynthProcessor}
  * @param cents {number}
  */

package/src/synthetizer/audio_engine/main_processor.js

@@ -12,7 +12,7 @@ import { VOLUME_ENVELOPE_SMOOTHING_FACTOR } from "./engine_components/volume_env
 import { systemExclusive } from "./engine_methods/system_exclusive.js";
 import { masterParameterType, setMasterParameter } from "./engine_methods/controller_control/master_parameters.js";
 import { resetAllControllers } from "./engine_methods/controller_control/reset_controllers.js";
-import { WorkletSoundfontManager } from "./engine_components/soundfont_manager.js";
+import { SoundFontManager } from "./engine_components/soundfont_manager.js";
 import { KeyModifierManager } from "./engine_components/key_modifier_manager.js";
 import { getVoices } from "./engine_components/voice.js";
 import { PAN_SMOOTHING_FACTOR } from "./engine_components/stereo_panner.js";
@@ -314,7 +314,7 @@ class SpessaSynthProcessor
     defaultDrumsUsesOverride = false;
     
     /**
-     * Controls if the worklet processor is fully initialized
+     * Controls if the processor is fully initialized
      * @type {Promise<boolean>}
      */
     processorInitialized = stbvorbis.isInitialized;
@@ -340,7 +340,7 @@ class SpessaSynthProcessor
      */
     
     /**
-     * Creates a new worklet synthesis system. contains all channels
+     * Creates a new synthesizer engine.
      * @param midiChannels {number}
      * @param soundfont {ArrayBuffer}
      * @param enableEventSystem {boolean}
@@ -380,12 +380,6 @@ class SpessaSynthProcessor
         this.currentSynthTime = initialTime;
         this.sampleRate = sampleRate;
         
-        this.isFullyReady = false;
-        this.processorInitialized.then(() =>
-        {
-            this.isFullyReady = true;
-        });
-        
         /**
          * Sample time in seconds
          * @type {number}
@@ -401,9 +395,9 @@ class SpessaSynthProcessor
         }
         
         /**
-         * @type {WorkletSoundfontManager}
+         * @type {SoundFontManager}
          */
-        this.soundfontManager = new WorkletSoundfontManager(
+        this.soundfontManager = new SoundFontManager(
             soundfont
         );
         this.sendPresetList();
@@ -412,7 +406,7 @@ class SpessaSynthProcessor
         
         for (let i = 0; i < initialChannelCount; i++)
         {
-            this.createWorkletChannel(false);
+            this.createMidiChannel(false);
         }
         
         this.midiAudioChannels[DEFAULT_PERCUSSION].preset = this.drumPreset;
@@ -764,7 +758,7 @@ class SpessaSynthProcessor
     }
     
     /**
-     * Calls synth event from the worklet side
+     * Calls synth event
      * @param eventName {EventTypes} the event name
      * @param eventData {EventCallbackData}
      * @this {SpessaSynthProcessor}
@@ -785,7 +779,7 @@ SpessaSynthProcessor.prototype.systemExclusive = systemExclusive;
 
 // channel related
 SpessaSynthProcessor.prototype.stopAllChannels = stopAllChannels;
-SpessaSynthProcessor.prototype.createWorkletChannel = createMidiChannel;
+SpessaSynthProcessor.prototype.createMidiChannel = createMidiChannel;
 SpessaSynthProcessor.prototype.resetAllControllers = resetAllControllers;
 
 // master parameter related

package/src/synthetizer/audio_engine/snapshot/channel_snapshot.js

@@ -104,13 +104,13 @@ export class ChannelSnapshot
     
     /**
      * Creates a snapshot of a single channel's state in the synthesizer.
-     * @param workletProcessor {SpessaSynthProcessor}
+     * @param spessaSynthProcessor {SpessaSynthProcessor}
      * @param channelNumber {number}
      * @returns {ChannelSnapshot}
      */
-    static getChannelSnapshot(workletProcessor, channelNumber)
+    static getChannelSnapshot(spessaSynthProcessor, channelNumber)
     {
-        const channelObject = workletProcessor.midiAudioChannels[channelNumber];
+        const channelObject = spessaSynthProcessor.midiAudioChannels[channelNumber];
         const channelSnapshot = new ChannelSnapshot();
         // program data
         channelSnapshot.program = channelObject.preset.program;
@@ -142,13 +142,13 @@ export class ChannelSnapshot
     
     /**
      * Applies the snapshot to the specified channel.
-     * @param workletProcessor {SpessaSynthProcessor}
+     * @param spessaSynthProcessor {SpessaSynthProcessor}
      * @param channelNumber {number}
      * @param channelSnapshot {ChannelSnapshot}
      */
-    static applyChannelSnapshot(workletProcessor, channelNumber, channelSnapshot)
+    static applyChannelSnapshot(spessaSynthProcessor, channelNumber, channelSnapshot)
     {
-        const channelObject = workletProcessor.midiAudioChannels[channelNumber];
+        const channelObject = spessaSynthProcessor.midiAudioChannels[channelNumber];
         channelObject.muteChannel(channelSnapshot.isMuted);
         channelObject.setDrums(channelSnapshot.drumChannel);
         

package/src/synthetizer/audio_engine/snapshot/synthesizer_snapshot.js

@@ -53,27 +53,27 @@ export class SynthesizerSnapshot
     
     /**
      * Creates a snapshot of the synthesizer's state.
-     * @param workletProcessor {SpessaSynthProcessor}
+     * @param spessaSynthProcessor {SpessaSynthProcessor}
      * @returns {SynthesizerSnapshot}
      */
-    static createSynthesizerSnapshot(workletProcessor)
+    static createSynthesizerSnapshot(spessaSynthProcessor)
     {
         const snapshot = new SynthesizerSnapshot();
         // channel snapshots
         snapshot.channelSnapshots =
-            workletProcessor.midiAudioChannels.map((_, i) =>
-                ChannelSnapshot.getChannelSnapshot(workletProcessor, i));
+            spessaSynthProcessor.midiAudioChannels.map((_, i) =>
+                ChannelSnapshot.getChannelSnapshot(spessaSynthProcessor, i));
         
         // key mappings
-        snapshot.keyMappings = workletProcessor.keyModifierManager.getMappings();
+        snapshot.keyMappings = spessaSynthProcessor.keyModifierManager.getMappings();
         // pan and volume
-        snapshot.mainVolume = workletProcessor.midiVolume;
-        snapshot.pan = workletProcessor.pan;
+        snapshot.mainVolume = spessaSynthProcessor.midiVolume;
+        snapshot.pan = spessaSynthProcessor.pan;
         
         // others
-        snapshot.system = workletProcessor.system;
-        snapshot.interpolation = workletProcessor.interpolationType;
-        snapshot.transposition = workletProcessor.transposition;
+        snapshot.system = spessaSynthProcessor.system;
+        snapshot.interpolation = spessaSynthProcessor.interpolationType;
+        snapshot.transposition = spessaSynthProcessor.transposition;
         
         // effect config is stored on the main thread, leave it empty
         snapshot.effectsConfig = {};
@@ -83,31 +83,31 @@ export class SynthesizerSnapshot
     
     /**
      * Applies the snapshot to the synthesizer.
-     * @param workletProcessor {SpessaSynthProcessor}
+     * @param spessaSynthProcessor {SpessaSynthProcessor}
      * @param snapshot {SynthesizerSnapshot}
      */
-    static applySnapshot(workletProcessor, snapshot)
+    static applySnapshot(spessaSynthProcessor, snapshot)
     {
         // restore system
-        workletProcessor.setSystem(snapshot.system);
+        spessaSynthProcessor.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);
+        spessaSynthProcessor.setMasterParameter(masterParameterType.mainVolume, snapshot.mainVolume);
+        spessaSynthProcessor.setMasterParameter(masterParameterType.masterPan, snapshot.pan);
+        spessaSynthProcessor.transposeAllChannels(snapshot.transposition);
+        spessaSynthProcessor.interpolationType = snapshot.interpolation;
+        spessaSynthProcessor.keyModifierManager.setMappings(snapshot.keyMappings);
         
         // add channels if more needed
-        while (workletProcessor.midiAudioChannels.length < snapshot.channelSnapshots.length)
+        while (spessaSynthProcessor.midiAudioChannels.length < snapshot.channelSnapshots.length)
         {
-            workletProcessor.createWorkletChannel();
+            spessaSynthProcessor.createMidiChannel();
         }
         
         // restore channels
         snapshot.channelSnapshots.forEach((channelSnapshot, index) =>
         {
-            ChannelSnapshot.applyChannelSnapshot(workletProcessor, index, channelSnapshot);
+            ChannelSnapshot.applyChannelSnapshot(spessaSynthProcessor, index, channelSnapshot);
         });
         
         SpessaSynthInfo("%cFinished restoring controllers!", consoleColors.info);