spessasynth_core 3.26.19 → 3.26.21

package/README.md

@@ -79,7 +79,6 @@ npm install --save spessasynth_core
 - **Smart preloading:** Only preloads the samples used in the MIDI file for smooth playback *(down to key and velocity!)*
 - **Lyrics support:** Add karaoke to your program!
 - **Raw lyrics available:** Decode in any encoding! *(Kanji? No problem!)*
-- **Runs in Audio Thread as well:** Never blocks the main thread
 - **Loop points support:** Ensures seamless loops
 
 ### Read and Write SoundFont and MIDI Files with Ease

package/package.json

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

package/src/soundfont/basic_soundfont/basic_global_zone.js

@@ -2,15 +2,5 @@ import { BasicZone } from "./basic_zone.js";
 
 export class BasicGlobalZone extends BasicZone
 {
-    
-    /**
-     * @param zone {BasicZone}
-     */
-    copyFrom(zone)
-    {
-        this.keyRange = { ...zone.keyRange };
-        this.velRange = { ...zone.velRange };
-        this.generators = [...zone.generators];
-        this.modulators = [...zone.modulators];
-    }
+    // nothing here, just a different instance...
 }

package/src/soundfont/basic_soundfont/basic_instrument.js

@@ -1,4 +1,5 @@
 import { BasicGlobalZone } from "./basic_global_zone.js";
