spessasynth_lib 3.25.22 → 3.26.0

package/utils/byte_functions/string.js

@@ -1,107 +0,0 @@
-import { IndexedByteArray } from "../indexed_array.js";
-
-/**
- * @param dataArray {IndexedByteArray}
- * @param bytes {number}
- * @param encoding {string} the textElement encoding
- * @param trimEnd {boolean} if we should trim once we reach an invalid byte
- * @returns {string}
- */
-export function readBytesAsString(dataArray, bytes, encoding = undefined, trimEnd = true)
-{
-    if (!encoding)
-    {
-        let finished = false;
-        let string = "";
-        for (let i = 0; i < bytes; i++)
-        {
-            let byte = dataArray[dataArray.currentIndex++];
-            if (finished)
-            {
-                continue;
-            }
-            if ((byte < 32 || byte > 127) && byte !== 10) // 10 is "\n"
-            {
-                if (trimEnd)
-                {
-                    finished = true;
-                    continue;
-                }
-                else
-                {
-                    if (byte === 0)
-                    {
-                        finished = true;
-                        continue;
-                    }
-                }
-            }
-            string += String.fromCharCode(byte);
-        }
-        return string;
-    }
-    else
-    {
-        let byteBuffer = dataArray.slice(dataArray.currentIndex, dataArray.currentIndex + bytes);
-        dataArray.currentIndex += bytes;
-        let decoder = new TextDecoder(encoding.replace(/[^\x20-\x7E]/g, ""));
-        return decoder.decode(byteBuffer.buffer);
-    }
-}
-
-/**
- * @param string {string}
- * @param padLength {number}
- * @returns {IndexedByteArray}
- */
-export function getStringBytes(string, padLength = 0)
-{
-    let len = string.length;
-    if (padLength > 0)
-    {
-        len = padLength;
-    }
-    const arr = new IndexedByteArray(len);
-    writeStringAsBytes(arr, string, padLength);
-    return arr;
-}
-
-/**
- * @param string {string}
- * @returns {IndexedByteArray}
- */
-export function getStringBytesZero(string)
-{
-    return getStringBytes(string, string.length + 1);
-}
-
-/**
- * @param string {string}
- * @param outArray {IndexedByteArray}
- * @param padLength {number}
- * @returns {IndexedByteArray} modified IN PLACE
- */
-export function writeStringAsBytes(outArray, string, padLength = 0)
-{
-    if (padLength > 0)
-    {
-        if (string.length > padLength)
-        {
-            string = string.slice(0, padLength);
-        }
-    }
-    for (let i = 0; i < string.length; i++)
-    {
-        outArray[outArray.currentIndex++] = string.charCodeAt(i);
-    }
-    
-    // pad with zeros if needed
-    if (padLength > string.length)
-    {
-        for (let i = 0; i < padLength - string.length; i++)
-        {
-            outArray[outArray.currentIndex++] = 0;
-        }
-    }
-    return outArray;
-}

package/utils/byte_functions/variable_length_quantity.js

@@ -1,42 +0,0 @@
-/**
- * Reads VLQ From a MIDI byte array
- * @param MIDIbyteArray {IndexedByteArray}
- * @returns {number}
- */
-export function readVariableLengthQuantity(MIDIbyteArray)
-{
-    let out = 0;
-    while (MIDIbyteArray)
-    {
-        const byte = MIDIbyteArray[MIDIbyteArray.currentIndex++];
-        // extract the first 7 bytes
-        out = (out << 7) | (byte & 127);
-        
-        // if the last byte isn't 1, stop reading
-        if ((byte >> 7) !== 1)
-        {
-            break;
-        }
-    }
-    return out;
-}
-
-/**
- * Write a VLQ from a number to a byte array
- * @param number {number}
- * @returns {number[]}
- */
-export function writeVariableLengthQuantity(number)
-{
-    // Add the first byte
-    let bytes = [number & 127];
-    number >>= 7;
-    
-    // Continue processing the remaining bytes
-    while (number > 0)
-    {
-        bytes.unshift((number & 127) | 128);
-        number >>= 7;
-    }
-    return bytes;
-}

package/utils/fill_with_defaults.js

