spessasynth_lib 3.24.13 → 3.24.16

package/midi_parser/midi_loader.js

@@ -1,14 +1,14 @@
-import { dataBytesAmount, getChannel, messageTypes, MidiMessage } from "./midi_message.js";
+import { dataBytesAmount, getChannel, MidiMessage } from "./midi_message.js";
 import { IndexedByteArray } from "../utils/indexed_array.js";
-import { consoleColors, formatTitle, sanitizeKarLyrics } from "../utils/other.js";
+import { consoleColors } from "../utils/other.js";
 import { SpessaSynthGroupCollapsed, SpessaSynthGroupEnd, SpessaSynthInfo, SpessaSynthWarn } from "../utils/loggin.js";
 import { readRIFFChunk } from "../soundfont/basic_soundfont/riff_chunk.js";
 import { readVariableLengthQuantity } from "../utils/byte_functions/variable_length_quantity.js";
 import { readBytesAsUintBigEndian } from "../utils/byte_functions/big_endian.js";
-import { getStringBytes, readBytesAsString } from "../utils/byte_functions/string.js";
+import { readBytesAsString } from "../utils/byte_functions/string.js";
 import { readLittleEndian } from "../utils/byte_functions/little_endian.js";
 import { RMIDINFOChunks } from "./rmidi_writer.js";
