spessasynth_lib 3.26.0 → 3.26.2

package/external_midi/README.md

@@ -0,0 +1,4 @@
+## This is the MIDI handling folder.
+
+The code here is respnsible for dealing with MIDI Inputs and outputs
+and also for the WebMidiLink functionality.

package/external_midi/midi_handler.js

@@ -0,0 +1,130 @@
+import { Synthetizer } from "../synthetizer/synthetizer.js";
+import { SpessaSynthCoreUtils as util } from "spessasynth_core";
+import { consoleColors } from "../utils/other.js";
+
+/**
+ * midi_handler.js
+ * purpose: handles the connection between MIDI devices and synthesizer/sequencer via Web MIDI API
+ */
+
+const NO_INPUT = null;
+
+// noinspection JSUnusedGlobalSymbols
+/**
+ * A class for handling MIDI devices
+ */
+export class MIDIDeviceHandler
+{
+    /**
+     * @returns {Promise<boolean>} if succeeded
+     */
+    async createMIDIDeviceHandler()
+    {
+        /**
+         * @type {MIDIInput}
+         */
+        this.selectedInput = NO_INPUT;
+        /**
+         * @type {MIDIOutput}
+         */
+        this.selectedOutput = NO_INPUT;
+        if (navigator.requestMIDIAccess)
+        {
+            // prepare the midi access
+            try
+            {
+                const response = await navigator.requestMIDIAccess({ sysex: true, software: true });
+                this.inputs = response.inputs;
+                this.outputs = response.outputs;
+                util.SpessaSynthInfo("%cMIDI handler created!", consoleColors.recognized);
+                return true;
+            }
+            catch (e)
+            {
+                util.SpessaSynthWarn(`Could not get MIDI Devices:`, e);
+                this.inputs = [];
+                this.outputs = [];
+                return false;
+            }
+        }
+        else
+        {
+            util.SpessaSynthWarn("Web MIDI Api not supported!", consoleColors.unrecognized);
+            this.inputs = [];
+            this.outputs = [];
+            return false;
+        }
+    }
+    
+    /**
+     * Connects the sequencer to a given MIDI output port
+     * @param output {MIDIOutput}
+     * @param seq {Sequencer}
+     */
+    connectMIDIOutputToSeq(output, seq)
+    {
+        this.selectedOutput = output;
+        seq.connectMidiOutput(output);
+        util.SpessaSynthInfo(
+            `%cPlaying MIDI to %c${output.name}`,
+            consoleColors.info,
+            consoleColors.recognized
+        );
+    }
+    
+    /**
+     * Disconnects a midi output port from the sequencer
+     * @param seq {Sequencer}
+     */
+    disconnectSeqFromMIDI(seq)
+    {
+        this.selectedOutput = NO_INPUT;
+        seq.connectMidiOutput(undefined);
+        util.SpessaSynthInfo(
+            "%cDisconnected from MIDI out.",
+            consoleColors.info
+        );
+    }
+    
+    /**
+     * Connects a MIDI input to the synthesizer
+     * @param input {MIDIInput}
+     * @param synth {Synthetizer}
+     */
+    connectDeviceToSynth(input, synth)
+    {
+        this.selectedInput = input;
+        input.onmidimessage = event =>
+        {
+            synth.sendMessage(event.data);
+        };
+        util.SpessaSynthInfo(
+            `%cListening for messages on %c${input.name}`,
+            consoleColors.info,
+            consoleColors.recognized
+        );
+    }
+    
+    /**
+     * @param input {MIDIInput}
+     */
+    disconnectDeviceFromSynth(input)
+    {
+        this.selectedInput = NO_INPUT;
+        input.onmidimessage = undefined;
+        util.SpessaSynthInfo(
+            `%cDisconnected from %c${input.name}`,
+            consoleColors.info,
+            consoleColors.recognized
+        );
+    }
+    
+    disconnectAllDevicesFromSynth()
+    {
+        this.selectedInput = NO_INPUT;
+        for (const i of this.inputs)
+        {
+            i[1].onmidimessage = undefined;
+        }
+    }
+}