@@ -1,21 +0,0 @@
-/**
- * Fills the object with default values
- * @param obj {Object}
- * @param defObj {Object}
- * @returns {Object}
- */
-export function fillWithDefaults(obj, defObj)
-{
-    if (obj === undefined)
-    {
-        obj = {};
-    }
-    for (const key in defObj)
-    {
-        if (defObj.hasOwnProperty(key) && !(key in obj))
-        {
-            obj[key] = defObj[key];
-        }
-    }
-    return obj;
-}

package/utils/indexed_array.js

@@ -1,52 +0,0 @@
-/**
- * indexed_array.js
- * purpose: exteds Uint8Array with a currentIndex property
- */
-
-export class IndexedByteArray extends Uint8Array
-{
-    /**
-     * The current index of the array
-     * @type {number}
-     */
-    currentIndex = 0;
-    
-    /**
-     * Creates a new instance of an Uint8Array with a currentIndex property
-     * @param args {any} same as for Uint8Array
-     */
-    constructor(args)
-    {
-        super(args);
-    }
-    
-    /**
-     * @param start {number?}
-     * @param end {number?}
-     * @returns {IndexedByteArray}
-     */
-    slice(start, end)
-    {
-        const a = super.slice(start, end);
-        a.currentIndex = 0;
-        return a;
-    }
-}
-
-
-/**
- * @param arrs {(IndexedByteArray|Uint8Array)[]}
- * @returns {IndexedByteArray|Uint8Array}
- */
-export function combineArrays(arrs)
-{
-    const length = arrs.reduce((sum, current) => sum + current.length, 0);
-    const newArr = new IndexedByteArray(length);
-    let offset = 0;
-    for (const arr of arrs)
-    {
-        newArr.set(arr, offset);
-        offset += arr.length;
-    }
-    return newArr;
-}

package/utils/loggin.js

@@ -1,79 +0,0 @@
-let ENABLE_INFO = false;
-let ENABLE_WARN = true;
-let ENABLE_GROUP = false;
-let ENABLE_TABLE = true;
-
-/**
- * Enables or disables looging
- * @param enableInfo {boolean} - enables info
- * @param enableWarn {boolean} - enables warning
- * @param enableGroup {boolean} - enables groups
- * @param enableTable {boolean} - enables tables
- */
-export function SpessaSynthLogging(enableInfo, enableWarn, enableGroup, enableTable)
-{
-    ENABLE_INFO = enableInfo;
-    ENABLE_WARN = enableWarn;
-    ENABLE_GROUP = enableGroup;
-    ENABLE_TABLE = enableTable;
-}
-
-/**
- * @param message {...any}
- */
-export function SpessaSynthInfo(...message)
-{
-    if (ENABLE_INFO)
-    {
-        console.info(...message);
-    }
-}
-
-/**
- * @param message {...any}
- */
-export function SpessaSynthWarn(...message)
-{
-    if (ENABLE_WARN)
-    {
-        console.warn(...message);
-    }
-}
-
-export function SpessaSynthTable(...args)
-{
-    if (ENABLE_TABLE)
-    {
-        console.table(...args);
-    }
-}
-
-/**
- * @param message {...any} the message
- */
-export function SpessaSynthGroup(...message)
-{
-    if (ENABLE_GROUP)
-    {
-        console.group(...message);
-    }
-}
-
-/**
- * @param message {...any} the message
- */
-export function SpessaSynthGroupCollapsed(...message)
-{
-    if (ENABLE_GROUP)
-    {
-        console.groupCollapsed(...message);
-    }
-}
-
-export function SpessaSynthGroupEnd()
-{
-    if (ENABLE_GROUP)
-    {
-        console.groupEnd();
-    }
-}

package/utils/other.js

