spessasynth_lib 3.22.1 → 3.22.3

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,77 @@
+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 mappings {KeyModifier[][]}
+     */
+    setMappings(mappings: KeyModifier[][]): void;
+    /**
+     * @returns {KeyModifier[][]}
+     */
+    getMappings(): KeyModifier[][];
+    /**
+     * @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.22.1",
+  "version": "3.22.3",
   "description": "MIDI and SoundFont2/DLS library with no compromises",
   "browser": "index.js",
   "types": "@types/index.d.ts",

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/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