+import { BasicInstrumentZone } from "./basic_instrument_zone.js";
 
 export class BasicInstrument
 {
@@ -22,42 +23,53 @@ export class BasicInstrument
     globalZone = new BasicGlobalZone();
     
     /**
-     * Instrument's use count, used for trimming
-     * @type {number}
-     * @private
+     * Instrument's linked presets (the presets that use it)
+     * note that duplicates are allowed since one preset can use the same instrument multople times
+     * @type {BasicPreset[]}
      */
-    _useCount = 0;
+    linkedPresets = [];
     
     /**
      * @returns {number}
      */
     get useCount()
     {
-        return this._useCount;
+        return this.linkedPresets.length;
     }
     
     /**
-     * @param zones {BasicInstrumentZone}
+     * @returns {BasicInstrumentZone}
      */
-    addZones(...zones)
+    createZone()
     {
-        zones.forEach(z => z.useCount++);
-        this.instrumentZones.push(...zones);
+        const zone = new BasicInstrumentZone(this);
+        this.instrumentZones.push(zone);
+        return zone;
     }
     
-    addUseCount()
+    /**
+     * @param preset {BasicPreset}
+     */
+    linkTo(preset)
     {
-        this._useCount++;
-        this.instrumentZones.forEach(z => z.useCount++);
+        this.linkedPresets.push(preset);
+        this.instrumentZones.forEach(z => z.useCount = this.linkedPresets.length);
     }
     
-    removeUseCount()
+    /**
+     * @param preset {BasicPreset}
+     */
+    unlinkFrom(preset)
     {
-        this._useCount--;
-        this.instrumentZones.forEach(z => z.useCount--);
+        const index = this.linkedPresets.indexOf(preset);
+        if (index < 0)
+        {
+            throw new Error(`Cannot unlink ${preset.presetName} from ${this.instrumentName}: not linked.`);
+        }
+        this.linkedPresets.splice(index, 1);
     }
     
-    deleteZones()
+    deleteAllZones()
     {
         this.instrumentZones.forEach(z => z.deleteZone());
         this.instrumentZones.length = 0;

package/src/soundfont/basic_soundfont/basic_instrument_zone.js

@@ -2,17 +2,32 @@ import { BasicZone } from "./basic_zone.js";
 
 export class BasicInstrumentZone extends BasicZone
 {
+    /**
+     * The parent instrument.
+     * @type {BasicInstrument}
+     */
+    parentInstrument;
+    
     /**
      * Zone's sample.
      * @type {BasicSample}
      */
     sample;
-    
     /**
-     * For tracking on the individual zone level, since multiple presets can refer to the same instrument
+     * For tracking on the individual zone level, since multiple presets can refer to the same instrument.
      * @type {number}
      */
-    useCount = 0;
+    useCount;
+    
+    /**
+     * @param instrument {BasicInstrument}
+     */
+    constructor(instrument)
+    {
+        super();
+        this.parentInstrument = instrument;
+        this.useCount = instrument.linkedPresets.length;
+    }
     
     /**
      * @param sample {BasicSample}
@@ -20,16 +35,23 @@ export class BasicInstrumentZone extends BasicZone
     setSample(sample)
     {
         this.sample = sample;
-        this.sample.useCount++;
+        sample.linkTo(this.parentInstrument);
     }
     
     deleteZone()
     {
-        this.sample.useCount--;
+        this.sample.unlinkFrom(this.parentInstrument);
     }
     
-    hasSample()
+    /**
+     * @param zone {BasicZone}
+     */
+    copyFrom(zone)
     {
-        return !!this.sample;
+        super.copyFrom(zone);
+        if (zone instanceof BasicInstrumentZone)
+        {
+            this.sample = zone.sample;
+        }
     }
 }

package/src/soundfont/basic_soundfont/basic_preset.js

@@ -10,6 +10,7 @@ import { Modulator } from "./modulator.js";
 import { isXGDrums } from "../../utils/xg_hacks.js";
 
 import { BasicGlobalZone } from "./basic_global_zone.js";
+import { BasicPresetZone } from "./basic_preset_zone.js";
 
 export class BasicPreset
 {
@@ -75,14 +76,6 @@ export class BasicPreset
         this.parentSoundBank = parentSoundBank;
     }
     
-    /**
-     * @param zones {BasicPresetZone}
-     */
-    addZones(...zones)
-    {
-        this.presetZones.push(...zones);
-    }
-    
     /**
      * @param allowXG {boolean}
      * @param allowSFX {boolean}
@@ -113,6 +106,16 @@ export class BasicPreset
         this.presetZones.splice(index, 1);
     }
     
+    /**
+     * @returns {BasicPresetZone}
+     */
+    createZone()
+    {
+        const z = new BasicPresetZone(this);
+        this.presetZones.push(z);
+        return z;
+    }
+    
     // noinspection JSUnusedGlobalSymbols
     /**
      * Preloads all samples (async)

package/src/soundfont/basic_soundfont/basic_preset_zone.js

@@ -3,14 +3,29 @@ import { BasicZone } from "./basic_zone.js";
 export class BasicPresetZone extends BasicZone
 {
     /**
-     * Zone's instrument
+     * The parent preset.
+     * @type {BasicPreset}
+     */
+    parentPreset;
+    
+    /**
+     * Zone's instrument.
      * @type {BasicInstrument}
      */
     instrument;
     
+    /**
+     * @param preset {BasicPreset}
+     */
+    constructor(preset)
+    {
+        super();
+        this.parentPreset = preset;
+    }
+    
     deleteZone()
     {
-        this.instrument.removeUseCount();
+        this.instrument.unlinkFrom(this.parentPreset);
     }
     
     /**
@@ -19,12 +34,18 @@ export class BasicPresetZone extends BasicZone
     setInstrument(instrument)
     {
         this.instrument = instrument;
-        this.instrument.addUseCount();
+        this.instrument.linkTo(this.parentPreset);
     }
     
-    
-    hasInstrument()
+    /**
+     * @param zone {BasicZone}
+     */
+    copyFrom(zone)
     {
-        return !!this.instrument;
+        super.copyFrom(zone);
+        if (zone instanceof BasicPresetZone)
+        {
+            this.instrument = zone.instrument;
+        }
     }
 }

package/src/soundfont/basic_soundfont/basic_sample.js

@@ -79,13 +79,12 @@ export class BasicSample
      * @type {Uint8Array}
      */
     compressedData = undefined;
-    
     /**
-     * The sample's use count
-     * @type {number}
+     * Sample's linked instruments (the instruments that use it)
+     * note that duplicates are allowed since one instrument can use the same sample multople times
+     * @type {BasicInstrument[]}
      */
-    useCount = 0;
-    
+    linkedInstruments = [];
     /**
      * The sample's audio data
      * @type {Float32Array}
@@ -126,6 +125,14 @@ export class BasicSample
         this.isCompressed = (sampleType & 0x10) > 0;
     }
     
+    /**
+     * The sample's use count
+     * @type {number}
+     */
+    get useCount()
+    {
+        return this.linkedInstruments.length;
+    }
     
     /**
      * @returns {Uint8Array|IndexedByteArray}
@@ -196,6 +203,27 @@ export class BasicSample
         
     }
     
+    /**
+     * @param instrument {BasicInstrument}
+     */
+    linkTo(instrument)
+    {
+        this.linkedInstruments.push(instrument);
+    }
+    
+    /**
+     * @param instrument {BasicInstrument}
+     */
+    unlinkFrom(instrument)
+    {
+        const index = this.linkedInstruments.indexOf(instrument);
+        if (index < 0)
+        {
+            throw new Error(`Cannot unlink ${instrument.instrumentName} from ${this.sampleName}: not linked.`);
+        }
+        this.linkedInstruments.splice(index, 1);
+    }
+    
     /**
      * @returns {Float32Array}
      */

package/src/soundfont/basic_soundfont/basic_soundbank.js

@@ -10,13 +10,11 @@ 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 { BasicPresetZone } from "./basic_preset_zone.js";
 import { Generator } from "./generator.js";
 import { BasicInstrument } from "./basic_instrument.js";
 import { BasicPreset } from "./basic_preset.js";
 import { isXGDrums } from "../../utils/xg_hacks.js";
 import { generatorTypes } from "./generator_types.js";
-import { BasicInstrumentZone } from "./basic_instrument_zone.js";
 import { BasicGlobalZone } from "./basic_global_zone.js";
 
 /**
@@ -168,26 +166,25 @@ class BasicSoundBank
             new Generator(generatorTypes.sampleModes, 1)
         );
         
-        const zone1 = new BasicInstrumentZone();
+        const inst = new BasicInstrument();
+        inst.instrumentName = "Saw Wave";
+        inst.globalZone = gZone;
+        
+        const zone1 = inst.createZone();
         zone1.setSample(sample);
         
-        const zone2 = new BasicInstrumentZone();
+        const zone2 = inst.createZone();
         zone2.setSample(sample);
         zone2.addGenerators(new Generator(generatorTypes.fineTune, -9));
         
-        
-        const inst = new BasicInstrument();
-        inst.instrumentName = "Saw Wave";
-        inst.globalZone = gZone;
-        inst.addZones(zone1, zone2);
         font.addInstruments(inst);
         
-        const pZone = new BasicPresetZone();
-        pZone.setInstrument(inst);
         
         const preset = new BasicPreset(font);
         preset.presetName = "Saw Wave";
-        preset.addZones(pZone);
+        const pZone = preset.createZone();
+        pZone.setInstrument(inst);
+        
         font.addPresets(preset);
         
         font.soundFontInfo["ifil"] = "2.1";
@@ -207,7 +204,14 @@ class BasicSoundBank
     
     flush()
     {
-        this.presets.sort((a, b) => (a.program - b.program) + (a.bank - b.bank));
+        this.presets.sort((a, b) =>
+        {
+            if (a.bank !== b.bank)
+            {
+                return a.bank - b.bank;
+            }
+            return a.program - b.program;
+        });
         this._parseInternal();
     }
     
@@ -443,7 +447,7 @@ class BasicSoundBank
         {
             if (i.useCount < 1)
             {
-                i.deleteZones();
+                i.deleteAllZones();
             }
         });
         this.instruments = this.instruments.filter(i => i.useCount > 0);
@@ -460,7 +464,7 @@ class BasicSoundBank
             throw new Error(`Cannot delete an instrument that has ${instrument.useCount} usages.`);
         }
         this.instruments.splice(this.instruments.indexOf(instrument), 1);
-        instrument.deleteZones();
+        instrument.deleteAllZones();
     }
     
     /**

package/src/soundfont/basic_soundfont/basic_zone.js

@@ -128,5 +128,16 @@ export class BasicZone
     {
         return this.generators.find(g => g.generatorType === generatorType)?.generatorValue ?? notFoundValue;
     }
+    
+    /**
+     * @param zone {BasicZone}
+     */
+    copyFrom(zone)
+    {
+        this.generators = [...zone.generators];
+        this.modulators = [...zone.modulators];
+        this.velRange = { ...zone.velRange };
+        this.keyRange = { ...zone.keyRange };
+    }
 }
 

