spessasynth_core 3.27.8 → 4.0.0

package/README.md

@@ -3,7 +3,10 @@
 <img src='https://raw.githubusercontent.com/spessasus/SpessaSynth/refs/heads/master/src/website/spessasynth_logo_rounded.png' width='300' alt='SpessaSynth logo'>
 </p>
 
-**A powerful SF2/DLS/MIDI JavaScript library. It works with any modern JS environment that supports WebAssembly.**
+*A powerful SF2/DLS/MIDI TypeScript/JavaScript library. It works with any modern JS environment that supports
+WebAssembly.*
+
+
 
 It allows you to:
 
@@ -13,13 +16,14 @@ It allows you to:
 - Convert DLS to SF2! (and back!)
 - [and more!](#current-features)
 
-### Install
 
-```shell
-npm install --save spessasynth_core
-```
+
+### v4.0.0 TypeScript Update is here! 
+
+[**Read about breaking changes here.**](https://spessasus.github.io/spessasynth_core/extra/3-28-migration-guide)
 
 > **Tip:**
+> 
 > Looking for an easy-to-use WebAudioAPI browser wrapper?
 > Try [spessasynth_lib](https://github.com/spessasus/spessasynth_lib)!
 
@@ -47,8 +51,9 @@ npm install --save spessasynth_core
 - **Modular design:** *Easy integration into other projects (load what you need)*
 - **Flexible:** *It's not just a MIDI player!*
 - **Easy to Use:** *Basic setup is
-  just [two lines of code!](https://spessasus.github.io/spessasynth_core/Getting-Started#minimal-setup)*
+  just [two lines of code!](https://spessasus.github.io/spessasynth_core/getting-started#minimal-setup)*
 - **No dependencies:** *Batteries included!*
+- **TypeScript definitions:** *Autocompletion in IDEs!*
 
 ### Powerful MIDI Synthesizer
 
@@ -77,23 +82,24 @@ npm install --save spessasynth_core
 - **Unlimited channel count:** Your CPU is the limit!
 - **Excellent MIDI Standards Support:**
     - **MIDI Controller Support:** Default supported
-      controllers [here](https://spessasus.github.io/spessasynth_core/MIDI-Implementation#default-supported-controllers)
+      controllers [here](https://spessasus.github.io/spessasynth_core/extra/midi-implementation#default-supported-controllers)
     - **Portamento Support:** *Smooth note gliding!*
     - **Sound Controllers:** *Real-time filter and envelope control!*
     - **MIDI Tuning Standard Support:**
-      *[more info here](https://spessasus.github.io/spessasynth_core/MIDI-Implementation#midi-tuning-standard)*
+      *[more info here](https://spessasus.github.io/spessasynth_core/extra/midi-implementation#midi-tuning-standard)*
     - [Full **RPN** and limited **NRPN**
-      support](https://spessasus.github.io/spessasynth_core/MIDI-Implementation#supported-registered-parameters)
+      support](https://spessasus.github.io/spessasynth_core/extra/midi-implementation#supported-registered-parameters)
     - **SoundFont2 NRPN Support**
     - [**AWE32**
-      NRPN Compatibility Layer](https://spessasus.github.io/spessasynth_core/MIDI-Implementation#awe32-nrpn-compatibility-layer)
+      NRPN Compatibility Layer](https://spessasus.github.io/spessasynth_core/extra/midi-implementation#awe32-nrpn-compatibility-layer)
     - Supports some [**Roland GS** and **Yamaha XG**
-      system exclusives](https://spessasus.github.io/spessasynth_core/MIDI-Implementation#supported-system-exclusives)
+      system exclusives](https://spessasus.github.io/spessasynth_core/extra/midi-implementation#supported-system-exclusives)
 
 ### 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://spessasus.github.io/spessasynth_core/About-Multi-Port) support:** *More than 16 channels!*
+- **[Multi-Port MIDI](https://spessasus.github.io/spessasynth_core/extra/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!)*
 - **Lyrics support:** *Add karaoke to your program!*
@@ -110,16 +116,16 @@ npm install --save spessasynth_core
 - **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://spessasus.github.io/spessasynth_core/Writing-MIDI-Files#modifymidi) to modify the
+  Use [helper functions](https://spessasus.github.io/spessasynth_core/writing-files/midi#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://spessasus.github.io/spessasynth_core/Creating-MIDI-Files)**
+- **[Write MIDI files from scratch](https://spessasus.github.io/spessasynth_core/midi/creating-midi-files)**
 - **Easy saving:** *Save with
-  just [one function!](https://spessasus.github.io/spessasynth_core/Writing-MIDI-Files#writemidi)*
+  just [one function!](https://spessasus.github.io/spessasynth_core/writing-files/midi#writemidi)*
 
-#### Read and write [RMID files with embedded SF2 soundfonts](https://github.com/spessasus/sf2-rmidi-specification#readme)*
+#### Read and write [RMID files with embedded sound banks](https://github.com/spessasus/sf2-rmidi-specification#readme)
 
 - **[Level 4](https://github.com/spessasus/sf2-rmidi-specification#level-4) compliance:** Reads and writes *everything!*
 - **Compression and trimming support:** *Reduce a MIDI file with a 1GB sound bank to **as small as 5MB**!*
@@ -129,15 +135,15 @@ npm install --save spessasynth_core
   encoding!)*
 - **Compatible with [Falcosoft Midi Player 6!](https://falcosoft.hu/softwares.html#midiplayer)**
 - **Easy saving:**
-  *[As simple as saving a MIDI file!](https://spessasus.github.io/spessasynth_core/Writing-MIDI-Files#writermidi)*
+  *[As simple as saving a MIDI file!](https://spessasus.github.io/spessasynth_core/writing-files/midi#writermidi)*
 
 #### Read and write SoundFont2 files
 
 - **Easy info access:** *Just
-  an [object of strings!](https://spessasus.github.io/spessasynth_core/Sound-Bank#soundfontinfo)*
+  an [object of strings!](https://spessasus.github.io/spessasynth_core/sound-bank#soundbankinfo)*
 - **Smart trimming:** Trim the sound bank to only include samples used in the MIDI *(down to key and velocity!)*
 - **SF3 conversion:** *Compress SoundFont2 files to SoundFont3 with variable quality!*
-- **Easy saving:** *Also just [one function!](https://spessasus.github.io/spessasynth_core/Sound-Bank#write)*
+- **Easy saving:** *Also just [one function!](https://spessasus.github.io/spessasynth_core/sound-bank#write)*
 
 #### Read and write SoundFont3 files
 
@@ -150,16 +156,16 @@ npm install --save spessasynth_core
 
 - Read DLS (DownLoadable Sounds) files like SF2 files!
 - **Native support:** *Saving it as sf2 is
-  still [just one function!](https://spessasus.github.io/spessasynth_core/Sound-Bank#write)*
+  still [just one function!](https://spessasus.github.io/spessasynth_core/sound-bank#write)*
 - *That's right, saving as DLS is
-  also [just one function!](https://spessasus.github.io/spessasynth_core/Sound-Bank#writedls)*
+  also [just one function!](https://spessasus.github.io/spessasynth_core/sound-bank#writedls)*
 - Converts articulators to both **modulators** and **generators**!
 - Works with both unsigned 8-bit samples and signed 16-bit samples!
 - **A-Law encoding support:** *Sure, why not?*
 - **Covers special generator cases:** *such as modLfoToPitch*!
 - **Correct volume:** *looking at you, Viena and gm.sf2!*
 - Support built right into the synthesizer!
-- **Convert SF2 to DLS:** [limited support](https://spessasus.github.io/spessasynth_core/DLS-Conversion-Problem)
+- **Convert SF2 to DLS:** [limited support](https://spessasus.github.io/spessasynth_core/extra/dls-conversion-problem)
 
 ### Export MIDI as WAV
 
@@ -168,12 +174,12 @@ npm install --save spessasynth_core
 - **Cue points:** *Write MIDI loop points as cue points!*
 - **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://spessasus.github.io/spessasynth_core/Writing-Wave-Files#audiobuffertowav)*
+  also [just one function!](https://spessasus.github.io/spessasynth_core/writing-files/wav#audiobuffertowav)*
 
 ### Limitations
 
 - Synth's performance may be questionable sometimes
-- [SF2 to DLS Conversion limits](https://github.com/spessasus/SpessaSynth/wiki/DLS-Conversion-Problem)
+- [SF2 to DLS Conversion limits](https://spessasus.github.io/spessasynth_core/extra/dls-conversion-problem)
 
 #### TODO
 
@@ -189,6 +195,7 @@ npm install --save spessasynth_core
 - [RecordingBlogs](https://www.recordingblogs.com/) - for detailed explanations on MIDI messages
 - [stbvorbis.js](https://github.com/hajimehoshi/stbvorbis.js) - for the Vorbis decoder
 - [fflate](https://github.com/101arrowz/fflate) - for the MIT DEFLATE implementation
+- [tsup](https://github.com/egoist/tsup) - for the TypeScript bundler
 - [foo_midi](https://github.com/stuerp/foo_midi) - for useful resources on XMF file format
 - [Falcosoft](https://falcosoft.hu) - for help with the RMIDI format
 - [Christian Collins](https://schristiancollins.com) - for various bug reports regarding the synthesizer
@@ -198,66 +205,93 @@ npm install --save spessasynth_core
 
 ### Short example: MIDI to wav converter
 
-```js
+```ts
 import * as fs from "node:fs";
-import {MIDI, SpessaSynthProcessor, SpessaSynthSequencer, audioToWav, loadSoundFont} from "spessasynth_core";
+import {
+    audioToWav,
+    BasicMIDI,
+    SoundBankLoader,
+    SpessaSynthProcessor,
+    SpessaSynthSequencer
+} from "../../src";
 
 // process arguments
 const args = process.argv.slice(2);
 if (args.length !== 3) {
-    console.log("Usage: node index.js <soundfont path> <midi path> <wav output path>");
+    console.info(
+        "Usage: tsx index.ts <soundbank path> <midi path> <wav output path>"
+    );
     process.exit();
 }
 const sf = fs.readFileSync(args[0]);
 const mid = fs.readFileSync(args[1]);
-const midi = new MIDI(mid);
+const midi = BasicMIDI.fromArrayBuffer(mid.buffer);
 const sampleRate = 44100;
-const sampleCount = 44100 * (midi.duration + 2);
+const sampleCount = Math.ceil(44100 * (midi.duration + 2));
 const synth = new SpessaSynthProcessor(sampleRate, {
     enableEventSystem: false,
-    effectsEnabled: false
+    enableEffects: false
 });
-synth.soundfontManager.reloadManager(loadSoundFont(sf));
+synth.soundBankManager.reloadManager(
+    SoundBankLoader.fromArrayBuffer(sf.buffer)
+);
 await synth.processorInitialized;
 const seq = new SpessaSynthSequencer(synth);
 seq.loadNewSongList([midi]);
-seq.loop = false;
+seq.play();
+
 const outLeft = new Float32Array(sampleCount);
 const outRight = new Float32Array(sampleCount);
 const start = performance.now();
 let filledSamples = 0;
 // note: buffer size is recommended to be very small, as this is the interval between modulator updates and LFO updates
-const bufSize = 128;
+const BUFFER_SIZE = 128;
 let i = 0;
-while (filledSamples + bufSize < sampleCount) {
-    const bufLeft = new Float32Array(bufSize);
-    const bufRight = new Float32Array(bufSize);
+const durationRounded = Math.floor(seq.midiData.duration * 100) / 100;
+const outputArray = [outLeft, outRight];
+while (filledSamples < sampleCount) {
     // process sequencer
     seq.processTick();
-    const arr = [bufLeft, bufRight];
     // render
-    synth.renderAudio(arr, arr, arr);
-    // write out
-    outLeft.set(bufLeft, filledSamples);
-    outRight.set(bufRight, filledSamples);
-    filledSamples += bufSize;
+    const bufferSize = Math.min(BUFFER_SIZE, sampleCount - filledSamples);
+    synth.renderAudio(outputArray, [], [], filledSamples, bufferSize);
+    filledSamples += bufferSize;
     i++;
     // log progress
     if (i % 100 === 0) {
-        console.log("Rendered", seq.currentTime, "/", midi.duration);
+        console.info(
+            "Rendered",
+            Math.floor(seq.currentTime * 100) / 100,
+            "/",
+            durationRounded
+        );
     }
 }
-console.log("Rendered in", Math.floor(performance.now() - start), "ms");
-const wave = audioToWav({
-    leftChannel: outLeft,
-    rightChannel: outRight,
-    sampleRate: sampleRate
+const rendered = Math.floor(performance.now() - start);
+console.info(
+    "Rendered in",
+    rendered,
+    `ms (${Math.floor(((midi.duration * 1000) / rendered) * 100) / 100}x)`
+);
+const wave = audioToWav([outLeft, outRight], sampleRate);
+fs.writeFile(args[2], new Uint8Array(wave), () => {
+    console.log(`File written to ${args[2]}`);
 });
-fs.writeFileSync(args[2], new Buffer(wave));
-process.exit();
+
+```
+
+### Building
+
+To build the NPM package, do:
+
+```bash
+npm install
+npm run build
 ```
 
-# License
+The files will be placed in the `dist` folder.
+
+## License
 
 Copyright © 2025 Spessasus
 Licensed under the Apache-2.0 License.