spessasynth_lib 3.24.26 → 3.24.27

package/README.md

@@ -32,13 +32,28 @@ document.getElementById("button").onclick = async () =>
 
 ## Current Features
 
+### Numerous Format Support
+Supported formats list:
+- `.mid` - Standard MIDI File
+- `.kar` - Soft Karaoke MIDI File
+- `.sf2` - SoundFont2 File
+- `.sf3` - SoundFont2 Compressed File
+- `.sfogg` - SF2Pack With Vorbis Compression
+- `.dls` - Downloadable Sounds Levels 1 & 2 (as well as Mobile DLS)
+- `.rmi` - RIFF MIDI File
+- `.rmi` - RIFF MIDI File With Embedded DLS
+- `.rmi` - [RIFF MIDI File With Embedded SF2](https://github.com/spessasus/sf2-rmidi-specification)
+
+*With [an easy way of converting between them!](https://github.com/spessasus/SpessaSynth/wiki/Converting-Between-Formats)*
+
 ### Easy Integration
-- **Modular design:** Easy integration into other projects (load what you need)
-- **[Detailed documentation:](https://github.com/spessasus/SpessaSynth/wiki/Home)** With [examples!](https://github.com/spessasus/SpessaSynth/wiki/Usage-As-Library#examples)
-- **Easy to Use:** basic setup is just [two lines of code!](https://github.com/spessasus/SpessaSynth/wiki/Usage-As-Library#minimal-setup)
-- **No dependencies:** _batteries included!_
+- **Modular design:** *Easy integration into other projects (load what you need)*
+- **[Detailed documentation:](https://github.com/spessasus/SpessaSynth/wiki/Home)** *With [examples!](https://github.com/spessasus/SpessaSynth/wiki/Usage-As-Library#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/wiki/Usage-As-Library#minimal-setup)*
+- **No dependencies:** *Batteries included!*
 
-### Powerful SoundFont Synthesizer
+### Powerful Synthesizer
 - Suitable for both **real-time** and **offline** synthesis
 - **Excellent SoundFont support:**
   - **Full Generator Support**
@@ -63,19 +78,22 @@ document.getElementById("button").onclick = async () =>
 - **[Custom modulators for additional controllers](https://github.com/spessasus/SpessaSynth/wiki/Modulator-Class#default-modulators):** *Why not?*
 - **Written using AudioWorklets:** 
   - Runs in a **separate thread** for maximum performance
+  - Doesn't stop playing even when the main thread is frozen
   - Supported by all modern browsers
 - **Unlimited channel count:** Your CPU is the limit!
 - **Excellent MIDI Standards Support:**
   - **MIDI Controller Support:** Default supported controllers [here](https://github.com/spessasus/SpessaSynth/wiki/MIDI-Implementation#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/wiki/MIDI-Implementation#midi-tuning-standard)
   - [Full **RPN** and limited **NRPN** support](https://github.com/spessasus/SpessaSynth/wiki/MIDI-Implementation#supported-registered-parameters)
   - Supports some [**Roland GS** and **Yamaha XG** system exclusives](https://github.com/spessasus/SpessaSynth/wiki/MIDI-Implementation#supported-system-exclusives)
-- **High-performance mode:** Play Rush E! _note: may kill your browser ;)_
+- **High-performance mode:** Play Rush E! *note: may kill your browser ;)*
 
-### Built-in Powerful and Fast Sequencer
-- **Supports MIDI formats 0, 1, and 2:** _note: format 2 support is experimental as it's very, very rare_
+### Powerful and Fast MIDI Sequencer
+- **Supports MIDI formats 0, 1, and 2:** *note: format 2 support is experimental as it's very, very rare.*
 - **[Multi-Port MIDI](https://github.com/spessasus/SpessaSynth/wiki/About-Multi-Port) support:** More than 16 channels!
-- **Smart preloading:** Only preloads the samples used in the MIDI file for smooth playback (down to key and velocity!)
+- **Smart preloading:** Only preloads the samples used in the MIDI file for smooth playback *(down to key and velocity!)*
 - **Lyrics support:** Add karaoke to your program!
 - **Raw lyrics available:** Decode in any encoding! *(Kanji? No problem!)*
 - **Runs in Audio Thread as well:** Never blocks the main thread
@@ -89,7 +107,7 @@ document.getElementById("button").onclick = async () =>
   - **Used channels on track:** Quickly determine which channels are used
   - **Key range detection:** Detect the key range of the MIDI
   - **Easy MIDI editing:** Use [helper functions](https://github.com/spessasus/SpessaSynth/wiki/Writing-MIDI-Files#modifymidi) to modify the song to your needs!
-  - **Loop detection:** Automatically detects loops in MIDIs (e.g., from _Touhou Project_)
+  - **Loop detection:** Automatically detects loops in MIDIs (e.g., from *Touhou Project*)
   - **First note detection:** Skip unnecessary silence at the start by jumping to the first note!
   - **Lyrics support:** Both regular MIDI and .kar files!
   - **[Write MIDI files from scratch](https://github.com/spessasus/SpessaSynth/wiki/Creating-MIDI-Files)**

package/midi_parser/basic_midi.js

@@ -92,9 +92,6 @@ export class BasicMIDI extends MIDISequenceData
          * @type {boolean}
          */
         let karaokeHasTitle = false;
-        let portOffset = 0;
-        this.midiPorts = [];
-        this.midiPortChannelOffsets = [];
         
         this.keyRange = { max: 0, min: 127 };
         
@@ -126,7 +123,6 @@ export class BasicMIDI extends MIDISequenceData
         {
             const track = this.tracks[i];
             const usedChannels = new Set();
-            this.midiPorts.push(-1);
             let trackHasVoiceMessages = false;
             
             for (const e of track)
@@ -230,16 +226,6 @@ export class BasicMIDI extends MIDISequenceData
                         e.messageData.currentIndex = 0;
                         break;
                     
-                    case messageTypes.midiPort:
-                        const port = e.messageData[0];
-                        this.midiPorts[i] = port;
-                        if (this.midiPortChannelOffsets[port] === undefined)
-                        {
-                            this.midiPortChannelOffsets[port] = portOffset;
-                            portOffset += 16;
-                        }
-                        break;
-                    
                     case messageTypes.copyright:
                         if (!copyrightDetected)
                         {
@@ -399,6 +385,33 @@ export class BasicMIDI extends MIDISequenceData
             consoleColors.recognized
         );
         
+        // determine ports
+        let portOffset = 0;
+        this.midiPorts = [];
+        this.midiPortChannelOffsets = [];
+        for (let trackNum = 0; trackNum < this.tracks.length; trackNum++)
+        {
+            this.midiPorts.push(-1);
+            if (this.usedChannelsOnTrack[trackNum].size === 0)
+            {
+                continue;
+            }
+            for (const e of this.tracks[trackNum])
+            {
+                if (e.messageStatusByte !== messageTypes.midiPort)
+                {
+                    continue;
+                }
+                const port = e.messageData[0];
+                this.midiPorts[trackNum] = port;
+                if (this.midiPortChannelOffsets[port] === undefined)
+                {
+                    this.midiPortChannelOffsets[port] = portOffset;
+                    portOffset += 16;
+                }
+            }
+        }
+        
         // fix midi ports:
         // midi tracks without ports will have a value of -1
         // if all ports have a value of -1, set it to 0,
@@ -408,15 +421,21 @@ export class BasicMIDI extends MIDISequenceData
         // but leave the conductor track with no port pref.
         // this spessasynth to reserve the first 16 channels for the conductor track
         // (which doesn't play anything) and use the additional 16 for the actual ports.
-        let defaultPort = 0;
+        let defaultPort = Infinity;
         for (let port of this.midiPorts)
         {
             if (port !== -1)
             {
-                defaultPort = port;
-                break;
+                if (defaultPort > port)
+                {
+                    defaultPort = port;
+                }
             }
         }
+        if (defaultPort === Infinity)
+        {
+            defaultPort = 0;
+        }
         this.midiPorts = this.midiPorts.map(port => port === -1 ? defaultPort : port);
         // add fake port if empty
         if (this.midiPortChannelOffsets.length === 0)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spessasynth_lib",
-  "version": "3.24.26",
+  "version": "3.24.27",
   "description": "MIDI and SoundFont2/DLS library with no compromises",
   "browser": "index.js",
   "type": "module",

package/soundfont/basic_soundfont/modulator.js

@@ -33,19 +33,50 @@ export class Modulator
     currentValue = 0;
     
     /**
-     * Creates a modulator
-     * @param params {{srcEnum: number, secSrcEnum: number, dest: generatorTypes, amt: number, transform: number}}
+     * The source enumeration for this modulator
+     * @type {number}
+     */
+    sourceEnum;
+    
+    /**
+     * The secondary source enumeration for this modulator
+     * @type {number}
      */
-    constructor(params)
+    secondarySourceEnum;
+    
+    /**
+     * The generator destination of this modulator
+     * @type {generatorTypes}
+     */
+    modulatorDestination;
+    
+    /**
+     * The transform amount for this modulator
+     * @type {number}
+     */
+    transformAmount;
+    
+    /**
+     * The transform type for this modulator
+     * @type {0|2}
+     */
+    transformType;
+    
+    /**
+     * creates a modulator
+     * @param srcEnum {number}
+     * @param secSrcEnum {number}
+     * @param destination {generatorTypes|number}
+     * @param amount {number}
+     * @param transformType {number}
+     */
+    constructor(srcEnum, secSrcEnum, destination, amount, transformType)
     {
-        this.sourceEnum = params.srcEnum;
-        /**
-         * @type {generatorTypes}
-         */
-        this.modulatorDestination = params.dest;
-        this.secondarySourceEnum = params.secSrcEnum;
-        this.transformAmount = params.amt;
-        this.transformType = params.transform;
+        this.sourceEnum = srcEnum;
+        this.modulatorDestination = destination;
+        this.secondarySourceEnum = secSrcEnum;
+        this.transformAmount = amount;
+        this.transformType = transformType;
         
         
         if (this.modulatorDestination > 58)
@@ -96,13 +127,13 @@ export class Modulator
      */
     static copy(modulator)
     {
-        return new Modulator({
-            srcEnum: modulator.sourceEnum,
-            secSrcEnum: modulator.secondarySourceEnum,
-            transform: modulator.transformType,
-            amt: modulator.transformAmount,
-            dest: modulator.modulatorDestination
-        });
+        return new Modulator(
+            modulator.sourceEnum,
+            modulator.secondarySourceEnum,
+            modulator.modulatorDestination,
+            modulator.transformAmount,
+            modulator.transformType
+        );
     }
     
     /**
@@ -121,62 +152,63 @@ export class Modulator
     }
     
     /**
-     * Sum transform and create a NEW modulator
-     * @param modulator {Modulator}
-     * @returns {Modulator}
-     */
-    sumTransform(modulator)
-    {
-        return new Modulator({
-            srcEnum: this.sourceEnum,
-            secSrcEnum: this.secondarySourceEnum,
-            dest: this.modulatorDestination,
-            transform: this.transformType,
-            amt: this.transformAmount + modulator.transformAmount
-        });
-    }
-    
-    /**
+     * @param mod {Modulator}
      * @returns {string}
      */
-    debugString()
+    static debugString(mod)
     {
         function getKeyByValue(object, value)
         {
             return Object.keys(object).find(key => object[key] === value);
         }
         
-        let sourceString = getKeyByValue(modulatorCurveTypes, this.sourceCurveType);
-        sourceString += this.sourcePolarity === 0 ? " unipolar " : " bipolar ";
-        sourceString += this.sourceDirection === 0 ? "forwards " : "backwards ";
-        if (this.sourceUsesCC)
+        let sourceString = getKeyByValue(modulatorCurveTypes, mod.sourceCurveType);
+        sourceString += mod.sourcePolarity === 0 ? " unipolar " : " bipolar ";
+        sourceString += mod.sourceDirection === 0 ? "forwards " : "backwards ";
+        if (mod.sourceUsesCC)
         {
-            sourceString += getKeyByValue(midiControllers, this.sourceIndex);
+            sourceString += getKeyByValue(midiControllers, mod.sourceIndex);
         }
         else
         {
-            sourceString += getKeyByValue(modulatorSources, this.sourceIndex);
+            sourceString += getKeyByValue(modulatorSources, mod.sourceIndex);
         }
         
-        let secSrcString = getKeyByValue(modulatorCurveTypes, this.secSrcCurveType);
-        secSrcString += this.secSrcPolarity === 0 ? " unipolar " : " bipolar ";
-        secSrcString += this.secSrcCurveType === 0 ? "forwards " : "backwards ";
-        if (this.secSrcUsesCC)
+        let secSrcString = getKeyByValue(modulatorCurveTypes, mod.secSrcCurveType);
+        secSrcString += mod.secSrcPolarity === 0 ? " unipolar " : " bipolar ";
+        secSrcString += mod.secSrcCurveType === 0 ? "forwards " : "backwards ";
+        if (mod.secSrcUsesCC)
         {
-            secSrcString += getKeyByValue(midiControllers, this.secSrcIndex);
+            secSrcString += getKeyByValue(midiControllers, mod.secSrcIndex);
         }
         else
         {
-            secSrcString += getKeyByValue(modulatorSources, this.secSrcIndex);
+            secSrcString += getKeyByValue(modulatorSources, mod.secSrcIndex);
         }
         return `Modulator:
         Source: ${sourceString}
         Secondary source: ${secSrcString}
-        Destination: ${getKeyByValue(generatorTypes, this.modulatorDestination)}
-        Trasform amount: ${this.transformAmount}
-        Transform type: ${this.transformType}
+        Destination: ${getKeyByValue(generatorTypes, mod.modulatorDestination)}
+        Trasform amount: ${mod.transformAmount}
+        Transform type: ${mod.transformType}
         \n\n`;
     }
+    
+    /**
+     * Sum transform and create a NEW modulator
+     * @param modulator {Modulator}
+     * @returns {Modulator}
+     */
+    sumTransform(modulator)
+    {
+        return new Modulator(
+            this.sourceEnum,
+            this.secondarySourceEnum,
+            this.modulatorDestination,
+            this.transformAmount + modulator.transformAmount,
+            this.transformType
+        );
+    }
 }
 
 export const DEFAULT_ATTENUATION_MOD_AMOUNT = 960;
@@ -189,155 +221,155 @@ export function getModSourceEnum(curveType, polarity, direction, isCC, index)
 
 const soundFontModulators = [
     // vel to attenuation
-    new Modulator({
-        srcEnum: getModSourceEnum(
+    new Modulator(
+        getModSourceEnum(
             DEFAULT_ATTENUATION_MOD_CURVE_TYPE,
             0,
             1,
             0,
             modulatorSources.noteOnVelocity
         ),
-        dest: generatorTypes.initialAttenuation,
-        amt: DEFAULT_ATTENUATION_MOD_AMOUNT,
-        secSrcEnum: 0x0,
-        transform: 0
-    }),
+        0x0,
+        generatorTypes.initialAttenuation,
+        DEFAULT_ATTENUATION_MOD_AMOUNT,
+        0
+    ),
     
     // mod wheel to vibrato
-    new Modulator({ srcEnum: 0x0081, dest: generatorTypes.vibLfoToPitch, amt: 50, secSrcEnum: 0x0, transform: 0 }),
+    new Modulator(0x0081, 0x0, generatorTypes.vibLfoToPitch, 50, 0),
     
     // vol to attenuation
-    new Modulator({
-        srcEnum: getModSourceEnum(
+    new Modulator(
+        getModSourceEnum(
             DEFAULT_ATTENUATION_MOD_CURVE_TYPE,
             0,
             1,
             1,
             midiControllers.mainVolume
         ),
-        dest: generatorTypes.initialAttenuation,
-        amt: DEFAULT_ATTENUATION_MOD_AMOUNT,
-        secSrcEnum: 0x0,
-        transform: 0
-    }),
+        0x0,
+        generatorTypes.initialAttenuation,
+        DEFAULT_ATTENUATION_MOD_AMOUNT,
+        0
+    ),
     
     // channel pressure to vibrato
-    new Modulator({ srcEnum: 0x000D, dest: generatorTypes.vibLfoToPitch, amt: 50, secSrcEnum: 0x0, transform: 0 }),
+    new Modulator(0x000D, 0x0, generatorTypes.vibLfoToPitch, 50, 0),
     
     // pitch wheel to tuning
-    new Modulator({ srcEnum: 0x020E, dest: generatorTypes.fineTune, amt: 12700, secSrcEnum: 0x0010, transform: 0 }),
+    new Modulator(0x020E, 0x0010, generatorTypes.fineTune, 12700, 0),
     
     // pan to uhh, pan
     // amount is 500 instead of 1000, see #59
-    new Modulator({ srcEnum: 0x028A, dest: generatorTypes.pan, amt: 500, secSrcEnum: 0x0, transform: 0 }),
+    new Modulator(0x028A, 0x0, generatorTypes.pan, 500, 0),
     
     // expression to attenuation
-    new Modulator({
-        srcEnum: getModSourceEnum(
+    new Modulator(
+        getModSourceEnum(
             DEFAULT_ATTENUATION_MOD_CURVE_TYPE,
             0,
             1,
             1,
             midiControllers.expressionController
         ),
-        dest: generatorTypes.initialAttenuation,
-        amt: DEFAULT_ATTENUATION_MOD_AMOUNT,
-        secSrcEnum: 0x0,
-        transform: 0
-    }),
+        0x0,
+        generatorTypes.initialAttenuation,
+        DEFAULT_ATTENUATION_MOD_AMOUNT,
+        0
+    ),
     
     // reverb effects to send
-    new Modulator({ srcEnum: 0x00DB, dest: generatorTypes.reverbEffectsSend, amt: 200, secSrcEnum: 0x0, transform: 0 }),
+    new Modulator(0x00DB, 0x0, generatorTypes.reverbEffectsSend, 200, 0),
     
     // chorus effects to send
-    new Modulator({ srcEnum: 0x00DD, dest: generatorTypes.chorusEffectsSend, amt: 200, secSrcEnum: 0x0, transform: 0 })
+    new Modulator(0x00DD, 0x0, generatorTypes.chorusEffectsSend, 200, 0)
 ];
 
 const customModulators = [
     // custom modulators heck yeah
     // poly pressure to vibrato
-    new Modulator({
-        srcEnum: getModSourceEnum(modulatorCurveTypes.linear, 0, 0, 0, modulatorSources.polyPressure),
-        dest: generatorTypes.vibLfoToPitch,
-        amt: 50,
-        secSrcEnum: 0x0,
-        transform: 0
-    }),
+    new Modulator(
+        getModSourceEnum(modulatorCurveTypes.linear, 0, 0, 0, modulatorSources.polyPressure),
+        0x0,
+        generatorTypes.vibLfoToPitch,
+        50,
+        0
+    ),
     
     // cc 92 (tremolo) to modLFO volume
-    new Modulator({
-        srcEnum: getModSourceEnum(
+    new Modulator(
+        getModSourceEnum(
             modulatorCurveTypes.linear,
             0,
             0,
             1,
             midiControllers.tremoloDepth
         ), /*linear forward unipolar cc 92 */
-        dest: generatorTypes.modLfoToVolume,
-        amt: 24,
-        secSrcEnum: 0x0, // no controller
-        transform: 0
-    }),
+        0x0, // no controller
+        generatorTypes.modLfoToVolume,
+        24,
+        0
+    ),
     
     // cc 73 (attack time) to volEnv attack
-    new Modulator({
-        srcEnum: getModSourceEnum(
+    new Modulator(
+        getModSourceEnum(
             modulatorCurveTypes.convex,
             1,
             0,
             1,
             midiControllers.attackTime
         ), // linear forward bipolar cc 72
-        dest: generatorTypes.attackVolEnv,
-        amt: 6000,
-        secSrcEnum: 0x0, // no controller
-        transform: 0
-    }),
+        0x0, // no controller
+        generatorTypes.attackVolEnv,
+        6000,
+        0
+    ),
     
     // cc 72 (release time) to volEnv release
-    new Modulator({
-        srcEnum: getModSourceEnum(
+    new Modulator(
+        getModSourceEnum(
             modulatorCurveTypes.linear,
             1,
             0,
             1,
             midiControllers.releaseTime
         ), // linear forward bipolar cc 72
-        dest: generatorTypes.releaseVolEnv,
-        amt: 3600,
-        secSrcEnum: 0x0, // no controller
-        transform: 0
-    }),
+        0x0, // no controller
+        generatorTypes.releaseVolEnv,
+        3600,
+        0
+    ),
     
     // cc 74 (brightness) to filterFc
-    new Modulator({
-        srcEnum: getModSourceEnum(
+    new Modulator(
+        getModSourceEnum(
             modulatorCurveTypes.linear,
             1,
             0,
             1,
             midiControllers.brightness
         ), // linear forwards bipolar cc 74
-        dest: generatorTypes.initialFilterFc,
-        amt: 6000,
-        secSrcEnum: 0x0, // no controller
-        transform: 0
-    }),
+        0x0, // no controller
+        generatorTypes.initialFilterFc,
+        6000,
+        0
+    ),
     
     // cc 71 (filter Q) to filter Q
-    new Modulator({
-        srcEnum: getModSourceEnum(
+    new Modulator(
+        getModSourceEnum(
             modulatorCurveTypes.linear,
             1,
             0,
             1,
             midiControllers.filterResonance
         ), // linear forwards bipolar cc 74
-        dest: generatorTypes.initialFilterQ,
-        amt: 250,
-        secSrcEnum: 0x0, // no controller
-        transform: 0
-    })
+        0x0, // no controller
+        generatorTypes.initialFilterQ,
+        250,
+        0
+    )
 ];
 
 export const defaultModulators = soundFontModulators.concat(customModulators);

package/soundfont/dls/articulator_converter.js

@@ -384,12 +384,12 @@ export function getSF2ModulatorFromArticulator(
     }
     
     // return the modulator!
-    return new Modulator({
-        srcEnum: sourceEnumFinal,
-        secSrcEnum: secSourceEnumFinal,
-        dest: destinationGenerator,
-        transform: 0x0,
-        amt: newValue
-    });
+    return new Modulator(
+        sourceEnumFinal,
+        secSourceEnumFinal,
+        destinationGenerator,
+        newValue,
+        0x0
+    );
     
 }

package/soundfont/dls/dls_sources.js

@@ -28,34 +28,34 @@ export const DLSSources = {
     coarseTune: 0x102
 };
 
-export const DEFAULT_DLS_REVERB = new Modulator({
-    srcEnum: 0x00DB,
-    dest: generatorTypes.reverbEffectsSend,
-    amt: 1000,
-    secSrcEnum: 0x0,
-    transform: 0
-});
+export const DEFAULT_DLS_REVERB = new Modulator(
+    0x00DB,
+    0x0,
+    generatorTypes.reverbEffectsSend,
+    1000,
+    0
+);
 
-export const DEFAULT_DLS_CHORUS = new Modulator({
-    srcEnum: 0x00DD,
-    dest: generatorTypes.chorusEffectsSend,
-    amt: 1000,
-    secSrcEnum: 0x0,
-    transform: 0
-});
+export const DEFAULT_DLS_CHORUS = new Modulator(
+    0x00DD,
+    0x0,
+    generatorTypes.chorusEffectsSend,
+    1000,
+    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_MOD = new Modulator(
+    0x0081,
+    0x0,
+    generatorTypes.vibLfoToPitch,
+    0,
+    0
+);
 
-export const DLS_1_NO_VIBRATO_PRESSURE = new Modulator({
-    srcEnum: 0x000D,
-    dest: generatorTypes.vibLfoToPitch,
-    amt: 0,
-    secSrcEnum: 0x0,
-    transform: 0
-});
+export const DLS_1_NO_VIBRATO_PRESSURE = new Modulator(
+    0x000D,
+    0x0,
+    generatorTypes.vibLfoToPitch,
+    0,
+    0
+);