spessasynth_lib 3.16.2 → 3.16.4

package/soundfont/{read → read_sf2}/instruments.js

@@ -1,14 +1,15 @@
-import {RiffChunk} from "./riff_chunk.js";
+import {RiffChunk} from "../basic_soundfont/riff_chunk.js";
 import {InstrumentZone} from "./zones.js";
 import {readBytesAsUintLittleEndian} from "../../utils/byte_functions/little_endian.js";
 import { readBytesAsString } from '../../utils/byte_functions/string.js'
+import { BasicInstrument } from '../basic_soundfont/basic_instrument.js'
 
 /**
  * instrument.js
  * purpose: parses soundfont instrument and stores them as a class
  */
 
-export class Instrument
+export class Instrument extends BasicInstrument
 {
     /**
      * Creates an instrument
@@ -16,70 +17,10 @@ export class Instrument
      */
     constructor(instrumentChunk)
     {
+        super();
         this.instrumentName = readBytesAsString(instrumentChunk.chunkData, 20).trim();
         this.instrumentZoneIndex = readBytesAsUintLittleEndian(instrumentChunk.chunkData, 2);
         this.instrumentZonesAmount = 0;
-        /**
-         * @type {InstrumentZone[]}
-         */
-        this.instrumentZones = [];
-        this._useCount = 0;
-    }
-
-    addUseCount()
-    {
-        this._useCount++;
-        this.instrumentZones.forEach(z => z.useCount++);
-    }
-
-    removeUseCount()
-    {
-        this._useCount--;
-        for(let i = 0; i < this.instrumentZones.length; i++)
-        {
-            if(this.safeDeleteZone(i))
-            {
-                i--;
-            }
-        }
-    }
-
-    /**
-     * @returns {number}
-     */
-    get useCount()
-    {
-        return this._useCount;
-    }
-
-    deleteInstrument()
-    {
-        this.instrumentZones.forEach(z => z.deleteZone());
-        this.instrumentZones.length = 0;
-    }
-
-    /**
-     * @param index {number}
-     * @returns {boolean} is the zone has been deleted
-     */
-    safeDeleteZone(index)
-    {
-        this.instrumentZones[index].useCount--;
-        if(this.instrumentZones[index].useCount < 1)
-        {
-            this.deleteZone(index);
-            return true;
-        }
-        return false;
-    }
-
-    /**
-     * @param index {number}
-     */
-    deleteZone(index)
-    {
-        this.instrumentZones[index].deleteZone();
-        this.instrumentZones.splice(index, 1);
     }
 
     /**

package/soundfont/{read → read_sf2}/modulators.js

@@ -63,7 +63,7 @@ export class Modulator{
 
         if(this.modulatorDestination > 58)
         {
-            this.modulatorDestination = -1; // flag as invalid (for linked ones)
+            this.modulatorDestination = generatorTypes.INVALID; // flag as invalid (for linked ones)
         }
 
         // decode the source

package/soundfont/read_sf2/presets.js

@@ -0,0 +1,78 @@
+import {RiffChunk} from "../basic_soundfont/riff_chunk.js";
+import {PresetZone} from "./zones.js";
+import {readBytesAsUintLittleEndian} from "../../utils/byte_functions/little_endian.js";
+import { readBytesAsString } from '../../utils/byte_functions/string.js'
+import { BasicPreset } from '../basic_soundfont/basic_preset.js'
+
+/**
+ * parses soundfont presets, also includes function for getting the generators and samples from midi note and velocity
+ */
+
+export class Preset extends BasicPreset
+{
+    /**
+     * Creates a preset
+     * @param presetChunk {RiffChunk}
+     */
+    constructor(presetChunk)
+    {
+        super();
+        this.presetName = readBytesAsString(presetChunk.chunkData, 20)
+            .trim()
+            .replace(/\d{3}:\d{3}/, ""); // remove those pesky "000:001"
+
+        this.program = readBytesAsUintLittleEndian(presetChunk.chunkData, 2);
+        this.bank = readBytesAsUintLittleEndian(presetChunk.chunkData, 2);
+        this.presetZoneStartIndex = readBytesAsUintLittleEndian(presetChunk.chunkData, 2);
+
+        // read the dwords
+        this.library = readBytesAsUintLittleEndian(presetChunk.chunkData, 4);
+        this.genre = readBytesAsUintLittleEndian(presetChunk.chunkData, 4);
+        this.morphology = readBytesAsUintLittleEndian(presetChunk.chunkData, 4);
+        this.presetZonesAmount = 0;
+    }
+
+    /**
+     * Loads all the preset zones, given the amount
+     * @param amount {number}
+     * @param zones {PresetZone[]}
+     */
+    getPresetZones(amount, zones)
+    {
+        this.presetZonesAmount = amount;
+        for (let i = this.presetZoneStartIndex; i < this.presetZonesAmount + this.presetZoneStartIndex; i++)
+        {
+            this.presetZones.push(zones[i]);
+        }
+    }
+}
+
+/**
+ * Reads the presets
+ * @param presetChunk {RiffChunk}
+ * @param presetZones {PresetZone[]}
+ * @returns {Preset[]}
+ */
+export function readPresets(presetChunk, presetZones)
+{
+    /**
+     * @type {Preset[]}
+     */
+    let presets = [];
+    while(presetChunk.chunkData.length > presetChunk.chunkData.currentIndex)
+    {
+        let preset = new Preset(presetChunk);
+        if(presets.length > 0)
+        {
+            let presetZonesAmount = preset.presetZoneStartIndex - presets[presets.length - 1].presetZoneStartIndex;
+            presets[presets.length - 1].getPresetZones(presetZonesAmount, presetZones);
+        }
+        presets.push(preset);
+    }
+    // remove EOP
+    if (presets.length > 1)
+    {
+        presets.pop();
+    }
+    return presets;
+}

package/soundfont/{read → read_sf2}/samples.js

@@ -1,143 +1,10 @@
-import {RiffChunk} from "./riff_chunk.js";
-import {IndexedByteArray} from "../../utils/indexed_array.js";
-import { readBytesAsUintLittleEndian, signedInt8} from "../../utils/byte_functions/little_endian.js";
+import { RiffChunk } from '../basic_soundfont/riff_chunk.js'
+import { IndexedByteArray } from '../../utils/indexed_array.js'
+import { readBytesAsUintLittleEndian, signedInt8 } from '../../utils/byte_functions/little_endian.js'
 import { stbvorbis } from '../../externals/stbvorbis_sync/stbvorbis_sync.min.js'
 import { SpessaSynthWarn } from '../../utils/loggin.js'
 import { readBytesAsString } from '../../utils/byte_functions/string.js'
-
-/**
- * samples.js
- * purpose: parses soundfont samples, resamples if needed.
- * loads sample data, handles async loading of sf3 compressed samples
- */
-
-export class BasicSample
-{
-    /**
-     * The basic representation of a soundfont sample
-     * @param sampleName {string}
-     * @param sampleRate {number}
-     * @param samplePitch {number}
-     * @param samplePitchCorrection {number}
-     * @param sampleLink {number}
-     * @param sampleType {number}
-     * @param loopStart {number} relative to sample start
-     * @param loopEnd {number} relative to sample start
-     */
-    constructor(
-        sampleName,
-        sampleRate,
-        samplePitch,
-        samplePitchCorrection,
-        sampleLink,
-        sampleType,
-        loopStart,
-        loopEnd
-    )
-    {
-        /**
-         * Sample's name
-         * @type {string}
-         */
-        this.sampleName = sampleName;
-        /**
-         * Sample rate in Hz
-         * @type {number}
-         */
-        this.sampleRate = sampleRate;
-        /**
-         * Original pitch of the sample as a MIDI note number
-         * @type {number}
-         */
-        this.samplePitch = samplePitch;
-        /**
-         * Pitch correction, in cents. Can be negative
-         * @type {number}
-         */
-        this.samplePitchCorrection = samplePitchCorrection;
-        /**
-         * Sample link, currently unused.
-         * @type {number}
-         */
-        this.sampleLink = sampleLink;
-        /**
-         * Type of the sample, an enum
-         * @type {number}
-         */
-        this.sampleType = sampleType;
-        /**
-         * Relative to start of the sample, bytes
-         * @type {number}
-         */
-        this.sampleLoopStartIndex = loopStart;
-        /**
-         * Relative to start of the sample, in bytes
-         * @type {number}
-         */
-        this.sampleLoopEndIndex = loopEnd;
-
-        /**
-         * Indicates if the sample is compressed
-         * @type {boolean}
-         */
-        this.isCompressed = (sampleType & 0x10) > 0;
-
-        /**
-         * The compressed sample data if it was compressed by spessasynth
-         * @type {Uint8Array}
-         */
-        this.compressedData = undefined;
-    }
-
-    /**
-     * @returns {Uint8Array|IndexedByteArray}
-     */
-    getRawData()
-    {
-        const e = new Error("Not implemented");
-        e.name = "NotImplementedError";
-        throw e;
-    }
-
-    /**
-     * @param quality {number}
-     * @param encodeVorbis {EncodeVorbisFunction}
-     */
-    compressSample(quality, encodeVorbis)
-    {
-        // no need to compress
-        if(this.isCompressed)
-        {
-            return;
-        }
-        // compress, always mono!
-        try
-        {
-            this.compressedData = encodeVorbis([this.getAudioData()], 1, this.sampleRate, quality);
-            // flag as compressed
-            this.sampleType |= 0x10;
-            this.isCompressed = true;
-        }
-        catch (e)
-        {
-            SpessaSynthWarn(`Failed to compress ${this.sampleName}. Leaving as uncompressed!`);
-            this.isCompressed = false;
-            this.compressedData = undefined;
-            this.sampleType &= -17;
-        }
-
-    }
-
-    /**
-     * @returns {Float32Array}
-     */
-    getAudioData()
-    {
-        const e = new Error("Not implemented");
-        e.name = "NotImplementedError";
-        throw e;
-    }
-}
+import { BasicSample } from '../basic_soundfont/basic_sample.js'
 
 export class LoadedSample extends BasicSample
 {
@@ -189,7 +56,6 @@ export class LoadedSample extends BasicSample
         this.sampleEndIndex = sampleEndIndex;
         this.isSampleLoaded = false;
         this.sampleID = sampleIndex;
-        this.useCount = 0;
         // in bytes
         this.sampleLength = this.sampleEndIndex - this.sampleStartIndex;
         this.sampleDataArray = smplArr;

package/soundfont/{read → read_sf2}/zones.js

@@ -1,52 +1,30 @@
 import {readBytesAsUintLittleEndian} from "../../utils/byte_functions/little_endian.js";
 import {IndexedByteArray} from "../../utils/indexed_array.js";
-import {RiffChunk} from "./riff_chunk.js";
+import {RiffChunk} from "../basic_soundfont/riff_chunk.js";
 import {Generator, generatorTypes} from "./generators.js";
-import {LoadedSample} from "./samples.js";
 import {Instrument} from "./instruments.js";
 import {Modulator} from "./modulators.js";
+import { BasicInstrumentZone, BasicPresetZone } from '../basic_soundfont/basic_zones.js'
 
 /**
  * zones.js
  * purpose: reads instrumend and preset zones from soundfont and gets their respective samples and generators and modulators
  */
 
-export class InstrumentZone {
+export class InstrumentZone extends BasicInstrumentZone
+{
     /**
      * Creates a zone (instrument)
      * @param dataArray {IndexedByteArray}
-     * @param index {number}
      */
-    constructor(dataArray, index)
+    constructor(dataArray)
     {
+        super();
         this.generatorZoneStartIndex = readBytesAsUintLittleEndian(dataArray, 2);
         this.modulatorZoneStartIndex = readBytesAsUintLittleEndian(dataArray, 2);
         this.modulatorZoneSize = 0;
         this.generatorZoneSize = 0;
-        this.zoneID = index;
-        this.keyRange = {min: 0, max: 127};
-        this.velRange = {min: 0, max: 127}
         this.isGlobal = true;
-        this.useCount = 0;
-
-        /**
-         * @type {Generator[]}
-         */
-        this.generators = [];
-        /**
-         * @type {Modulator[]}
-         */
-        this.modulators = [];
-    }
-
-    deleteZone()
-    {
-        this.useCount--;
-        if(this.isGlobal)
-        {
-            return;
-        }
-        this.sample.useCount--;
     }
 
     setZoneSize(modulatorZoneSize, generatorZoneSize)
@@ -81,7 +59,7 @@ export class InstrumentZone {
 
     /**
      * Loads the zone's sample
-     * @param samples {LoadedSample[]}
+     * @param samples {BasicSample[]}
      */
     getSample(samples)
     {
@@ -126,7 +104,7 @@ export class InstrumentZone {
  * @param zonesChunk {RiffChunk}
  * @param instrumentGenerators {Generator[]}
  * @param instrumentModulators {Modulator[]}
- * @param instrumentSamples {LoadedSample[]}
+ * @param instrumentSamples {BasicSample[]}
  * @returns {InstrumentZone[]}
  */
 export function readInstrumentZones(zonesChunk, instrumentGenerators, instrumentModulators, instrumentSamples)
@@ -135,10 +113,9 @@ export function readInstrumentZones(zonesChunk, instrumentGenerators, instrument
      * @type {InstrumentZone[]}
      */
     let zones = [];
-    let index = 0;
     while(zonesChunk.chunkData.length > zonesChunk.chunkData.currentIndex)
     {
-        let zone = new InstrumentZone(zonesChunk.chunkData, index);
+        let zone = new InstrumentZone(zonesChunk.chunkData);
         if(zones.length > 0)
         {
             let modulatorZoneSize = zone.modulatorZoneStartIndex - zones[zones.length - 1].modulatorZoneStartIndex;
@@ -151,7 +128,6 @@ export function readInstrumentZones(zonesChunk, instrumentGenerators, instrument
             zones[zones.length - 1].getVelRange();
         }
         zones.push(zone);
-        index++;
     }
     if(zones.length > 1)
     {
@@ -161,31 +137,20 @@ export function readInstrumentZones(zonesChunk, instrumentGenerators, instrument
     return zones;
 }
 
-export class
-PresetZone
+export class PresetZone extends BasicPresetZone
 {
     /**
      * Creates a zone (preset)
      * @param dataArray {IndexedByteArray}
-     * @param index {number}
      */
-    constructor(dataArray, index) {
+    constructor(dataArray)
+    {
+        super();
         this.generatorZoneStartIndex = readBytesAsUintLittleEndian(dataArray, 2);
         this.modulatorZoneStartIndex = readBytesAsUintLittleEndian(dataArray, 2);
         this.modulatorZoneSize = 0;
         this.generatorZoneSize = 0;
-        this.zoneID = index;
-        this.keyRange = {min: 0, max: 127};
-        this.velRange = {min: 0, max: 127}
         this.isGlobal = true;
-        /**
-         * @type {Generator[]}
-         */
-        this.generators = [];
-        /**
-         * @type {Modulator[]}
-         */
-        this.modulators = [];
     }
 
     setZoneSize(modulatorZoneSize, generatorZoneSize)
@@ -194,15 +159,6 @@ PresetZone
         this.generatorZoneSize = generatorZoneSize;
     }
 
-    deleteZone()
-    {
-        if(this.isGlobal)
-        {
-            return;
-        }
-        this.instrument.removeUseCount();
-    }
-
     /**
      * grab the generators
      * @param generators {Generator[]}
@@ -283,10 +239,9 @@ export function readPresetZones(zonesChunk, presetGenerators, presetModulators,
      * @type {PresetZone[]}
      */
     let zones = [];
-    let index = 0;
     while(zonesChunk.chunkData.length > zonesChunk.chunkData.currentIndex)
     {
-        let zone = new PresetZone(zonesChunk.chunkData, index);
+        let zone = new PresetZone(zonesChunk.chunkData);
         if(zones.length > 0)
         {
             let modulatorZoneSize = zone.modulatorZoneStartIndex - zones[zones.length - 1].modulatorZoneStartIndex;
@@ -299,7 +254,6 @@ export function readPresetZones(zonesChunk, presetGenerators, presetModulators,
             zones[zones.length - 1].getVelRange();
         }
         zones.push(zone);
-        index++;
     }
     if(zones.length > 1)
     {