spessasynth_core 3.26.30 → 3.26.32

package/README.md

@@ -37,7 +37,6 @@ npm install --save spessasynth_core
 
 ### Easy Integration
 - **Modular design:** *Easy integration into other projects (load what you need)*
-- **[Detailed documentation:](https://github.com/spessasus/spessasynth_core/wiki/Home)** *With [examples!](https://github.com/spessasus/spessasynth_core/wiki/Getting-Started#examples)*
 - **Flexible:** *It's not just a MIDI player!*
 - **Easy to Use:** *Basic setup is just [two lines of code!](https://github.com/spessasus/spessasynth_core/wiki/Getting-Started#minimal-setup)*
 - **No dependencies:** *Batteries included!*

package/package.json

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

package/src/midi/midi_tools/rmidi_writer.js

@@ -1,5 +1,5 @@
-import { combineArrays, IndexedByteArray } from "../../utils/indexed_array.js";
-import { writeRIFFOddSize } from "../../soundfont/basic_soundfont/riff_chunk.js";
+import { IndexedByteArray } from "../../utils/indexed_array.js";
+import { writeRIFFChunkParts, writeRIFFChunkRaw } from "../../soundfont/basic_soundfont/riff_chunk.js";
 import { getStringBytes } from "../../utils/byte_functions/string.js";
 import { messageTypes, midiControllers, MIDIMessage } from "../midi_message.js";
 import { getGsOn } from "./midi_editor.js";
@@ -419,25 +419,25 @@ export function writeRMIDI(
     /**
      * @type {Uint8Array[]}
      */
-    const infoContent = [getStringBytes("INFO")];
+    const infoContent = [];
     const encoder = new TextEncoder();
     // software (SpessaSynth)
     infoContent.push(
-        writeRIFFOddSize(RMIDINFOChunks.software, encoder.encode("SpessaSynth"), true)
+        writeRIFFChunkRaw(RMIDINFOChunks.software, encoder.encode("SpessaSynth"), true)
     );
     // name
     if (metadata.name !== undefined)
     {
         
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.name, encoder.encode(metadata.name), true)
+            writeRIFFChunkRaw(RMIDINFOChunks.name, encoder.encode(metadata.name), true)
         );
         encoding = FORCED_ENCODING;
     }
     else
     {
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.name, mid.rawMidiName, true)
+            writeRIFFChunkRaw(RMIDINFOChunks.name, mid.rawMidiName, true)
         );
     }
     // creation date
@@ -445,7 +445,7 @@ export function writeRMIDI(
     {
         encoding = FORCED_ENCODING;
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.creationDate, encoder.encode(metadata.creationDate), true)
+            writeRIFFChunkRaw(RMIDINFOChunks.creationDate, encoder.encode(metadata.creationDate), true)
         );
     }
     else
@@ -459,7 +459,7 @@ export function writeRMIDI(
             minute: "numeric"
         });
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.creationDate, getStringBytes(today, true), true)
+            writeRIFFChunkRaw(RMIDINFOChunks.creationDate, getStringBytes(today, true), true)
         );
     }
     // comment
@@ -467,14 +467,14 @@ export function writeRMIDI(
     {
         encoding = FORCED_ENCODING;
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.comment, encoder.encode(metadata.comment))
+            writeRIFFChunkRaw(RMIDINFOChunks.comment, encoder.encode(metadata.comment))
         );
     }
     // engineer
     if (metadata.engineer !== undefined)
     {
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.engineer, encoder.encode(metadata.engineer), true)
+            writeRIFFChunkRaw(RMIDINFOChunks.engineer, encoder.encode(metadata.engineer), true)
         );
     }
     // album
@@ -483,10 +483,10 @@ export function writeRMIDI(
         // note that there are two album chunks: IPRD and IALB
         encoding = FORCED_ENCODING;
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.album, encoder.encode(metadata.album), true)
+            writeRIFFChunkRaw(RMIDINFOChunks.album, encoder.encode(metadata.album), true)
         );
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.album2, encoder.encode(metadata.album), true)
+            writeRIFFChunkRaw(RMIDINFOChunks.album2, encoder.encode(metadata.album), true)
         );
     }
     // artist
@@ -494,7 +494,7 @@ export function writeRMIDI(
     {
         encoding = FORCED_ENCODING;
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.artist, encoder.encode(metadata.artist), true)
+            writeRIFFChunkRaw(RMIDINFOChunks.artist, encoder.encode(metadata.artist), true)
         );
     }
     // genre
