spessasynth_lib 3.21.14 → 3.22.2

package/@types/soundfont/basic_soundfont/basic_soundfont.d.ts

@@ -81,6 +81,10 @@ export class BasicSoundFont {
      * @returns {BasicPreset}
      */
     getPresetByName(presetName: string): BasicPreset;
+    /**
+     * @param error {string}
+     */
+    parsingError(error: string): void;
     write: typeof write;
 }
 import { Modulator } from "./modulator.js";

package/@types/synthetizer/key_modifier_manager.d.ts

@@ -0,0 +1,42 @@
+export class KeyModifierManager {
+    /**
+     * @param synth {Synthetizer}
+     */
+    constructor(synth: Synthetizer);
+    synth: Synthetizer;
+    /**
+     * @private
+     * @param type {workletKeyModifierMessageType}
+     * @param data {any}
+     */
+    private _sendToWorklet;
+    /**
+     * Modifies a single key
+     * @param channel {number} the channel affected. Usually 0-15
+     * @param midiNote {number} the MIDI note to change. 0-127
+     * @param options {{
+     *     velocity: number|undefined,
+     *     patch: {
+     *         bank: number,
+     *         program: number
+     *     }|undefined
+     * }} the key's modifiers
+     */
+    addModifier(channel: number, midiNote: number, options: {
+        velocity: number | undefined;
+        patch: {
+            bank: number;
+            program: number;
+        } | undefined;
+    }): void;
+    /**
+     * Deletes a key modifier
+     * @param channel {number} the channel affected. Usually 0-15
+     * @param midiNote {number} the MIDI note to change. 0-127
+     */
+    deleteModifier(channel: number, midiNote: number): void;
+    /**
+     * Clears ALL Modifiers
+     */
+    clearModifiers(): void;
+}

package/@types/synthetizer/synthetizer.d.ts

@@ -82,6 +82,11 @@ export class Synthetizer {
      * @type {SoundfontManager}
      */
     soundfontManager: SoundfontManager;
+    /**
+     * The synth's key modifier manager
+     * @type {KeyModifierManager}
+     */
+    keyModifierManager: KeyModifierManager;
     /**
      * @type {function(SynthesizerSnapshot)}
      * @private
@@ -343,4 +348,5 @@ export type StartRenderingDataConfig = {
 };
 import { EventHandler } from "./synth_event_handler.js";
 import { SoundfontManager } from "./synth_soundfont_manager.js";
+import { KeyModifierManager } from "./key_modifier_manager.js";
 import { FancyChorus } from "./audio_effects/fancy_chorus.js";

package/@types/synthetizer/worklet_system/message_protocol/worklet_message.d.ts

@@ -29,6 +29,7 @@ export namespace workletMessageType {
     let sequencerSpecific: number;
     let requestSynthesizerSnapshot: number;
     let setLogLevel: number;
+    let keyModifierManager: number;
 }
 export type masterParameterType = number;
 export namespace masterParameterType {
@@ -63,6 +64,9 @@ export type WorkletMessage = {
     } | boolean | ArrayBuffer | {
         messageType: WorkletSequencerMessageType;
         messageData: any;
+    } | {
+        messageType: workletKeyModifierMessageType;
+        messageData: any;
     });
 };
 export type WorkletReturnMessage = {

package/@types/synthetizer/worklet_system/worklet_methods/worklet_key_modifier.d.ts

@@ -0,0 +1,69 @@
+export class KeyModifier {
+    /**
+     * @param velocity {number}
+     * @param bank {number}
+     * @param program {number}
+     */
+    constructor(velocity?: number, bank?: number, program?: number);
+    /**
+     * The new override velocity. -1 means unchanged
+     * @type {number}
+     */
+    velocity: number;
+    /**
+     * The patch this key uses. -1 on either means default
+     * @type {{bank: number, program: number}}
+     */
+    patch: {
+        bank: number;
+        program: number;
+    };
+}
+export type workletKeyModifierMessageType = number;
+export namespace workletKeyModifierMessageType {
+    let addMapping: number;
+    let deleteMapping: number;
+    let clearMappings: number;
+}
+export class WorkletKeyModifierManager {
+    /**
+     * The velocity override mappings for MIDI keys
+     * @type {KeyModifier[][]}
+     * @private
+     */
+    private _keyMappings;
+    /**
+     * @param type {workletKeyModifierMessageType}
+     * @param data {any}
+     */
+    handleMessage(type: workletKeyModifierMessageType, data: any): void;
+    /**
+     * @param channel {number}
+     * @param midiNote {number}
+     * @param mapping {KeyModifier}
+     */
+    addMapping(channel: number, midiNote: number, mapping: KeyModifier): void;
+    deleteMapping(channel: any, midiNote: any): void;
+    clearMappings(): void;
+    /**
+     * @param channel {number}
+     * @param midiNote {number}
+     * @returns {number} velocity, -1 if unchanged
+     */
+    getVelocity(channel: number, midiNote: number): number;
+    /**
+     * @param channel {number}
+     * @param midiNote {number}
+     * @returns {boolean}
+     */
+    hasOverridePatch(channel: number, midiNote: number): boolean;
+    /**
+     * @param channel {number}
+     * @param midiNote {number}
+     * @returns {{bank: number, program: number}} -1 if unchanged
+     */
+    getPatch(channel: number, midiNote: number): {
+        bank: number;
+        program: number;
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spessasynth_lib",
-  "version": "3.21.14",
+  "version": "3.22.2",
   "description": "MIDI and SoundFont2/DLS library with no compromises",
   "browser": "index.js",
   "types": "@types/index.d.ts",

package/sequencer/sequencer.js

@@ -459,7 +459,7 @@ export class Sequencer
                 }
                 else
                 {
-                    throw new Error(messageData);
+                    throw new Error("Sequencer error: " + messageData);
                 }
                 return;
             

package/sequencer/worklet_sequencer/song_control.js

@@ -49,7 +49,7 @@ export function loadNewSequence(parsedMidi, autoPlay = true)
     this.stop();
     if (!parsedMidi.tracks)
     {
-        throw "No tracks supplied!";
+        throw new Error("This MIDI has no tracks!");
     }
     
     this.oneTickToSeconds = 60 / (120 * parsedMidi.timeDivision);

package/soundfont/basic_soundfont/basic_soundfont.js

@@ -225,6 +225,14 @@ class BasicSoundFont
         }
         return preset;
     }