package/external_midi/web_midi_link.js

@@ -0,0 +1,43 @@
+import { Synthetizer } from "../synthetizer/synthetizer.js";
+import { consoleColors } from "../utils/other.js";
+import { SpessaSynthCoreUtils } from "spessasynth_core";
+
+/**
+ * web_midi_link.js
+ * purpose: handles the web midi link connection to the synthesizer
+ * https://www.g200kg.com/en/docs/webmidilink/
+ */
+
+export class WebMIDILinkHandler
+{
+    /**
+     * @param synth {Synthetizer} the synth to play to
+     */
+    constructor(synth)
+    {
+        
+        window.addEventListener("message", msg =>
+        {
+            if (typeof msg.data !== "string")
+            {
+                return;
+            }
+            /**
+             * @type {string[]}
+             */
+            const data = msg.data.split(",");
+            if (data[0] !== "midi")
+            {
+                return;
+            }
+            
+            data.shift(); // remove MIDI
+            
+            const midiData = data.map(byte => parseInt(byte, 16));
+            
+            synth.sendMessage(midiData);
+        });
+        
+        SpessaSynthCoreUtils.SpessaSynthInfo("%cWeb MIDI Link handler created!", consoleColors.recognized);
+    }
+}

package/index.js

@@ -1,31 +1,5 @@
 // Import modules
-import {
-    ALL_CHANNELS_OR_DIFFERENT_ACTION,
-    BasicInstrument,
-    BasicInstrumentZone,
-    BasicMIDI,
-    BasicPreset,
-    BasicPresetZone,
-    BasicSample,
-    BasicSoundBank,
-    ChannelSnapshot,
-    DEFAULT_PERCUSSION,
-    Generator,
-    IndexedByteArray,
-    loadSoundFont,
-    messageTypes,
-    MIDI,
-    MIDIBuilder,
-    midiControllers,
-    MIDIMessage,
-    Modulator,
-    modulatorSources,
-    NON_CC_INDEX_OFFSET,
-    RMIDINFOChunks,
-    SpessaSynthLogging,
-    SynthesizerSnapshot,
-    VOICE_CAP
-} from "spessasynth_core";
+
 import { Synthetizer } from "./synthetizer/synthetizer.js";
 import { Sequencer } from "./sequencer/sequencer.js";
 import { audioBufferToWav } from "./utils/buffer_to_wav.js";