-import { BasicMIDI, MIDIticksToSeconds } from "./basic_midi.js";
+import { BasicMIDI } from "./basic_midi.js";
 
 /**
  * midi_loader.js
@@ -32,22 +32,11 @@ class MIDI extends BasicMIDI
     {
         super();
         SpessaSynthGroupCollapsed(`%cParsing MIDI File...`, consoleColors.info);
+        this.fileName = fileName;
         const binaryData = new IndexedByteArray(arrayBuffer);
         let fileByteArray;
         
         // check for rmid
-        let copyrightDetected = false;
-        
-        let nameDetected = false;
-        
-        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")
@@ -70,7 +59,7 @@ class MIDI extends BasicMIDI
             // this is a rmid, load the midi into an array for parsing
             fileByteArray = riff.chunkData;
             
-            // keep loading chunks until we get sfbk
+            // keep loading chunks until we get the "SFBK" header
             while (binaryData.currentIndex <= binaryData.length)
             {
                 const startIndex = binaryData.currentIndex;
@@ -90,7 +79,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.
-                        DLSRMID = true;
+                        this.isDLSRMIDI = true;
                     }
                 }
                 else if (currentChunk.header === "LIST")
@@ -108,7 +97,6 @@ class MIDI extends BasicMIDI
                         if (this.RMIDInfo["ICOP"])
                         {
                             // special case, overwrites the copyright components array
-                            copyrightDetected = true;
                             this.copyright = readBytesAsString(
                                 this.RMIDInfo["ICOP"],
                                 this.RMIDInfo["ICOP"].length,
@@ -119,20 +107,20 @@ class MIDI extends BasicMIDI
                         if (this.RMIDInfo["INAM"])
                         {
                             this.rawMidiName = this.RMIDInfo[RMIDINFOChunks.name];
+                            // noinspection JSCheckFunctionSignatures
                             this.midiName = readBytesAsString(
                                 this.rawMidiName,
                                 this.rawMidiName.length,
                                 undefined,
                                 false
                             ).replaceAll("\n", " ");
-                            nameDetected = true;
                         }
                         // these can be used interchangeably
                         if (this.RMIDInfo["IALB"] && !this.RMIDInfo["IPRD"])
                         {
                             this.RMIDInfo["IPRD"] = this.RMIDInfo["IALB"];
                         }
-                        if (this.RMIDInfo["PRD"] && !this.RMIDInfo["IALB"])
+                        if (this.RMIDInfo["IPRD"] && !this.RMIDInfo["IALB"])
                         {
                             this.RMIDInfo["IALB"] = this.RMIDInfo["IPRD"];
                         }
@@ -145,7 +133,7 @@ class MIDI extends BasicMIDI
                 }
             }
             
-            if (DLSRMID)
+            if (this.isDLSRMIDI)
             {
                 // Assume bank offset of 0 by default. If we find any bank selects, then the offset is 1.
                 this.bankOffset = 0;
@@ -180,64 +168,7 @@ class MIDI extends BasicMIDI
         this.tracksAmount = readBytesAsUintBigEndian(headerChunk.data, 2);
         // time division
         this.timeDivision = readBytesAsUintBigEndian(headerChunk.data, 2);
-        
-        /**
-         * The MIDI's key range
-         * @type {{min: number, max: number}}
-         */
-        this.keyRange = { min: 127, max: 0 };
-        
-        /**
-         * Contains the lyrics as binary chunks
-         * @type {Uint8Array[]}
-         */
-        this.lyrics = [];
-        
-        /**
-         * Contains all the tempo changes in the file. (Ordered from last to first)
-         * @type {{
-         *     ticks: number,
-         *     tempo: number
-         * }[]}
-         */
-        this.tempoChanges = [{ ticks: 0, tempo: 120 }];
-        
-        let loopStart = null;
-        let loopEnd = null;
-        
-        /**
-         * 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;
-        
-        this.lastVoiceEventTick = 0;
-        
-        /**
-         * Midi port numbers for each one of the tracks
-         * @type {number[]}
-         */
-        this.midiPorts = [];
-        
-        let portOffset = 0;
-        /**
-         * Channel offsets for each port, using the SpessaSynth method
-         * @type {number[]}
-         */
-        this.midiPortChannelOffsets = [];
-        
-        /**
-         * All channels that each track uses. Note: these channels range from 0 to 15, excluding the port offsets!
-         * @type {Set<number>[]}
-         */
-        this.usedChannelsOnTrack = [];
-        
-        /**
-         * Read all the tracks
-         * @type {MidiMessage[][]}
-         */
-        this.tracks = [];
+        // read all the tracks
         for (let i = 0; i < this.tracksAmount; i++)
         {
             /**
@@ -245,8 +176,6 @@ class MIDI extends BasicMIDI
              */
             const track = [];
             const trackChunk = this.readMIDIChunk(fileByteArray);
-            const usedChannels = new Set();
-            this.midiPorts.push(-1);
             
             if (trackChunk.type !== "MTrk")
             {
@@ -254,7 +183,6 @@ class MIDI extends BasicMIDI
                 throw new SyntaxError(`Invalid track header! Expected "MTrk" got "${trackChunk.type}"`);
             }
             
-            let trackHasVoiceMessages = false;
             
             /**
              * MIDI running byte
@@ -322,19 +250,7 @@ class MIDI extends BasicMIDI
                     default:
                         // voice message
                         // gets the midi message length
-                        if (totalTicks > this.lastVoiceEventTick)
-                        {
-                            this.lastVoiceEventTick = totalTicks;
-                        }
                         eventDataLength = dataBytesAmount[statusByte >> 4];
-                        if ((statusByte & 0xF0) === messageTypes.noteOn)
-                        {
-                            usedChannels.add(statusByteChannel);
-                            const note = trackChunk.data[trackChunk.data.currentIndex];
-                            this.keyRange.min = Math.min(this.keyRange.min, note);
-                            this.keyRange.max = Math.max(this.keyRange.max, note);
-                        }
-                        
                         // save the status byte
                         runningByte = statusByte;
                         break;
@@ -342,211 +258,16 @@ class MIDI extends BasicMIDI
                 
                 // put the event data into the array
                 const eventData = new IndexedByteArray(eventDataLength);
-                const messageData = trackChunk.data.slice(
+                eventData.set(trackChunk.data.slice(
                     trackChunk.data.currentIndex,
                     trackChunk.data.currentIndex + eventDataLength
-                );
+                ), 0);
+                const event = new MidiMessage(totalTicks, statusByte, eventData);
+                track.push(event);
+                // advance the track chunk
                 trackChunk.data.currentIndex += eventDataLength;
-                eventData.set(messageData, 0);
-                
-                const message = new MidiMessage(totalTicks, statusByte, eventData);
-                track.push(message);
-                
-                switch (statusByteChannel)
-                {
-                    case -2:
-                        // since this is a meta-message
-                        const eventText = readBytesAsString(eventData, eventData.length);
-                        switch (statusByte)
-                        {
-                            case messageTypes.setTempo:
-                                // add the tempo change
-                                this.tempoChanges.push({
-                                    ticks: totalTicks,
-                                    tempo: 60000000 / readBytesAsUintBigEndian(messageData, 3)
-                                });
-                                break;
-                            
-                            case messageTypes.marker:
-                                // check for loop markers
-                                const text = eventText.trim().toLowerCase();
-                                switch (text)
-                                {
-                                    default:
-                                        break;
-                                    
-                                    case "start":
-                                    case "loopstart":
-                                        loopStart = totalTicks;
-                                        break;
-                                    
-                                    case "loopend":
-                                        loopEnd = totalTicks;
-                                }
-                                eventData.currentIndex = 0;
-                                break;
-                            
-                            case messageTypes.midiPort:
-                                const port = eventData[0];
-                                this.midiPorts[i] = port;
-                                if (this.midiPortChannelOffsets[port] === undefined)
-                                {
-                                    this.midiPortChannelOffsets[port] = portOffset;
-                                    portOffset += 16;
-                                }
-                                break;
-                            
-                            case messageTypes.copyright:
-                                if (!copyrightDetected)
-                                {
-                                    
-                                    eventData.currentIndex = 0;
-                                    copyrightComponents.push(readBytesAsString(
-                                        eventData,
-                                        eventData.length,
-                                        undefined,
-                                        false
-                                    ));
-                                }
-                                break;
-                            
-                            case messageTypes.lyric:
-                                
-                                // 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().startsWith("@KMIDI KARAOKE FILE"))
-                                {
-                                    this.isKaraokeFile = true;
-                                    SpessaSynthInfo("%cKaraoke MIDI detected!", consoleColors.recognized);
-                                }
-                                
-                                if (this.isKaraokeFile)
-                                {
-                                    // replace the type of the message with text
-                                    message.messageStatusByte = messageTypes.text;
-                                    statusByte = messageTypes.text;
-                                }
-                                else
-                                {
-                                    // add lyrics like a regular midi file
-                                    this.lyrics.push(eventData);
-                                    this.lyricsTicks.push(totalTicks);
-                                    break;
-                                }
-                            
-                            // kar: treat the same as text
-                            // fallthrough
-                            case messageTypes.text:
-                                // possibly Soft Karaoke MIDI file
-                                // it has a text event at the start of the file
-                                // "@KMIDI KARAOKE FILE"
-                                const checkedText = eventText.trim();
-                                if (checkedText.startsWith("@KMIDI KARAOKE FILE"))
-                                {
-                                    this.isKaraokeFile = true;
-                                    
-                                    SpessaSynthInfo("%cKaraoke MIDI detected!", consoleColors.recognized);
-                                }
-                                else if (this.isKaraokeFile)
-                                {
-                                    // check for @T (title)
-                                    // or @A because it is a title too sometimes?
-                                    // IDK it's strange
-                                    if (checkedText.startsWith("@T") || checkedText.startsWith("@A"))
-                                    {
-                                        if (!karaokeHasTitle)
-                                        {
-                                            this.midiName = checkedText.substring(2).trim();
-                                            karaokeHasTitle = true;
-                                            nameDetected = true;
-                                            // encode to rawMidiName
-                                            this.rawMidiName = getStringBytes(this.midiName);
-                                        }
-                                        else
-                                        {
-                                            // append to copyright
-                                            copyrightComponents.push(checkedText.substring(2).trim());
-                                        }
-                                    }
-                                    else if (checkedText[0] !== "@")
-                                    {
-                                        // non @: the lyrics
-                                        this.lyrics.push(sanitizeKarLyrics(eventData));
-                                        this.lyricsTicks.push(totalTicks);
-                                    }
-                                }
-                                break;
-                        }
-                        break;
-                    
-                    case -3:
-                        // since this is a sysex message, do nothing
-                        break;
-                    
-                    
-                    default:
-                        // 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])
-                            {
-                                case 2:
-                                case 116:
-                                    loopStart = totalTicks;
-                                    break;
-                                
-                                case 4:
-                                case 117:
-                                    if (loopEnd === null)
-                                    {
-                                        loopEnd = totalTicks;
-                                    }
-                                    else
-                                    {
-                                        // this controller has occured more than once;
-                                        // this means
-                                        // that it doesn't indicate the loop
-                                        loopEnd = 0;
-                                    }
-                                    break;
-                                
-                                case 0:
-                                    // check RMID
-                                    if (DLSRMID && eventData[1] !== 0 && eventData[1] !== 127)
-                                    {
-                                        SpessaSynthInfo(
-                                            "%cDLS RMIDI with offset 1 detected!",
-                                            consoleColors.recognized
-                                        );
-                                        this.bankOffset = 1;
-                                    }
-                            }
-                        }
-                }
             }
             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}`,
@@ -561,213 +282,8 @@ class MIDI extends BasicMIDI
             `%cAll tracks parsed correctly!`,
             consoleColors.recognized
         );
-        
-        SpessaSynthGroupCollapsed(
-            `%cCorrecting loops, ports and detecting notes...`,
-            consoleColors.info
-        );
-        
-        const firstNoteOns = [];
-        for (const t of this.tracks)
-        {
-            const firstNoteOn = t.find(e => (e.messageStatusByte & 0xF0) === messageTypes.noteOn);
-            if (firstNoteOn)
-            {
-                firstNoteOns.push(firstNoteOn.ticks);
-            }
-        }
-        this.firstNoteOn = Math.min(...firstNoteOns);
-        
-        SpessaSynthInfo(
-            `%cFirst note-on detected at: %c${this.firstNoteOn}%c ticks!`,
-            consoleColors.info,
-            consoleColors.recognized,
-            consoleColors.info
-        );
-        
-        
-        if (loopStart !== null && loopEnd === null)
-        {
-            // not a loop
-            loopStart = this.firstNoteOn;
-            loopEnd = this.lastVoiceEventTick;
-        }
-        else
-        {
-            if (loopStart === null)
-            {
-                loopStart = this.firstNoteOn;
-            }
-            
-            if (loopEnd === null || loopEnd === 0)
-            {
-                loopEnd = this.lastVoiceEventTick;
-            }
-        }
-        
-        /**
-         *
-         * @type {{start: number, end: number}}
-         */
-        this.loop = { start: loopStart, end: loopEnd };
-        
-        SpessaSynthInfo(
-            `%cLoop points: start: %c${this.loop.start}%c end: %c${this.loop.end}`,
-            consoleColors.info,
-            consoleColors.recognized,
-            consoleColors.info,
-            consoleColors.recognized
-        );
-        
-        // 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 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)
-        {
-            if (port !== -1)
-            {
-                defaultPort = port;
-                break;
-            }
-        }
-        this.midiPorts = this.midiPorts.map(port => port === -1 ? defaultPort : port);
-        // add fake port if empty
-        if (this.midiPortChannelOffsets.length === 0)
-        {
-            this.midiPortChannelOffsets = [0];
-        }
-        if (this.midiPortChannelOffsets.length < 2)
-        {
-            SpessaSynthInfo(`%cNo additional MIDI Ports detected.`, consoleColors.info);
-        }
-        else
-        {
-            SpessaSynthInfo(`%cMIDI Ports detected!`, consoleColors.recognized);
-        }
-        
-        // midi name
-        if (!nameDetected)
-        {
-            if (this.tracks.length > 1)
-            {
-                // if more than 1 track and the first track has no notes, just find the first trackName in the first track
-                if (
-                    this.tracks[0].find(
-                        message => message.messageStatusByte >= messageTypes.noteOn
-                            &&
-                            message.messageStatusByte < messageTypes.polyPressure
-                    ) === undefined
-                )
-                {
-                    
-                    let name = this.tracks[0].find(message => message.messageStatusByte === messageTypes.trackName);
-                    if (name)
-                    {
-                        this.rawMidiName = name.messageData;
-                        name.messageData.currentIndex = 0;
-                        this.midiName = readBytesAsString(name.messageData, name.messageData.length, undefined, false);
-                    }
-                }
-            }
-            else
-            {
-                // if only 1 track, find the first "track name" event
-                let name = this.tracks[0].find(message => message.messageStatusByte === messageTypes.trackName);
-                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;
-        // if midiName is "", use the file name
-        if (this.midiName.length === 0)
-        {
-            SpessaSynthInfo(
-                `%cNo name detected. Using the alt name!`,
-                consoleColors.info
-            );
-            this.midiName = formatTitle(fileName);
-            this.midiNameUsesFileName = true;
-            // encode it too
-            this.rawMidiName = new Uint8Array(this.midiName.length);
-            for (let i = 0; i < this.midiName.length; i++)
-            {
-                this.rawMidiName[i] = this.midiName.charCodeAt(i);
-            }
-        }
-        else
-        {
-            SpessaSynthInfo(
-                `%cMIDI Name detected! %c"${this.midiName}"`,
-                consoleColors.info,
-                consoleColors.recognized
-            );
-        }
-        
-        // lyrics fix:
-        // sometimes, all lyrics events lack spaces at the start or end of the lyric
-        // then, and only then, add space at the end of each lyric
-        // space ASCII is 32
-        let lacksSpaces = true;
-        for (const lyric of this.lyrics)
-        {
-            if (lyric[0] === 32 || lyric[lyric.length - 1] === 32)
-            {
-                lacksSpaces = false;
-                break;
-            }
-        }
-        
-        if (lacksSpaces)
-        {
-            this.lyrics = this.lyrics.map(lyric =>
-            {
-                // One exception: hyphens at the end. Don't add a space to them
-                if (lyric[lyric.length - 1] === 45)
-                {
-                    return lyric;
-                }
-                const withSpaces = new Uint8Array(lyric.length + 1);
-                withSpaces.set(lyric, 0);
-                withSpaces[lyric.length] = 32;
-                return withSpaces;
-            });
-        }
-        
-        
-        // reverse the tempo changes
-        this.tempoChanges.reverse();
-        
-        /**
-         * The total playback time, in seconds
-         * @type {number}
-         */
-        this.duration = MIDIticksToSeconds(this.lastVoiceEventTick, this);
-        
+        // parse the events
+        this._parseInternal();
         SpessaSynthGroupEnd();
         SpessaSynthInfo(
             `%cMIDI file parsed. Total tick time: %c${this.lastVoiceEventTick}%c, total seconds time: %c${this.duration}`,
@@ -776,7 +292,6 @@ class MIDI extends BasicMIDI
             consoleColors.info,
             consoleColors.recognized
         );
-        SpessaSynthGroupEnd();
     }
     
     /**

package/midi_parser/midi_message.js

@@ -7,6 +7,24 @@ import { IndexedByteArray } from "../utils/indexed_array.js";
 
 export class MidiMessage
 {
+    /**
+     * Absolute number of MIDI ticks from the start of the track.
+     * @type {number}
+     */
+    ticks;
+    
+    /**
+     * The MIDI message status byte. Note that for meta events, it is the second byte. (not 0xFF)
+     * @type {number}
+     */
+    messageStatusByte;
+    
+    /**
+     * Message's binary data
+     * @type {IndexedByteArray}
+     */
+    messageData;
+    
     /**
      * @param ticks {number}
      * @param byte {number} the message status byte
@@ -14,13 +32,8 @@ export class MidiMessage
      */
     constructor(ticks, byte, data)
     {
-        // absolute ticks from the start
         this.ticks = ticks;
-        // message status byte (for meta it's the second byte)
         this.messageStatusByte = byte;
-        /**
-         * @type {IndexedByteArray}
-         */
         this.messageData = data;
     }
 }

package/midi_parser/midi_sequence.js

@@ -124,9 +124,9 @@ export class MIDISequenceData
     format = 0;
     
     /**
-     * The RMID (Resource Interchangeable MIDI) info data, if the file is RMID formatted.
+     * The RMID (Resource-Interchangeable MIDI) info data, if the file is RMID formatted.
      * Otherwise, this field is undefined.
-     * Chunk type (e.g. "INAM"): Chunk data as binary array.
+     * Chunk type (e.g. "INAM"): Chunk data as a binary array.
      * @type {Object<string, IndexedByteArray>}
      */
     RMIDInfo = {};