spessasynth_core 3.26.17 → 3.26.19

package/index.js

@@ -18,12 +18,12 @@ import {
 import { SynthesizerSnapshot } from "./src/synthetizer/audio_engine/snapshot/synthesizer_snapshot.js";
 import { ChannelSnapshot } from "./src/synthetizer/audio_engine/snapshot/channel_snapshot.js";
 
-import { BasicSoundBank } from "./src/soundfont/basic_soundfont/basic_soundfont.js";
+import { BasicSoundBank } from "./src/soundfont/basic_soundfont/basic_soundbank.js";
 import { BasicSample } from "./src/soundfont/basic_soundfont/basic_sample.js";
-import { BasicInstrumentZone, BasicPresetZone } from "./src/soundfont/basic_soundfont/basic_zones.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";
-import { Generator, generatorTypes } from "./src/soundfont/basic_soundfont/generator.js";
+import { Generator } from "./src/soundfont/basic_soundfont/generator.js";
 import { Modulator, modulatorCurveTypes, modulatorSources } from "./src/soundfont/basic_soundfont/modulator.js";
 import { loadSoundFont } from "./src/soundfont/load_soundfont.js";
 
@@ -51,6 +51,8 @@ import { consoleColors } from "./src/utils/other.js";
 import { inflateSync } from "./src/externals/fflate/fflate.min.js";
 import { DLSDestinations } from "./src/soundfont/dls/dls_destinations.js";
 import { DLSSources } from "./src/soundfont/dls/dls_sources.js";
+import { generatorTypes } from "./src/soundfont/basic_soundfont/generator_types.js";
+import { BasicInstrumentZone } from "./src/soundfont/basic_soundfont/basic_instrument_zone.js";
 // you shouldn't use these...
 const SpessaSynthCoreUtils = {
     consoleColors,

package/package.json

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

package/src/externals/README.md

@@ -0,0 +1,6 @@
+## This is the external dependencies' folder.
+
+The code here contains third-party libraries used by SpessaSynth.
+
+- `stbvorbis_sync` - Vorbis audio decoder for SF3 soundfonts
+- `fflate` - Used for decompressing XMF files. It is also used to compress the reverb buffer in spessasynth_lib

package/src/sequencer/README.md

@@ -2,4 +2,8 @@
 
 The code here is responsible for playing back the parsed MIDI sequence with the synthesizer.
 
-- `sequencer_engine` - the core sequencer engine
+- `sequencer_engine.js` - the core sequencer engine
+- `play.js` - handles playback control and timing
+- `song_control.js` - manages song state and control
+- `process_event.js` - processes MIDI events during playback
+- `process_tick.js` - processes a single MIDI tick (think of it like a rendering quantum of the sequencer)

package/src/soundfont/README.md

@@ -1,13 +1,11 @@
-## This is the SoundFont2 parsing library.
+## This is the SoundFont and DLS parsing library.
 
-The code here is responsible for parsing the SoundFont2 file and
+The code here is responsible for parsing the SoundFont2/DLS file and
 providing an easy way to get the data out.
-Default modulators are also stored here (in `modulators.js`)
 
-`basic_soundfont` folder contains the classes that represent the soundfont file.
+- `basic_soundfont` folder contains the classes that represent a sound bank file. 
+It also contains the code for writing the files.
 
-`read_sf2` folder contains the code for reading an `.sf2` file.
+- `read_sf2` folder contains the code for reading a `.sf2` file.
 
-`write` folder contains the code for writing out an `.sf2` file.
-
-`dls` folder contains the code for reading a `.dls` file (and converting in into a soundfont representation).
+- `dls` folder contains the code for reading a `.dls` file (and converting in into a soundfont representation).

package/src/soundfont/basic_soundfont/basic_global_zone.js

@@ -0,0 +1,16 @@
+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];
+    }
+}

package/src/soundfont/basic_soundfont/basic_instrument.js

