spessasynth_lib 3.23.14 → 3.24.0

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

@@ -3,62 +3,68 @@
  * purpose: manages the synthesizer's event system, calling assinged functions when synthesizer requests dispatching the event
  */
 /**
- *
- * @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 |
@@ -70,6 +76,7 @@
  *     PitchWheelCallback |
  *     SoundfontErrorCallback |
  *     ChannelPressureCallback |
+ *     SynthDisplayCallback |
  *     undefined
  * } EventCallbackData
  */
@@ -88,7 +95,8 @@
  * "mutechannel"|
  * "presetlistchange"|
  * "allcontrollerreset"|
- * "soundfonterror"} EventTypes
+ * "soundfonterror"|
+ * "synthdisplay"} EventTypes
  */
 export class EventHandler {
     /**
@@ -122,45 +130,134 @@ export class EventHandler {
     callEvent(name: EventTypes, eventData: EventCallbackData): void;
 }
 export type NoteOnCallback = {
+    /**
+     * - The MIDI note number.
+     */
     midiNote: number;
+    /**
+     * - The MIDI channel number.
+     */
     channel: number;
+    /**
+     * - The velocity of the note.
+     */
     velocity: number;
 };
 export type NoteOffCallback = {
+    /**
+     * - The MIDI note number.
+     */
     midiNote: number;
+    /**
+     * - The MIDI channel number.
+     */
     channel: number;
 };
 export type DrumChangeCallback = {
+    /**
+     * - The MIDI channel number.
+     */
     channel: number;
+    /**
+     * - Indicates if the channel is a drum channel.
+     */
     isDrumChannel: boolean;
 };
 export type ProgramChangeCallback = {
+    /**
+     * - The MIDI channel number.
+     */
     channel: number;
+    /**
+     * - The program number.
+     */
     program: number;
+    /**
+     * - The bank number.
+     */
     bank: number;
+    /**
+     * - Indicates if the change was user-initiated.
+     */
     userCalled: boolean;
 };
 export type ControllerChangeCallback = {
+    /**
+     * - The MIDI channel number.
+     */
     channel: number;
+    /**
+     * - The controller number.
+     */
     controllerNumber: number;
+    /**
+     * - The value of the controller.
+     */
     controllerValue: number;
 };
 export type MuteChannelCallback = {
+    /**
+     * - The MIDI channel number.
+     */
     channel: number;
+    /**
+     * - Indicates if the channel is muted.
+     */
     isMuted: boolean;
 };
-export type PresetListChangeCallback = {
+export type PresetListChangeCallbackSingle = {
+    /**
+     * - The name of the preset.
+     */
     presetName: string;
+    /**
+     * - The bank number.
+     */
     bank: number;
+    /**
+     * - The program number.
+     */
     program: number;
-}[];
+};
+/**
+ * - A list of preset objects.
+ */
+export type PresetListChangeCallback = PresetListChangeCallbackSingle[];
+export type SynthDisplayCallback = {
+    /**
+     * - The data to display.
+     */
+    displayData: Uint8Array;
+    /**
+     * - The type of display.
+     */
+    displayType: SynthDisplayType;
+};
 export type PitchWheelCallback = {
+    /**
+     * - The MIDI channel number.
+     */
     channel: number;
+    /**
+     * - The most significant byte of the pitch wheel value.
+     */
     MSB: number;
+    /**
+     * - The least significant byte of the pitch wheel value.
+     */
     LSB: number;
 };
 export type ChannelPressureCallback = {
+    /**
+     * - The MIDI channel number.
+     */
     channel: number;
+    /**
+     * - The pressure value.
+     */
     pressure: number;
 };
-export type SoundfontErrorCallback = string;
+/**
+ * - The error message for soundfont errors.
+ */
+export type SoundfontErrorCallback = Error;

package/README.md

