spessasynth_core 3.26.39 → 3.26.40

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spessasynth_core",
-  "version": "3.26.39",
+  "version": "3.26.40",
   "description": "MIDI and SoundFont2/DLS library with no compromises",
   "main": "index.js",
   "type": "module",

package/src/midi/midi_tools/rmidi_writer.js

@@ -35,16 +35,16 @@ const DEFAULT_COPYRIGHT = "Created using SpessaSynth";
 
 /**
  * @typedef {Object} RMIDMetadata
- * @property {string|undefined} name - the name of the file
- * @property {string|undefined} engineer - the engineer who worked on the file
- * @property {string|undefined} artist - the artist
- * @property {string|undefined} album - the album
- * @property {string|undefined} genre - the genre of the song
- * @property {ArrayBuffer|undefined} picture - the image for the file (album cover)
- * @property {string|undefined} comment - the coment of the file
- * @property {string|undefined} creationDate - the creation date of the file
- * @property {string|undefined} copyright - the copyright of the file
- * @property {string|unescape} midiEncoding - the encoding of the inner MIDI file
+ * @property {string} name - the name of the file
+ * @property {string} engineer - the engineer who worked on the file
+ * @property {string} artist - the artist
+ * @property {string} album - the album
+ * @property {string} genre - the genre of the song
+ * @property {ArrayBuffer} picture - the image for the file (album cover)
+ * @property {string} comment - the coment of the file
+ * @property {string} creationDate - the creation date of the file
+ * @property {string} copyright - the copyright of the file
+ * @property {string} midiEncoding - the encoding of the inner MIDI file
  */
 
 /**
@@ -54,7 +54,7 @@ const DEFAULT_COPYRIGHT = "Created using SpessaSynth";
  * @param soundfont {BasicSoundBank}
  * @param bankOffset {number} the bank offset for RMIDI
  * @param encoding {string} the encoding of the RMIDI info chunk
- * @param metadata {RMIDMetadata} the metadata of the file. Optional. If provided, the encoding is forced to utf-8/
+ * @param metadata {Partial<RMIDMetadata>} the metadata of the file. Optional. If provided, the encoding is forced to utf-8/
  * @param correctBankOffset {boolean}
  * @returns {IndexedByteArray}
  */

package/src/soundfont/basic_soundfont/basic_instrument.js

@@ -85,6 +85,7 @@ export class BasicInstrument
         });
     }
     
+    // unlinks everything from this instrument
     deleteInstrument()
     {
         if (this.useCount > 0)
@@ -92,7 +93,6 @@ export class BasicInstrument
             throw new Error(`Cannot delete an instrument that is used by: ${this.linkedPresets.map(p => p.presetName)}.`);
         }
         this.instrumentZones.forEach(z => z.deleteZone());
-        this.instrumentZones.length = 0;
     }
     
     /**

package/src/soundfont/basic_soundfont/basic_preset.js

@@ -91,10 +91,10 @@ export class BasicPreset
         );
     }
     
+    // unlinks everything from this preset
     deletePreset()
     {
         this.presetZones.forEach(z => z.deleteZone());
-        this.presetZones.length = 0;
     }
     
     /**

package/src/soundfont/basic_soundfont/write_dls/write_dls.js

@@ -10,7 +10,7 @@ import { fillWithDefaults } from "../../../utils/fill_with_defaults.js";
 
 /**
  * @typedef {Object} DLSWriteOptions
- * @property {ProgressFunction|undefined} progressFunction - a function to show progress for writing large banks. It can be undefined.
+ * @property {ProgressFunction} progressFunction - a function to show progress for writing large banks. It can be undefined.
  */
 
 
@@ -24,7 +24,7 @@ const DEFAULT_DLS_OPTIONS = {
 /**
  * Write the soundfont as a .dls file. Experimental
  * @this {BasicSoundBank}
- * @param {DLSWriteOptions|undefined} options - options for writing the file.
+ * @param {Partial<DLSWriteOptions>} options - options for writing the file.
  * @returns {Uint8Array}
  */
 export async function writeDLS(options = DEFAULT_DLS_OPTIONS)

package/src/soundfont/basic_soundfont/write_sf2/write.js

@@ -26,15 +26,15 @@ import { fillWithDefaults } from "../../../utils/fill_with_defaults.js";
 
 /**
  * @typedef {Object} SoundFont2WriteOptions
- * @property {boolean|undefined} compress - if the soundfont should be compressed with a given function.
- * @property {SampleEncodingFunction|undefined} compressionFunction -
+ * @property {boolean} compress - if the soundfont should be compressed with a given function.
+ * @property {SampleEncodingFunction} compressionFunction -
  * the encode vorbis function. It can be undefined if not compressed.
- * @property {ProgressFunction|undefined} progressFunction - a function to show progress for writing large banks. It can be undefined.
- * @property {boolean|undefined} writeDefaultModulators - if the DMOD chunk should be written.
+ * @property {ProgressFunction} progressFunction - a function to show progress for writing large banks. It can be undefined.
+ * @property {boolean} writeDefaultModulators - if the DMOD chunk should be written.
  * Recommended.
- * @property {boolean|undefined} writeExtendedLimits - if the xdta chunk should be written to allow virtually infinite parameters.
+ * @property {boolean} writeExtendedLimits - if the xdta chunk should be written to allow virtually infinite parameters.
  * Recommended.
- * @property {boolean|undefined} decompress - if an sf3 bank should be decompressed back to sf2. Not recommended.
+ * @property {boolean} decompress - if an sf3 bank should be decompressed back to sf2. Not recommended.
  */
 
 
@@ -61,7 +61,7 @@ const DEFAULT_WRITE_OPTIONS = {
 /**
  * Write the soundfont as an .sf2 file
  * @this {BasicSoundBank}
- * @param {SoundFont2WriteOptions} options
+ * @param {Partial<SoundFont2WriteOptions>} options
  * @returns {Uint8Array}
  */
 export async function write(options = DEFAULT_WRITE_OPTIONS)

package/src/utils/buffer_to_wav.js

@@ -1,9 +1,9 @@
 /**
  * @typedef {Object} WaveMetadata
- * @property {string|undefined} title - the song's title
- * @property {string|undefined} artist - the song's artist
- * @property {string|undefined} album - the song's album
- * @property {string|undefined} genre - the song's genre
+ * @property {string} title - the song's title
+ * @property {string} artist - the song's artist
+ * @property {string} album - the song's album
+ * @property {string} genre - the song's genre
  */
 
 import { IndexedByteArray } from "./indexed_array.js";
@@ -16,7 +16,7 @@ import { writeLittleEndian } from "./byte_functions/little_endian.js";
  * @param audioData {Float32Array[]} channels
  * @param sampleRate {number}
  * @param normalizeAudio {boolean} find the max sample point and set it to 1, and scale others with it
- * @param metadata {WaveMetadata}
+ * @param metadata {Partial<WaveMetadata>}
  * @param loop {{start: number, end: number}} loop start and end points in seconds. Undefined if no loop
  * @returns {ArrayBuffer}
  */