spessasynth_core 4.2.4 → 4.2.6

package/dist/index.d.ts

@@ -135,8 +135,12 @@ declare const generatorTypes: Readonly<{
     readonly overridingRootKey: 58;
     readonly unused5: 59;
     readonly endOper: 60;
-    readonly vibLfoToVolume: 61;
-    readonly vibLfoToFilterFc: 62;
+    readonly amplitude: 61;
+    readonly vibLfoRate: 62;
+    readonly vibLfoAmplitudeDepth: 63;
+    readonly vibLfoToFilterFc: 64;
+    readonly modLfoRate: 65;
+    readonly modLfoAmplitudeDepth: 66;
 }>;
 type GeneratorType = (typeof generatorTypes)[keyof typeof generatorTypes];
 declare const GENERATORS_AMOUNT: number;
@@ -422,10 +426,9 @@ declare class VolumeEnvelope {
      * @param sampleCount the amount of samples to write
      * @param buffer the audio buffer to modify
      * @param gainTarget the gain target to smooth.
-     * @param centibelOffset the centibel offset to apply.
      * @returns if the voice is still active
      */
-    process(sampleCount: number, buffer: Float32Array, gainTarget: number, centibelOffset: number): boolean;
+    process(sampleCount: number, buffer: Float32Array, gainTarget: number): boolean;
     /**
      * Starts the release phase in the envelope.
      * @param voice the voice this envelope belongs to.
@@ -1088,7 +1091,7 @@ interface InsertionProcessorSnapshot {
      */
     channels: boolean[];
 }