package/src/soundfont/basic_soundfont/modulator.js

@@ -150,6 +150,7 @@ export class Modulator
      * @param destination {generatorTypes}
      * @param amount {number}
      * @param transformType {0|2}
+     * @param isEffectModulator {boolean}
      */
     constructor(sourceIndex,
                 sourceCurveType,
@@ -163,7 +164,8 @@ export class Modulator
                 secSrcDirection,
                 destination,
                 amount,
-                transformType)
+                transformType,
+                isEffectModulator = false)
     {
         this.sourcePolarity = sourcePolarity;
         this.sourceDirection = sourceDirection;
@@ -180,6 +182,7 @@ export class Modulator
         this.modulatorDestination = destination;
         this.transformAmount = amount;
         this.transformType = transformType;
+        this.isEffectModulator = isEffectModulator;
         
         
         if (this.modulatorDestination > MAX_GENERATOR)
@@ -208,7 +211,8 @@ export class Modulator
             modulator.secSrcDirection,
             modulator.modulatorDestination,
             modulator.transformAmount,
-            modulator.transformType
+            modulator.transformType,
+            modulator.isEffectModulator
         );
     }
     
@@ -322,7 +326,8 @@ export class Modulator
             this.secSrcDirection,
             this.modulatorDestination,
             this.transformAmount + modulator.transformAmount,