+    
+    /**
+     * @param error {string}
+     */
+    parsingError(error)
+    {
+        throw new Error(`SF parsing error: ${error} The file may be corrupted.`);
+    }
 }
 
 BasicSoundFont.prototype.write = write;

package/soundfont/basic_soundfont/write_sf2/write.js

@@ -123,7 +123,7 @@ export function write(options = DEFAULT_WRITE_OPTIONS)
         smplStartOffsets,
         smplEndOffsets,
         options?.compress,
-        options?.compressionQuality || 0.5,
+        options?.compressionQuality ?? 0.5,
         options.compressionFunction
     );
     

package/soundfont/dls/articulator_converter.js

@@ -71,7 +71,7 @@ function getSF2SourceFromDLS(source)
     }
     if (sourceEnum === undefined)
     {
-        throw `not known?? ${source}`;
+        throw new Error(`Unknown DLS Source: ${source}`);
     }
     return { enum: sourceEnum, isCC: isCC };
 }

package/soundfont/dls/dls_sample.js

@@ -58,7 +58,7 @@ export class DLSSample extends BasicSample
         {
             if (!this.compressedData)
             {
-                throw new Error("Compressed but no data??");
+                throw new Error("Compressed but no data?? This shouldn't happen!!");
             }
             return this.compressedData;
         }

package/soundfont/dls/dls_soundfont.js

@@ -25,7 +25,7 @@ class DLSSoundFont extends BasicSoundFont
         if (!this.dataArray)
         {
             SpessaSynthGroupEnd();
-            throw new TypeError("No data!");
+            this.parsingError("No data provided!");
         }
         
         // read the main chunk
