spessasynth_lib 3.24.26 → 3.24.28

package/README.md

@@ -32,13 +32,28 @@ document.getElementById("button").onclick = async () =>
 
 ## Current Features
 
+### Numerous Format Support
+Supported formats list:
+- `.mid` - Standard MIDI File
+- `.kar` - Soft Karaoke MIDI File
+- `.sf2` - SoundFont2 File
+- `.sf3` - SoundFont2 Compressed File
+- `.sfogg` - SF2Pack With Vorbis Compression
+- `.dls` - Downloadable Sounds Levels 1 & 2 (as well as Mobile DLS)
+- `.rmi` - RIFF MIDI File
+- `.rmi` - RIFF MIDI File With Embedded DLS
+- `.rmi` - [RIFF MIDI File With Embedded SF2](https://github.com/spessasus/sf2-rmidi-specification)
+
+*With [an easy way of converting between them!](https://github.com/spessasus/SpessaSynth/wiki/Converting-Between-Formats)*
+
 ### Easy Integration
-- **Modular design:** Easy integration into other projects (load what you need)
-- **[Detailed documentation:](https://github.com/spessasus/SpessaSynth/wiki/Home)** With [examples!](https://github.com/spessasus/SpessaSynth/wiki/Usage-As-Library#examples)
-- **Easy to Use:** basic setup is just [two lines of code!](https://github.com/spessasus/SpessaSynth/wiki/Usage-As-Library#minimal-setup)
-- **No dependencies:** _batteries included!_
+- **Modular design:** *Easy integration into other projects (load what you need)*
+- **[Detailed documentation:](https://github.com/spessasus/SpessaSynth/wiki/Home)** *With [examples!](https://github.com/spessasus/SpessaSynth/wiki/Usage-As-Library#examples)*
+- **Flexible:** *It's not just a MIDI player!*
+- **Easy to Use:** *Basic setup is just [two lines of code!](https://github.com/spessasus/SpessaSynth/wiki/Usage-As-Library#minimal-setup)*
+- **No dependencies:** *Batteries included!*
 
-### Powerful SoundFont Synthesizer
+### Powerful Synthesizer
 - Suitable for both **real-time** and **offline** synthesis
 - **Excellent SoundFont support:**
   - **Full Generator Support**
@@ -63,19 +78,22 @@ document.getElementById("button").onclick = async () =>
 - **[Custom modulators for additional controllers](https://github.com/spessasus/SpessaSynth/wiki/Modulator-Class#default-modulators):** *Why not?*
 - **Written using AudioWorklets:** 
   - Runs in a **separate thread** for maximum performance
+  - Doesn't stop playing even when the main thread is frozen
   - Supported by all modern browsers
 - **Unlimited channel count:** Your CPU is the limit!
 - **Excellent MIDI Standards Support:**
   - **MIDI Controller Support:** Default supported controllers [here](https://github.com/spessasus/SpessaSynth/wiki/MIDI-Implementation#supported-controllers)
+  - **Portamento Support:** Glide the notes!
+  - **Sound Controllers:** Real-time filter and envelope control!
   - **MIDI Tuning Standard Support:** [more info here](https://github.com/spessasus/SpessaSynth/wiki/MIDI-Implementation#midi-tuning-standard)
   - [Full **RPN** and limited **NRPN** support](https://github.com/spessasus/SpessaSynth/wiki/MIDI-Implementation#supported-registered-parameters)
   - Supports some [**Roland GS** and **Yamaha XG** system exclusives](https://github.com/spessasus/SpessaSynth/wiki/MIDI-Implementation#supported-system-exclusives)
-- **High-performance mode:** Play Rush E! _note: may kill your browser ;)_
+- **High-performance mode:** Play Rush E! *note: may kill your browser ;)*
 
-### Built-in Powerful and Fast Sequencer
-- **Supports MIDI formats 0, 1, and 2:** _note: format 2 support is experimental as it's very, very rare_
+### Powerful and Fast MIDI Sequencer
+- **Supports MIDI formats 0, 1, and 2:** *note: format 2 support is experimental as it's very, very rare.*
 - **[Multi-Port MIDI](https://github.com/spessasus/SpessaSynth/wiki/About-Multi-Port) support:** More than 16 channels!
-- **Smart preloading:** Only preloads the samples used in the MIDI file for smooth playback (down to key and velocity!)
+- **Smart preloading:** Only preloads the samples used in the MIDI file for smooth playback *(down to key and velocity!)*
 - **Lyrics support:** Add karaoke to your program!
 - **Raw lyrics available:** Decode in any encoding! *(Kanji? No problem!)*
 - **Runs in Audio Thread as well:** Never blocks the main thread
@@ -89,7 +107,7 @@ document.getElementById("button").onclick = async () =>
   - **Used channels on track:** Quickly determine which channels are used
   - **Key range detection:** Detect the key range of the MIDI
   - **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_)
+  - **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)**

package/index.js

@@ -8,7 +8,10 @@ import { Generator } from "./soundfont/basic_soundfont/generator.js";
 import { Modulator } from "./soundfont/basic_soundfont/modulator.js";
 import { BasicPresetZone } from "./soundfont/basic_soundfont/basic_zones.js";
 import { BasicPreset } from "./soundfont/basic_soundfont/basic_preset.js";
+import { BasicMIDI } from "./midi_parser/basic_midi.js";
+import { MidiMessage } from "./midi_parser/midi_message.js";
 import { MIDI } from './midi_parser/midi_loader.js';
+import { RMIDINFOChunks } from "./midi_parser/rmidi_writer.js";
 import { MIDIticksToSeconds } from './midi_parser/basic_midi.js';
 import { MIDIBuilder } from "./midi_parser/midi_builder.js";
 import { Synthetizer, VOICE_CAP, DEFAULT_PERCUSSION } from './synthetizer/synthetizer.js';
@@ -32,19 +35,28 @@ import { MIDIDeviceHandler} from "./external_midi/midi_handler.js";
 import { WebMidiLinkHandler} from "./external_midi/web_midi_link.js";
 import { formatTime, formatTitle, consoleColors, arrayToHexString } from './utils/other.js';
 import { readBytesAsUintBigEndian } from './utils/byte_functions/big_endian.js';
+import { readBytesAsString } from "./utils/byte_functions/string.js";
+import { readLittleEndian } from "./utils/byte_functions/little_endian.js";
+import { readVariableLengthQuantity } from "./utils/byte_functions/variable_length_quantity.js";
 import { modulatorSources } from "./soundfont/basic_soundfont/modulator.js";
 import { NON_CC_INDEX_OFFSET } from "./synthetizer/worklet_system/worklet_utilities/controller_tables.js";
 import { ALL_CHANNELS_OR_DIFFERENT_ACTION } from './synthetizer/worklet_system/message_protocol/worklet_message.js';
+import { DEFAULT_SYNTH_CONFIG } from "./synthetizer/audio_effects/effects_config.js";
 import { trimSoundfont} from "./soundfont/basic_soundfont/write_sf2/soundfont_trimmer.js";
 import { WORKLET_URL_ABSOLUTE } from './synthetizer/worklet_url.js';
+import { SynthesizerSnapshot} from "./synthetizer/worklet_system/snapshot/synthesizer_snapshot.js";
+import { ChannelSnapshot } from "./synthetizer/worklet_system/snapshot/channel_snapshot.js";
 
 // Export modules
 export {
     // Synthesizer and Sequencer
     Sequencer,
     Synthetizer,
+    SynthesizerSnapshot,
+    ChannelSnapshot,
     DEFAULT_PERCUSSION,
     VOICE_CAP,
+    DEFAULT_SYNTH_CONFIG,
     
     // SoundFont
     BasicSoundFont,
@@ -61,13 +73,16 @@ export {
     
     // MIDI
     MIDI,
+    BasicMIDI,
     MIDIBuilder,
     IndexedByteArray,
+    MidiMessage,
     writeMIDIFile,
     writeRMIDI,
     applySnapshotToMIDI,
     modifyMIDI,
     MIDIticksToSeconds,
+    RMIDINFOChunks,
     
     // Utilities
     audioBufferToWav,
@@ -86,7 +101,12 @@ export {
     consoleColors,
     formatTitle,
     formatTime,
+    
     readBytesAsUintBigEndian,
+    readBytesAsString,
+    readLittleEndian,
+    readVariableLengthQuantity,
+    
     NON_CC_INDEX_OFFSET,
     ALL_CHANNELS_OR_DIFFERENT_ACTION,
     WORKLET_URL_ABSOLUTE

package/midi_parser/basic_midi.js

@@ -92,9 +92,6 @@ export class BasicMIDI extends MIDISequenceData
          * @type {boolean}
          */
         let karaokeHasTitle = false;
-        let portOffset = 0;
-        this.midiPorts = [];
-        this.midiPortChannelOffsets = [];
         
         this.keyRange = { max: 0, min: 127 };
         
@@ -126,7 +123,6 @@ export class BasicMIDI extends MIDISequenceData
         {
             const track = this.tracks[i];
             const usedChannels = new Set();
-            this.midiPorts.push(-1);
             let trackHasVoiceMessages = false;
             
             for (const e of track)
@@ -230,16 +226,6 @@ export class BasicMIDI extends MIDISequenceData
                         e.messageData.currentIndex = 0;
                         break;
                     
-                    case messageTypes.midiPort:
-                        const port = e.messageData[0];
-                        this.midiPorts[i] = port;
-                        if (this.midiPortChannelOffsets[port] === undefined)
-                        {
-                            this.midiPortChannelOffsets[port] = portOffset;
-                            portOffset += 16;
-                        }
-                        break;
-                    
                     case messageTypes.copyright:
                         if (!copyrightDetected)
                         {
@@ -399,6 +385,33 @@ export class BasicMIDI extends MIDISequenceData
             consoleColors.recognized
         );
         
+        // determine ports
+        let portOffset = 0;
+        this.midiPorts = [];
+        this.midiPortChannelOffsets = [];
+        for (let trackNum = 0; trackNum < this.tracks.length; trackNum++)
+        {
+            this.midiPorts.push(-1);
+            if (this.usedChannelsOnTrack[trackNum].size === 0)
+            {
+                continue;
+            }
+            for (const e of this.tracks[trackNum])
+            {
+                if (e.messageStatusByte !== messageTypes.midiPort)
+                {
+                    continue;
+                }
+                const port = e.messageData[0];
+                this.midiPorts[trackNum] = port;
+                if (this.midiPortChannelOffsets[port] === undefined)
+                {
+                    this.midiPortChannelOffsets[port] = portOffset;
+                    portOffset += 16;
+                }
+            }
+        }
+        
         // 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,
@@ -408,15 +421,21 @@ export class BasicMIDI extends MIDISequenceData
         // 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;
+        let defaultPort = Infinity;
         for (let port of this.midiPorts)
         {
             if (port !== -1)
             {
-                defaultPort = port;
-                break;
+                if (defaultPort > port)
+                {
+                    defaultPort = port;
+                }
             }
         }
+        if (defaultPort === Infinity)
+        {
+            defaultPort = 0;
+        }
         this.midiPorts = this.midiPorts.map(port => port === -1 ? defaultPort : port);
         // add fake port if empty
         if (this.midiPortChannelOffsets.length === 0)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spessasynth_lib",
-  "version": "3.24.26",
+  "version": "3.24.28",
   "description": "MIDI and SoundFont2/DLS library with no compromises",
   "browser": "index.js",
   "type": "module",
@@ -11,6 +11,7 @@
     "type": "git",
     "url": "git+https://github.com/spessasus/SpessaSynth.git"
   },
+  "main": "index.js",
   "keywords": [
     "soundfont",
     "synthesizer",

package/sequencer/sequencer.js

@@ -99,7 +99,7 @@ export class Sequencer
     
     /**
      * Fires on meta-event
-     * @type {Object<string, function([number, Uint8Array])>}
+     * @type {Object<string, function([number, Uint8Array, number])>}
      */
     onMetaEvent = {};
     
@@ -438,7 +438,7 @@ export class Sequencer
     
     /**
      * Adds a new event that gets called when a meta-event occurs
-     * @param callback {function([number, Uint8Array])} the meta-event type and its data
+     * @param callback {function([number, Uint8Array, number])} the meta-event type, its data and the track number
      * @param id {string} must be unique
      */
     addOnMetaEvent(callback, id)

package/sequencer/worklet_sequencer/process_event.js

@@ -171,7 +171,10 @@ export function _processEvent(event, trackIndex)
     }
     if (statusByteData.status >= 0 && statusByteData.status < 0x80)
     {
-        this.post(WorkletSequencerReturnMessageType.metaEvent, [event.messageStatusByte, event.messageData]);
+        this.post(
+            WorkletSequencerReturnMessageType.metaEvent,
+            [event.messageStatusByte, event.messageData, trackIndex]
+        );
     }
 }
 

package/sequencer/worklet_sequencer/sequencer_message.js

@@ -47,6 +47,6 @@ export const WorkletSequencerReturnMessageType = {
     pause: 4,                   // no data
     getMIDI: 5,                 // midiData<MIDI>
     midiError: 6,               // errorMSG<string>
-    metaEvent: 7,               // [messageType<number>, messageData<Uint8Array>]
+    metaEvent: 7,               // [messageType<number>, messageData<Uint8Array>, trackNum<number>]
     loopCountChange: 8          // newLoopCount<number>
 };