-            this.transformType
+            this.transformType,
+            this.isEffectModulator
         );
     }
 }

package/src/soundfont/basic_soundfont/write_dls/combine_zones.js

@@ -1,8 +1,7 @@
 import { Modulator } from "../modulator.js";
 import { Generator } from "../generator.js";
 import { generatorLimits, generatorTypes } from "../generator_types.js";
-import { BasicInstrumentZone } from "../basic_instrument_zone.js";
-import { BasicGlobalZone } from "../basic_global_zone.js";
+import { BasicInstrument } from "../basic_instrument.js";
 
 const notGlobalizedTypes = new Set([
     generatorTypes.velRange,
@@ -32,7 +31,7 @@ const notGlobalizedTypes = new Set([
  * Combines preset zones
  * @param preset {BasicPreset}
  * @param globalize {boolean}
- * @returns {{global: BasicGlobalZone, zones: BasicInstrumentZone[]}}
+ * @returns {BasicInstrument}
  */
 export function combineZones(preset, globalize = true)
 {
@@ -64,10 +63,7 @@ export function combineZones(preset, globalize = true)
         main.push(...adder.filter(m => !main.find(mm => Modulator.isIdentical(m, mm))));
     }
     
-    /**
-     * @type {BasicInstrumentZone[]}
-     */
-    const finalZones = [];
+    const outputInstrument = new BasicInstrument();
     
     /**
      * @type {Generator[]}
@@ -77,7 +73,6 @@ export function combineZones(preset, globalize = true)
      * @type {Modulator[]}
      */
     const globalPresetModulators = [];
-    
     // find the global zone and apply ranges, generators, and modulators
     const globalPresetZone = preset.globalZone;
     globalPresetGenerators.push(...globalPresetZone.generators);
@@ -209,7 +204,7 @@ export function combineZones(preset, globalize = true)
             );
             
             // create the zone and copy over values
-            const zone = new BasicInstrumentZone();
+            const zone = outputInstrument.createZone();
             zone.keyRange = instZoneKeyRange;
             zone.velRange = instZoneVelRange;
             if (zone.keyRange.min === 0 && zone.keyRange.max === 127)
@@ -221,12 +216,11 @@ export function combineZones(preset, globalize = true)
                 zone.velRange.min = -1;
             }
             zone.setSample(instZone.sample);
-            zone.generators = finalGenList;
-            zone.modulators = finalModList;
-            finalZones.push(zone);
+            zone.addGenerators(...finalGenList);
+            zone.addModulators(...finalModList);
         }
     }
