spessasynth_core 3.26.41 → 3.27.0

package/README.md

@@ -6,10 +6,10 @@
 **A powerful SF2/DLS/MIDI JavaScript library. It works with any modern JS environment that supports WebAssembly.**
 
 It allows you to:
-- Play MIDI files using SF2/SF3/DLS files
-- Write MIDI files
-- Write SF2/SF3 files
-- Convert DLS to SF2 (and back!)
+- Play MIDI files using SF2/SF3/DLS files!
+- Read and write MIDI files!
+- Write SF2/SF3 files!
+- Convert DLS to SF2! (and back!)
 - [and more!](https://github.com/spessasus/spessasynth_core?tab=readme-ov-file#current-features)
 > **TIP:**
 > Looking for an easy-to-use WebAudioAPI browser wrapper? Try [spessasynth_lib](https://github.com/spessasus/spessasynth_lib)!
@@ -18,20 +18,23 @@ It allows you to:
 npm install --save spessasynth_core
 ```
 
-### [Project site (consider giving it a star!)](https://github.com/spessasus/SpessaSynth)
+### [Project site (consider giving it a star!)](https://github.com/spessasus/spessasynth_core)
 
-### [Demo (using the spessasynth_lib wrapper)](https://spessasus.github.io/SpessaSynth)
+### Made with spessasynth_core
+- [SpessaSynth Online SF2/DLS MIDI Player](https://spessasus.github.io/SpessaSynth)
+- [SpessaFont Online SoundFont/DLS Editor](https://spessasus.github.io/SpessaFont)
 
 ### [Documentation (in progress!)](https://github.com/spessasus/spessasynth_core/wiki/Home)
 
 
 > Note: This is the new heart of the SpessaSynth library, after the repository has been split.
 
-**Project index**
+**SpessaSynth Project index**
 
-- spessasynth_core (you are here) - SF2/DLS/MIDI library
+- [spessasynth_core](https://github.com/spessasus/spessasynth_core) (you are here) - SF2/DLS/MIDI library
 - [spessasynth_lib](https://github.com/spessasus/spessasynth_lib) - spessasynth_core wrapper optimized for browsers and WebAudioAPI
-- [SpessaSynth](https://github.com/spessasus/SpessaSynth) - online/local web player/editor application
+- [SpessaSynth](https://github.com/spessasus/SpessaSynth) - online/local MIDI player/editor application
+- [SpessaFont](https://github.com/spessasus/SpessaFont) - online SF2/DLS editor
 
 ## Current Features
 

package/index.js

@@ -21,7 +21,7 @@ import { SynthesizerSnapshot } from "./src/synthetizer/audio_engine/snapshot/syn
 import { ChannelSnapshot } from "./src/synthetizer/audio_engine/snapshot/channel_snapshot.js";
 
 import { BasicSoundBank } from "./src/soundfont/basic_soundfont/basic_soundbank.js";
-import { BasicSample, sampleTypes } from "./src/soundfont/basic_soundfont/basic_sample.js";
+import { BasicSample, CreatedSample, sampleTypes } from "./src/soundfont/basic_soundfont/basic_sample.js";
 import { BasicPresetZone } from "./src/soundfont/basic_soundfont/basic_preset_zone.js";
 import { BasicInstrument } from "./src/soundfont/basic_soundfont/basic_instrument.js";
 import { BasicPreset } from "./src/soundfont/basic_soundfont/basic_preset.js";
@@ -98,6 +98,7 @@ export {
     BasicZone,
     BasicGlobalZone,
     BasicSample,
+    CreatedSample,
     BasicInstrumentZone,
     BasicInstrument,
     BasicPreset,

package/package.json

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

package/src/soundfont/basic_soundfont/basic_instrument.js

@@ -97,13 +97,14 @@ export class BasicInstrument
     
     /**
      * @param index {number}
+     * @param force {boolean} ignore use count
      * @returns {boolean} if deleted
      */
-    deleteZone(index)
+    deleteZone(index, force = false)
     {
         const zone = this.instrumentZones[index];
         zone.useCount -= 1;
-        if (zone.useCount < 1)
+        if (zone.useCount < 1 || force)
         {
             zone.deleteZone();
             this.instrumentZones.splice(index, 1);

package/src/soundfont/basic_soundfont/basic_sample.js

@@ -6,7 +6,11 @@ import { stbvorbis } from "../../externals/stbvorbis_sync/stbvorbis_sync.min.js"
 const RESAMPLE_RATE = 48000;
 
 /**
- * @enum {number}
+ * @typedef {1|2|4|8|32769|32770|32772|32776} sampleTypes
+ */
+
+/**
+ * @enum {sampleTypes}
  */
 export const sampleTypes = {
     monoSample: 1,
@@ -113,7 +117,7 @@ export class BasicSample
      * @param sampleRate {number} The sample's rate in Hz
      * @param samplePitch {number} The sample's pitch as a MIDI note number
      * @param samplePitchCorrection {number} The sample's pitch correction in cents
-     * @param sampleType {sampleTypes|number} The sample's type, an enum that can indicate SF3
+     * @param sampleType {sampleTypes} The sample's type, an enum that can indicate SF3
      * @param loopStart {number} The sample's loop start relative to the sample start in sample points
      * @param loopEnd {number} The sample's loop end relative to the sample start in sample points
      */
@@ -437,4 +441,37 @@ export class BasicSample
         this.isCompressed = true;
         this.dataOverriden = false;
     }
+}
+
+
+export class CreatedSample extends BasicSample
+{
+    /**
+     * A simplified class for creating samples
+     * @param name
+     * @param sampleRate
+     * @param sampleData
+     */
+    constructor(name, sampleRate, sampleData)
+    {
+        super(name, sampleRate, 60, 0, sampleTypes.monoSample, 0, sampleData.length - 1);
+        this.setAudioData(sampleData);
+    }
+    
+    /**
+     * @param allowVorbis {boolean}
+     * @returns {Uint8Array}
+     */
+    getRawData(allowVorbis)
+    {
+        return super.getRawData(allowVorbis);
+    }
+    
+    /**
+     * @param audioData {Float32Array}
+     */
+    setAudioData(audioData)
+    {
+        super.setAudioData(audioData);
+    }
 }

package/src/soundfont/basic_soundfont/basic_soundbank.js

@@ -9,7 +9,7 @@ import { consoleColors } from "../../utils/other.js";
 import { write } from "./write_sf2/write.js";
 import { defaultModulators, Modulator } from "./modulator.js";
 import { writeDLS } from "./write_dls/write_dls.js";
-import { BasicSample } from "./basic_sample.js";
+import { BasicSample, sampleTypes } from "./basic_sample.js";
 import { Generator } from "./generator.js";
 import { BasicInstrument } from "./basic_instrument.js";
 import { BasicPreset } from "./basic_preset.js";
@@ -158,7 +158,7 @@ class BasicSoundBank
             44100,
             65,
             20,
-            0,
+            sampleTypes.monoSample,
             0,
             127
         );

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

@@ -11,7 +11,7 @@ import {
     resetParameters
 } from "../engine_methods/controller_control/reset_controllers.js";
 import { renderVoice } from "../engine_methods/render_voice.js";
-import { panVoice } from "./stereo_panner.js";
+import { panAndMixVoice } from "./stereo_panner.js";
 import { killNote } from "../engine_methods/stopping_notes/kill_note.js";
 import { setTuning } from "../engine_methods/tuning_control/set_tuning.js";
 import { setModulationDepth } from "../engine_methods/tuning_control/set_modulation_depth.js";
@@ -273,18 +273,22 @@ class MidiAudioChannel
      * @param reverbOutputRight {Float32Array} right output for reverb
      * @param chorusOutputLeft {Float32Array} left output for chorus
      * @param chorusOutputRight {Float32Array} right output for chorus
+     * @param startIndex {number}
+     * @param sampleCount {number}
      */
     renderAudio(
         outputLeft, outputRight,
         reverbOutputLeft, reverbOutputRight,
-        chorusOutputLeft, chorusOutputRight
+        chorusOutputLeft, chorusOutputRight,
+        startIndex, sampleCount
     )
     {
         this.voices = this.voices.filter(v => !this.renderVoice(
             v, this.synth.currentSynthTime,
             outputLeft, outputRight,
             reverbOutputLeft, reverbOutputRight,
-            chorusOutputLeft, chorusOutputRight
+            chorusOutputLeft, chorusOutputRight,
+            startIndex, sampleCount
         ));
     }
     
@@ -516,7 +520,7 @@ class MidiAudioChannel
 
 // voice
 MidiAudioChannel.prototype.renderVoice = renderVoice;
-MidiAudioChannel.prototype.panVoice = panVoice;
+MidiAudioChannel.prototype.panAndMixVoice = panAndMixVoice;
 MidiAudioChannel.prototype.killNote = killNote;
 MidiAudioChannel.prototype.stopAllNotes = stopAllNotes;
 MidiAudioChannel.prototype.muteChannel = muteChannel;

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

@@ -125,7 +125,7 @@ export class SoundFontManager
     
     // noinspection JSUnusedGlobalSymbols
     /**
-     * Adds a new soundfont with a given ID
+     * Adds a new soundfont with a given ID, or replaces an existing one.
      * @param font {BasicSoundBank}
      * @param id {string}
      * @param bankOffset {number}

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

@@ -38,13 +38,15 @@ for (let pan = MIN_PAN; pan <= MAX_PAN; pan++)
  * @param reverbRight {Float32Array} right reverb input
  * @param chorusLeft {Float32Array} left chorus buffer
  * @param chorusRight {Float32Array} right chorus buffer
+ * @param startIndex {number}
  * @this {MidiAudioChannel}
  */
-export function panVoice(voice,
-                         inputBuffer,
-                         outputLeft, outputRight,
-                         reverbLeft, reverbRight,
-                         chorusLeft, chorusRight)
+export function panAndMixVoice(voice,
+                               inputBuffer,
+                               outputLeft, outputRight,
+                               reverbLeft, reverbRight,
+                               chorusLeft, chorusRight,
+                               startIndex)
 {
     if (isNaN(inputBuffer[0]))
     {
@@ -82,10 +84,10 @@ export function panVoice(voice,
             const reverbGain = this.synth.reverbGain * this.synth.reverbSend * gain * (reverbSend / REVERB_DIVIDER);
             for (let i = 0; i < inputBuffer.length; i++)
             {
-                reverbLeft[i] += reverbGain * inputBuffer[i];
+                const idx = i + startIndex;
+                reverbLeft[idx] += reverbGain * inputBuffer[i];
+                reverbRight[idx] += reverbGain * inputBuffer[i];
             }
-            // copy as its mono
-            reverbRight.set(reverbLeft);
         }
         
         const chorusSend = voice.modulatedGenerators[generatorTypes.chorusEffectsSend];
@@ -97,8 +99,9 @@ export function panVoice(voice,
             const chorusRightGain = gainRight * chorusGain;
             for (let i = 0; i < inputBuffer.length; i++)
             {
-                chorusLeft[i] += chorusLeftGain * inputBuffer[i];
-                chorusRight[i] += chorusRightGain * inputBuffer[i];
+                const idx = i + startIndex;
+                chorusLeft[idx] += chorusLeftGain * inputBuffer[i];
+                chorusRight[idx] += chorusRightGain * inputBuffer[i];
             }
         }
     }
@@ -108,14 +111,14 @@ export function panVoice(voice,
     {
         for (let i = 0; i < inputBuffer.length; i++)
         {
-            outputLeft[i] += gainLeft * inputBuffer[i];
+            outputLeft[i + startIndex] += gainLeft * inputBuffer[i];
         }
     }
     if (gainRight > 0)
     {
         for (let i = 0; i < inputBuffer.length; i++)
         {
-            outputRight[i] += gainRight * inputBuffer[i];
+            outputRight[i + startIndex] += gainRight * inputBuffer[i];
         }
     }
 }

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

@@ -18,6 +18,8 @@ import { generatorTypes } from "../../../soundfont/basic_soundfont/generator_typ
  * @param reverbOutputRight {Float32Array} right output for reverb
  * @param chorusOutputLeft {Float32Array} left output for chorus
  * @param chorusOutputRight {Float32Array} right output for chorus
+ * @param startIndex {number}
+ * @param sampleCount {number}
  * @this {MidiAudioChannel}
  * @returns {boolean} true if the voice is finished
  */
@@ -25,7 +27,8 @@ export function renderVoice(
     voice, timeNow,
     outputLeft, outputRight,
     reverbOutputLeft, reverbOutputRight,
-    chorusOutputLeft, chorusOutputRight
+    chorusOutputLeft, chorusOutputRight,
+    startIndex, sampleCount
 )
 {
     // check if release
@@ -168,7 +171,7 @@ export function renderVoice(
     
     
     // SYNTHESIS
-    const bufferOut = new Float32Array(outputLeft.length);
+    const bufferOut = new Float32Array(sampleCount);
     
     // wave table oscillator
     switch (this.synth.interpolationType)
@@ -191,14 +194,20 @@ export function renderVoice(
     LowpassFilter.apply(voice, bufferOut, lowpassExcursion, this.synth.filterSmoothingFactor);
     
     // vol env
-    VolumeEnvelope.apply(voice, bufferOut, volumeExcursionCentibels, this.synth.volumeEnvelopeSmoothingFactor);
+    VolumeEnvelope.apply(
+        voice,
+        bufferOut,
+        volumeExcursionCentibels,
+        this.synth.volumeEnvelopeSmoothingFactor
+    );
     
-    this.panVoice(
+    this.panAndMixVoice(
         voice,
         bufferOut,
         outputLeft, outputRight,
         reverbOutputLeft, reverbOutputRight,
-        chorusOutputLeft, chorusOutputRight
+        chorusOutputLeft, chorusOutputRight,
+        startIndex
     );
     return voice.finished;
 }

package/src/synthetizer/audio_engine/engine_methods/soundfont_management/embedded_sound_bank.js

@@ -24,7 +24,6 @@ export function setEmbeddedSoundFont(font, offset)
 {
     // the embedded bank is set as the first bank in the manager,
     // with a special ID that does not clear when reloadManager is performed.
-    this.soundfontBankOffset = offset;
     const loadedFont = loadSoundFont(font);
     this.soundfontManager.addNewSoundFont(loadedFont, EMBEDDED_SOUND_BANK_ID, offset);
     // rearrange so the embedded is first (most important as it overrides all others)

package/src/synthetizer/audio_engine/main_processor.js

@@ -172,6 +172,12 @@ export const SYNTHESIZER_GAIN = 1.0;
 class SpessaSynthProcessor
 {
     
+    /**
+     * Manages sound banks.
+     * @type {SoundFontManager}
+     */
+    soundfontManager = new SoundFontManager(this.updatePresetList.bind(this));
+    
     /**
      * Cached voices for all presets for this synthesizer.
      * Nesting goes like this:
@@ -210,13 +216,6 @@ class SpessaSynthProcessor
      */
     tunings = [];
     
-    
-    /**
-     * Bank offset for things like embedded RMIDIS. Added for every program change
-     * @type {number}
-     */
-    soundfontBankOffset = 0;
-    
     /**
      * The volume gain, set by user
      * @type {number}
@@ -345,6 +344,7 @@ class SpessaSynthProcessor
      */
     effectsEnabled;
     
+    
     /**
      * for applying the snapshot after an override sound bank too
      * @type {SynthesizerSnapshot}
@@ -408,11 +408,6 @@ class SpessaSynthProcessor
             this.tunings.push([]);
         }
         
-        /**
-         * @type {SoundFontManager}
-         */
-        this.soundfontManager = new SoundFontManager(this.updatePresetList.bind(this));
-        
         for (let i = 0; i < this.midiOutputsCount; i++)
         {
             this.createMidiChannel(false);
@@ -496,10 +491,17 @@ class SpessaSynthProcessor
      * @param outputs {Float32Array[]} output stereo channels (L, R)
      * @param reverb {Float32Array[]} reverb stereo channels (L, R)
      * @param chorus {Float32Array[]} chorus stereo channels (L, R)
-     */
-    renderAudio(outputs, reverb, chorus)
+     * @param startIndex {number} start offset of the passed arrays, rendering starts at this index, defaults to 0
+     * @param sampleCount {number} the length of the rendered buffer, defaults to float32array length - startOffset
+     */
+    renderAudio(outputs,
+                reverb,
+                chorus,
+                startIndex = 0,
+                sampleCount = 0
+    )
     {
-        this.renderAudioSplit(reverb, chorus, Array(16).fill(outputs));
+        this.renderAudioSplit(reverb, chorus, Array(16).fill(outputs), startIndex, sampleCount);
     }
     
     /**
@@ -508,8 +510,15 @@ class SpessaSynthProcessor
      * @param reverbChannels {Float32Array[]} reverb stereo channels (L, R)
      * @param chorusChannels {Float32Array[]} chorus stereo channels (L, R)
      * @param separateChannels {Float32Array[][]} a total of 16 stereo pairs (L, R) for each MIDI channel
-     */
-    renderAudioSplit(reverbChannels, chorusChannels, separateChannels)
+     * @param startIndex {number} start offset of the passed arrays, rendering starts at this index, defaults to 0
+     * @param sampleCount {number} the length of the rendered buffer, defaults to float32array length - startOffset
+     */
+    renderAudioSplit(reverbChannels,
+                     chorusChannels,
+                     separateChannels,
+                     startIndex = 0,
+                     sampleCount = 0
+    )
     {
         // process event queue
         const time = this.currentSynthTime;
@@ -522,6 +531,10 @@ class SpessaSynthProcessor
         const chrL = chorusChannels[0];
         const chrR = chorusChannels[1];
         
+        // validate
+        startIndex = Math.max(startIndex, 0);
+        const quantumSize = sampleCount || separateChannels[0][0].length - startIndex;
+        
         // for every channel
         this.totalVoicesAmount = 0;
         this.midiAudioChannels.forEach((channel, index) =>
@@ -538,7 +551,8 @@ class SpessaSynthProcessor
             channel.renderAudio(
                 separateChannels[ch][0], separateChannels[ch][1],
                 revL, revR,
-                chrL, chrR
+                chrL, chrR,
+                startIndex, quantumSize
             );
             
             this.totalVoicesAmount += channel.voices.length;
@@ -550,7 +564,7 @@ class SpessaSynthProcessor
         });
         
         // advance the time appropriately
-        this.currentSynthTime += separateChannels[0][0].length * this.sampleTime;
+        this.currentSynthTime += quantumSize * this.sampleTime;
     }
     
     // noinspection JSUnusedGlobalSymbols