@@ -85,7 +85,7 @@ class DLSSoundFont extends BasicSoundFont
         if (!colhChunk)
         {
             SpessaSynthGroupEnd();
-            throw new Error("No colh chunk!");
+            this.parsingError("No colh chunk!");
         }
         this.instrumentAmount = readLittleEndian(colhChunk.chunkData, 4);
         SpessaSynthInfo(
@@ -96,6 +96,11 @@ class DLSSoundFont extends BasicSoundFont
         
         // read wave list
         let waveListChunk = findRIFFListType(chunks, "wvpl");
+        if (!waveListChunk)
+        {
+            SpessaSynthGroupEnd();
+            this.parsingError("No wvpl chunk!");
+        }
         this.readDLSSamples(waveListChunk);
         
         // read instrument list
@@ -103,7 +108,7 @@ class DLSSoundFont extends BasicSoundFont
         if (!instrumentListChunk)
         {
             SpessaSynthGroupEnd();
-            throw new Error("No lins chunk!");
+            this.parsingError("No lins chunk!");
         }
         this.readDLSInstrumentList(instrumentListChunk);
         
@@ -135,7 +140,7 @@ class DLSSoundFont extends BasicSoundFont
         if (chunk.header.toLowerCase() !== expected.toLowerCase())
         {
             SpessaSynthGroupEnd();
-            throw new SyntaxError(`Invalid DLS chunk header! Expected "${expected.toLowerCase()}" got "${chunk.header.toLowerCase()}"`);
+            this.parsingError(`Invalid DLS chunk header! Expected "${expected.toLowerCase()}" got "${chunk.header.toLowerCase()}"`);
         }
     }
     
@@ -148,9 +153,17 @@ class DLSSoundFont extends BasicSoundFont
         if (text.toLowerCase() !== expected.toLowerCase())
         {
             SpessaSynthGroupEnd();
-            throw new SyntaxError(`Invalid DLS soundfont! Expected "${expected.toLowerCase()}" got "${text.toLowerCase()}"`);
+            this.parsingError(`FourCC error: Expected "${expected.toLowerCase()}" got "${text.toLowerCase()}"`);
         }
     }
+    
+    /**
+     * @param error {string}
+     */
+    parsingError(error)
+    {
+        throw new Error(`DLS parse error: ${error} The file may be corrupted.`);
+    }
 }
 
 DLSSoundFont.prototype.readDLSInstrumentList = readDLSInstrumentList;

package/soundfont/dls/read_instrument.js

@@ -85,7 +85,7 @@ export function readDLSInstrument(chunk)
         if (type !== "rgn " && type !== "rgn2")
         {
             SpessaSynthGroupEnd();
-            throw new SyntaxError(`Invalid DLS region! Expected "rgn " or "rgn2" got "${type}"`);
+            this.parsingError(`Invalid DLS region! Expected "rgn " or "rgn2" got "${type}"`);
         }
         
         

package/soundfont/dls/read_samples.js

@@ -80,7 +80,7 @@ export function readDLSSamples(waveListChunk)
         const dataChunk = waveChunks.find(c => c.header === "data");
         if (!dataChunk)
         {
-            throw new Error("No data chunk in the wave chunk!");
+            this.parsingError("No data chunk in the WAVE chunk!");
         }
         const sampleLength = dataChunk.size / bytesPerSample;
         const sampleData = new Float32Array(sampleLength);

package/soundfont/read_sf2/samples.js

@@ -113,11 +113,18 @@ export class LoadedSample extends BasicSample
         const buff = smplArr.slice(this.sampleStartIndex / 2 + smplStart, this.sampleEndIndex / 2 + smplStart);
         // reset array and being decoding
         this.sampleData = new Float32Array(0);
