spessasynth_lib 3.23.13 → 3.24.0

package/midi_parser/midi_sequence.js

@@ -44,6 +44,12 @@ export class MIDISequenceData
      */
     lyrics = [];
     
+    /**
+     * An array of tick positions where lyrics events occur in the sequence.
+     * @type {number[]}
+     */
+    lyricsTicks = [];
+    
     /**
      * The tick position of the first note-on event in the MIDI sequence.
      * @type {number}
@@ -130,4 +136,11 @@ export class MIDISequenceData
      * @type {number}
      */
     bankOffset = 0;
+    
+    /**
+     * If the MIDI file is a Soft Karaoke file (.kar), this flag is set to true.
+     * https://www.mixagesoftware.com/en/midikit/help/HTML/karaoke_formats.html
+     * @type {boolean}
+     */
+    isKaraokeFile = false;
 }

package/package.json

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

package/sequencer/worklet_sequencer/process_event.js

@@ -121,13 +121,33 @@ export function _processEvent(event, trackIndex)
             if (statusByteData.status === messageTypes.lyric)
             {
                 lyricsIndex = Math.min(
-                    this.midiData.lyrics.indexOf(event.messageData) + 1,
+                    this.midiData.lyricsTicks.indexOf(event.ticks) + 1,
                     this.midiData.lyrics.length - 1
                 );
             }
+            let sentStatus = statusByteData.status;
+            // if MIDI is a karaoke file, it uses the "text" event type or "lyrics" for lyrics (duh)
+            // why?
+            // because the MIDI standard is a messy pile of garbage and it's not my fault that it's like this :(
+            // I'm just trying to make the best out of a bad situation
+            // I'm sorry
+            // okay i should get back to work
+            // anyways,
+            // check for karaoke file and change the status byte to "lyric" if it's a karaoke file
+            if (this.midiData.isKaraokeFile && (
+                statusByteData.status === messageTypes.text ||
+                statusByteData.status === messageTypes.lyric
+            ))
+            {
+                lyricsIndex = Math.min(
+                    this.midiData.lyricsTicks.indexOf(event.ticks) + 1,
+                    this.midiData.lyricsTicks.length
+                );
+                sentStatus = messageTypes.lyric;
+            }
             this.post(
                 WorkletSequencerReturnMessageType.textEvent,
-                [event.messageData, statusByteData.status, lyricsIndex]
+                [event.messageData, sentStatus, lyricsIndex]
             );
             break;
         

package/synthetizer/synth_event_handler.js