@@ -1,3 +1,5 @@
+import { BasicGlobalZone } from "./basic_global_zone.js";
+
 export class BasicInstrument
 {
     /**
@@ -9,9 +11,16 @@ export class BasicInstrument
     /**
      * The instrument's zones
      * @type {BasicInstrumentZone[]}
+     * @readonly
      */
     instrumentZones = [];
     
+    /**
+     * Instrument's global zone
+     * @type {BasicGlobalZone}
+     */
+    globalZone = new BasicGlobalZone();
+    
     /**
      * Instrument's use count, used for trimming
      * @type {number}
@@ -27,6 +36,15 @@ export class BasicInstrument
         return this._useCount;
     }
     
+    /**
+     * @param zones {BasicInstrumentZone}
+     */
+    addZones(...zones)
+    {
+        zones.forEach(z => z.useCount++);
+        this.instrumentZones.push(...zones);
+    }
+    
     addUseCount()
     {
         this._useCount++;
@@ -36,16 +54,10 @@ export class BasicInstrument
     removeUseCount()
     {
         this._useCount--;
-        for (let i = 0; i < this.instrumentZones.length; i++)
-        {
-            if (this.safeDeleteZone(i))
-            {
-                i--;
-            }
-        }
+        this.instrumentZones.forEach(z => z.useCount--);
     }
     
-    deleteInstrument()
+    deleteZones()
     {
         this.instrumentZones.forEach(z => z.deleteZone());
         this.instrumentZones.length = 0;
@@ -53,25 +65,17 @@ export class BasicInstrument
     
     /**
      * @param index {number}
-     * @returns {boolean} is the zone has been deleted
+     * @returns {boolean} if deleted
      */
-    safeDeleteZone(index)
+    deleteZone(index)
     {
-        this.instrumentZones[index].useCount--;
-        if (this.instrumentZones[index].useCount < 1)
+        const zone = this.instrumentZones[index];
+        if (zone.useCount < 1)
         {
-            this.deleteZone(index);
+            zone.deleteZone();
+            this.instrumentZones.splice(index, 1);
             return true;
         }
         return false;
     }
-    
-    /**
-     * @param index {number}
-     */
-    deleteZone(index)
-    {
-        this.instrumentZones[index].deleteZone();
-        this.instrumentZones.splice(index, 1);
-    }
 }

package/src/soundfont/basic_soundfont/basic_instrument_zone.js

@@ -0,0 +1,35 @@
+import { BasicZone } from "./basic_zone.js";
+
+export class BasicInstrumentZone extends BasicZone
+{
+    /**
+     * Zone's sample.
+     * @type {BasicSample}
+     */
+    sample;
+    
+    /**
+     * For tracking on the individual zone level, since multiple presets can refer to the same instrument
+     * @type {number}
+     */
+    useCount = 0;
+    
+    /**
+     * @param sample {BasicSample}
+     */
+    setSample(sample)
+    {
+        this.sample = sample;
+        this.sample.useCount++;
+    }
+    
+    deleteZone()
+    {
+        this.sample.useCount--;
+    }
+    
+    hasSample()
+    {
+        return !!this.sample;
+    }
+}

package/src/soundfont/basic_soundfont/basic_preset.js

@@ -4,13 +4,13 @@
  *  presetGenerators: Generator[],
  *  modulators: Modulator[],
  *  sample: BasicSample,
- *  sampleID: number,
  * }} SampleAndGenerators
  */
-import { generatorTypes } from "./generator.js";
 import { Modulator } from "./modulator.js";
 import { isXGDrums } from "../../utils/xg_hacks.js";
 
+import { BasicGlobalZone } from "./basic_global_zone.js";
+
 export class BasicPreset
 {
     /**
@@ -44,6 +44,12 @@ export class BasicPreset
      */
     presetZones = [];
     
+    /**
+     * Preset's global zone
+     * @type {BasicGlobalZone}
+     */
+    globalZone = new BasicGlobalZone();
+    
     /**
      * unused metadata
      * @type {number}
@@ -69,6 +75,14 @@ export class BasicPreset
         this.parentSoundBank = parentSoundBank;
     }
     
+    /**
+     * @param zones {BasicPresetZone}
+     */
+    addZones(...zones)
+    {
+        this.presetZones.push(...zones);
+    }
+    
     /**
      * @param allowXG {boolean}
      * @param allowSFX {boolean}
@@ -171,62 +185,60 @@ export class BasicPreset
          * global zone is always first, so it or nothing
          * @type {Generator[]}
          */
-        let globalPresetGenerators = this.presetZones[0].isGlobal ? [...this.presetZones[0].generators] : [];
+        let globalPresetGenerators = [...this.globalZone.generators];
         
         /**
          * @type {Modulator[]}
          */
-        let globalPresetModulators = this.presetZones[0].isGlobal ? [...this.presetZones[0].modulators] : [];
-        const globalKeyRange = this.presetZones[0].isGlobal ? this.presetZones[0].keyRange : { min: 0, max: 127 };
-        const globalVelRange = this.presetZones[0].isGlobal ? this.presetZones[0].velRange : { min: 0, max: 127 };
+        let globalPresetModulators = [...this.globalZone.modulators];
+        const globalKeyRange = this.globalZone.keyRange;
+        const globalVelRange = this.globalZone.velRange;
         
         // find the preset zones in range
         let presetZonesInRange = this.presetZones.filter(currentZone =>
-            (
-                isInRange(
-                    currentZone.hasKeyRange ? currentZone.keyRange : globalKeyRange,
-                    midiNote
-                )
-                &&
-                isInRange(
-                    currentZone.hasVelRange ? currentZone.velRange : globalVelRange,
-                    velocity
-                )
-            ) && !currentZone.isGlobal);
+            isInRange(
+                currentZone.hasKeyRange ? currentZone.keyRange : globalKeyRange,
+                midiNote
+            )
+            &&
+            isInRange(
+                currentZone.hasVelRange ? currentZone.velRange : globalVelRange,
+                velocity
+            )
+        );
         
