spessasynth_core 3.27.5 → 3.27.7

package/README.md

@@ -66,7 +66,7 @@ npm install --save spessasynth_core
 - **Soundfont manager:** Stack multiple soundfonts!
 - **Unlimited channel count:** Your CPU is the limit!
 - **Excellent MIDI Standards Support:**
-  - **MIDI Controller Support:** Default supported controllers [here](https://github.com/spessasus/spessasynth_core/wiki/MIDI-Implementation#supported-controllers)
+  - **MIDI Controller Support:** Default supported controllers [here](https://github.com/spessasus/spessasynth_core/wiki/MIDI-Implementation#default-supported-controllers)
   - **Portamento Support:** Glide the notes!
   - **Sound Controllers:** Real-time filter and envelope control!
   - **MIDI Tuning Standard Support:** [more info here](https://github.com/spessasus/spessasynth_core/wiki/MIDI-Implementation#midi-tuning-standard)
@@ -110,7 +110,7 @@ npm install --save spessasynth_core
   - **Easy info access:** Just an [object of strings!](https://github.com/spessasus/spessasynth_core/wiki/SoundFont2-Class#soundfontinfo)
   - **Smart trimming:** Trim the SoundFont to only include samples used in the MIDI *(down to key and velocity!)*
   - **sf3 conversion:** Compress SoundFont2 files to SoundFont3 with variable quality!
-  - **Easy saving:** Also just [one function!](https://github.com/spessasus/spessasynth_core/wiki/SoundFont2-Class#write)
+  - **Easy saving:** Also just [one function!](https://github.com/spessasus/spessasynth_core/wiki/Sound-Bank-Parser#write)
 
 #### Read and write SoundFont3 files
   - Same features as SoundFont2 but with now with **Ogg Vorbis compression!**
@@ -119,7 +119,8 @@ npm install --save spessasynth_core
 
 #### Read and write DLS Level One or Two files
   - Read DLS (DownLoadable Sounds) files as SF2 files!
-  - **Works like a normal soundfont:** *Saving it as sf2 is still [just one function!](https://github.com/spessasus/spessasynth_core/wiki/SoundFont2-Class#write)*
+  - **Works like a normal soundfont:** *Saving it as sf2 is still [just one function!](https://github.com/spessasus/spessasynth_core/wiki/Sound-Bank-Parser#write)*
+  - *That's right, saving as DLS is also [just one function!](https://github.com/spessasus/spessasynth_core/wiki/Sound-Bank-Parser#writedls)*
   - Converts articulators to both **modulators** and **generators**!
   - Works with both unsigned 8-bit samples and signed 16-bit samples!
   - A-Law encoding support

package/package.json

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

package/src/midi/basic_midi.js

@@ -41,7 +41,7 @@ class BasicMIDI extends MIDISequenceData
     isDLSRMIDI = false;
     
     /**
-     * Copies a MIDI
+     * Copies a MIDI (tracks are shallowly copied!)
      * @param mid {BasicMIDI}
      * @returns {BasicMIDI}
      */
@@ -51,9 +51,27 @@ class BasicMIDI extends MIDISequenceData
         m._copyFromSequence(mid);
         
         m.isDLSRMIDI = mid.isDLSRMIDI;
-        m.embeddedSoundFont = mid.embeddedSoundFont ? mid.embeddedSoundFont.slice(0) : undefined; // Deep copy
+        m.embeddedSoundFont = mid?.embeddedSoundFont ? mid.embeddedSoundFont : undefined; // Shallow copy
         m.tracks = mid.tracks.map(track => [...track]); // Shallow copy of each track array
-        
+        return m;
+    }
+    
+    /**
+     * Copies a MIDI with deep copy
+     * @param mid {BasicMIDI}
+     * @returns {BasicMIDI}
+     */
+    static copyFromDeep(mid)
+    {
+        const m = new BasicMIDI();
+        m._copyFromSequence(mid);
+        m.isDLSRMIDI = mid.isDLSRMIDI;
+        m.embeddedSoundFont = mid.embeddedSoundFont ? mid.embeddedSoundFont.slice(0) : undefined; // Deep copy
+        m.tracks = mid.tracks.map(track => track.map(event => new MIDIMessage(
+            event.ticks,
+            event.messageStatusByte,
+            event.messageData
+        ))); // Deep copy
         return m;
     }
     
@@ -217,7 +235,6 @@ class BasicMIDI extends MIDISequenceData
                             copyrightComponents.push(readBytesAsString(
                                 e.messageData,
                                 e.messageData.length,
-                                undefined,
                                 false
                             ));
                             e.messageData.currentIndex = 0;
@@ -466,7 +483,7 @@ class BasicMIDI extends MIDISequenceData
                     {
                         this.rawMidiName = name.messageData;
                         name.messageData.currentIndex = 0;
-                        this.midiName = readBytesAsString(name.messageData, name.messageData.length, undefined, false);
+                        this.midiName = readBytesAsString(name.messageData, name.messageData.length, false);
                     }
                 }
             }
@@ -478,7 +495,7 @@ class BasicMIDI extends MIDISequenceData
                 {
                     this.rawMidiName = name.messageData;
                     name.messageData.currentIndex = 0;
-                    this.midiName = readBytesAsString(name.messageData, name.messageData.length, undefined, false);
+                    this.midiName = readBytesAsString(name.messageData, name.messageData.length, false);
                 }
             }
         }

package/src/midi/midi_loader.js

@@ -45,7 +45,7 @@ class MIDI extends BasicMIDI
             // possibly an RMID file (https://github.com/spessasus/sf2-rmidi-specification#readme)
             // skip size
             binaryData.currentIndex += 8;
-            const rmid = readBytesAsString(binaryData, 4, undefined, false);
+            const rmid = readBytesAsString(binaryData, 4, false);
             if (rmid !== "RMID")
             {
                 SpessaSynthGroupEnd();
@@ -101,18 +101,15 @@ class MIDI extends BasicMIDI
                             this.copyright = readBytesAsString(
                                 this.RMIDInfo["ICOP"],
                                 this.RMIDInfo["ICOP"].length,
-                                undefined,
                                 false
                             ).replaceAll("\n", " ");
                         }
                         if (this.RMIDInfo["INAM"])
                         {
                             this.rawMidiName = this.RMIDInfo[RMIDINFOChunks.name];
-                            // noinspection JSCheckFunctionSignatures
                             this.midiName = readBytesAsString(
-                                this.rawMidiName,
+                                /** @type {IndexedByteArray}*/this.rawMidiName,
                                 this.rawMidiName.length,
-                                undefined,
                                 false
                             ).replaceAll("\n", " ");
                         }

package/src/midi/midi_sequence.js

@@ -1,3 +1,5 @@
+import { IndexedByteArray } from "../utils/indexed_array.js";
+
 /**
  * This is the base type for MIDI files. It contains all the "metadata" and information.
  * It extends to:
@@ -133,7 +135,7 @@ class MIDISequenceData
      * 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 a binary array.
-     * @type {Object<string, IndexedByteArray>}
+     * @type {Record<string, IndexedByteArray>}
      */
     RMIDInfo = {};
     
@@ -217,7 +219,11 @@ class MIDISequenceData
         // copying objects
         this.loop = { ...sequence.loop };
         this.keyRange = { ...sequence.keyRange };
-        this.RMIDInfo = { ...sequence.RMIDInfo };
+        this.RMIDInfo = {};
+        for (const [key, value] of Object.entries(sequence.RMIDInfo))
+        {
+            this.RMIDInfo[key] = new IndexedByteArray(value);
+        }
     }
 }
 

package/src/midi/midi_tools/midi_editor.js

@@ -180,7 +180,7 @@ export function modifyMIDI(
     const midiPorts = midi.midiPorts.slice();
     /**
      * midi port: channel offset
-     * @type {Object<number, number>}
+     * @type {Record<number, number>}
      */
     const midiPortChannelOffsets = {};
     let midiPortChannelOffset = 0;

package/src/midi/midi_tools/rmidi_writer.js

@@ -48,7 +48,7 @@ const DEFAULT_COPYRIGHT = "Created using SpessaSynth";
  */
 
 /**
- * Writes an RMIDI file
+ * Writes an RMIDI file. Note that this method modifies the MIDI file in-place.
  * @this {BasicMIDI}
  * @param soundfontBinary {Uint8Array}
  * @param soundfont {BasicSoundBank}

package/src/midi/midi_tools/used_keys_loaded.js

@@ -10,7 +10,7 @@ import { SoundFontManager } from "../../synthetizer/audio_engine/engine_componen
  * Gets the used programs and keys for this MIDI file with a given sound bank
  * @this {BasicMIDI}
  * @param soundfont {SoundFontManager|BasicSoundBank} - the sound bank
- * @returns {Object<string, Set<string>>} Object<bank:program, Set<key-velocity>>
+ * @returns {Record<string, Set<string>>} Record<bank:program, Set<key-velocity>>
  */
 export function getUsedProgramsAndKeys(soundfont)
 {
@@ -81,7 +81,7 @@ export function getUsedProgramsAndKeys(soundfont)
     /**
      * find all programs used and key-velocity combos in them
      * bank:program each has a set of midiNote-velocity
-     * @type {Object<string, Set<string>>}
+     * @type {Record<string, Set<string>>}
      */
     const usedProgramsAndKeys = {};
     

package/src/midi/xmf_loader.js

@@ -90,7 +90,7 @@ class XMFNode
     metadataLength;
     
     /**
-     * @type {Object<string, any>}
+     * @type {Record<string, any>}
      */
     metadata = {};
     

package/src/sequencer/sequencer_engine.js

@@ -111,8 +111,8 @@ class SpessaSynthSequencer
     midiPortChannelOffset = 0;
     /**
      * stored as:
-     * Object<midi port, channel offset>
-     * @type {Object<number, number>}
+     * Record<midi port, channel offset>
+     * @type {Record<number, number>}
      */
     midiPortChannelOffsets = {};
     

package/src/sequencer/song_control.js

@@ -147,7 +147,7 @@ export function loadNewSongList(midiBuffers, autoPlay = true)
      * parse the MIDIs (only the array buffers, MIDI is unchanged)
      * @type {BasicMIDI[]}
      */
-    this.songs = midiBuffers.map(m => BasicMIDI.copyFrom(m));
+    this.songs = midiBuffers;
     if (this.songs.length < 1)
     {
         return;

package/src/soundfont/basic_soundfont/basic_soundbank.js

@@ -32,7 +32,7 @@ class BasicSoundBank
     
     /**
      * Soundfont's info stored as name: value. ifil and iver are stored as string representation of float (e.g., 2.1)
-     * @type {Object<string, string|IndexedByteArray>}
+     * @type {Record<string, string|IndexedByteArray>}
      */
     soundFontInfo = {};
     
@@ -77,7 +77,7 @@ class BasicSoundBank
     
     /**
      * Creates a new basic soundfont template (or copies)
-     * @param data {undefined|{presets: BasicPreset[], info: Object<string, string>}}
+     * @param data {undefined|{presets: BasicPreset[], info: Record<string, string>}}
      */
     constructor(data = undefined)
     {

package/src/soundfont/basic_soundfont/generator.js

@@ -69,5 +69,8 @@ export function addAndClampGenerator(generatorType, presetGens, instrumentGens)
     }
     
     // limits are applied in the compute_modulator function
-    return instruValue + presetValue;
+    // clamp to prevent short from overflowing
+    // testcase: Sega Genesis soundfont (spessasynth/#169) adds 20,999 and the default 13,500 to initialFilterFc
+    // which is more than 32k
+    return Math.max(-32767, Math.min(32767, instruValue + presetValue));
 }

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

@@ -234,7 +234,7 @@ export function combineZones(preset, globalize = true)
                 continue;
             }
             /**
-             * @type {Object<string, number>}
+             * @type {Record<string, number>}
              */
             let occurencesForValues = {};
             const defaultForChecked = generatorLimits[checkedType]?.def || 0;

package/src/soundfont/load_soundfont.js

@@ -12,7 +12,7 @@ export function loadSoundFont(buffer)
 {
     const check = buffer.slice(8, 12);
     const a = new IndexedByteArray(check);
-    const id = readBytesAsString(a, 4, undefined, false).toLowerCase();
+    const id = readBytesAsString(a, 4, false).toLowerCase();
     if (id === "dls ")
     {
         return new DLSSoundFont(buffer);

package/src/soundfont/read_sf2/soundfont.js

@@ -101,7 +101,7 @@ export class SoundFont2 extends BasicSoundBank
                     break;
                 
                 case "icmt":
-                    text = readBytesAsString(chunk.chunkData, chunk.chunkData.length, undefined, false);
+                    text = readBytesAsString(chunk.chunkData, chunk.chunkData.length, false);
                     this.soundFontInfo[chunk.header] = text;
                     break;
                 

package/src/synthetizer/audio_engine/engine_components/soundfont_manager.js

@@ -33,7 +33,7 @@ export class SoundFontManager
     {
         /**
          * <"bank-program", "presetName">
-         * @type {Object<string, string>}
+         * @type {Record<string, string>}
          */
         const presetList = {};
         // gather the presets in reverse and replace if necessary

package/src/utils/byte_functions/string.js

@@ -3,50 +3,39 @@ import { IndexedByteArray } from "../indexed_array.js";
 /**
  * @param dataArray {IndexedByteArray}
  * @param bytes {number}
- * @param encoding {string} the textElement encoding
  * @param trimEnd {boolean} if we should trim once we reach an invalid byte
  * @returns {string}
  */
-export function readBytesAsString(dataArray, bytes, encoding = undefined, trimEnd = true)
+export function readBytesAsString(dataArray, bytes, trimEnd = true)
 {
-    if (!encoding)
+    let finished = false;
+    let string = "";
+    for (let i = 0; i < bytes; i++)
     {
-        let finished = false;
-        let string = "";
-        for (let i = 0; i < bytes; i++)
+        let byte = dataArray[dataArray.currentIndex++];
+        if (finished)
         {
-            let byte = dataArray[dataArray.currentIndex++];
-            if (finished)
+            continue;
+        }
+        if ((byte < 32 || byte > 127) && byte !== 10) // 10 is "\n"
+        {
+            if (trimEnd)
             {
+                finished = true;
                 continue;
             }
-            if ((byte < 32 || byte > 127) && byte !== 10) // 10 is "\n"
+            else
             {
-                if (trimEnd)
+                if (byte === 0)
                 {
                     finished = true;
                     continue;
                 }
-                else
-                {
-                    if (byte === 0)
-                    {
-                        finished = true;
-                        continue;
-                    }
-                }
             }
-            string += String.fromCharCode(byte);
         }
-        return string;
-    }
-    else
-    {
-        let byteBuffer = dataArray.slice(dataArray.currentIndex, dataArray.currentIndex + bytes);
-        dataArray.currentIndex += bytes;
-        let decoder = new TextDecoder(encoding.replace(/[^\x20-\x7E]/g, ""));
-        return decoder.decode(byteBuffer.buffer);
+        string += String.fromCharCode(byte);
     }
+    return string;
 }
 
 /**