@@ -4,62 +4,80 @@
  */
 
 /**
- *
- * @typedef {{
- *     midiNote: number,
- *     channel: number,
- *     velocity: number
- * }} NoteOnCallback
- *
- * @typedef {{
- *     midiNote: number,
- *     channel: number
- * }} NoteOffCallback
- *
- * @typedef {{
- *     channel: number,
- *     isDrumChannel: boolean
- * }} DrumChangeCallback
- *
- * @typedef {{
- *     channel: number,
- *     program: number,
- *     bank: number,
- *     userCalled: boolean
- * }} ProgramChangeCallback
- *
- * @typedef {{
- *     channel: number,
- *     controllerNumber: number,
- *     controllerValue: number
- * }} ControllerChangeCallback
- *
- * @typedef {{
- *     channel:number,
- *     isMuted: boolean
- * }} MuteChannelCallback
- *
- * @typedef {{
- *     presetName: string,
- *     bank: number,
- *     program: number
- * }[]} PresetListChangeCallback
- *
- *
- * @typedef {{
- *     channel: number,
- *     MSB: number,
- *     LSB: number
- * }} PitchWheelCallback
- *
- * @typedef {{
- *     channel: number,
- *     pressure: number
- * }} ChannelPressureCallback
- *
- * @typedef {string} SoundfontErrorCallback
- *
- *
+ * @typedef {Object} NoteOnCallback
+ * @property {number} midiNote - The MIDI note number.
+ * @property {number} channel - The MIDI channel number.
+ * @property {number} velocity - The velocity of the note.
+ */
+
+/**
+ * @typedef {Object} NoteOffCallback
+ * @property {number} midiNote - The MIDI note number.
+ * @property {number} channel - The MIDI channel number.
+ */
+
+/**
+ * @typedef {Object} DrumChangeCallback
+ * @property {number} channel - The MIDI channel number.
+ * @property {boolean} isDrumChannel - Indicates if the channel is a drum channel.
+ */
+
+/**
+ * @typedef {Object} ProgramChangeCallback
+ * @property {number} channel - The MIDI channel number.
+ * @property {number} program - The program number.
+ * @property {number} bank - The bank number.
+ * @property {boolean} userCalled - Indicates if the change was user-initiated.
+ */
+
+/**
+ * @typedef {Object} ControllerChangeCallback
+ * @property {number} channel - The MIDI channel number.
+ * @property {number} controllerNumber - The controller number.
+ * @property {number} controllerValue - The value of the controller.
+ */
+
+/**
+ * @typedef {Object} MuteChannelCallback
+ * @property {number} channel - The MIDI channel number.
+ * @property {boolean} isMuted - Indicates if the channel is muted.
+ */
+
+/**
+ * @typedef {Object} PresetListChangeCallbackSingle
+ * @property {string} presetName - The name of the preset.
+ * @property {number} bank - The bank number.
+ * @property {number} program - The program number.
+ */
+
+/**
+ * @typedef {PresetListChangeCallbackSingle[]} PresetListChangeCallback - A list of preset objects.
+ */
+
+/**
+ * @typedef {Object} SynthDisplayCallback
+ * @property {Uint8Array} displayData - The data to display.
+ * @property {SynthDisplayType} displayType - The type of display.
+ */
+
+/**
+ * @typedef {Object} PitchWheelCallback
+ * @property {number} channel - The MIDI channel number.
+ * @property {number} MSB - The most significant byte of the pitch wheel value.
+ * @property {number} LSB - The least significant byte of the pitch wheel value.
+ */
+
+/**
+ * @typedef {Object} ChannelPressureCallback
+ * @property {number} channel - The MIDI channel number.
+ * @property {number} pressure - The pressure value.
+ */
+
+/**
+ * @typedef {Error} SoundfontErrorCallback - The error message for soundfont errors.
+ */
+
+/**
  * @typedef {
  *     NoteOnCallback |
  *     NoteOffCallback |
@@ -71,6 +89,7 @@
  *     PitchWheelCallback |
  *     SoundfontErrorCallback |
  *     ChannelPressureCallback |
+ *     SynthDisplayCallback |
  *     undefined
  * } EventCallbackData
  */
@@ -90,7 +109,8 @@
  * "mutechannel"|
  * "presetlistchange"|
  * "allcontrollerreset"|
- * "soundfonterror"} EventTypes
+ * "soundfonterror"|
+ * "synthdisplay"} EventTypes
  */
 export class EventHandler
 {
@@ -104,20 +124,21 @@ export class EventHandler
          * @type {Object<EventTypes, Object<string, function(EventCallbackData)>>}
          */
         this.events = {
-            "noteoff": {},
-            "noteon": {},
-            "pitchwheel": {},
-            "controllerchange": {},
-            "programchange": {},
-            "channelpressure": {},
-            "polypressure": {},
-            "drumchange": {},
-            "stopall": {},
-            "newchannel": {},
-            "mutechannel": {},
-            "presetlistchange": {},
-            "allcontrollerreset": {},
-            "soundfonterror": {}
+            "noteoff": {},              // called on note off message
+            "noteon": {},               // called on note on message
+            "pitchwheel": {},           // called on pitch wheel change
+            "controllerchange": {},     // called on controller change
+            "programchange": {},        // called on program change
+            "channelpressure": {},      // called on channel pressure message
+            "polypressure": {},         // called on poly pressure message
+            "drumchange": {},           // called when channel type changes
+            "stopall": {},              // called when synth receives stop all command
+            "newchannel": {},           // called when a new channel is created
+            "mutechannel": {},          // called when a channel is muted/unmuted
+            "presetlistchange": {},     // called when the preset list changes (soundfont gets reloaded)
+            "allcontrollerreset": {},   // called when all controllers are reset
+            "soundfonterror": {},       // called when a soundfont parsing error occurs
+            "synthdisplay": {}          // called when there's a SysEx message to display some text
         };
         
         /**