spessasynth_lib 3.23.3 → 3.23.6

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

@@ -25,9 +25,10 @@ export class Modulator {
     /**
      * @param mod1 {Modulator}
      * @param mod2 {Modulator}
+     * @param checkAmount {boolean}
      * @returns {boolean}
      */
-    static isIdentical(mod1: Modulator, mod2: Modulator): boolean;
+    static isIdentical(mod1: Modulator, mod2: Modulator, checkAmount?: boolean): boolean;
     /**
      * Creates a modulator
      * @param params {{srcEnum: number, secSrcEnum: number, dest: generatorTypes, amt: number, transform: number}}

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

@@ -1,3 +1,12 @@
+/**
+ * @param source {number}
+ * @param control {number}
+ * @param destination {number}
+ * @param value {number}
+ * @param transform {number}
+ * @param msg {string}
+ */
+export function modulatorConverterDebug(source: number, control: number, destination: number, value: number, transform: number, msg?: string): void;
 /**
  * @param source {number}
  * @param control {number}

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

@@ -20,3 +20,8 @@ export namespace DLSSources {
     let fineTune: number;
     let coarseTune: number;
 }
+export const DEFAULT_DLS_REVERB: Modulator;
+export const DEFAULT_DLS_CHORUS: Modulator;
+export const DLS_1_NO_VIBRATO_MOD: Modulator;
+export const DLS_1_NO_VIBRATO_PRESSURE: Modulator;
+import { Modulator } from "../basic_soundfont/modulator.js";

package/@types/synthetizer/synth_event_handler.d.ts

@@ -96,6 +96,11 @@ export class EventHandler {
      * @type {Object<EventTypes, Object<string, function(EventCallbackData)>>}
      */
     events: any;
+    /**
+     * Set to 0 to disabled, otherwise in seconds
+     * @type {number}
+     */
+    timeDelay: number;
     /**
      * Adds a new event listener
      * @param name {EventTypes}

package/@types/utils/byte_functions/string.d.ts

@@ -12,6 +12,11 @@ export function readBytesAsString(dataArray: IndexedByteArray, bytes: number, en
  * @returns {IndexedByteArray}
  */
 export function getStringBytes(string: string, padLength?: number): IndexedByteArray;
+/**
+ * @param string {string}
+ * @returns {IndexedByteArray}
+ */
+export function getStringBytesZero(string: string): IndexedByteArray;
 /**
  * @param string {string}
  * @param outArray {IndexedByteArray}

package/midi_parser/rmidi_writer.js

@@ -1,7 +1,7 @@
 import { combineArrays, IndexedByteArray } from "../utils/indexed_array.js";
 import { writeMIDIFile } from "./midi_writer.js";
 import { writeRIFFOddSize } from "../soundfont/basic_soundfont/riff_chunk.js";
-import { getStringBytes } from "../utils/byte_functions/string.js";
+import { getStringBytes, getStringBytesZero } from "../utils/byte_functions/string.js";
 import { messageTypes, midiControllers, MidiMessage } from "./midi_message.js";
 import { DEFAULT_PERCUSSION } from "../synthetizer/synthetizer.js";
 import { getGsOn } from "./midi_editor.js";
@@ -409,7 +409,7 @@ export function writeRMIDI(
             minute: "numeric"
         });
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.creationDate, getStringBytes(today), true)
+            writeRIFFOddSize(RMIDINFOChunks.creationDate, getStringBytesZero(today), true)
         );
     }
     // comment
@@ -471,7 +471,7 @@ 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))
+            writeRIFFOddSize(RMIDINFOChunks.copyright, getStringBytesZero(copyright))
         );
     }
     
@@ -488,7 +488,7 @@ export function writeRMIDI(
         encoding = FORCED_ENCODING;
     }
     // encoding
-    infoContent.push(writeRIFFOddSize(RMIDINFOChunks.encoding, getStringBytes(encoding)));
+    infoContent.push(writeRIFFOddSize(RMIDINFOChunks.encoding, getStringBytesZero(encoding)));
     
     // combine and write out
     const infodata = combineArrays(infoContent);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spessasynth_lib",
-  "version": "3.23.3",
+  "version": "3.23.6",
   "description": "MIDI and SoundFont2/DLS library with no compromises",
   "browser": "index.js",
   "types": "@types/index.d.ts",

package/soundfont/basic_soundfont/modulator.js

@@ -108,14 +108,16 @@ export class Modulator
     /**
      * @param mod1 {Modulator}
      * @param mod2 {Modulator}
+     * @param checkAmount {boolean}
      * @returns {boolean}
      */
-    static isIdentical(mod1, mod2)
+    static isIdentical(mod1, mod2, checkAmount = false)
     {
         return (mod1.sourceEnum === mod2.sourceEnum)
             && (mod1.modulatorDestination === mod2.modulatorDestination)
             && (mod1.secondarySourceEnum === mod2.secondarySourceEnum)
-            && (mod1.transformType === mod2.transformType);
+            && (mod1.transformType === mod2.transformType)
+            && (!checkAmount || (mod1.transformAmount === mod2.transformAmount));
     }
     
     /**

package/soundfont/basic_soundfont/riff_chunk.js

@@ -101,7 +101,7 @@ export function writeRIFFOddSize(header, data, addZeroByte = false, isList = fal
     if (addZeroByte)
     {
         const tempData = new Uint8Array(data.length + 1);
-        tempData.set(data, 0);
+        tempData.set(data);
         data = tempData;
     }
     let offset = 8;

package/soundfont/basic_soundfont/write_dls/art2.js

@@ -5,6 +5,13 @@ import { Generator, generatorTypes } from "../generator.js";
 import { writeDword } from "../../../utils/byte_functions/little_endian.js";
 import { consoleColors } from "../../../utils/other.js";
 import { SpessaSynthInfo, SpessaSynthWarn } from "../../../utils/loggin.js";
+import { Modulator } from "../modulator.js";
+import {
+    DEFAULT_DLS_CHORUS,
+    DEFAULT_DLS_REVERB,
+    DLS_1_NO_VIBRATO_MOD,
+    DLS_1_NO_VIBRATO_PRESSURE
+} from "../../dls/dls_sources.js";
 
 const invalidGeneratorTypes = new Set([
     generatorTypes.sampleModes,
@@ -108,6 +115,16 @@ export function writeArticulator(zone)
      */
     const modulators = zone.modulators.reduce((arrs, m) =>
     {
+        // do not write the default DLS modulators
+        if (
+            Modulator.isIdentical(m, DEFAULT_DLS_CHORUS, true) ||
+            Modulator.isIdentical(m, DEFAULT_DLS_REVERB, true) ||
+            Modulator.isIdentical(m, DLS_1_NO_VIBRATO_MOD, true) ||
+            Modulator.isIdentical(m, DLS_1_NO_VIBRATO_PRESSURE, true)
+        )
+        {
+            return arrs;
+        }
         const art = getDLSArticulatorFromSf2Modulator(m);
         if (art !== undefined)
         {

package/soundfont/basic_soundfont/write_dls/ins.js

@@ -3,7 +3,7 @@ import { combineZones } from "./combine_zones.js";
 import { writeRIFFOddSize } from "../riff_chunk.js";
 import { writeDword } from "../../../utils/byte_functions/little_endian.js";
 import { writeDLSRegion } from "./rgn2.js";
-import { getStringBytes } from "../../../utils/byte_functions/string.js";
+import { getStringBytesZero } from "../../../utils/byte_functions/string.js";
 import { writeArticulator } from "./art2.js";
 import { SpessaSynthGroupCollapsed, SpessaSynthGroupEnd } from "../../../utils/loggin.js";
 import { consoleColors } from "../../../utils/other.js";
@@ -84,7 +84,7 @@ export function writeIns(preset)
     // writeINFO
     const inam = writeRIFFOddSize(
         "INAM",
-        getStringBytes(preset.presetName)
+        getStringBytesZero(preset.presetName)
     );
     const info = writeRIFFOddSize(
         "INFO",

package/soundfont/basic_soundfont/write_dls/modulator_converter.js

@@ -257,7 +257,7 @@ export function getDLSArticulatorFromSf2Modulator(mod)
         return undefined;
     }
     let source = getDLSSourceFromSf2Source(mod.sourceUsesCC, mod.sourceIndex);
-    let sourceCurve = mod.sourceCurveType;
+    let sourceTransformType = mod.sourceCurveType;
     let sourceBipolar = mod.sourcePolarity;
     let sourceDirection = mod.sourceDirection;
     if (source === undefined)
@@ -265,8 +265,13 @@ export function getDLSArticulatorFromSf2Modulator(mod)
         SpessaSynthWarn(`Invalid source: ${mod.sourceIndex}, CC: ${mod.sourceUsesCC}`);
         return undefined;
     }
+    // attenuation is the opposite of gain. Invert
+    if (mod.modulatorDestination === generatorTypes.initialAttenuation)
+    {
+        sourceDirection = sourceDirection === 1 ? 0 : 1;
+    }
     let control = getDLSSourceFromSf2Source(mod.secSrcUsesCC, mod.secSrcIndex);
-    let controlCurve = mod.secSrcCurveType;
+    let controlTransformType = mod.secSrcCurveType;
     let controlBipolar = mod.secSrcPolarity;
     let controlDirection = mod.secSrcDirection;
     if (control === undefined)
@@ -288,12 +293,12 @@ export function getDLSArticulatorFromSf2Modulator(mod)
         amt = specialCombo.amt;
         // move source to control
         control = source;
-        controlCurve = sourceCurve;
+        controlTransformType = sourceTransformType;
         controlBipolar = sourceBipolar;
         controlDirection = sourceDirection;
         
         // set source as static as it's either: env, lfo or keynum
-        sourceCurve = modulatorCurveTypes.linear;
+        sourceTransformType = modulatorCurveTypes.linear;
         sourceBipolar = specialCombo.isBipolar ? 1 : 0;
         sourceDirection = 0;
         source = specialCombo.source;
@@ -307,11 +312,12 @@ export function getDLSArticulatorFromSf2Modulator(mod)
     
     // source curve type maps to desfont curve type in section 2.10, table 9
     let transform = 0;
-    transform |= controlCurve << 4;
+    transform |= controlTransformType << 4;
     transform |= controlBipolar << 8;
     transform |= controlDirection << 9;
     
-    transform |= sourceCurve << 10;
+    // use use the source curve in output transform
+    transform |= sourceTransformType;
     transform |= sourceBipolar << 14;
     transform |= sourceDirection << 15;
     return new Articulator(

package/soundfont/basic_soundfont/write_dls/rgn2.js

@@ -14,14 +14,14 @@ import { writeArticulator } from "./art2.js";
 export function writeDLSRegion(zone, globalZone)
 {
     // region header
-    const rgnhData = new IndexedByteArray(14);
+    const rgnhData = new IndexedByteArray(12);
     // keyRange
     writeWord(rgnhData, Math.max(zone.keyRange.min, 0));
     writeWord(rgnhData, zone.keyRange.max);
     // velRange
     writeWord(rgnhData, Math.max(zone.velRange.min, 0));
     writeWord(rgnhData, zone.velRange.max);
-    // fusOptions
+    // fusOptions: 0 it seems
     writeWord(rgnhData, 0);
     // keyGroup (exclusive class)
     const exclusive = zone.getGeneratorValue(generatorTypes.exclusiveClass, 0);
@@ -71,21 +71,22 @@ export function writeDLSRegion(zone, globalZone)
     const wlnkData = new IndexedByteArray(12);
     writeWord(wlnkData, 0); // fusOptions
     writeWord(wlnkData, 0); // usPhaseGroup
-    let sampleType = 0;
-    switch (zone.sample.sampleType)
-    {
-        default:
-        case 1:
-        case 4:
-            // mono/left
-            sampleType = 0;
-            break;
-        
-        case 2:
-            // right
-            sampleType = 1;
-    }
-    writeDword(wlnkData, sampleType); // ulChannel
+    // let sampleType = 0;
+    // switch (zone.sample.sampleType)
+    // {
+    //     default:
+    //     case 1:
+    //     case 4:
+    //         // mono/left
+    //         sampleType = 0;
+    //         break;
+    //
+    //     case 2:
+    //         // right
+    //         sampleType = 1;
+    // }
+    // 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(
         "wlnk",
@@ -93,14 +94,18 @@ export function writeDLSRegion(zone, globalZone)
     );
     
     // art
-    const art2 = writeArticulator(zone);
-    
-    const lar2 = writeRIFFOddSize(
-        "lar2",
-        art2,
-        false,
-        true
-    );
+    let lar2 = new IndexedByteArray(0);
+    if (zone.modulators.length + zone.generators.length > 0)
+    {
+        const art2 = writeArticulator(zone);
+        
+        lar2 = writeRIFFOddSize(
+            "lar2",
+            art2,
+            false,
+            true
+        );
+    }
     
     return writeRIFFOddSize(
         "rgn2",

package/soundfont/basic_soundfont/write_dls/wave.js

@@ -2,7 +2,7 @@ import { combineArrays, IndexedByteArray } from "../../../utils/indexed_array.js
 import { writeDword, writeWord } from "../../../utils/byte_functions/little_endian.js";
 import { writeRIFFOddSize } from "../riff_chunk.js";
 import { writeWavesample } from "./wsmp.js";
-import { getStringBytes } from "../../../utils/byte_functions/string.js";
+import { getStringBytesZero } from "../../../utils/byte_functions/string.js";
 import { SpessaSynthInfo } from "../../../utils/loggin.js";
 import { consoleColors } from "../../../utils/other.js";
 
@@ -23,6 +23,11 @@ export function writeDLSSample(sample)
         "fmt ",
         fmtData
     );
+    let loop = 1;
+    if (sample.sampleLoopStartIndex + Math.abs(sample.getAudioData().length - sample.sampleLoopEndIndex) < 2)
+    {
+        loop = 0;
+    }
     const wsmp = writeWavesample(
         sample,
         sample.samplePitch,
@@ -30,7 +35,7 @@ export function writeDLSSample(sample)
         0,
         sample.sampleLoopStartIndex,
         sample.sampleLoopEndIndex,
-        1
+        loop
     );
     const audio = sample.getAudioData();
     let data;
@@ -60,7 +65,7 @@ export function writeDLSSample(sample)
     
     const inam = writeRIFFOddSize(
         "INAM",
-        getStringBytes(sample.sampleName)
+        getStringBytesZero(sample.sampleName)
     );
     const info = writeRIFFOddSize(
         "INFO",

package/soundfont/basic_soundfont/write_dls/write_dls.js

@@ -2,7 +2,7 @@ import { writeRIFFOddSize } from "../riff_chunk.js";
 import { writeDword } from "../../../utils/byte_functions/little_endian.js";
 import { combineArrays, IndexedByteArray } from "../../../utils/indexed_array.js";
 import { writeLins } from "./lins.js";
-import { getStringBytes, writeStringAsBytes } from "../../../utils/byte_functions/string.js";
+import { getStringBytesZero, writeStringAsBytes } from "../../../utils/byte_functions/string.js";
 import { writeWavePool } from "./wvpl.js";
 import { SpessaSynthGroupCollapsed, SpessaSynthGroupEnd, SpessaSynthInfo } from "../../../utils/loggin.js";
 import { consoleColors } from "../../../utils/other.js";
@@ -80,7 +80,8 @@ export function writeDLS()
         infos.push(
             writeRIFFOddSize(
                 info,
-                getStringBytes(data)
+                getStringBytesZero(data),
+                true
             )
         );
     }

package/soundfont/basic_soundfont/write_dls/wsmp.js

@@ -37,8 +37,8 @@ export function writeWavesample(
     // gain correction:  Each unit of gain represents 1/655360 dB
     const lGain = Math.floor(attenuationCb * -65536);
     writeDword(wsmpData, lGain);
-    // fulOptions
-    writeDword(wsmpData, 0);
+    // fulOptions: has to be 2 according to all DLS files I have
+    writeDword(wsmpData, 2);
     
     const loopSize = loopEnd - loopStart;
     let ulLoopType = 0;

package/soundfont/dls/articulator_converter.js

@@ -188,13 +188,15 @@ function checkForSpecialDLSCombo(source, destination)
  * @param destination {number}
  * @param value {number}
  * @param transform {number}
+ * @param msg {string}
  */
-function modulatorConverterDebug(
+export function modulatorConverterDebug(
     source,
     control,
     destination,
     value,
-    transform
+    transform,
+    msg = "Attempting to convert the following DLS Articulator to SF2 Modulator:"
 )
 {
     const type = Object.keys(DLSDestinations).find(k => DLSDestinations[k] === destination);
@@ -204,7 +206,7 @@ function modulatorConverterDebug(
     const srcString = srcType ? srcType : source.toString(16);
     const ctrlString = ctrlType ? ctrlType : control.toString(16);
     console.debug(
-        `%cAttempting to convert the following DLS Articulator to SF2 Modulator:
+        `%c${msg}
         Source: %c${srcString}%c
         Control: %c${ctrlString}%c
         Destination: %c${typeString}%c
@@ -240,6 +242,13 @@ export function getSF2ModulatorFromArticulator(
     value
 )
 {
+    // modulatorConverterDebug(
+    //     source,
+    //     control,
+    //     destination,
+    //     value,
+    //     transform
+    // );
     // check for special combinations
     const specialDestination = checkForSpecialDLSCombo(source, destination);
     /**
@@ -320,13 +329,6 @@ export function getSF2ModulatorFromArticulator(
         // special case: for attenuation, invert source (dls gain is the opposite of sf2 attenuation)
         if (destinationGenerator === generatorTypes.initialAttenuation)
         {
-            // modulatorConverterDebug(
-            //     source,
-            //     control,
-            //     destination,
-            //     value,
-            //     transform
-            // );
             // if the value is negative, the source shall be negative!
             // why?
             // Idk, it makes it work with ROCK.RMI and NOKIA_S30.dls

package/soundfont/dls/dls_sources.js

@@ -1,3 +1,6 @@
+import { Modulator } from "../basic_soundfont/modulator.js";
+import { generatorTypes } from "../basic_soundfont/generator.js";
+
 /**
  * @enum {number}
  */
@@ -23,4 +26,36 @@ export const DLSSources = {
     pitchWheelRange: 0x100,
     fineTune: 0x101,
     coarseTune: 0x102
-};
+};
+
+export const DEFAULT_DLS_REVERB = new Modulator({
+    srcEnum: 0x00DB,
+    dest: generatorTypes.reverbEffectsSend,
+    amt: 1000,
+    secSrcEnum: 0x0,
+    transform: 0
+});
+
+export const DEFAULT_DLS_CHORUS = new Modulator({
+    srcEnum: 0x00DD,
+    dest: generatorTypes.chorusEffectsSend,
+    amt: 1000,
+    secSrcEnum: 0x0,
+    transform: 0
+});
+
+export const DLS_1_NO_VIBRATO_MOD = new Modulator({
+    srcEnum: 0x0081,
+    dest: generatorTypes.vibLfoToPitch,
+    amt: 0,
+    secSrcEnum: 0x0,
+    transform: 0
+});
+
+export const DLS_1_NO_VIBRATO_PRESSURE = new Modulator({
+    srcEnum: 0x000D,
+    dest: generatorTypes.vibLfoToPitch,
+    amt: 0,
+    secSrcEnum: 0x0,
+    transform: 0
+});

package/soundfont/dls/read_articulation.js

@@ -1,6 +1,6 @@
 import { readLittleEndian } from "../../utils/byte_functions/little_endian.js";
 import { DLSDestinations } from "./dls_destinations.js";
-import { DLSSources } from "./dls_sources.js";
+import { DLS_1_NO_VIBRATO_MOD, DLS_1_NO_VIBRATO_PRESSURE, DLSSources } from "./dls_sources.js";
 import { getSF2ModulatorFromArticulator } from "./articulator_converter.js";
 import { SpessaSynthInfo, SpessaSynthWarn } from "../../utils/loggin.js";
 import { consoleColors } from "../../utils/other.js";
@@ -306,21 +306,9 @@ export function readArticulation(chunk, disableVibrato)
     {
         modulators.push(
             // mod to vib
-            new Modulator({
-                srcEnum: 0x0081,
-                dest: generatorTypes.vibLfoToPitch,
-                amt: 0,
-                secSrcEnum: 0x0,
-                transform: 0
-            }),
+            Modulator.copy(DLS_1_NO_VIBRATO_MOD),
             // press to vib
-            new Modulator({
-                srcEnum: 0x000D,
-                dest: generatorTypes.vibLfoToPitch,
-                amt: 0,
-                secSrcEnum: 0x0,
-                transform: 0
-            })
+            Modulator.copy(DLS_1_NO_VIBRATO_PRESSURE)
         );
     }
     

package/soundfont/dls/read_instrument.js

@@ -7,6 +7,7 @@ import { BasicInstrumentZone } from "../basic_soundfont/basic_zones.js";
 import { consoleColors } from "../../utils/other.js";
 import { generatorLimits, generatorTypes } from "../basic_soundfont/generator.js";
 import { Modulator } from "../basic_soundfont/modulator.js";
+import { DEFAULT_DLS_CHORUS, DEFAULT_DLS_REVERB } from "./dls_sources.js";
 
 /**
  * @this {DLSSoundFont}
@@ -85,24 +86,12 @@ export function readDLSInstrument(chunk)
     // reverb
     if (globalZone.modulators.find(m => m.modulatorDestination === generatorTypes.reverbEffectsSend) === undefined)
     {
-        globalZone.modulators.push(new Modulator({
-            srcEnum: 0x00DB,
-            dest: generatorTypes.reverbEffectsSend,
-            amt: 1000,
-            secSrcEnum: 0x0,
-            transform: 0
-        }));
+        globalZone.modulators.push(Modulator.copy(DEFAULT_DLS_REVERB));
     }
     // chorus
     if (globalZone.modulators.find(m => m.modulatorDestination === generatorTypes.chorusEffectsSend) === undefined)
     {
-        globalZone.modulators.push(new Modulator({
-            srcEnum: 0x00DD,
-            dest: generatorTypes.chorusEffectsSend,
-            amt: 1000,
-            secSrcEnum: 0x0,
-            transform: 0
-        }));
+        globalZone.modulators.push(Modulator.copy(DEFAULT_DLS_CHORUS));
     }
     preset.DLSInstrument.instrumentZones.push(globalZone);
     

package/synthetizer/synth_event_handler.js

@@ -119,6 +119,12 @@ export class EventHandler
             "allcontrollerreset": {},
             "soundfonterror": {}
         };
+        
+        /**
+         * Set to 0 to disabled, otherwise in seconds
+         * @type {number}
+         */
+        this.timeDelay = 0;
     }
     
     /**
@@ -151,7 +157,17 @@ export class EventHandler
     {
         if (this.events[name])
         {
-            Object.values(this.events[name]).forEach(ev => ev(eventData));
+            if (this.timeDelay > 0)
+            {
+                setTimeout(() =>
+                {
+                    Object.values(this.events[name]).forEach(ev => ev(eventData));
+                }, this.timeDelay * 1000);
+            }
+            else
+            {
+                Object.values(this.events[name]).forEach(ev => ev(eventData));
+            }
         }
     }
 }