spessasynth_core 4.3.9 → 4.3.11

package/dist/index.d.ts

@@ -737,42 +737,6 @@ declare class BasicPresetZone extends BasicZone {
   getWriteGenerators(bank: BasicSoundBank): Generator[];
 }
 //#endregion
-//#region src/soundbank/soundfont/write/types.d.ts
-/**
- * Returned structure containing extended SF2 chunks.
- */
-interface ExtendedSF2Chunks {
-  /**
-   * The PDTA part of the chunk.
-   */
-  pdta: IndexedByteArray;
-  /**
-   * The XDTA (https://github.com/spessasus/soundfont-proposals/blob/main/extended_limits.md) part of the chunk.
-   */
-  xdta: IndexedByteArray;
-}
-/**
- * Write indexes for tracking writing a SoundFont file.
- */
-interface SoundFontWriteIndexes {
-  /**
-   * Generator start index.
-   */
-  gen: number;
-  /**
-   * Modulator start index.
-   */
-  mod: number;
-  /**
-   * Zone start index.
-   */
-  bag: number;
-  /**
-   * Preset/instrument start index.
-   */
-  hdr: number;
-}
-//#endregion
 //#region src/soundbank/basic_soundbank/basic_preset.d.ts
 declare class BasicPreset implements MIDIPatchFull {
   /**
@@ -862,12 +826,6 @@ declare class BasicPreset implements MIDIPatchFull {
    * @returns The instrument containing the flattened zones. In theory, it should exactly the same as this preset.
    */
   toFlattenedInstrument(): BasicInstrument;
-  /**
-   * Writes the SF2 header
-   * @param phdrData
-   * @param index
-   */
-  write(phdrData: ExtendedSF2Chunks, index: number): void;
 }
 //#endregion
 //#region src/soundbank/basic_soundbank/basic_instrument.d.ts
@@ -926,7 +884,6 @@ declare class BasicInstrument {
    * to the global zone as possible to reduce clutter and the count of parameters.
    */
   globalize(): void;
-  write(instData: ExtendedSF2Chunks, index: number): void;
 }
 //#endregion
 //#region src/soundbank/basic_soundbank/basic_sample.d.ts
@@ -3335,6 +3292,29 @@ declare class ModulatorSource {
   getValue(channel: SF2Channel, pitchWheel: number, voice: Voice): number;
 }
 //#endregion