-        presetZonesInRange.forEach(zone =>
+        presetZonesInRange.forEach(presetZone =>
         {
+            const instrument = presetZone.instrument;
             // the global zone is already taken into account earlier
-            if (zone.instrument.instrumentZones.length < 1)
+            if (instrument.instrumentZones.length < 1)
             {
                 return;
             }
-            let presetGenerators = zone.generators;
-            let presetModulators = zone.modulators;
-            const firstZone = zone.instrument.instrumentZones[0];
+            let presetGenerators = presetZone.generators;
+            let presetModulators = presetZone.modulators;
             /**
              * global zone is always first, so it or nothing
              * @type {Generator[]}
              */
-            let globalInstrumentGenerators = firstZone.isGlobal ? [...firstZone.generators] : [];
-            let globalInstrumentModulators = firstZone.isGlobal ? [...firstZone.modulators] : [];
-            const globalKeyRange = firstZone.isGlobal ? firstZone.keyRange : { min: 0, max: 127 };
-            const globalVelRange = firstZone.isGlobal ? firstZone.velRange : { min: 0, max: 127 };
+            let globalInstrumentGenerators = [...instrument.globalZone.generators];
+            let globalInstrumentModulators = [...instrument.globalZone.modulators];
+            const globalKeyRange = instrument.globalZone.keyRange;
+            const globalVelRange = instrument.globalZone.velRange;
             
             
-            let instrumentZonesInRange = zone.instrument.instrumentZones
+            let instrumentZonesInRange = instrument.instrumentZones
                 .filter(currentZone =>
-                    (
-                        isInRange(
-                            currentZone.hasKeyRange ? currentZone.keyRange : globalKeyRange,
-                            midiNote
-                        )
-                        &&
-                        isInRange(
-                            currentZone.hasVelRange ? currentZone.velRange : globalVelRange,
-                            velocity
-                        )
-                    ) && !currentZone.isGlobal
+                    
+                    isInRange(
+                        currentZone.hasKeyRange ? currentZone.keyRange : globalKeyRange,
+                        midiNote
+                    )
+                    &&
+                    isInRange(
+                        currentZone.hasVelRange ? currentZone.velRange : globalVelRange,
+                        velocity
+                    )
                 );
             
             instrumentZonesInRange.forEach(instrumentZone =>
@@ -275,7 +287,8 @@ export class BasicPreset
                     if (identicalInstrumentModulator !== -1)
                     {
                         // sum the amounts
-                        // (this makes a new modulator because otherwise it would overwrite the one in the soundfont!
+                        // this makes a new modulator
+                        // because otherwise it would overwrite the one in the soundfont!
                         finalModulatorList[identicalInstrumentModulator] = finalModulatorList[identicalInstrumentModulator].sumTransform(
                             mod);
                     }
@@ -291,9 +304,7 @@ export class BasicPreset
                     instrumentGenerators: instrumentGenerators,
                     presetGenerators: presetGenerators,
                     modulators: finalModulatorList,
-                    sample: instrumentZone.sample,
-                    sampleID: instrumentZone.generators.find(
-                        g => g.generatorType === generatorTypes.sampleID).generatorValue
+                    sample: instrumentZone.sample
                 });
             });
         });

package/src/soundfont/basic_soundfont/basic_preset_zone.js