-    const globalZone = new BasicGlobalZone();
+    const globalZone = outputInstrument.globalZone;
     if (globalize)
     {
         // create a global zone and add repeating generators to it
@@ -245,7 +239,7 @@ export function combineZones(preset, globalize = true)
             let occurencesForValues = {};
             const defaultForChecked = generatorLimits[checkedType]?.def || 0;
             occurencesForValues[defaultForChecked] = 0;
-            for (const z of finalZones)
+            for (const z of outputInstrument.instrumentZones)
             {
                 const gen = z.generators.find(g => g.generatorType === checkedType);
                 if (gen)
@@ -311,7 +305,7 @@ export function combineZones(preset, globalize = true)
                     globalZone.addGenerators(new Generator(checkedType, targetValue));
                 }
                 // remove from the zones
-                finalZones.forEach(z =>
+                outputInstrument.instrumentZones.forEach(z =>
                 {
                     const gen = z.generators.findIndex(g =>
                         g.generatorType === checkedType);
@@ -337,12 +331,12 @@ export function combineZones(preset, globalize = true)
         }
         
         // globalize only modulators that exist in all zones
-        const firstZone = finalZones[0];
+        const firstZone = outputInstrument.instrumentZones[0];
         const modulators = firstZone.modulators.map(m => Modulator.copy(m));
         for (const checkedModulator of modulators)
         {
             let existsForAllZones = true;
-            for (const zone of finalZones)
+            for (const zone of outputInstrument.instrumentZones)
             {
                 if (!existsForAllZones)
                 {
@@ -362,7 +356,7 @@ export function combineZones(preset, globalize = true)
             {
                 globalZone.addModulators(Modulator.copy(checkedModulator));
                 // delete it from local zones.
-                for (const zone of finalZones)
+                for (const zone of outputInstrument.instrumentZones)
                 {
                     const modulator = zone.modulators.find(m => Modulator.isIdentical(m, checkedModulator));
                     // Check if the amount is correct.
@@ -376,8 +370,5 @@ export function combineZones(preset, globalize = true)
             }
         }
     }
-    return {
-        zones: finalZones,
-        global: globalZone
-    };
+    return outputInstrument;
 }

package/src/soundfont/basic_soundfont/write_dls/ins.js

@@ -22,7 +22,9 @@ export function writeIns(preset)
         consoleColors.info
     );
     // combine preset and instrument zones into a single instrument zone (region) list
-    const { global, zones } = combineZones(preset);
+    const inst = combineZones(preset);
+    const global = inst.globalZone;
+    const zones = inst.instrumentZones;
     
     
     // insh: instrument header

package/src/soundfont/dls/dls_instrument.js

@@ -0,0 +1,20 @@
+import { BasicInstrument } from "../basic_soundfont/basic_instrument.js";
+import { DLSZone } from "./dls_zone.js";
+
+export class DLSInstrument extends BasicInstrument
+{
+    constructor()
+    {
+        super();
+    }
+    
+    /**
+     * @returns {DLSZone}
+     */
+    createZone()
+    {
+        const z = new DLSZone(this);
+        this.instrumentZones.push(z);
+        return z;
+    }
+}

package/src/soundfont/dls/dls_preset.js

@@ -1,9 +1,13 @@
 import { BasicPreset } from "../basic_soundfont/basic_preset.js";
-import { BasicPresetZone } from "../basic_soundfont/basic_preset_zone.js";
-import { BasicInstrument } from "../basic_soundfont/basic_instrument.js";
+import { DLSInstrument } from "./dls_instrument.js";
 
 export class DLSPreset extends BasicPreset
 {
+    /**
+     * @type {DLSInstrument}
+     */
+    dlsInstrument = new DLSInstrument();
+    
     /**
      * Creates a new DLS preset
      * @param dls {BasicSoundBank}
@@ -33,11 +37,7 @@ export class DLSPreset extends BasicPreset
             this.bank = 128;
         }
         
-        this.DLSInstrument = new BasicInstrument();
-        
-        const zone = new BasicPresetZone();
-        zone.setInstrument(this.DLSInstrument);
-        
-        this.presetZones = [zone];
+        const zone = this.createZone();
+        zone.setInstrument(this.dlsInstrument);
     }
 }

package/src/soundfont/dls/dls_zone.js

@@ -5,14 +5,11 @@ import { BasicInstrumentZone } from "../basic_soundfont/basic_instrument_zone.js
 export class DLSZone extends BasicInstrumentZone
 {
     /**
-     * @param keyRange {SoundFontRange}
-     * @param velRange {SoundFontRange}
+     * @param inst {BasicInstrument}
      */
-    constructor(keyRange, velRange)
+    constructor(inst)
     {
-        super();
-        this.keyRange = keyRange;
-        this.velRange = velRange;
+        super(inst);
     }
     
     /**
@@ -86,7 +83,7 @@ export class DLSZone extends BasicInstrumentZone
         {
             this.addGenerators(new Generator(generatorTypes.overridingRootKey, sampleKey));
         }
-        // add sample ID
+        // add sample
         this.setSample(sample);
     }
 }