@@ -502,14 +502,14 @@ export function writeRMIDI(
     {
         encoding = FORCED_ENCODING;
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.genre, encoder.encode(metadata.genre), true)
+            writeRIFFChunkRaw(RMIDINFOChunks.genre, encoder.encode(metadata.genre), true)
         );
     }
     // picture
     if (metadata.picture !== undefined)
     {
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.picture, new Uint8Array(metadata.picture))
+            writeRIFFChunkRaw(RMIDINFOChunks.picture, new Uint8Array(metadata.picture))
         );
     }
     // copyright
@@ -517,7 +517,7 @@ export function writeRMIDI(
     {
         encoding = FORCED_ENCODING;
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.copyright, encoder.encode(metadata.copyright), true)
+            writeRIFFChunkRaw(RMIDINFOChunks.copyright, encoder.encode(metadata.copyright), true)
         );
     }
     else
@@ -525,43 +525,42 @@ export function writeRMIDI(
         // use midi copyright if possible
         const copyright = mid.copyright.length > 0 ? mid.copyright : DEFAULT_COPYRIGHT;
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.copyright, getStringBytes(copyright, true))
+            writeRIFFChunkRaw(RMIDINFOChunks.copyright, getStringBytes(copyright, true))
         );
     }
     
     // bank offset
     const DBNK = new IndexedByteArray(2);
     writeLittleEndian(DBNK, bankOffset, 2);
-    infoContent.push(writeRIFFOddSize(RMIDINFOChunks.bankOffset, DBNK));
+    infoContent.push(writeRIFFChunkRaw(RMIDINFOChunks.bankOffset, DBNK));
     // midi encoding
     if (metadata.midiEncoding !== undefined)
     {
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.midiEncoding, encoder.encode(metadata.midiEncoding))
+            writeRIFFChunkRaw(RMIDINFOChunks.midiEncoding, encoder.encode(metadata.midiEncoding))
         );
         encoding = FORCED_ENCODING;
     }
     // encoding
-    infoContent.push(writeRIFFOddSize(RMIDINFOChunks.encoding, getStringBytes(encoding, true)));
+    infoContent.push(writeRIFFChunkRaw(RMIDINFOChunks.encoding, getStringBytes(encoding, true)));
     
     // combine and write out
-    const infodata = combineArrays(infoContent);
-    const rmiddata = combineArrays([
-        getStringBytes("RMID"),
-        writeRIFFOddSize(
-            "data",
-            newMid
-        ),
-        writeRIFFOddSize(
-            "LIST",
-            infodata
-        ),
-        soundfontBinary
-    ]);
     SpessaSynthInfo("%cFinished!", consoleColors.info);
     SpessaSynthGroupEnd();
-    return writeRIFFOddSize(
+    return writeRIFFChunkParts(
         "RIFF",
-        rmiddata
+        [
+            getStringBytes("RMID"),
+            writeRIFFChunkRaw(
+                "data",
+                newMid
+            ),
+            writeRIFFChunkParts(
+                "INFO",
+                infoContent,
+                true
+            ),
+            soundfontBinary
+        ]
     );
 }

package/src/soundfont/basic_soundfont/basic_preset.js

@@ -128,10 +128,7 @@ export class BasicPreset
             {
                 this.getSamplesAndGenerators(key, velocity).forEach(samandgen =>
                 {
-                    if (!samandgen.sample.isSampleLoaded)
-                    {
-                        samandgen.sample.getAudioData();
-                    }
+                    samandgen.sample.getAudioData();
                 });
             }
         }

package/src/soundfont/basic_soundfont/basic_sample.js

@@ -341,10 +341,20 @@ export class BasicSample
     {
         const data = this.getAudioData();
         const data16 = new Int16Array(data.length);
-        
-        for (let i = 0; i < data.length; i++)
+        const len = data.length;
+        for (let i = 0; i < len; i++)
         {
-            data16[i] = data[i] * 32768;
+            let sample = data[i] * 32768;
+            // Clamp for safety (do not use Math.max/Math.min here)
+            if (sample > 32767)
+            {
+                sample = 32767;
+            }
+            else if (sample < -32768)
+            {
+                sample = -32768;
+            }
+            data16[i] = sample;
         }
         return new IndexedByteArray(data16.buffer);
     }

package/src/soundfont/basic_soundfont/basic_soundbank.js