+//#region src/soundbank/soundfont/write/types.d.ts
+/**
+ * Write indexes for tracking writing a SoundFont file.
+ */
+interface SoundFontWriteIndexes {
+  /**
+   * Generator start index.
+   */
+  gen: number;
+  /**
+   * Modulator start index.
+   */
+  mod: number;
+  /**
+   * Zone start index.
+   */
+  bag: number;
+  /**
+   * Preset/instrument start index.
+   */
+  hdr: number;
+}
+//#endregion
 //#region src/soundbank/basic_soundbank/modulator.d.ts
 declare class Modulator {
   /**
@@ -3397,12 +3377,12 @@ declare class BasicSoundBank {
   static isSF3DecoderReady: Promise<boolean>;
   /**
    * The type of the sound bank that was loaded.
-   * Either `sf2` for SoundFont2/SoundFont3 or `dls` for DownLoadable Sounds.
+   * Either `sf2` for SoundFont2/SoundFont3 or `dls` for DownLoadable Sounds or `sfe` for SF-Enhanced.
    *
    * Please note that SF3 or SFOGG files are parsed as `sf2` files, but with compressed samples.
    * The type is still `sf2`.
    */
-  readonly type: "sf2" | "dls";
+  readonly type: "sf2" | "dls" | "sfe";
   /**
    * Sound bank's info.
    */
@@ -3427,7 +3407,7 @@ declare class BasicSoundBank {
    * If the sound bank has custom default modulators (DMOD).
    */
   customDefaultModulators: boolean;
-  constructor(type?: "sf2" | "dls");
+  constructor(type?: "sf2" | "sfe" | "dls");
   private _isXGBank;
   /**
    * Checks for XG drum sets and considers if this sound bank is XG.
@@ -3470,6 +3450,14 @@ declare class BasicSoundBank {
    * @returns the binary file data.
    */
   writeSF2(writeOptions?: Partial<SoundFont2WriteOptions>): ArrayBuffer;
+  /**
+   * Writes the sound bank as an [SFE 4](https://sfe-team-was-taken.github.io/SFE/) file.
+   * This enables features such as bank LSB and RIFF64.
+   * Note that spessasynth is currently the only software that can read these files.
+   * @param writeOptions the options for writing.
+   * @returns the binary file data.
+   */
+  writeSFE(writeOptions?: Partial<SFEWriteOptions>): ArrayBuffer;
   addPresets(...presets: BasicPreset[]): void;
   addInstruments(...instruments: BasicInstrument[]): void;
   addSamples(...samples: BasicSample[]): void;
@@ -3703,6 +3691,17 @@ interface SoundFont2WriteOptions extends SoundBankWriteOptions {
  * Options for writing a DLS file.
  */
 type DLSWriteOptions = SoundBankWriteOptions;
+/**
+ * Options for writing an SFE 4 file.
+ */
+interface SFEWriteOptions extends SoundBankWriteOptions {
+  /**
+   * If the RIFS (64-bit RIFF chunks) should be used.
+   * Increases maximum size from 4GB to effectively infinite.
+   * Recommended, since SFE 4 is effectively incompatible with SF2.
+   */
+  rf64: boolean;
+}
 interface GenericRange {
   min: number;
   max: number;
@@ -3729,7 +3728,7 @@ type PresetsWithKeyCombinations = Map<BasicPreset, Map<number, Set<number>>>;
 type MIDISystem = "gm" | "gm2" | "gs" | "xg";
 //#endregion
 //#region src/utils/riff_chunk.d.ts
-type GenericRIFFFourCC = "RIFF" | "LIST" | "INFO";
+type GenericRIFFFourCC = "RIFF" | "RIFS" | "LIST" | "INFO";
 type WAVFourCC = "wave" | "cue " | "fmt ";
 type FourCC = GenericRIFFFourCC | SoundBankInfoFourCC | SF2InfoFourCC | SF2ChunkFourCC | DLSInfoFourCC | DLSChunkFourCC | RMIDInfoFourCC | WAVFourCC;
 //#endregion
@@ -4224,7 +4223,7 @@ declare class BasicMIDI {
    * Do not call in audioWorkletGlobalScope as it uses TextDecoder.
    * RMIDI encoding overrides the provided encoding.
    */
-  getExtraMetadata(encoding?: string): any[];
+  getExtraMetadata(encoding?: string): string[];
   /**
    * Sets a given RMIDI info value.
    * @param infoType The type to set.
@@ -4867,5 +4866,5 @@ declare class SpessaSynthSequencer {
   protected sendMIDIPitchWheel(channel: number, pitch: number): void;
 }
 //#endregion
-export { BasicInstrument, BasicInstrumentZone, BasicMIDI, BasicPreset, BasicPresetZone, BasicSample, BasicSoundBank, BasicZone, CONTROLLER_TABLE_SIZE, CachedVoiceList, type ChannelMIDIParameter, ChannelMIDIParameterChange, type ChannelSystemParameter, ChorusProcessor, ChorusProcessorSnapshot, ControllerChangeCallback, DEFAULT_CHANNEL_MIDI_PARAMETERS, DEFAULT_CHANNEL_SYSTEM_PARAMETERS, DEFAULT_DRUM_REVERB, DEFAULT_GLOBAL_MIDI_PARAMETERS, DEFAULT_GLOBAL_SYSTEM_PARAMETERS, DEFAULT_MIDI_CONTROLLERS, DEFAULT_PERCUSSION, DEFAULT_SYNTH_MODE, DLSChunkFourCC, DLSInfoFourCC, DLSLoop, DLSWriteOptions, DelayProcessor, DelayProcessorSnapshot, EffectChangeCallback, EmptySample, type FourCC, GENERATORS_AMOUNT, Generator, GeneratorLimits, GeneratorType, GeneratorTypes, GenericBankInfoFourCC, type GenericRIFFFourCC, GenericRange, type GlobalMIDIParameter, GlobalMIDIParameterChangeCallback, type GlobalSystemParameter, IndexedByteArray, InsertionProcessor, InsertionProcessorConstructor, InsertionProcessorSnapshot, InterpolationType, InterpolationTypes, KeyModifier, MAX_GENERATOR, MIDIBuilder, MIDIChannel, MIDIController, MIDIControllers, MIDIFormat, MIDILoop, MIDILoopType, MIDIMessage, MIDIMessageType, MIDIMessageTypes, MIDIPatch, MIDIPatchFull, MIDIPatchTools, MIDISystem, MIDITrack, MIDIUtils, type ModifyMIDIOptions, Modulator, ModulatorControllerSource, ModulatorControllerSources, ModulatorCurveType, ModulatorCurveTypes, ModulatorSource, ModulatorSourceIndex, ModulatorTransformType, ModulatorTransformTypes, NonRegisteredLSB, NonRegisteredMSB, NoteOffCallback, NoteOnCallback, NoteTime, PolyPressureCallback, PresetsWithKeyCombinations, ProgramChangeCallback, ProgressFunction, RMIDIWriteOptions, RMIDInfoData, RMIDInfoFourCC, RegisteredParameterTypes, ReverbProcessor, ReverbProcessorSnapshot, SF2Channel, SF2ChunkFourCC, SF2InfoFourCC, SF2VersionTag, SPESSASYNTH_GAIN_FACTOR, SPESSA_BUFSIZE, SampleEncodingFunction, SampleLoopingMode, SampleType, SampleTypes, SequencerEvent, SequencerEventData, SetSampleFormatOptions, SoundBankInfoData, SoundBankInfoFourCC, SoundBankLoader, SoundBankManagerListEntry, SoundFont2WriteOptions, SpessaLog, SpessaSynthCoreUtils, SpessaSynthProcessor, SpessaSynthSequencer, StopAllCallback, SynthMethodOptions, SynthProcessorEvent, SynthProcessorEventData, SynthProcessorOptions, type SynthesizerSnapshot, SysExAcceptedArray, TempoChange, TimelineEvent, VOICE_CAP, VoiceParameters, WaveMetadata, WaveWriteOptions, audioToWav };
+export { BasicInstrument, BasicInstrumentZone, BasicMIDI, BasicPreset, BasicPresetZone, BasicSample, BasicSoundBank, BasicZone, CONTROLLER_TABLE_SIZE, CachedVoiceList, type ChannelMIDIParameter, ChannelMIDIParameterChange, type ChannelSystemParameter, ChorusProcessor, ChorusProcessorSnapshot, ControllerChangeCallback, DEFAULT_CHANNEL_MIDI_PARAMETERS, DEFAULT_CHANNEL_SYSTEM_PARAMETERS, DEFAULT_DRUM_REVERB, DEFAULT_GLOBAL_MIDI_PARAMETERS, DEFAULT_GLOBAL_SYSTEM_PARAMETERS, DEFAULT_MIDI_CONTROLLERS, DEFAULT_PERCUSSION, DEFAULT_SYNTH_MODE, DLSChunkFourCC, DLSInfoFourCC, DLSLoop, DLSWriteOptions, DelayProcessor, DelayProcessorSnapshot, EffectChangeCallback, EmptySample, type FourCC, GENERATORS_AMOUNT, Generator, GeneratorLimits, GeneratorType, GeneratorTypes, GenericBankInfoFourCC, type GenericRIFFFourCC, GenericRange, type GlobalMIDIParameter, GlobalMIDIParameterChangeCallback, type GlobalSystemParameter, IndexedByteArray, InsertionProcessor, InsertionProcessorConstructor, InsertionProcessorSnapshot, InterpolationType, InterpolationTypes, KeyModifier, MAX_GENERATOR, MIDIBuilder, MIDIChannel, MIDIController, MIDIControllers, MIDIFormat, MIDILoop, MIDILoopType, MIDIMessage, MIDIMessageType, MIDIMessageTypes, MIDIPatch, MIDIPatchFull, MIDIPatchTools, MIDISystem, MIDITrack, MIDIUtils, type ModifyMIDIOptions, Modulator, ModulatorControllerSource, ModulatorControllerSources, ModulatorCurveType, ModulatorCurveTypes, ModulatorSource, ModulatorSourceIndex, ModulatorTransformType, ModulatorTransformTypes, NonRegisteredLSB, NonRegisteredMSB, NoteOffCallback, NoteOnCallback, NoteTime, PolyPressureCallback, PresetsWithKeyCombinations, ProgramChangeCallback, ProgressFunction, RMIDIWriteOptions, RMIDInfoData, RMIDInfoFourCC, RegisteredParameterTypes, ReverbProcessor, ReverbProcessorSnapshot, SF2Channel, SF2ChunkFourCC, SF2InfoFourCC, SF2VersionTag, SFEWriteOptions, SPESSASYNTH_GAIN_FACTOR, SPESSA_BUFSIZE, SampleEncodingFunction, SampleLoopingMode, SampleType, SampleTypes, SequencerEvent, SequencerEventData, SetSampleFormatOptions, SoundBankInfoData, SoundBankInfoFourCC, SoundBankLoader, SoundBankManagerListEntry, SoundFont2WriteOptions, SpessaLog, SpessaSynthCoreUtils, SpessaSynthProcessor, SpessaSynthSequencer, StopAllCallback, SynthMethodOptions, SynthProcessorEvent, SynthProcessorEventData, SynthProcessorOptions, type SynthesizerSnapshot, SysExAcceptedArray, TempoChange, TimelineEvent, VOICE_CAP, VoiceParameters, WaveMetadata, WaveWriteOptions, audioToWav };
 //# sourceMappingURL=index.d.ts.map