spessasynth_lib 3.24.4 → 3.24.6

package/README.md

@@ -43,12 +43,21 @@ document.getElementById("button").onclick = async () =>
 - **Excellent SoundFont support:**
   - **Full Generator Support**
   - **Full Modulator Support:** *First (to my knowledge) JavaScript SoundFont synth with that feature!*
-  - **GeneralUserGS Certified:** *[See more here!](https://github.com/mrbumpy409/GeneralUser-GS/blob/main/documentation/README.md)*
+  - **GeneralUserGS Compatible:** *[See more here!](https://github.com/mrbumpy409/GeneralUser-GS/blob/main/documentation/README.md)*
   - **SoundFont3 Support:** Play compressed SoundFonts!
   - **Experimental SF2Pack Support:** Play soundfonts compressed with BASSMIDI! (*Note: only works with vorbis compression*)
   - **Can load very large SoundFonts:** up to 4GB! *Note: Only Firefox handles this well; Chromium has a hard-coded memory limit*
+- **Great DLS Support:**
+  - **DLS Level 1 Support**
+  - **DLS Level 2 Support**
+  - **Mobile DLS Support**
+  - **Correct articulator support:** *Converts articulators to both modulators and generators!*
+  - **Tested and working with gm.dls!**
+  - **Correct volume:** *Properly translated to SoundFont volume!*
+  - **A-Law encoding support**
+  - **Both unsigned 8-bit and signed 16-bit sample support (24-bit theoretically supported as well!)**
+  - **Detects special articulator combinations:** *Such as vibratoLfoToPitch*
 - **Soundfont manager:** Stack multiple soundfonts!
-- **DLS Level 1 and 2 Support:** *works with gm.dls!*
 - **Reverb and chorus support:** [customizable!](https://github.com/spessasus/SpessaSynth/wiki/Synthetizer-Class#effects-configuration-object)
 - **Export audio files** using [OfflineAudioContext](https://developer.mozilla.org/en-US/docs/Web/API/OfflineAudioContext)
 - **[Custom modulators for additional controllers](https://github.com/spessasus/SpessaSynth/wiki/Modulator-Class#default-modulators):** *Why not?*
@@ -106,15 +115,16 @@ document.getElementById("button").onclick = async () =>
   - **Variable compression quality:** You choose between file size and quality!
   - **Compression preserving:** Avoid decompressing and recompressing uncompressed samples for minimal quality loss!
 
-#### Read and write DLS Level 1 or 2 files
+#### 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/wiki/SoundFont2-Class#write)*
   - Converts articulators to both **modulators** and **generators**!
   - Works with both unsigned 8-bit samples and signed 16-bit samples!
+  - A-Law encoding support
   - **Covers special generator cases:** *such as modLfoToPitch*!
   - **Correct volume:** *looking at you, Viena and gm.sf2!*
   - Support built right into the synthesizer!
-  - **Convert SF2 to DLS:** [with limitations](https://github.com/spessasus/SpessaSynth/wiki/DLS-Conversion-Problem);
+  - **Convert SF2 to DLS:** [with limitations](https://github.com/spessasus/SpessaSynth/wiki/DLS-Conversion-Problem)
 
 ### Export MIDI as WAV
   - Save the MIDI file as WAV audio!

package/midi_parser/midi_loader.js

@@ -12,7 +12,9 @@ import { BasicMIDI, MIDIticksToSeconds } from "./basic_midi.js";
 
 /**
  * midi_loader.js
- * purpose: parses a midi file for the seqyencer, including things like marker or CC 2/4 loop detection, copyright detection etc.
+ * purpose:
+ * parses a midi file for the seqyencer,
+ * including things like marker or CC 2/4 loop detection, copyright detection, etc.
  */
 
 /**
@@ -65,7 +67,7 @@ class MIDI extends BasicMIDI
                 SpessaSynthGroupEnd();
                 throw new SyntaxError(`Invalid RMIDI Chunk header! Expected "data", got "${rmid}"`);
             }
-            // this is an rmid, load the midi into array for parsing
+            // this is a rmid, load the midi into an array for parsing
             fileByteArray = riff.chunkData;
             
             // keep loading chunks until we get sfbk
@@ -87,7 +89,7 @@ class MIDI extends BasicMIDI
                     }
                     if (type === "dls ")
                     {
-                        // assume bank offset of 0 by default. If we find any bank selects, then the offset is 1.
+                        // Assume bank offset of 0 by default. If we find any bank selects, then the offset is 1.
                         DLSRMID = true;
                     }
                 }
@@ -145,7 +147,13 @@ class MIDI extends BasicMIDI
             
             if (DLSRMID)
             {
-                // assume bank offset of 0 by default. If we find any bank selects, then the offset is 1.
+                // Assume bank offset of 0 by default. If we find any bank selects, then the offset is 1.
+                this.bankOffset = 0;
+            }
+            
+            // if no embedded bank, assume 0
+            if (this.embeddedSoundFont === undefined)
+            {
                 this.bankOffset = 0;
             }
         }
@@ -198,8 +206,8 @@ class MIDI extends BasicMIDI
         let loopEnd = null;
         
         /**
-         * For karaoke files, text events starting with @T are considered titles
-         * usually the first one is the title, and the latter are things such as "sequenced by" etc.
+         * For karaoke files, text events starting with @T are considered titles,
+         * usually the first one is the title, and the latter is things such as "sequenced by" etc.
          * @type {boolean}
          */
         let karaokeHasTitle = false;
@@ -207,7 +215,7 @@ class MIDI extends BasicMIDI
         this.lastVoiceEventTick = 0;
         
         /**
-         * Midi port numbers for each tracks
+         * Midi port numbers for each one of the tracks
          * @type {number[]}
          */
         this.midiPorts = [];
@@ -274,16 +282,19 @@ class MIDI extends BasicMIDI
                 {
                     statusByte = runningByte;
                 }
-                else if (!runningByte && statusByteCheck < 0x80)
-                {
-                    // if we don't have a running byte and the status byte isn't valid, it's an error.
-                    SpessaSynthGroupEnd();
-                    throw new SyntaxError(`Unexpected byte with no running byte. (${statusByteCheck})`);
-                }
                 else
-                {
-                    // if the status byte is valid, just use that
-                    statusByte = trackChunk.data[trackChunk.data.currentIndex++];
+                { // noinspection PointlessBooleanExpressionJS
+                    if (!runningByte && statusByteCheck < 0x80)
+                    {
+                        // if we don't have a running byte and the status byte isn't valid, it's an error.
+                        SpessaSynthGroupEnd();
+                        throw new SyntaxError(`Unexpected byte with no running byte. (${statusByteCheck})`);
+                    }
+                    else
+                    {
+                        // if the status byte is valid, use that
+                        statusByte = trackChunk.data[trackChunk.data.currentIndex++];
+                    }
                 }
                 const statusByteChannel = getChannel(statusByte);
                 
@@ -310,7 +321,7 @@ class MIDI extends BasicMIDI
                     
                     default:
                         // voice message
-                        // get the midi message length
+                        // gets the midi message length
                         if (totalTicks > this.lastVoiceEventTick)
                         {
                             this.lastVoiceEventTick = totalTicks;
@@ -344,7 +355,7 @@ class MIDI extends BasicMIDI
                 switch (statusByteChannel)
                 {
                     case -2:
-                        // since this is a meta message
+                        // since this is a meta-message
                         const eventText = readBytesAsString(eventData, eventData.length);
                         switch (statusByte)
                         {
@@ -404,7 +415,7 @@ class MIDI extends BasicMIDI
                                 // note here: .kar files sometimes just use...
                                 // lyrics instead of text because why not (of course)
                                 // perform the same check for @KMIDI KARAOKE FILE
-                                if (eventText.trim() === "@KMIDI KARAOKE FILE")
+                                if (eventText.trim().startsWith("@KMIDI KARAOKE FILE"))
                                 {
                                     this.isKaraokeFile = true;
                                     SpessaSynthInfo("%cKaraoke MIDI detected!", consoleColors.recognized);
@@ -431,7 +442,7 @@ class MIDI extends BasicMIDI
                                 // it has a text event at the start of the file
                                 // "@KMIDI KARAOKE FILE"
                                 const checkedText = eventText.trim();
-                                if (checkedText === "@KMIDI KARAOKE FILE")
+                                if (checkedText.startsWith("@KMIDI KARAOKE FILE"))
                                 {
                                     this.isKaraokeFile = true;
                                     
@@ -440,7 +451,8 @@ class MIDI extends BasicMIDI
                                 else if (this.isKaraokeFile)
                                 {
                                     // check for @T (title)
-                                    // or @A because it is a title too sometimes??? idk it's weird
+                                    // or @A because it is a title too sometimes?
+                                    // IDK it's strange
                                     if (checkedText.startsWith("@T") || checkedText.startsWith("@A"))
                                     {
                                         if (!karaokeHasTitle)
@@ -477,6 +489,11 @@ class MIDI extends BasicMIDI
                         // since this is a voice message
                         // check for loop (CC 2/4)
                         trackHasVoiceMessages = true;
+                        // voice messages are 7-bit always
+                        for (let j = 0; j < eventData.length; j++)
+                        {
+                            eventData[j] = Math.min(127, eventData[j]);
+                        }
                         if ((statusByte & 0xF0) === messageTypes.controllerChange)
                         {
                             switch (eventData[0])
@@ -494,7 +511,9 @@ class MIDI extends BasicMIDI
                                     }
                                     else
                                     {
-                                        // this controller has occured more than once, this means that it doesnt indicate the loop
+                                        // this controller has occured more than once;
+                                        // this means
+                                        // that it doesn't indicate the loop
                                         loopEnd = 0;
                                     }
                                     break;
@@ -516,7 +535,7 @@ class MIDI extends BasicMIDI
             this.tracks.push(track);
             this.usedChannelsOnTrack.push(usedChannels);
             
-            // if the track has no voice messages, its "track name" event (if it has any)
+            // If the track has no voice messages, its "track name" event (if it has any)
             // is some metadata. Add it to copyright
             if (!trackHasVoiceMessages)
             {
@@ -602,9 +621,13 @@ class MIDI extends BasicMIDI
         
         // 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, otherwise take the first midi port and replace all -1 with it
-        // why do this? some midis (for some reason) specify all channels to port 1 or else, 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 additional 16 for the actual ports.
+        // if all ports have a value of -1, set it to 0,
+        // otherwise take the first midi port and replace all -1 with it,
+        // why would we do this?
+        // some midis (for some reason) specify all channels to port 1 or else,
+        // 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;
         for (let port of this.midiPorts)
         {
@@ -615,7 +638,7 @@ class MIDI extends BasicMIDI
             }
         }
         this.midiPorts = this.midiPorts.map(port => port === -1 ? defaultPort : port);
-        // add dummy port if empty
+        // add fake port if empty
         if (this.midiPortChannelOffsets.length === 0)
         {
             this.midiPortChannelOffsets = [0];
@@ -723,7 +746,7 @@ class MIDI extends BasicMIDI
         {
             this.lyrics = this.lyrics.map(lyric =>
             {
-                // one exception: hyphens at the end. Don't add a space to them
+                // One exception: hyphens at the end. Don't add a space to them
                 if (lyric[lyric.length - 1] === 45)
                 {
                     return lyric;

package/package.json

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

package/sequencer/sequencer.js

@@ -149,12 +149,12 @@ export class Sequencer
          * @type {boolean}
          * @private
          */
-        this._skipToFirstNoteOn = options?.skipToFirstNoteOn || true;
+        this._skipToFirstNoteOn = options?.skipToFirstNoteOn ?? true;
         /**
          * @type {boolean}
          * @private
          */
-        this._preservePlaybackState = options?.preservePlaybackState || false;
+        this._preservePlaybackState = options?.preservePlaybackState ?? false;
         
         if (this._skipToFirstNoteOn === false)
         {
@@ -167,7 +167,7 @@ export class Sequencer
             this._sendMessage(WorkletSequencerMessageType.setPreservePlaybackState, true);
         }
         
-        this.loadNewSongList(midiBinaries, options?.autoPlay || true);
+        this.loadNewSongList(midiBinaries, options?.autoPlay ?? true);
         
         window.addEventListener("beforeunload", this.resetMIDIOut.bind(this));
     }

package/synthetizer/synthetizer.js

@@ -109,7 +109,7 @@ export class Synthetizer
         this._voicesAmount = 0;
         
         /**
-         * For Black MIDI's - forces release time to 50ms
+         * For Black MIDI's - forces release time to 50 ms
          * @type {boolean}
          */
         this._highPerformanceMode = false;
@@ -268,7 +268,7 @@ export class Synthetizer
     }
     
     /**
-     * For Black MIDI's - forces release time to 50ms
+     * For Black MIDI's - forces release time to 50 ms
      * @param {boolean} value
      */
     set highPerformanceMode(value)
@@ -325,8 +325,8 @@ export class Synthetizer
     
     /**
      * Sets the interpolation type for the synthesizer:
-     * 0 - linear
-     * 1 - nearest neighbor
+     * 0. - linear
+     * 1. - nearest neighbor
      * @param type {interpolationTypes}
      */
     setInterpolationType(type)
@@ -663,7 +663,7 @@ export class Synthetizer
     
     /**
      * Sets the master stereo panning
-     * @param pan {number} -1 to 1, the pan (-1 is left, 0 is midde, 1 is right)
+     * @param pan {number} (-1 to 1), the pan (-1 is left, 0 is midde, 1 is right)
      */
     setMasterPan(pan)
     {
@@ -691,7 +691,8 @@ export class Synthetizer
      * Changes the patch for a given channel
      * @param channel {number} usually 0-15: the channel to change
      * @param programNumber {number} 0-127 the MIDI patch number
-     * @param userChange {boolean} indicates if the program change has been called by user. defaults to false
+     * @param userChange {boolean} indicates if user has called the program change.
+     * defaults to false
      */
     programChange(channel, programNumber, userChange = false)
     {
@@ -912,6 +913,7 @@ export class Synthetizer
         for (let i = 0; i < this.channelsAmount; i++)
         {
             this.controllerChange(i, midiControllers.reverbDepth, 127);
+            this.lockController(i, midiControllers.reverbDepth, true);
         }
         return "That's the spirit!";
     }