spessasynth_lib 3.23.6 → 3.23.8

package/@types/midi_parser/basic_midi.d.ts

@@ -7,17 +7,24 @@
 export function MIDIticksToSeconds(ticks: number, mid: BasicMIDI): number;
 export class BasicMIDI {
     /**
-     * The time division of the sequence
+     * Copies a MIDI
+     * @param mid {BasicMIDI}
+     * @returns {BasicMIDI}
+     */
+    static copyFrom(mid: BasicMIDI): BasicMIDI;
+    /**
+     * The time division of the sequence, representing the number of ticks per beat.
      * @type {number}
      */
     timeDivision: number;
     /**
-     * The duration of the sequence, in seconds
+     * The duration of the sequence, in seconds.
      * @type {number}
      */
     duration: number;
     /**
-     * The tempo changes in the sequence, ordered from last to first
+     * The tempo changes in the sequence, ordered from the last change to the first.
+     * Each change is represented by an object with a tick position and a tempo value in beats per minute.
      * @type {{ticks: number, tempo: number}[]}
      */
     tempoChanges: {
@@ -25,27 +32,27 @@ export class BasicMIDI {
         tempo: number;
     }[];
     /**
-     * Contains the copyright strings
+     * A string containing the copyright information for the MIDI sequence if detected.
      * @type {string}
      */
     copyright: string;
     /**
-     * The amount of tracks in the sequence
+     * The number of tracks in the MIDI sequence.
      * @type {number}
      */
     tracksAmount: number;
     /**
-     * The lyrics of the sequence as binary chunks
+     * An array containing the lyrics of the sequence, stored as binary chunks (Uint8Array).
      * @type {Uint8Array[]}
      */
     lyrics: Uint8Array[];
     /**
-     * First note on of the MIDI file
+     * The tick position of the first note-on event in the MIDI sequence.
      * @type {number}
      */
     firstNoteOn: number;
     /**
-     * The MIDI's key range
+     * The MIDI key range used in the sequence, represented by a minimum and maximum note value.
      * @type {{min: number, max: number}}
      */
     keyRange: {
@@ -53,27 +60,27 @@ export class BasicMIDI {
         max: number;
     };
     /**
-     * The last voice (note on, off, cc change etc.) event tick
+     * The tick position of the last voice event (such as note-on, note-off, or control change) in the sequence.
      * @type {number}
      */
     lastVoiceEventTick: number;
     /**
-     * Midi port numbers for each track
+     * An array of MIDI port numbers used by each track in the sequence.
      * @type {number[]}
      */
     midiPorts: number[];
     /**
-     * Channel offsets for each port, using the SpessaSynth method
+     * An array of channel offsets for each MIDI port, using the SpessaSynth method.
      * @type {number[]}
      */
     midiPortChannelOffsets: number[];
     /**
-     * All channels that each track uses
+     * A list of sets, where each set contains the MIDI channels used by each track in the sequence.
      * @type {Set<number>[]}
      */
     usedChannelsOnTrack: Set<number>[];
     /**
-     * The loop points (in ticks) of the sequence
+     * The loop points (in ticks) of the sequence, including both start and end points.
      * @type {{start: number, end: number}}
      */
     loop: {
@@ -81,45 +88,58 @@ export class BasicMIDI {
         end: number;
     };
     /**
-     * The sequence's name
+     * The name of the MIDI sequence.
      * @type {string}
      */
     midiName: string;
     /**
-     * The file name of the sequence, if provided in the MIDI class
+     * A boolean indicating if the sequence's name is the same as the file name.
+     * @type {boolean}
+     */
+    midiNameUsesFileName: boolean;
+    /**
+     * The file name of the MIDI sequence, if provided during parsing.
      * @type {string}
      */
     fileName: string;
     /**
-     * The raw, encoded MIDI name.
+     * The raw, encoded MIDI name, represented as a Uint8Array.
+     * Useful when the MIDI file uses a different code page.
      * @type {Uint8Array}
      */
     rawMidiName: Uint8Array;
     /**
-     * The MIDI's embedded soundfont
+     * The embedded soundfont in the MIDI file, represented as an ArrayBuffer, if available.
      * @type {ArrayBuffer|undefined}
      */
     embeddedSoundFont: ArrayBuffer | undefined;
     /**
-     * The MIDI file's format
+     * The format of the MIDI file, which can be 0, 1, or 2, indicating the type of the MIDI file.
      * @type {number}
      */
     format: number;
     /**
-     * The RMID Info data if RMID, otherwise undefined
+     * The RMID (Resource Interchangeable MIDI) info data, if the file is RMID formatted.
+     * Otherwise, this field is undefined.
+     * Chunk type (e.g. "INAM"): Chunk data as binary array.
      * @type {Object<string, IndexedByteArray>}
      */
     RMIDInfo: {
         [x: string]: IndexedByteArray;
     };
     /**
-     * The bank offset for RMIDI
+     * The bank offset used for RMID files.
      * @type {number}
      */
     bankOffset: number;
     /**
-     * The actual track data of the MIDI file
+     * The actual track data of the MIDI file, represented as an array of tracks.
+     * Tracks are arrays of MidiMessage objects.
      * @type {MidiMessage[][]}
      */
     tracks: MidiMessage[][];
+    /**
+     * Updates all internal values
+     */
+    flush(): void;
 }

package/@types/midi_parser/midi_builder.d.ts

@@ -6,10 +6,6 @@ export class MIDIBuilder extends BasicMIDI {
      */
     constructor(name: string, timeDivision?: number, initialTempo?: number);
     encoder: TextEncoder;
-    /**
-     * Updates all internal values
-     */
-    flush(): void;
     /**
      * Adds a new "set tempo" message
      * @param ticks {number} the tick number of the event

package/@types/midi_parser/midi_data.d.ts

@@ -4,21 +4,23 @@
  */
 export class MidiData {
     /**
-     * @param midi {BasicMIDI}
+     * Constructor that copies data from a BasicMIDI instance, except for tracks and embeddedSoundFont.
+     * @param {BasicMIDI} midi - The BasicMIDI instance to copy data from.
      */
     constructor(midi: BasicMIDI);
     /**
-     * The time division of the sequence
+     * The time division of the sequence, representing the number of ticks per beat.
      * @type {number}
      */
     timeDivision: number;
     /**
-     * The duration of the sequence, in seconds
+     * The duration of the sequence, in seconds.
      * @type {number}
      */
     duration: number;
     /**
-     * The tempo changes in the sequence, ordered from last to first
+     * The tempo changes in the sequence, ordered from the last change to the first.
+     * Each change is represented by an object with a tick position and a tempo value in beats per minute.
      * @type {{ticks: number, tempo: number}[]}
      */
     tempoChanges: {
@@ -26,23 +28,27 @@ export class MidiData {
         tempo: number;
     }[];
     /**
-     * Contains the copyright strings
+     * A string containing the copyright information for the MIDI sequence.
      * @type {string}
      */
     copyright: string;
     /**
-     * The amount of tracks in the sequence
+     * The number of tracks in the MIDI sequence.
      * @type {number}
      */
     tracksAmount: number;
     /**
-     * The lyrics of the sequence as binary chunks
+     * An array containing the lyrics of the sequence, stored as binary chunks (Uint8Array).
      * @type {Uint8Array[]}
      */
     lyrics: Uint8Array[];
-    firstNoteOn: any;
     /**
-     * The MIDI's key range
+     * The tick position of the first note-on event in the MIDI sequence.
+     * @type {number}
+     */
+    firstNoteOn: number;
+    /**
+     * The MIDI key range used in the sequence, represented by a minimum and maximum note value.
      * @type {{min: number, max: number}}
      */
     keyRange: {
@@ -50,27 +56,27 @@ export class MidiData {
         max: number;
     };
     /**
-     * The last voice (note on, off, cc change etc.) event tick
+     * The tick position of the last voice event (such as note-on, note-off, or control change) in the sequence.
      * @type {number}
      */
     lastVoiceEventTick: number;
     /**
-     * Midi port numbers for each track
+     * An array of MIDI port numbers used by each track in the sequence.
      * @type {number[]}
      */
     midiPorts: number[];
     /**
-     * Channel offsets for each port, using the SpessaSynth method
+     * An array of channel offsets for each MIDI port, using the SpessaSynth method.
      * @type {number[]}
      */
     midiPortChannelOffsets: number[];
     /**
-     * All channels that each track uses
+     * A list of sets, where each set contains the MIDI channels used by each track in the sequence.
      * @type {Set<number>[]}
      */
     usedChannelsOnTrack: Set<number>[];
     /**
-     * The loop points (in ticks) of the sequence
+     * The loop points (in ticks) of the sequence, including both start and end points.
      * @type {{start: number, end: number}}
      */
     loop: {
@@ -78,34 +84,46 @@ export class MidiData {
         end: number;
     };
     /**
-     * The sequence's name
+     * The name of the MIDI sequence.
      * @type {string}
      */
     midiName: string;
     /**
-     * The file name of the sequence, if provided in the MIDI class
+     * A boolean indicating if the sequence's name is the same as the file name.
+     * @type {boolean}
+     */
+    midiNameUsesFileName: boolean;
+    /**
+     * The file name of the MIDI sequence, if provided by the MIDI class.
      * @type {string}
      */
     fileName: string;
     /**
-     * The raw, encoded MIDI name.
+     * The raw, encoded MIDI name, represented as a Uint8Array.
      * @type {Uint8Array}
      */
     rawMidiName: Uint8Array;
     /**
-     * Indicates if the midi has an embedded soundfont
+     * A boolean indicating if the MIDI file contains an embedded soundfont.
+     * If the embedded soundfont is undefined, this will be false.
      * @type {boolean}
      */
     isEmbedded: boolean;
     /**
-     * The RMID Info data if RMID, otherwise undefined
+     * The MIDI file's format, which can be 0, 1, or 2, indicating the type of the MIDI file.
+     * @type {number}
+     */
+    format: number;
+    /**
+     * The RMID (Resource Interchangeable MIDI) info data, if the file is RMID formatted.
+     * Otherwise, this field is undefined.
      * @type {Object<string, IndexedByteArray>}
      */
     RMIDInfo: {
         [x: string]: IndexedByteArray;
     };
     /**
-     * The bank offset for RMIDI
+     * The bank offset used for RMID files.
      * @type {number}
      */
     bankOffset: number;

package/@types/sequencer/sequencer.d.ts

@@ -47,7 +47,7 @@ export class Sequencer {
      */
     absoluteStartTime: number;
     /**
-     * @type {function(MIDI)}
+     * @type {function(BasicMIDI)}
      * @private
      */
     private _getMIDIResolve;
@@ -237,3 +237,4 @@ export type SequencerOptions = {
 import { MidiData } from "../midi_parser/midi_data.js";
 import { Synthetizer } from "../synthetizer/synthetizer.js";
 import { MIDI } from "../midi_parser/midi_loader.js";
+import { BasicMIDI } from "../midi_parser/basic_midi.js";

package/@types/soundfont/basic_soundfont/basic_sample.d.ts

@@ -66,6 +66,11 @@ export class BasicSample {
      * @type {number}
      */
     useCount: number;
+    /**
+     * The sample's audio data
+     * @type {Float32Array}
+     */
+    sampleData: Float32Array;
     /**
      * @returns {Uint8Array|IndexedByteArray}
      */

package/@types/soundfont/basic_soundfont/basic_soundfont.d.ts

@@ -5,6 +5,11 @@ export class BasicSoundFont {
      * @returns {BasicSoundFont}
      */
     static mergeSoundfonts(...soundfonts: BasicSoundFont[]): BasicSoundFont;
+    /**
+     * Creates a simple soundfont with one saw wave preset.
+     * @returns {ArrayBufferLike}
+     */
+    static getDummySoundfontFile(): ArrayBufferLike;
     /**
      * Creates a new basic soundfont template
      * @param data {undefined|{presets: BasicPreset[], info: Object<string, string>}}
@@ -89,6 +94,9 @@ export class BasicSoundFont {
     write: typeof write;
     writeDLS: typeof writeDLS;
 }
+import { BasicPreset } from "./basic_preset.js";
+import { BasicSample } from "./basic_sample.js";
+import { BasicInstrument } from "./basic_instrument.js";
 import { Modulator } from "./modulator.js";
 import { write } from "./write_sf2/write.js";
 import { writeDLS } from "./write_dls/write_dls.js";

package/@types/soundfont/dls/dls_sample.d.ts

@@ -15,10 +15,5 @@ export class DLSSample extends BasicSample {
      * @type {number}
      */
     sampleDbAttenuation: number;
-    /**
-     * @type {Float32Array}
-     */
-    sampleData: Float32Array;
-    getRawData(): Uint8Array<ArrayBuffer>;
 }
 import { BasicSample } from "../basic_soundfont/basic_sample.js";

package/@types/soundfont/read_sf2/samples.d.ts

@@ -31,7 +31,6 @@ export class LoadedSample extends BasicSample {
     sampleID: number;
     sampleLength: number;
     sampleDataArray: Float32Array<ArrayBuffer> | IndexedByteArray;
-    sampleData: Float32Array<ArrayBuffer>;
     isDataRaw: boolean;
     /**
      * Get raw data, whether it's compressed or not as we simply write it to the file