spessasynth_core 4.2.3 → 4.2.5

package/dist/index.d.ts

@@ -531,12 +531,39 @@ declare const dataEntryStates: {
 };
 type DataEntryState = (typeof dataEntryStates)[keyof typeof dataEntryStates];
 declare const customControllers: {
+    /**
+     * Cents, RPN for fine-tuning
+     */
     readonly channelTuning: 0;
+    /**
+     * Cents, only the decimal tuning, (e.g., transpose is 4.5,
+     * Then shift by 4 keys + tune by 50 cents)
+     */
     readonly channelTransposeFine: 1;
+    /**
+     * The MIDI specification assumes the default modulation depth is 50 cents,
+     * but it may vary for different sound banks.
+     * For example, if you want a modulation depth of 100 cents,
+     * the multiplier will be 2,
+     * which, for a preset with a depth of 50,
+     * will create a total modulation depth of 100 cents.
+     */
     readonly modulationMultiplier: 2;
+    /**
+     * Cents, set by system exclusive
+     */
     readonly masterTuning: 3;
+    /**
+     * Semitones, for RPN coarse tuning
+     */
     readonly channelTuningSemitones: 4;
+    /**
+     * Key shift: for system exclusive
+     */
     readonly channelKeyShift: 5;
+    /**
+     * Sf2 NPRN LSB for selecting a generator value
+     */
     readonly sf2NPRNGeneratorLSB: 6;
 };
 type CustomController = (typeof customControllers)[keyof typeof customControllers];
@@ -1061,7 +1088,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 {
@@ -1373,6 +1400,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.
      */
@@ -1388,15 +1421,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.
@@ -1615,11 +1648,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
      */
@@ -2842,26 +2870,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.
      */
@@ -3575,7 +3611,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.
@@ -3584,7 +3620,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.