@@ -39,39 +13,10 @@ export {
     // Synthesizer and Sequencer
     Sequencer,
     Synthetizer,
-    SynthesizerSnapshot,
-    ChannelSnapshot,
-    DEFAULT_PERCUSSION,
-    VOICE_CAP,
     DEFAULT_SYNTH_CONFIG,
-    ALL_CHANNELS_OR_DIFFERENT_ACTION,
-    NON_CC_INDEX_OFFSET,
-    
-    // SoundFont
-    BasicSoundBank,
-    BasicSample,
-    BasicInstrumentZone,
-    BasicInstrument,
-    BasicPreset,
-    BasicPresetZone,
-    Generator,
-    Modulator,
-    loadSoundFont,
-    modulatorSources,
-    
-    // MIDI
-    MIDI,
-    BasicMIDI,
-    MIDIBuilder,
-    MIDIMessage,
-    RMIDINFOChunks,
     
     // Utilities
-    IndexedByteArray,
     audioBufferToWav,
-    SpessaSynthLogging,
-    midiControllers,
-    messageTypes,
     MIDIDeviceHandler,
     WebMIDILinkHandler,
     WORKLET_URL_ABSOLUTE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spessasynth_lib",
-  "version": "3.26.0",
+  "version": "3.26.2",
   "description": "MIDI and SoundFont2/DLS library for the browsers with no compromises",
   "browser": "index.js",
   "type": "module",
@@ -45,7 +45,10 @@
     "index.js",
     "LICENSE",
     "README.md",
-    "src"
+    "sequencer",
+    "synthetizer",
+    "utils",
+    "external_midi"
   ],
   "dependencies": {
     "spessasynth_core": "latest"

package/sequencer/README.md

@@ -0,0 +1,32 @@
+## This is the sequencer's folder.
+
+The code here is responsible for playing back the parsed MIDI sequence with the synthesizer.
+
+- `sequencer_engine` - the core sequencer engine, currently runs in audio worklet
+
+### Message protocol:
+
+#### Message structure
+
+```js
+const message = {
+    messageType: number, // WorkletSequencerMessageType
+    messageData: any     // any
+}
+```
+
+#### To worklet
+
+Sequencer uses `Synthetizer`'s `post` method to post a message with `messageData` set to
+`workletMessageType.sequencerSpecific`.
+The `messageData` is set to the sequencer's message.
+
+#### From worklet
+
+`WorkletSequencer` uses `SpessaSynthProcessor`'s post to send a message with `messageData` set to
+`returnMessageType.sequencerSpecific`.
+The `messageData` is set to the sequencer's return message.
+
+### Process tick
+
+`processTick` is called every time the `process` method is called via `SpessaSynthProcessor.processTickCallback`.

package/sequencer/default_sequencer_options.js

@@ -0,0 +1,8 @@
+/**
+ * @type {SequencerOptions}
+ */
+export const DEFAULT_SEQUENCER_OPTIONS = {
+    skipToFirstNoteOn: true,
+    autoPlay: true,
+    preservePlaybackState: false
+};

package/sequencer/midi_data.js

@@ -0,0 +1,63 @@
+import { BasicMIDI, MIDISequenceData } from "spessasynth_core";
+
+/**
+ * A simplified version of the MIDI, accessible at all times from the Sequencer.
+ * Use getMIDI() to get the actual sequence.
+ * This class contains all properties that MIDI does, except for tracks and the embedded soundfont.
+ */
+export class MIDIData extends MIDISequenceData
+{
+    
+    /**
+     * A boolean indicating if the MIDI file contains an embedded soundfont.
+     * If the embedded soundfont is undefined, this will be false.
+     * @type {boolean}
+     */
+    isEmbedded = false;
+    
+    /**
+     * Constructor that copies data from a BasicMIDI instance.
+     * @param {BasicMIDI} midi - The BasicMIDI instance to copy data from.
+     */
+    constructor(midi)
+    {
+        super();
+        this._copyFromSequence(midi);
+        
+        // Set isEmbedded based on the presence of an embeddedSoundFont
+        this.isEmbedded = midi.embeddedSoundFont !== undefined;
+    }
+}
+
+
+/**
+ * Temporary MIDI data used when the MIDI is not loaded.
+ * @type {MIDIData}
+ */
+export const DUMMY_MIDI_DATA = {
+    duration: 99999,
+    firstNoteOn: 0,
+    loop: {
+        start: 0,
+        end: 123456
+    },
+    
+    lastVoiceEventTick: 123456,
+    lyrics: [],
+    copyright: "",
+    midiPorts: [],
+    midiPortChannelOffsets: [],
+    tracksAmount: 0,
+    tempoChanges: [{ ticks: 0, tempo: 120 }],
+    fileName: "NOT_LOADED.mid",
+    midiName: "Loading...",
+    rawMidiName: new Uint8Array([76, 111, 97, 100, 105, 110, 103, 46, 46, 46]), // "Loading..."
+    usedChannelsOnTrack: [],
+    timeDivision: 0,
+    keyRange: { min: 0, max: 127 },
+    isEmbedded: false,
+    RMIDInfo: {},
+    bankOffset: 0,
+    midiNameUsesFileName: false,
+    format: 0
+};