spessasynth_core 4.0.22 → 4.0.24

package/dist/index.d.ts

@@ -1177,7 +1177,8 @@ declare class SoundBankManager {
  */
 declare function killVoicesIntenral(this: SpessaSynthProcessor, amount: number): void;
 
-type TypedArray = Uint8Array | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array | Uint8ClampedArray | Float32Array | Float64Array;
+type SysExAcceptedArray = number[] | IndexedByteArray | Uint8Array | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array | Uint8ClampedArray | Float32Array | Float64Array;
+
 /**
  * Executes a system exclusive message for the synthesizer.
  * @param syx The system exclusive message as an array of bytes.
@@ -1186,7 +1187,7 @@ type TypedArray = Uint8Array | Int8Array | Uint16Array | Int16Array | Uint32Arra
  * This is a rather extensive method that handles various system exclusive messages,
  * including Roland GS, MIDI Tuning Standard, and other non-realtime messages.
  */
-declare function systemExclusiveInternal(this: SpessaSynthProcessor, syx: number[] | IndexedByteArray | TypedArray, channelOffset?: number): void;
+declare function systemExclusiveInternal(this: SpessaSynthProcessor, syx: SysExAcceptedArray, channelOffset?: number): void;
 
 declare const midiMessageTypes: {
     readonly noteOff: 128;
@@ -1482,10 +1483,9 @@ declare class ProtectedSynthValues {
     voiceKilling: (amount: number) => unknown;
     /**
      * Cached voices for all presets for this synthesizer.
-     * Nesting goes like this:
-     * this.cachedVoices[bankMSB][bankLSB][programNumber][midiNote][velocity] = a list of voices for that.
+     * Nesting is calculated in getCachedVoiceIndex, returns a list of voices for this note.
      */
-    cachedVoices: VoiceList[][][][][];
+    cachedVoices: VoiceList[];
     constructor(eventCallbackHandler: <K extends keyof SynthProcessorEventData>(eventType: K, eventData: SynthProcessorEventData[K]) => unknown, getVoices: (channel: number, midiNote: number, velocity: number, realKey: number) => VoiceList, voiceKillingFunction: (amount: number) => unknown, volumeEnvelopeSmoothingFactor: number, panSmoothingFactor: number, filterSmoothingFactor: number);
     /**
      * Copied callback so MIDI channels can call it.
@@ -1811,7 +1811,7 @@ declare class MIDIChannel {
  * This will reset all controllers to their default values,
  * except for the locked controllers.
  */
-declare function resetAllControllersInternal(this: SpessaSynthProcessor, log?: boolean): void;
+declare function resetAllControllersInternal(this: SpessaSynthProcessor, system?: SynthSystem): void;
 /**
  * Reset all controllers for channel.
  * This will reset all controllers to their default values,
@@ -2259,6 +2259,7 @@ declare class SpessaSynthProcessor {
     protected callEvent<K extends keyof SynthProcessorEventData>(eventName: K, eventData: SynthProcessorEventData[K]): void;
     protected getCachedVoice(patch: MIDIPatch, midiNote: number, velocity: number): VoiceList | undefined;
     protected setCachedVoice(patch: MIDIPatch, midiNote: number, velocity: number, voices: VoiceList): void;
+    private getCachedVoiceIndex;
     private createMIDIChannelInternal;
     private updatePresetList;
     private getDefaultPresets;
@@ -3217,6 +3218,13 @@ declare class BasicMIDI {
      * @returns The output data is a key-value pair: preset -> Set<"key-velocity">
      */
     getUsedProgramsAndKeys(soundbank: BasicSoundBank | SoundBankManager): Map<BasicPreset, Set<string>>;
+    /**
+     * Preloads all voices for this sequence in a given synth.
+     * This caches all the needed voices for playing back this sequencer, resulting in a smooth playback.
+     * The sequencer calls this function by default when loading the songs.
+     * @param synth
+     */
+    preloadSynth(synth: SpessaSynthProcessor): void;
     /**
      * Updates all internal values of the MIDI.
      * @param sortEvents if the events should be sorted by ticks. Recommended to be true.
@@ -4020,7 +4028,7 @@ declare class SpessaSynthSequencer {
      */
     protected stop(): void;
     /**
-     * @returns the index of the first to the current played time
+     * @returns The track number of the next closest event, based on eventIndexes.
      */
     protected findFirstEventIndex(): number;
     /**
@@ -4044,10 +4052,10 @@ declare class SpessaSynthSequencer {
     protected recalculateStartTime(time: number): void;
     /**
      * Jumps to a MIDI tick without any further processing.
-     * @param tick The MIDI tick to jump to.
+     * @param targetTicks The MIDI tick to jump to.
      * @protected
      */
-    protected jumpToTick(tick: number): void;
+    protected jumpToTick(targetTicks: number): void;
     protected sendMIDINoteOn(channel: number, midiNote: number, velocity: number): void;
     protected sendMIDINoteOff(channel: number, midiNote: number): void;
     protected sendMIDICC(channel: number, type: MIDIController, value: number): void;
@@ -4075,7 +4083,6 @@ declare const CONTROLLER_TABLE_SIZE = 147;
  */
 declare const defaultMIDIControllerValues: Int16Array<ArrayBuffer>;
 declare const setResetValue: (i: MIDIController, v: number) => number;
-declare const PORTAMENTO_CONTROL_UNSET = 1;
 declare const CUSTOM_CONTROLLER_TABLE_SIZE: number;
 declare const customResetArray: Float32Array<ArrayBuffer>;
 
@@ -4089,4 +4096,4 @@ declare class SoundBankLoader {
     private static loadDLS;
 }
 
-export { ALL_CHANNELS_OR_DIFFERENT_ACTION, BasicGlobalZone, BasicInstrument, BasicInstrumentZone, BasicMIDI, BasicPreset, BasicPresetZone, BasicSample, BasicSoundBank, BasicZone, CONTROLLER_TABLE_SIZE, CUSTOM_CONTROLLER_TABLE_SIZE, type ChannelPressureCallback, type ChannelProperty, type ChannelPropertyChangeCallback, ChannelSnapshot, type ControllerChangeCallback, type CustomController, DEFAULT_MASTER_PARAMETERS, DEFAULT_PERCUSSION, DEFAULT_WAV_WRITE_OPTIONS, type DLSChunkFourCC, type DLSDestination, type DLSInfoFourCC, type DLSLoop, type DLSLoopType, DLSLoopTypes, type DLSSource, type DLSTransform, type DLSWriteOptions, type DataEntryState, type DesiredChannelTranspose, type DesiredControllerChange, type DesiredProgramChange, type DrumChangeCallback, EmptySample, type FourCC, GENERATORS_AMOUNT, Generator, type GeneratorType, type GenericBankInfoFourCC, type GenericRIFFFourCC, type GenericRange, IndexedByteArray, type InterpolationType, KeyModifier, MAX_GENERATOR, MIDIBuilder, type MIDIController, type MIDIFormat, type MIDILoop, type MIDILoopType, MIDIMessage, type MIDIMessageType, type MIDIPatch, type MIDIPatchNamed, MIDIPatchTools, MIDITrack, type MTSNoteTuning, type MTSProgramTuning, type MasterParameterChangeCallback, type MasterParameterType, Modulator, type ModulatorCurveType, ModulatorSource, type ModulatorSourceEnum, type ModulatorSourceIndex, type ModulatorTransformType, type MuteChannelCallback, NON_CC_INDEX_OFFSET, type NoteOffCallback, type NoteOnCallback, type NoteTime, PORTAMENTO_CONTROL_UNSET, type PitchWheelCallback, type PolyPressureCallback, type PresetList, type PresetListEntry, type ProgramChangeCallback, type ProgressFunction, type RMIDIWriteOptions, type RMIDInfoData, type RMIDInfoFourCC, type SF2ChunkFourCC, type SF2InfoFourCC, type SF2VersionTag, type SampleEncodingFunction, type SampleLoopingMode, type SampleType, type SequencerEvent, type SequencerEventData, type SoundBankErrorCallback, type SoundBankInfoData, type SoundBankInfoFourCC, SoundBankLoader, type SoundBankManagerListEntry, type SoundFont2WriteOptions, SpessaSynthCoreUtils, SpessaSynthLogging, SpessaSynthProcessor, SpessaSynthSequencer, type StopAllCallback, type SynthMethodOptions, type SynthProcessorEvent, type SynthProcessorEventData, type SynthProcessorOptions, type SynthSystem, SynthesizerSnapshot, type TempoChange, type VoiceList, type VoiceSynthesisData, type WaveMetadata, type WaveWriteOptions, audioToWav, customControllers, customResetArray, dataEntryStates, defaultMIDIControllerValues, dlsDestinations, dlsSources, generatorLimits, generatorTypes, interpolationTypes, midiControllers, midiMessageTypes, modulatorCurveTypes, modulatorSources, modulatorTransformTypes, sampleTypes, setResetValue };
+export { ALL_CHANNELS_OR_DIFFERENT_ACTION, BasicGlobalZone, BasicInstrument, BasicInstrumentZone, BasicMIDI, BasicPreset, BasicPresetZone, BasicSample, BasicSoundBank, BasicZone, CONTROLLER_TABLE_SIZE, CUSTOM_CONTROLLER_TABLE_SIZE, type ChannelPressureCallback, type ChannelProperty, type ChannelPropertyChangeCallback, ChannelSnapshot, type ControllerChangeCallback, type CustomController, DEFAULT_MASTER_PARAMETERS, DEFAULT_PERCUSSION, DEFAULT_WAV_WRITE_OPTIONS, type DLSChunkFourCC, type DLSDestination, type DLSInfoFourCC, type DLSLoop, type DLSLoopType, DLSLoopTypes, type DLSSource, type DLSTransform, type DLSWriteOptions, type DataEntryState, type DesiredChannelTranspose, type DesiredControllerChange, type DesiredProgramChange, type DrumChangeCallback, EmptySample, type FourCC, GENERATORS_AMOUNT, Generator, type GeneratorType, type GenericBankInfoFourCC, type GenericRIFFFourCC, type GenericRange, IndexedByteArray, type InterpolationType, KeyModifier, MAX_GENERATOR, MIDIBuilder, type MIDIController, type MIDIFormat, type MIDILoop, type MIDILoopType, MIDIMessage, type MIDIMessageType, type MIDIPatch, type MIDIPatchNamed, MIDIPatchTools, MIDITrack, type MTSNoteTuning, type MTSProgramTuning, type MasterParameterChangeCallback, type MasterParameterType, Modulator, type ModulatorCurveType, ModulatorSource, type ModulatorSourceEnum, type ModulatorSourceIndex, type ModulatorTransformType, type MuteChannelCallback, NON_CC_INDEX_OFFSET, type NoteOffCallback, type NoteOnCallback, type NoteTime, type PitchWheelCallback, type PolyPressureCallback, type PresetList, type PresetListEntry, type ProgramChangeCallback, type ProgressFunction, type RMIDIWriteOptions, type RMIDInfoData, type RMIDInfoFourCC, type SF2ChunkFourCC, type SF2InfoFourCC, type SF2VersionTag, type SampleEncodingFunction, type SampleLoopingMode, type SampleType, type SequencerEvent, type SequencerEventData, type SoundBankErrorCallback, type SoundBankInfoData, type SoundBankInfoFourCC, SoundBankLoader, type SoundBankManagerListEntry, type SoundFont2WriteOptions, SpessaSynthCoreUtils, SpessaSynthLogging, SpessaSynthProcessor, SpessaSynthSequencer, type StopAllCallback, type SynthMethodOptions, type SynthProcessorEvent, type SynthProcessorEventData, type SynthProcessorOptions, type SynthSystem, SynthesizerSnapshot, type TempoChange, type VoiceList, type VoiceSynthesisData, type WaveMetadata, type WaveWriteOptions, audioToWav, customControllers, customResetArray, dataEntryStates, defaultMIDIControllerValues, dlsDestinations, dlsSources, generatorLimits, generatorTypes, interpolationTypes, midiControllers, midiMessageTypes, modulatorCurveTypes, modulatorSources, modulatorTransformTypes, sampleTypes, setResetValue };