@@ -0,0 +1,30 @@
+import { BasicZone } from "./basic_zone.js";
+
+export class BasicPresetZone extends BasicZone
+{
+    /**
+     * Zone's instrument
+     * @type {BasicInstrument}
+     */
+    instrument;
+    
+    deleteZone()
+    {
+        this.instrument.removeUseCount();
+    }
+    
+    /**
+     * @param instrument {BasicInstrument}
+     */
+    setInstrument(instrument)
+    {
+        this.instrument = instrument;
+        this.instrument.addUseCount();
+    }
+    
+    
+    hasInstrument()
+    {
+        return !!this.instrument;
+    }
+}

package/src/soundfont/basic_soundfont/{basic_soundfont.js → basic_soundbank.js}

@@ -10,15 +10,20 @@ 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 { BasicInstrumentZone, BasicPresetZone } from "./basic_zones.js";
-import { Generator, generatorTypes } from "./generator.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";
 
+/**
+ * Represents a single sound bank, be it DLS or SF2.
+ */
 class BasicSoundBank
 {
-    
     /**
      * Soundfont's info stored as name: value. ifil and iver are stored as string representation of float (e.g., 2.1)
      * @type {Object<string, string|IndexedByteArray>}
@@ -62,15 +67,47 @@ class BasicSoundBank
     isXGBank = false;
     
     /**
-     * Creates a new basic soundfont template
+     * Creates a new basic soundfont template (or copies)
      * @param data {undefined|{presets: BasicPreset[], info: Object<string, string>}}
      */
     constructor(data = undefined)
     {
         if (data?.presets)
         {
-            this.presets.push(...data.presets);
             this.soundFontInfo = data.info;
+            this.addPresets(...data.presets);
+            /**
+             * @type {BasicInstrument[]}
+             */
+            const instrumentList = [];
+            for (const preset of data.presets)
+            {
+                for (const zone of preset.presetZones)
+                {
+                    if (!instrumentList.includes(zone.instrument))
+                    {
+                        instrumentList.push(zone.instrument);
+                    }
+                }
+            }
+            this.addInstruments(...instrumentList);
+            
+            /**
+             * @type {BasicSample[]}
+             */
+            const sampleList = [];
+            
+            for (const instrument of instrumentList)
+            {
+                for (const zone of instrument.instrumentZones)
+                {
+                    if (!sampleList.includes(zone.sample))
+                    {
+                        sampleList.push(zone.sample);
+                    }
+                }
+            }
+            this.addSamples(...sampleList);
         }
     }
     
@@ -122,44 +159,74 @@ class BasicSoundBank
         {
             sample.sampleData[i] = (i / 128) * 2 - 1;
         }
-        font.samples.push(sample);
+        font.addSamples(sample);
         
-        const gZone = new BasicInstrumentZone();
-        gZone.isGlobal = true;
-        gZone.generators.push(new Generator(generatorTypes.initialAttenuation, 375));
-        gZone.generators.push(new Generator(generatorTypes.releaseVolEnv, -1000));
-        gZone.generators.push(new Generator(generatorTypes.sampleModes, 1));
+        const gZone = new BasicGlobalZone();
+        gZone.addGenerators(
+            new Generator(generatorTypes.initialAttenuation, 375),
+            new Generator(generatorTypes.releaseVolEnv, -1000),
+            new Generator(generatorTypes.sampleModes, 1)
+        );
         
         const zone1 = new BasicInstrumentZone();
-        zone1.sample = sample;
+        zone1.setSample(sample);
         
         const zone2 = new BasicInstrumentZone();
-        zone2.sample = sample;
-        zone2.generators.push(new Generator(generatorTypes.fineTune, -9));
+        zone2.setSample(sample);
+        zone2.addGenerators(new Generator(generatorTypes.fineTune, -9));
         
         
         const inst = new BasicInstrument();
         inst.instrumentName = "Saw Wave";
-        inst.instrumentZones.push(gZone);
-        inst.instrumentZones.push(zone1);
-        inst.instrumentZones.push(zone2);
-        font.instruments.push(inst);
+        inst.globalZone = gZone;
+        inst.addZones(zone1, zone2);
+        font.addInstruments(inst);
         
         const pZone = new BasicPresetZone();
-        pZone.instrument = inst;
+        pZone.setInstrument(inst);
         
         const preset = new BasicPreset(font);
         preset.presetName = "Saw Wave";
-        preset.presetZones.push(pZone);
-        font.presets.push(preset);
+        preset.addZones(pZone);
+        font.addPresets(preset);
         
         font.soundFontInfo["ifil"] = "2.1";
         font.soundFontInfo["isng"] = "EMU8000";
         font.soundFontInfo["INAM"] = "Dummy";
-        font._parseInternal();
+        font.flush();
         return font.write().buffer;
     }
     