-        /**
-         * @type {{data: Float32Array[], error: (string|null), sampleRate: number, eof: boolean}}
-         */
-        const vorbis = stbvorbis.decode(buff.buffer);
-        this.sampleData = vorbis.data[0];
+        try
+        {
+            /**
+             * @type {{data: Float32Array[], error: (string|null), sampleRate: number, eof: boolean}}
+             */
+            const vorbis = stbvorbis.decode(buff.buffer);
+            this.sampleData = vorbis.data[0];
+        }
+        catch (e)
+        {
+            throw new Error(`Ogg Vorbis decode error: ${e}`);
+        }
     }
     
     /**

package/soundfont/read_sf2/soundfont.js

@@ -39,7 +39,7 @@ export class SoundFont2 extends BasicSoundFont
         if (!this.dataArray)
         {
             SpessaSynthGroupEnd();
-            throw new TypeError("No data!");
+            this.parsingError("No data provided!");
         }
         
         // read the main read
@@ -280,7 +280,7 @@ export class SoundFont2 extends BasicSoundFont
         if (chunk.header.toLowerCase() !== expected.toLowerCase())
         {
             SpessaSynthGroupEnd();
-            throw new SyntaxError(`Invalid chunk header! Expected "${expected.toLowerCase()}" got "${chunk.header.toLowerCase()}"`);
+            this.parsingError(`Invalid chunk header! Expected "${expected.toLowerCase()}" got "${chunk.header.toLowerCase()}"`);
         }
     }
     
@@ -293,7 +293,7 @@ export class SoundFont2 extends BasicSoundFont
         if (text.toLowerCase() !== expected.toLowerCase())
         {
             SpessaSynthGroupEnd();
-            throw new SyntaxError(`Invalid soundFont! Expected "${expected.toLowerCase()}" got "${text.toLowerCase()}"`);
+            this.parsingError(`Invalid FourCC: Expected "${expected.toLowerCase()}" got "${text.toLowerCase()}"\``);
         }
     }
 }

package/synthetizer/key_modifier_manager.js

@@ -0,0 +1,73 @@
+import { workletMessageType } from "./worklet_system/message_protocol/worklet_message.js";
+import { KeyModifier, workletKeyModifierMessageType } from "./worklet_system/worklet_methods/worklet_key_modifier.js";
+
+export class KeyModifierManager
+{
+    /**
+     * @param synth {Synthetizer}
+     */
+    constructor(synth)
+    {
+        this.synth = synth;
+    }
+    
+    /**
+     * @private
+     * @param type {workletKeyModifierMessageType}
+     * @param data {any}
+     */
+    _sendToWorklet(type, data)
+    {
+        this.synth.post({
+            messageType: workletMessageType.keyModifierManager,
+            messageData: [
+                type,
+                data
+            ]
+        });
+    }
+    
+    /**
+     * Modifies a single key
+     * @param channel {number} the channel affected. Usually 0-15
+     * @param midiNote {number} the MIDI note to change. 0-127
+     * @param options {{
+     *     velocity: number|undefined,
+     *     patch: {
+     *         bank: number,
+     *         program: number
+     *     }|undefined
+     * }} the key's modifiers
+     */
+    addModifier(channel, midiNote, options)
+    {
+        const velocity = options?.velocity || -1;
+        const program = options?.patch?.program ?? -1;
+        const bank = options?.patch?.bank ?? -1;
+        this._sendToWorklet(
+            workletKeyModifierMessageType.addMapping,
+            [channel, midiNote, new KeyModifier(velocity, bank, program)]
+        );
+    }
+    
+    /**
+     * Deletes a key modifier
+     * @param channel {number} the channel affected. Usually 0-15
+     * @param midiNote {number} the MIDI note to change. 0-127
+     */
+    deleteModifier(channel, midiNote)
+    {
+        this._sendToWorklet(
+            workletKeyModifierMessageType.deleteMapping,
+            [channel, midiNote]
+        );
+    }
+    
+    /**
+     * Clears ALL Modifiers
+     */
+    clearModifiers()
+    {
+        this._sendToWorklet(workletKeyModifierMessageType.clearMappings, undefined);
+    }
+}

package/synthetizer/synthetizer.js

@@ -14,6 +14,7 @@ import { SpessaSynthInfo, SpessaSynthWarn } from "../utils/loggin.js";
 import { DEFAULT_EFFECTS_CONFIG } from "./audio_effects/effects_config.js";
 import { SoundfontManager } from "./synth_soundfont_manager.js";
 import { channelConfiguration } from "./worklet_system/worklet_utilities/worklet_processor_channel.js";
+import { KeyModifierManager } from "./key_modifier_manager.js";
 
 
 /**
@@ -183,6 +184,12 @@ export class Synthetizer
          */
         this.soundfontManager = new SoundfontManager(this);
         
+        /**
+         * The synth's key modifier manager
+         * @type {KeyModifierManager}
+         */
+        this.keyModifierManager = new KeyModifierManager(this);
+        
         /**
          * @type {function(SynthesizerSnapshot)}
          * @private