@@ -82,6 +82,7 @@ document.getElementById("button").onclick = async () =>
   - **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_)
   - **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)**
   - **Easy saving:** Save with just [one function!](https://github.com/spessasus/SpessaSynth/wiki/Writing-MIDI-Files#writemidifile)
 
@@ -122,7 +123,6 @@ document.getElementById("button").onclick = async () =>
   - **Loop multiple times:** *Render two (or more) loops into the file for seamless transitions!*
   - *That's right, saving as WAV is also [just one function!](https://github.com/spessasus/SpessaSynth/wiki/Writing-Wave-Files#audiobuffertowav)*
 
-
 # License
 
 MIT License, except for the stbvorbis_sync.js in the `externals` folder which is licensed under the Apache-2.0 license.

package/midi_parser/midi_loader.js

@@ -10,9 +10,6 @@ import { readLittleEndian } from "../utils/byte_functions/little_endian.js";
 import { RMIDINFOChunks } from "./rmidi_writer.js";
 import { BasicMIDI, MIDIticksToSeconds } from "./basic_midi.js";
 
-
-const GS_TEXT_HEADER = new Uint8Array([0x41, 0x10, 0x45, 0x12, 0x10, 0x00, 0x00]);
-
 /**
  * midi_loader.js
  * purpose: parses a midi file for the seqyencer, including things like marker or CC 2/4 loop detection, copyright detection etc.
@@ -43,6 +40,12 @@ class MIDI extends BasicMIDI
         
         let DLSRMID = false;
         
+        /**
+         * Will be joined with "\n" to form the final string
+         * @type {string[]}
+         */
+        let copyrightComponents = [];
+        
         const initialString = readBytesAsString(binaryData, 4);
         binaryData.currentIndex -= 4;
         if (initialString === "RIFF")
@@ -102,6 +105,7 @@ class MIDI extends BasicMIDI
                         }
                         if (this.RMIDInfo["ICOP"])
                         {
+                            // special case, overwrites the copyright components array
                             copyrightDetected = true;
                             this.copyright = readBytesAsString(
                                 this.RMIDInfo["ICOP"],
@@ -242,6 +246,8 @@ class MIDI extends BasicMIDI
                 throw new SyntaxError(`Invalid track header! Expected "MTrk" got "${trackChunk.type}"`);
             }
             
+            let trackHasVoiceMessages = false;
+            
             /**
              * MIDI running byte
              * @type {number}
@@ -382,12 +388,14 @@ class MIDI extends BasicMIDI
                             case messageTypes.copyright:
                                 if (!copyrightDetected)
                                 {
-                                    this.copyright += readBytesAsString(
+                                    
+                                    eventData.currentIndex = 0;
+                                    copyrightComponents.push(readBytesAsString(
                                         eventData,
                                         eventData.length,
                                         undefined,
                                         false
-                                    ) + "\n";
+                                    ));
                                 }
                                 break;
                             
@@ -446,7 +454,7 @@ class MIDI extends BasicMIDI
                                         else
                                         {
                                             // append to copyright
-                                            this.copyright += checkedText.substring(2).trim() + " \n";
+                                            copyrightComponents.push(checkedText.substring(2).trim());
                                         }
                                     }
                                     else if (checkedText[0] !== "@")
@@ -461,29 +469,14 @@ class MIDI extends BasicMIDI
                         break;
                     
                     case -3:
-                        // since this is a sysex message
-                        // check for embedded copyright (roland SC display sysex) http://www.bandtrax.com.au/sysex.htm
-                        // header goes like this: 41 10 45 12 10 00 00
-                        if (eventData.slice(0, 7).every((n, i) => GS_TEXT_HEADER[i] === n))
-                        {
-                            /**
-                             * @type {IndexedByteArray}
-                             */
-                            const cutText = eventData.slice(7, messageData.length - 3);
-                            const decoded = readBytesAsString(cutText, cutText.length) + "\n";
-                            this.copyright += decoded;
-                            SpessaSynthInfo(
-                                `%cDecoded Roland SC message! %c${decoded}`,
-                                consoleColors.recognized,
-                                consoleColors.value
-                            );
-                        }
+                        // since this is a sysex message, do nothing
                         break;
                     
                     
                     default:
                         // since this is a voice message
                         // check for loop (CC 2/4)
+                        trackHasVoiceMessages = true;
                         if ((statusByte & 0xF0) === messageTypes.controllerChange)
                         {
                             switch (eventData[0])
@@ -522,6 +515,20 @@ 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)
+            // is some metadata. Add it to copyright
+            if (!trackHasVoiceMessages)
+            {
+                const trackName = track.find(e => e.messageStatusByte === messageTypes.trackName);
+                if (trackName)
+                {
+                    trackName.messageData.currentIndex = 0;
+                    const name = readBytesAsString(trackName.messageData, trackName.messageData.length);
+                    copyrightComponents.push(name);
+                }
+            }
+            
             SpessaSynthInfo(
                 `%cParsed %c${this.tracks.length}%c / %c${this.tracksAmount}`,
                 consoleColors.info,
@@ -641,6 +648,7 @@ class MIDI extends BasicMIDI
                     if (name)
                     {
                         this.rawMidiName = name.messageData;
+                        name.messageData.currentIndex = 0;
                         this.midiName = readBytesAsString(name.messageData, name.messageData.length, undefined, false);
                     }
                 }
@@ -652,11 +660,23 @@ class MIDI extends BasicMIDI
                 if (name)
                 {
                     this.rawMidiName = name.messageData;
+                    name.messageData.currentIndex = 0;
                     this.midiName = readBytesAsString(name.messageData, name.messageData.length, undefined, false);
                 }
             }
         }
         
+        if (!copyrightDetected)
+        {
+            this.copyright = copyrightComponents
+                // trim and group newlines into one
+                .map(c => c.trim().replace(/(\r?\n)+/g, "\n"))
+                // remove empty strings
+                .filter(c => c.length > 0)
+                // join with newlines
+                .join("\n") || "";
+        }
+        
         this.fileName = fileName;
         this.midiName = this.midiName.trim();
         this.midiNameUsesFileName = false;

package/package.json

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

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
         };
         
         /**