@@ -1,92 +0,0 @@
-/**
- * other.js
- * purpose: contains some useful functions that don't belong in any specific category
- */
-
-/**
- * Formats the given seconds to nice readable time
- * @param totalSeconds {number} time in seconds
- * @return {{seconds: number, minutes: number, time: string}}
- */
-export function formatTime(totalSeconds)
-{
-    totalSeconds = Math.floor(totalSeconds);
-    let minutes = Math.floor(totalSeconds / 60);
-    let seconds = Math.round(totalSeconds - (minutes * 60));
-    return {
-        "minutes": minutes,
-        "seconds": seconds,
-        "time": `${minutes.toString().padStart(2, "0")}:${seconds.toString().padStart(2, "0")}`
-    };
-}
-
-/**
- * @param fileName {string}
- * @returns {string}
- */
-export function formatTitle(fileName)
-{
-    return fileName
-        .trim()
-        .replaceAll(".mid", "")
-        .replaceAll(".kar", "")
-        .replaceAll(".rmi", "")
-        .replaceAll(".xmf", "")
-        .replaceAll(".mxmf", "")
-        .replaceAll("_", " ")
-        .trim();
-}
-
-/**
- * Does what it says
- * @param arr {number[]|Uint8Array}
- * @returns {string}
- */
-export function arrayToHexString(arr)
-{
-    let hexString = "";
-    
-    for (let i = 0; i < arr.length; i++)
-    {
-        const hex = arr[i].toString(16).padStart(2, "0").toUpperCase();
-        hexString += hex;
-        hexString += " ";
-    }
-    
-    return hexString;
-}
-
-/**
- * @param eventData {Uint8Array}
- * @returns {Uint8Array}
- */
-export function sanitizeKarLyrics(eventData)
-{
-    // for KAR files:
-    // https://www.mixagesoftware.com/en/midikit/help/HTML/karaoke_formats.html
-    // "/" is the newline character
-    // "\" is also the newline character
-    // "\" ASCII code is 92
-    // "/" ASCII code is 47
-    // newline ASCII code is 10
-    const sanitized = [];
-    for (let byte of eventData)
-    {
-        if (byte === 47 || byte === 92)
-        {
-            byte = 10;
-        }
-        sanitized.push(byte);
-    }
-    return new Uint8Array(sanitized);
-}
-
-export const consoleColors = {
-    warn: "color: orange;",
-    unrecognized: "color: red;",
-    info: "color: aqua;",
-    recognized: "color: lime",
-    value: "color: yellow; background-color: black;"
-};
-
-

package/utils/sysex_detector.js

@@ -1,58 +0,0 @@
-/**
- * @param e {MIDIMessage}
- * @returns boolean
- */
-export function isXGOn(e)
-{
-    return e.messageData[0] === 0x43 && // Yamaha
-        e.messageData[2] === 0x4C &&    // XG ON
-        e.messageData[5] === 0x7E &&
-        e.messageData[6] === 0x00;
-}
-
-/**
- * @param e {MIDIMessage}
- * @returns boolean
- */
-export function isGSDrumsOn(e)
-{
-    return e.messageData[0] === 0x41 &&     // roland
-        e.messageData[2] === 0x42 &&        // GS
-        e.messageData[3] === 0x12 &&        // GS
-        e.messageData[4] === 0x40 &&        // system parameter
-        (e.messageData[5] & 0x10) !== 0 &&  // part parameter
-        e.messageData[6] === 0x15;          // drum pars
-}
-
-/**
- * @param e {MIDIMessage}
- * @returns boolean
- */
-export function isGSOn(e)
-{
-    return e.messageData[0] === 0x41  // roland
-        && e.messageData[2] === 0x42  // GS
-        && e.messageData[6] === 0x7F; // Mode set
-}
-
-/**
- * @param e {MIDIMessage}
- * @returns boolean
- */
-export function isGMOn(e)
-{
-    return e.messageData[0] === 0x7E  // non realtime
-        && e.messageData[2] === 0x09  // gm system
-        && e.messageData[3] === 0x01; // gm1
-}
-
-/**
- * @param e {MIDIMessage}
- * @returns boolean
- */
-export function isGM2On(e)
-{
-    return e.messageData[0] === 0x7E  // non realtime
-        && e.messageData[2] === 0x09  // gm system
-        && e.messageData[3] === 0x03; // gm2
-}

package/utils/xg_hacks.js