@@ -16,12 +16,20 @@ import { BasicPreset } from "./basic_preset.js";
 import { isXGDrums } from "../../utils/xg_hacks.js";
 import { generatorTypes } from "./generator_types.js";
 import { BasicGlobalZone } from "./basic_global_zone.js";
+import { stbvorbis } from "../../externals/stbvorbis_sync/stbvorbis_sync.min.js";
 
 /**
  * Represents a single sound bank, be it DLS or SF2.
  */
 class BasicSoundBank
 {
+    /**
+     * Indicates if the SF3/SF2Pack decoder is ready.
+     * @type {Promise<boolean>}
+     * @static
+     */
+    static isSF3DecoderReady = stbvorbis.isInitialized;
+    
     /**
      * 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>}
@@ -187,7 +195,7 @@ class BasicSoundBank
         font.addPresets(preset);
         
         font.soundFontInfo["ifil"] = "2.1";
-        font.soundFontInfo["isng"] = "EMU8000";
+        font.soundFontInfo["isng"] = "E-mu 10K2";
         font.soundFontInfo["INAM"] = "Dummy";
         font.flush();
         return font.write().buffer;

package/src/soundfont/basic_soundfont/riff_chunk.js

@@ -4,13 +4,31 @@ import { readBytesAsString, writeStringAsBytes } from "../../utils/byte_function
 
 /**
  * riff_chunk.js
- * reads a riff read and stores it as a class
+ * reads a riff chunk and stores it as a class
  */
 
 export class RiffChunk
 {
     /**
-     * Creates a new riff read
+     * The chunks FourCC code
+     * @type {string}
+     */
+    header;
+    
+    /**
+     * Chunk's size, in bytes
+     * @type {number}
+     */
+    size;
+    
+    /**
+     * Chunk's binary data
+     * @type {IndexedByteArray}
+     */
+    chunkData;
+    
+    /**
+     * Creates a new RIFF chunk
      * @constructor
      * @param header {string}
      * @param size {number}
@@ -36,6 +54,13 @@ export function readRIFFChunk(dataArray, readData = true, forceShift = false)
     let header = readBytesAsString(dataArray, 4);
     
     let size = readLittleEndian(dataArray, 4);
+    if (header === "")
+    {
+        // safeguard against evil DLS files
+        // The test case: CrysDLS v1.23.dls
+        // https://github.com/spessasus/spessasynth_core/issues/5
+        size = 0;
+    }
     /**
      * @type {IndexedByteArray}
      */
@@ -61,75 +86,93 @@ export function readRIFFChunk(dataArray, readData = true, forceShift = false)
 }
 
 /**
- * @param chunk {RiffChunk}
- * @param prepend {IndexedByteArray}
+ * Writes a RIFF chunk correctly
+ * @param header {string} fourCC
+ * @param data {Uint8Array} chunk data
+ * @param addZeroByte {boolean} add a zero byte into the chunk size
+ * @param isList {boolean} adds "LIST" as the chunk type and writes the actual type at the start of the data
  * @returns {IndexedByteArray}
  */
-export function writeRIFFChunk(chunk, prepend = undefined)
+export function writeRIFFChunkRaw(header, data, addZeroByte = false, isList = false)
 {
-    let size = 8 + chunk.size;
-    if (chunk.size % 2 !== 0)
+    let dataStartOffset = 8;
+    let headerWritten = header;
+    let dataLength = data.length;
+    if (addZeroByte)
     {
-        size++;
+        dataLength++;
     }
-    if (prepend)
+    let writtenSize = dataLength;
+    if (isList)
     {
-        size += prepend.length;
+        // written header is LIST and the passed header is the first 4 bytes of chunk data
+        dataStartOffset += 4;
+        writtenSize += 4;
+        headerWritten = "LIST";
     }
-    const array = new IndexedByteArray(size);
-    // prepend data (for example, type before the read)
-    if (prepend)
+    let finalSize = dataStartOffset + dataLength;
+    if (finalSize % 2 !== 0)
     {
-        array.set(prepend, array.currentIndex);
-        array.currentIndex += prepend.length;
+        // pad byte does not get included in the size
+        finalSize++;
     }
-    // write header
-    writeStringAsBytes(array, chunk.header);
-    // write size (excluding header and the size itself) and then prepend if specified
-    writeDword(array, size - 8 - (prepend?.length || 0));
-    // write data
-    array.set(chunk.chunkData, array.currentIndex);
-    return array;
+    
+    const outArray = new IndexedByteArray(finalSize);
+    // FourCC ("RIFF", "LIST", "pdta" etc.)
+    writeStringAsBytes(outArray, headerWritten);
+    // chunk size
+    writeDword(outArray, writtenSize);
+    if (isList)
+    {
+        // list type (e.g. "INFO")
+        writeStringAsBytes(outArray, header);
+    }
+    outArray.set(data, dataStartOffset);
+    return outArray;
 }
 
 /**
- * @param header {string}
- * @param data {Uint8Array}
- * @param addZeroByte {Boolean}
+ * Writes RIFF chunk given binary blobs
+ * @param header {string} fourCC
+ * @param chunks {Uint8Array[]} chunk data parts, it will be combined in order
  * @param isList {boolean} adds "LIST" as the chunk type and writes the actual type at the start of the data
  * @returns {IndexedByteArray}
  */
-export function writeRIFFOddSize(header, data, addZeroByte = false, isList = false)
+export function writeRIFFChunkParts(header, chunks, isList = false)
 {
-    if (addZeroByte)
-    {
-        const tempData = new Uint8Array(data.length + 1);
-        tempData.set(data);
-        data = tempData;
-    }
-    let offset = 8;
-    let finalSize = offset + data.length;
-    let writtenSize = data.length;
-    if (finalSize % 2 !== 0)
-    {
-        finalSize++;
-    }
+    let dataOffset = 8;
     let headerWritten = header;
+    let dataLength = chunks.reduce((len, c) => c.length + len, 0);
+    let writtenSize = dataLength;
     if (isList)
     {
-        finalSize += 4;
+        // written header is LIST and the passed header is the first 4 bytes of chunk data
+        dataOffset += 4;
         writtenSize += 4;
-        offset += 4;
         headerWritten = "LIST";
     }
+    let finalSize = dataOffset + dataLength;
+    if (finalSize % 2 !== 0)
+    {
+        // pad byte does not get included in the size
+        finalSize++;
+    }
+    
     const outArray = new IndexedByteArray(finalSize);
+    // fourCC ("RIFF", "LIST", "pdta" etc.)
     writeStringAsBytes(outArray, headerWritten);
+    // chunk size
     writeDword(outArray, writtenSize);
     if (isList)
     {
+        // list type (e.g. "INFO")
         writeStringAsBytes(outArray, header);
     }
-    outArray.set(data, offset);
+    chunks.forEach(c =>
+    {
+        outArray.set(c, dataOffset);
+        dataOffset += c.length;
+    });
     return outArray;
 }
 

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

@@ -1,6 +1,6 @@
 import { getDLSArticulatorFromSf2Generator, getDLSArticulatorFromSf2Modulator } from "./modulator_converter.js";
-import { writeRIFFOddSize } from "../riff_chunk.js";
-import { combineArrays, IndexedByteArray } from "../../../utils/indexed_array.js";
+import { writeRIFFChunkParts } from "../riff_chunk.js";
+import { IndexedByteArray } from "../../../utils/indexed_array.js";
 import { Generator } from "../generator.js";
 import { writeDword } from "../../../utils/byte_functions/little_endian.js";
 import { consoleColors } from "../../../utils/other.js";
@@ -167,8 +167,8 @@ export function writeArticulator(zone)
     
     
     const out = generators.map(a => a.writeArticulator());
-    return writeRIFFOddSize(
+    return writeRIFFChunkParts(
         "art2",
-        combineArrays([art2Data, ...out])
+        [art2Data, ...out]
     );
 }

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

@@ -1,6 +1,6 @@
-import { combineArrays, IndexedByteArray } from "../../../utils/indexed_array.js";
+import { IndexedByteArray } from "../../../utils/indexed_array.js";
 import { combineZones } from "./combine_zones.js";
-import { writeRIFFOddSize } from "../riff_chunk.js";
+import { writeRIFFChunkParts, writeRIFFChunkRaw } from "../riff_chunk.js";
 import { writeDword } from "../../../utils/byte_functions/little_endian.js";
 import { writeDLSRegion } from "./rgn2.js";
 import { writeArticulator } from "./art2.js";
@@ -40,14 +40,14 @@ export function writeIns(preset)
     writeDword(inshData, ulBank);                     // ulBank
     writeDword(inshData, preset.program & 127); // ulInstrument
     
-    const insh = writeRIFFOddSize(
+    const insh = writeRIFFChunkRaw(
         "insh",
         inshData
     );
     
     // write global zone
     const art2 = writeArticulator(global);
-    let lar2 = writeRIFFOddSize(
+    let lar2 = writeRIFFChunkRaw(
         "lar2",
         art2,
         false,
@@ -55,24 +55,22 @@ export function writeIns(preset)
     );
     
     // write the region list
-    const lrgnData = combineArrays(zones.reduce((arrs, z) =>
-    {
-        arrs.push(writeDLSRegion.apply(this, [z, global]));
-        return arrs;
-    }, []));
-    const lrgn = writeRIFFOddSize(
+    const lrgn = writeRIFFChunkParts(
         "lrgn",
-        lrgnData,
-        false,
+        zones.reduce((arrs, z) =>
+        {
+            arrs.push(writeDLSRegion.apply(this, [z, global]));
+            return arrs;
+        }, []),
         true
     );
     
     // writeINFO
-    const inam = writeRIFFOddSize(
+    const inam = writeRIFFChunkRaw(
         "INAM",
         getStringBytes(preset.presetName, true)
     );
-    const info = writeRIFFOddSize(
+    const info = writeRIFFChunkRaw(
         "INFO",
         inam,
         false,
@@ -80,10 +78,8 @@ export function writeIns(preset)
     );
     
     SpessaSynthGroupEnd();
-    return writeRIFFOddSize(
-        "ins ",
-        combineArrays([insh, lrgn, lar2, info]),
-        false,
+    return writeRIFFChunkParts(
+        "ins ", [insh, lrgn, lar2, info],
         true
     );
 }

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

@@ -1,5 +1,4 @@
-import { writeRIFFOddSize } from "../riff_chunk.js";
-import { combineArrays } from "../../../utils/indexed_array.js";
+import { writeRIFFChunkParts } from "../riff_chunk.js";
 import { writeIns } from "./ins.js";
 
 /**
@@ -8,11 +7,9 @@ import { writeIns } from "./ins.js";
  */
 export function writeLins()
 {
-    const lins = combineArrays(this.presets.map(p => writeIns.apply(this, [p])));
-    return writeRIFFOddSize(
+    return writeRIFFChunkParts(
         "lins",
-        lins,
-        false,
+        this.presets.map(p => writeIns.apply(this, [p])),
         true
     );
 }

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

@@ -1,6 +1,6 @@
-import { combineArrays, IndexedByteArray } from "../../../utils/indexed_array.js";
+import { IndexedByteArray } from "../../../utils/indexed_array.js";
 import { writeDword, writeWord } from "../../../utils/byte_functions/little_endian.js";
-import { writeRIFFOddSize } from "../riff_chunk.js";
+import { writeRIFFChunkParts, writeRIFFChunkRaw } from "../riff_chunk.js";
 import { writeWavesample } from "./wsmp.js";
 import { writeArticulator } from "./art2.js";
 import { generatorTypes } from "../generator_types.js";
@@ -28,7 +28,7 @@ export function writeDLSRegion(zone, globalZone)
     writeWord(rgnhData, exclusive);
     // usLayer
     writeWord(rgnhData, 0);
-    const rgnh = writeRIFFOddSize(
+    const rgnh = writeRIFFChunkRaw(
         "rgnh",
         rgnhData
     );
@@ -88,7 +88,7 @@ export function writeDLSRegion(zone, globalZone)
     // 1 means that the first bit is on so mono/left
     writeDword(wlnkData, 1); // ulChannel
     writeDword(wlnkData, this.samples.indexOf(zone.sample)); // ulTableIndex
-    const wlnk = writeRIFFOddSize(
+    const wlnk = writeRIFFChunkRaw(
         "wlnk",
         wlnkData
     );
@@ -99,7 +99,7 @@ export function writeDLSRegion(zone, globalZone)
     {
         const art2 = writeArticulator(zone);
         
-        lar2 = writeRIFFOddSize(
+        lar2 = writeRIFFChunkRaw(
             "lar2",
             art2,
             false,
@@ -107,15 +107,14 @@ export function writeDLSRegion(zone, globalZone)
         );
     }
     
-    return writeRIFFOddSize(
+    return writeRIFFChunkParts(
         "rgn2",
-        combineArrays([
+        [
             rgnh,
             wsmp,
             wlnk,
             lar2
-        ]),
-        false,
+        ],
         true
     );
 }