-type InsertionProcessorConstructor = new (sampleRate: number) => InsertionProcessor;
+type InsertionProcessorConstructor = new (sampleRate: number, maxBufferSize: number) => InsertionProcessor;
 
 type SynthSystem = "gm" | "gm2" | "gs" | "xg";
 interface NoteOnCallback {
@@ -1400,6 +1403,12 @@ interface ChannelProperty {
     transposition: number;
 }
 interface SynthProcessorOptions {
+    /**
+     * The maximum buffer size the synthesizer can render at once.
+     * Attempting to `.process()` more samples than this will result in an error.
+     * Defaults to 128.
+     */
+    maxBufferSize: number;
     /**
      * Indicates if the event system is enabled. This can be changed later.
      */
@@ -1415,15 +1424,15 @@ interface SynthProcessorOptions {
     /**
      * Reverb processor for the synthesizer. Leave undefined to use the default.
      */
-    reverbProcessor: ReverbProcessor;
+    reverbProcessor?: ReverbProcessor;
     /**
      * Chorus processor for the synthesizer. Leave undefined to use the default.
      */
-    chorusProcessor: ChorusProcessor;
+    chorusProcessor?: ChorusProcessor;
     /**
      * Delay processor for the synthesizer. Leave undefined to use the default.
      */
-    delayProcessor: DelayProcessor;
+    delayProcessor?: DelayProcessor;
 }
 /**
  * The master parameters of the synthesizer.
@@ -1642,11 +1651,6 @@ declare class Voice {
      * Volume envelope.
      */
     readonly volEnv: VolumeEnvelope;
-    /**
-     * The buffer to use when rendering the voice (to avoid memory allocations)
-     * If the user supplied a larger one, it must be resized.
-     */
-    buffer: Float32Array<ArrayBuffer>;
     /**
      * Resonance offset, it is affected by the default resonant modulator
      */
@@ -1773,6 +1777,10 @@ declare class Voice {
      * Used for exclusive notes and killing notes.
      */
     overrideReleaseVolEnv: number;
+    vibLfoPhase: number;
+    vibLfoStartTime: number;
+    modLfoPhase: number;
+    modLfoStartTime: number;
     constructor(sampleRate: number);
     /**
      * Computes a given modulator
@@ -1960,7 +1968,7 @@ declare class Generator {
      * Constructs a new generator
      * @param type generator type
      * @param value generator value
-     * @param validate if the limits should be validated
+     * @param validate if the limits should be validated and clamped.
      */
     constructor(type: GeneratorType, value: number, validate?: boolean);
     write(genData: IndexedByteArray): void;
@@ -1998,18 +2006,34 @@ declare class BasicZone {
     set fineTuning(tuningCents: number);
     /**
      * Adds to a given generator, or its default value.
+     * @param type the generator type.
+     * @param value the value to add.
+     * @param validate if the value should be clamped to allowed limits.
      */
     addToGenerator(type: GeneratorType, value: number, validate?: boolean): void;
     /**
      * Sets a generator to a given value if preset, otherwise adds a new one.
+     * @param type the generator type.
+     * @param value the value to set. Set to null to remove this generator (set as "unset").
+     * @param validate if the value should be clamped to allowed limits.
      */
     setGenerator(type: GeneratorType, value: number | null, validate?: boolean): void;
     /**
      * Adds generators to the zone.
-     * @param generators
+     * @param generators the generators to add.
      */
     addGenerators(...generators: Generator[]): void;
+    /**
+     * Adds modulators to the zone.
+     * @param modulators the modulators to add.
+     */
     addModulators(...modulators: Modulator[]): void;
+    /**
+     * Gets a generator value.
+     * @param generatorType the generator type.
+     * @param notFoundValue if the generator is not found, this value is returned. A default value can be passed here, or null for example,
+     * to check if the generator is set.
+     */
     getGenerator<K>(generatorType: GeneratorType, notFoundValue: number | K): number | K;
     copyFrom(zone: BasicZone): void;
     /**
@@ -2784,7 +2808,11 @@ declare class DynamicModulatorSystem {
         mod: Modulator;
         id: string;
     }[];
+    active: boolean;
+    private readonly channelNumber;
+    constructor(channelNumber: number);
     resetModulators(): void;
+    setupReceiver(addr3: number, data: number, source: number, sourceName: string, bipolar?: boolean): void;
     /**
      * @param source Like in midiControllers: values below NON_CC_INDEX_OFFSET are CCs,
      * above are regular modulator sources.
@@ -2793,7 +2821,7 @@ declare class DynamicModulatorSystem {
      * @param isBipolar If true, the modulation is bipolar (ranges from -1 to 1 instead of from 0 to 1).
      * @param isNegative If true, the modulation is negative (goes from 1 to 0 instead of from 0 to 1).
      */
-    setModulator(source: ModulatorSourceEnum, destination: GeneratorType, amount: number, isBipolar?: boolean, isNegative?: boolean): void;
+    private setModulator;
     private getModulatorID;
     private deleteModulator;
 }
@@ -2869,26 +2897,34 @@ declare class SynthesizerCore {
      * All MIDI channels of the synthesizer.
      */
     readonly midiChannels: MIDIChannel[];
+    /**
+     * The maximum allowed buffer size to render.
+     */
+    readonly maxBufferSize: number;
+    /**
+     * The buffer to use when rendering a voice.
+     */
+    readonly voiceBuffer: Float32Array<ArrayBuffer>;
     /**
      * The insertion processor's left input buffer.
      */
-    insertionInputL: Float32Array<ArrayBuffer>;
+    readonly insertionInputL: Float32Array<ArrayBuffer>;
     /**
      * The insertion processor's right input buffer.
      */
-    insertionInputR: Float32Array<ArrayBuffer>;
+    readonly insertionInputR: Float32Array<ArrayBuffer>;
     /**
      * The reverb processor's input buffer.
      */
-    reverbInput: Float32Array<ArrayBuffer>;
+    readonly reverbInput: Float32Array<ArrayBuffer>;
     /**
      * The chorus processor's input buffer.
      */
-    chorusInput: Float32Array<ArrayBuffer>;
+    readonly chorusInput: Float32Array<ArrayBuffer>;
     /**
      * The delay processor's input buffer.
      */
-    delayInput: Float32Array<ArrayBuffer>;
+    readonly delayInput: Float32Array<ArrayBuffer>;
     /**
      * Delay is not used outside SC-88+ MIDIs, this is an optimization.
      */
@@ -3286,7 +3322,7 @@ declare class MIDIChannel {
     /**
      * A system for dynamic modulator assignment for advanced system exclusives.
      */
-    sysExModulators: DynamicModulatorSystem;
+    readonly sysExModulators: DynamicModulatorSystem;
     /**
      * The key shift of the channel (in semitones).
      */
@@ -3304,12 +3340,12 @@ declare class MIDIChannel {
      */
     insertionEnabled: boolean;
     /**
-     * CC1 for GS system exclusive.
+     * CC1 for GS controller matrix.
      * An arbitrary MIDI controller, which can be bound to any synthesis parameter.
      */
     cc1: number;
     /**
-     * CC2 for GS system exclusive.
+     * CC2 for GS controller matrix.
      * An arbitrary MIDI controller, which can be bound to any synthesis parameter.
      */
     cc2: number;
@@ -3602,7 +3638,7 @@ declare class SpessaSynthProcessor {
      */
     onEventCall?: (event: SynthProcessorEvent) => unknown;
     /**
-     * Renders float32 audio data to stereo outputs; buffer size of 128 is recommended.
+     * Renders float32 audio data to stereo outputs; buffer size must be equal or smaller than `maxBufferSize`
      * All float arrays must have the same length.
      * @param left the left output channel.
      * @param right the right output channel.
@@ -3611,7 +3647,7 @@ declare class SpessaSynthProcessor {
      */
     readonly process: (left: Float32Array, right: Float32Array, startIndex?: number, sampleCount?: number) => void;
     /**
-     * Renders float32 audio data to stereo outputs; buffer size of 128 is recommended.
+     * Renders float32 audio data to stereo outputs; buffer size must be equal or smaller than `maxBufferSize
      * All float arrays must have the same length.
      * @param outputs any number stereo pairs (L, R) to render channels separately into.
      * @param effectsLeft the left stereo effect output buffer.