+    /**
+     * @param preset {BasicPreset}
+     */
+    addPresets(...preset)
+    {
+        this.presets.push(...preset);
+    }
+    
+    flush()
+    {
+        this.presets.sort((a, b) => (a.program - b.program) + (a.bank - b.bank));
+        this._parseInternal();
+    }
+    
+    /**
+     * @param instrument {BasicInstrument}
+     */
+    addInstruments(...instrument)
+    {
+        this.instruments.push(...instrument);
+    }
+    
+    /**
+     * @param sample {BasicSample}
+     */
+    addSamples(...sample)
+    {
+        this.samples.push(...sample);
+    }
+    
     /**
      * parses the bank after loading is done
      * @protected
@@ -209,7 +276,7 @@ class BasicSoundBank
         const soundfont = this;
         
         /**
-         * @param instrument {Instrument}
+         * @param instrument {BasicInstrument}
          * @param combos {{key: number, velocity: number}[]}
          * @returns {number}
          */
@@ -219,10 +286,6 @@ class BasicSoundBank
             for (let iZoneIndex = 0; iZoneIndex < instrument.instrumentZones.length; iZoneIndex++)
             {
                 const iZone = instrument.instrumentZones[iZoneIndex];
-                if (iZone.isGlobal)
-                {
-                    continue;
-                }
                 const iKeyRange = iZone.keyRange;
                 const iVelRange = iZone.velRange;
                 let isIZoneUsed = false;
@@ -240,14 +303,13 @@ class BasicSoundBank
                 if (!isIZoneUsed)
                 {
                     SpessaSynthInfo(
-                        `%c${iZone.sample.sampleName} %cremoved from %c${instrument.instrumentName}%c. Use count: %c${iZone.useCount - 1}`,
+                        `%c${iZone.sample.sampleName} %cremoved from %c${instrument.instrumentName}%c.`,
                         consoleColors.recognized,
                         consoleColors.info,
                         consoleColors.recognized,
-                        consoleColors.info,
-                        consoleColors.recognized
+                        consoleColors.info
                     );
-                    if (instrument.safeDeleteZone(iZoneIndex))
+                    if (instrument.deleteZone(iZoneIndex))
                     {
                         trimmedIZones++;
                         iZoneIndex--;
@@ -293,6 +355,7 @@ class BasicSoundBank
                     consoleColors.info
                 );
                 soundfont.deletePreset(p);
+                soundfont.removeUnusedElements();
                 presetIndex--;
             }
             else
@@ -316,10 +379,6 @@ class BasicSoundBank
                 for (let zoneIndex = 0; zoneIndex < p.presetZones.length; zoneIndex++)
                 {
                     const zone = p.presetZones[zoneIndex];
-                    if (zone.isGlobal)
-                    {
-                        continue;
-                    }
                     const keyRange = zone.keyRange;
                     const velRange = zone.velRange;
                     // check if any of the combos matches the zone
@@ -384,13 +443,7 @@ class BasicSoundBank
         {
             if (i.useCount < 1)
             {
-                i.instrumentZones.forEach(z =>
-                {
-                    if (!z.isGlobal)
-                    {
-                        z.sample.useCount--;
-                    }
-                });
+                i.deleteZones();
             }
         });
         this.instruments = this.instruments.filter(i => i.useCount > 0);
@@ -407,8 +460,7 @@ class BasicSoundBank
             throw new Error(`Cannot delete an instrument that has ${instrument.useCount} usages.`);
         }
         this.instruments.splice(this.instruments.indexOf(instrument), 1);
-        instrument.deleteInstrument();
-        this.removeUnusedElements();
+        instrument.deleteZones();
     }
     
     /**
@@ -418,7 +470,6 @@ class BasicSoundBank
     {
         preset.deletePreset();
         this.presets.splice(this.presets.indexOf(preset), 1);
-        this.removeUnusedElements();
     }
     
     /**
@@ -431,7 +482,6 @@ class BasicSoundBank
             throw new Error(`Cannot delete sample that has ${sample.useCount} usages.`);
         }
         this.samples.splice(this.samples.indexOf(sample), 1);
-        this.removeUnusedElements();
     }
     
     /**
@@ -563,15 +613,6 @@ class BasicSoundBank
         delete this.instruments;
         delete this.samples;
     }
-    
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * Clears the cache for all the presets
-     */
-    clearCache()
-    {
-        this.presets.forEach(p => p.clearCache());
-    }
 }
 
 BasicSoundBank.prototype.write = write;