@@ -1,193 +0,0 @@
-import { SpessaSynthInfo } from "./loggin.js";
-import { consoleColors } from "./other.js";
-import { DEFAULT_PERCUSSION } from "../synthetizer/synth_constants.js";
-
-export const XG_SFX_VOICE = 64;
-
-const GM2_DEFAULT_BANK = 121;
-
-/**
- * @param sys {SynthSystem}
- * @returns {number}
- */
-export function getDefaultBank(sys)
-{
-    return sys === "gm2" ? GM2_DEFAULT_BANK : 0;
-}
-
-/**
- * @param bankNr {number}
- * @returns {boolean}
- */
-export function isXGDrums(bankNr)
-{
-    return bankNr === 120 || bankNr === 126 || bankNr === 127;
-}
-
-/**
- * @param bank {number}
- * @returns {boolean}
- */
-export function isValidXGMSB(bank)
-{
-    return isXGDrums(bank) || bank === XG_SFX_VOICE || bank === GM2_DEFAULT_BANK;
-}
-
-/**
- * Bank select hacks abstracted here
- * @param bankBefore {number} the current bank number
- * @param bank {number} the cc change bank number
- * @param system {SynthSystem} MIDI system
- * @param isLSB {boolean} is bank LSB?
- * @param isDrums {boolean} is drum channel?
- * @param channelNumber {number} channel number
- * @returns {{
- *     newBank: number,
- *     drumsStatus: 0|1|2
- * }} 0 - unchanged, 1 - OFF, 2 - ON
- */
-export function parseBankSelect(bankBefore, bank, system, isLSB, isDrums, channelNumber)
-{
-    // 64 means SFX in MSB, so it is allowed
-    let out = bankBefore;
-    let drumsStatus = 0;
-    if (isLSB)
-    {
-        if (isSystemXG(system))
-        {
-            if (!isValidXGMSB(bank))
-            {
-                out = bank;
-            }
-        }
-        else if (system === "gm2")
-        {
-            out = bank;
-        }
-    }
-    else
-    {
-        let canSetBankSelect = true;
-        switch (system)
-        {
-            case "gm":
-                // gm ignores bank select
-                SpessaSynthInfo(
-                    `%cIgnoring the Bank Select (${bank}), as the synth is in GM mode.`,
-                    consoleColors.info
-                );
-                canSetBankSelect = false;
-                break;
-            
-            case "xg":
-                canSetBankSelect = isValidXGMSB(bank);
-                // for xg, if msb is 120, 126 or 127, then it's drums
-                if (isXGDrums(bank))
-                {
-                    drumsStatus = 2;
-                }
-                else
-                {
-                    // drums shall not be disabled on channel 9
-                    if (channelNumber % 16 !== DEFAULT_PERCUSSION)
-                    {
-                        drumsStatus = 1;
-                    }
-                }
-                break;
-            
-            case "gm2":
-                if (bank === 120)
-                {
-                    drumsStatus = 2;
-                }
-                else
-                {
-                    if (channelNumber % 16 !== DEFAULT_PERCUSSION)
-                    {
-                        drumsStatus = 1;
-                    }
-                }
-        }
-        
-        if (isDrums)
-        {
-            // 128 for percussion channel
-            bank = 128;
-        }
-        if (bank === 128 && !isDrums)
-        {
-            // if a channel is not for percussion, default to bank current
-            bank = bankBefore;
-        }
-        if (canSetBankSelect)
-        {
-            out = bank;
-        }
-    }
-    return {
-        newBank: out,
-        drumsStatus: drumsStatus
-    };
-}
-
-
-/**
- * Chooses a bank number according to spessasynth logic
- * That is:
- * for GS, bank MSB if not drum, otherwise 128
- * for XG: bank MSB if drum and MSB is valid, 128 othewise, bank MSB if it is SFX voice, LSB otherwise
- * @param msb {number}
- * @param lsb {number}
- * @param isDrums {boolean}
- * @param isXG {boolean}
- * @returns {number}
- */
-export function chooseBank(msb, lsb, isDrums, isXG)
-{
-    if (isXG)
-    {
-        if (isDrums)
-        {
-            if (isXGDrums(msb))
-            {
-                return msb;
-            }
-            else
-            {
-                return 128;
-            }
-        }
-        else
-        {
-            // check for SFX
-            if (isValidXGMSB(msb))
-            {
-                return msb;
-            }
-            // if lsb is 0 and msb is not, use that
-            if (lsb === 0 && msb !== 0)
-            {
-                return msb;
-            }
-            if (!isValidXGMSB(lsb))
-            {
-                return lsb;
-            }
-            return 0;
-        }
-    }
-    else
-    {
-        return isDrums ? 128 : msb;
-    }
-}
-
-/**
- * @param system {SynthSystem}
- * @returns boolean
- */
-export function isSystemXG(system)
-{
-    return system === "gm2" || system === "xg";
-}