spessasynth_core 1.1.5 → 1.1.7

package/README.md

@@ -9,37 +9,84 @@
 npm install --save spessasynth_core
 ```
 
-### [Project site (consider giving it a star!)](https://github.com/spessasus/spessasynth_core)
+### [Project site (consider giving it a star!)](https://github.com/spessasus/SpessaSynth)
 
-### [Demo (using the spessasynth_lib wrapper)](https://spessasus.github.io/SpessaSynth)
+### [Demo (using the spessasynth_lib wrapper)](https://spessasus.github.io/spessasynth_core)
 
 ### [Documentation (in progress!)](https://github.com/spessasus/spessasynth_core/wiki/Home)
 
 
-> Note: This is the new heart of the SpessaSynth library, after the repository has been split.
-
+> Note: This is the new heart of the spessasynth_core library, after the repository has been split.
+
+### 
+```js
+import * as fs from "node:fs";
+import { MIDI } from "../../src/midi/midi_loader.js";
+import { SpessaSynthProcessor } from "../../src/synthetizer/audio_engine/main_processor.js";
+import { SpessaSynthSequencer } from "../../src/sequencer/sequencer_engine.js";
+import { audioToWav } from "../../src/utils/buffer_to_wav.js";
+
+// 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>");
+    process.exit();
+}
+// load the files
+const sf = fs.readFileSync(args[0]);
+const mid = fs.readFileSync(args[1]);
+
+const midi = new MIDI(mid);
+const sampleRate = 44100;
+const sampleCount = 44100 * (midi.duration + 2);
+
+const synth = new SpessaSynthProcessor(
+    sf,
+    sampleRate,
+    {},
+    false,
+    false
+);
+await synth.processorInitialized;
+
+const seq = new SpessaSynthSequencer(synth);
+seq.loadNewSongList([midi]);
+seq.loop = false;
+
+const outLeft = new Float32Array(sampleCount);
+const outRight = new Float32Array(sampleCount);
+const start = performance.now();
+let filledSamples = 0;
+
+const bufSize = 128;
+while (filledSamples + bufSize < sampleCount)
+{
+    const bufLeft = new Float32Array(bufSize);
+    const bufRight = new Float32Array(bufSize);
+    seq.processTick();
+    const arr = [bufLeft, bufRight];
+    synth.renderAudio(arr, arr, arr);
+    outLeft.set(bufLeft, filledSamples);
+    outRight.set(bufRight, filledSamples);
+    filledSamples += bufSize;
+}
+const wave = audioToWav({
+    leftChannel: outLeft,
+    rightChannel: outRight,
+    sampleRate: sampleRate
+});
+fs.writeFileSync(args[2], new Buffer(wave));
+process.exit();
+```
 
 ## 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)
-- `.xmf` - eXtensible Music Format
-- `.mxmf` - Mobile eXtensible Music format
-
-*With [an easy way of converting between them!](https://github.com/spessasus/spessasynth_core/wiki/Converting-Between-Formats)*
-
 ### Easy Integration
 - **Modular design:** *Easy integration into other projects (load what you need)*
+- **[Detailed documentation:](https://github.com/spessasus/spessasynth_core/wiki/Home)** *With [examples!](https://github.com/spessasus/spessasynth_core/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_core/wiki/Usage-As-Library#minimal-setup)*
 - **No dependencies:** *Batteries included!*
 
 ### Powerful MIDI Synthesizer
@@ -50,7 +97,7 @@ Supported formats list:
   - **GeneralUserGS Compatible:** *[See more here!](https://github.com/mrbumpy409/GeneralUser-GS/blob/main/documentation/README.md)*
   - **SoundFont3 Support:** Play compressed SoundFonts!
   - **Experimental SF2Pack Support:** Play soundfonts compressed with BASSMIDI! (*Note: only works with vorbis compression*)
-  - **Can load very large SoundFonts:** up to 4GB!
+  - **Can load very large SoundFonts:** up to 4GB! *Note: Only Firefox handles this well; Chromium has a hard-coded memory limit*
 - **Great DLS Support:**
   - **DLS Level 1 Support**
   - **DLS Level 2 Support**
@@ -62,7 +109,6 @@ Supported formats list:
   - **Both unsigned 8-bit and signed 16-bit sample support (24-bit theoretically supported as well!)**
   - **Detects special articulator combinations:** *Such as vibratoLfoToPitch*
 - **Soundfont manager:** Stack multiple soundfonts!
-- **[Custom modulators for additional controllers](https://github.com/spessasus/spessasynth_core/wiki/Modulator-Class#default-modulators):** *Why not?*
 - **Unlimited channel count:** Your CPU is the limit!
 - **Excellent MIDI Standards Support:**
   - **MIDI Controller Support:** Default supported controllers [here](https://github.com/spessasus/spessasynth_core/wiki/MIDI-Implementation#supported-controllers)
@@ -78,7 +124,8 @@ Supported formats list:
 - **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!)*
-- **Loop points support:** Ensures seamless loops!
+- **Runs in Audio Thread as well:** Never blocks the main thread
+- **Loop points support:** Ensures seamless loops
 
 ### Read and Write SoundFont and MIDI Files with Ease
 #### Read and write MIDI files
@@ -130,6 +177,7 @@ Supported formats list:
   - **Metadata support:** *Embed metadata such as title, artist, album and more!*
   - **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://github.com/spessasus/spessasynth_core/wiki/Writing-Wave-Files#audiobuffertowav)*
 
 ### Special Thanks
 - [FluidSynth](https://github.com/FluidSynth/fluidsynth) - for the source code that helped implement functionality and fixes

package/index.js

@@ -1,7 +1,22 @@
 import { SpessaSynthProcessor } from "./src/synthetizer/audio_engine/main_processor.js";
 import { SpessaSynthSequencer } from "./src/sequencer/sequencer_engine.js";
-import { ALL_CHANNELS_OR_DIFFERENT_ACTION, DEFAULT_PERCUSSION, VOICE_CAP } from "./src/synthetizer/synth_constants.js";
-import { NON_CC_INDEX_OFFSET } from "./src/synthetizer/audio_engine/engine_components/controller_tables.js";
+import {
+    ALL_CHANNELS_OR_DIFFERENT_ACTION,
+    DEFAULT_PERCUSSION,
+    DEFAULT_SYNTH_MODE,
+    MIDI_CHANNEL_COUNT,
+    VOICE_CAP
+} from "./src/synthetizer/synth_constants.js";
+import {
+    channelConfiguration,
+    NON_CC_INDEX_OFFSET
+} from "./src/synthetizer/audio_engine/engine_components/controller_tables.js";
+import { KeyModifier } from "./src/synthetizer/audio_engine/engine_components/key_modifier_manager.js";
+import {
+    masterParameterType
+} from "./src/synthetizer/audio_engine/engine_methods/controller_control/master_parameters.js";
+import { SynthesizerSnapshot } from "./src/synthetizer/audio_engine/snapshot/synthesizer_snapshot.js";
+import { ChannelSnapshot } from "./src/synthetizer/audio_engine/snapshot/channel_snapshot.js";
 
 import { BasicSoundBank } from "./src/soundfont/basic_soundfont/basic_soundfont.js";
 import { BasicSample } from "./src/soundfont/basic_soundfont/basic_sample.js";
@@ -9,13 +24,15 @@ import { BasicInstrumentZone, BasicPresetZone } from "./src/soundfont/basic_soun
 import { BasicInstrument } from "./src/soundfont/basic_soundfont/basic_instrument.js";
 import { BasicPreset } from "./src/soundfont/basic_soundfont/basic_preset.js";
 import { Generator } from "./src/soundfont/basic_soundfont/generator.js";
-import { Modulator } from "./src/soundfont/basic_soundfont/modulator.js";
+import { Modulator, modulatorSources } from "./src/soundfont/basic_soundfont/modulator.js";
 import { loadSoundFont } from "./src/soundfont/load_soundfont.js";
 
 import { MIDI } from "./src/midi/midi_loader.js";
 import { BasicMIDI } from "./src/midi/basic_midi.js";
+import { MIDISequenceData } from "./src/midi/midi_sequence.js";
 import { MIDIBuilder } from "./src/midi/midi_builder.js";
 import { messageTypes, midiControllers, MIDIMessage } from "./src/midi/midi_message.js";
+import { interpolationTypes, synthDisplayTypes } from "./src/synthetizer/audio_engine/engine_components/enums.js";
 import { RMIDINFOChunks } from "./src/midi/midi_tools/rmidi_writer.js";
 import { IndexedByteArray } from "./src/utils/indexed_array.js";
 import { audioToWav } from "./src/utils/buffer_to_wav.js";
@@ -26,7 +43,9 @@ import {
     SpessaSynthLogging,
     SpessaSynthWarn
 } from "./src/utils/loggin.js";
+import { readBytesAsUintBigEndian } from "./src/utils/byte_functions/big_endian.js";
 import { consoleColors } from "./src/utils/other.js";
+import { inflateSync } from "./src/externals/fflate/fflate.min.js";
 
 // you shouldn't use these...
 const SpessaSynthCoreUtils = {
@@ -34,17 +53,28 @@ const SpessaSynthCoreUtils = {
     SpessaSynthInfo,
     SpessaSynthWarn,
     SpessaSynthGroupCollapsed,
-    SpessaSynthGroupEnd
+    SpessaSynthGroupEnd,
+    readBytesAsUintBigEndian,
+    inflateSync
 };
 
 export {
     // synth and seq
     SpessaSynthSequencer,
     SpessaSynthProcessor,
+    SynthesizerSnapshot,
+    ChannelSnapshot,
+    KeyModifier,
+    masterParameterType,
+    channelConfiguration,
+    interpolationTypes,
+    synthDisplayTypes,
     DEFAULT_PERCUSSION,
     VOICE_CAP,
     ALL_CHANNELS_OR_DIFFERENT_ACTION,
     NON_CC_INDEX_OFFSET,
+    DEFAULT_SYNTH_MODE,
+    MIDI_CHANNEL_COUNT,
     
     // sound banks
     loadSoundFont,
@@ -56,9 +86,11 @@ export {
     BasicPresetZone,
     Generator,
     Modulator,
+    modulatorSources,
     
     // MIDI
     MIDI,
+    MIDISequenceData,
     BasicMIDI,
     MIDIBuilder,
     MIDIMessage,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spessasynth_core",
-  "version": "1.1.5",
+  "version": "1.1.7",
   "description": "MIDI and SoundFont2/DLS library with no compromises",
   "main": "index.js",
   "type": "module",

package/src/synthetizer/audio_engine/engine_components/enums.js

@@ -0,0 +1,18 @@
+/**
+ *
+ * @enum {number}
+ */
+export const interpolationTypes = {
+    linear: 0,
+    nearestNeighbor: 1,
+    fourthOrder: 2
+};
+/**
+ * The text types for the synth display
+ * @enum {number}
+ */
+export const synthDisplayTypes = {
+    SoundCanvasText: 0,
+    XGText: 1,
+    SoundCanvasDotDisplay: 2
+};

package/src/synthetizer/audio_engine/engine_components/wavetable_oscillator.js

@@ -3,16 +3,6 @@
  * purpose: plays back raw audio data at an arbitrary playback rate
  */
 
-/**
- *
- * @enum {number}
- */
-export const interpolationTypes = {
-    linear: 0,
-    nearestNeighbor: 1,
-    fourthOrder: 2
-};
-
 
 export class WavetableOscillator
 {

package/src/synthetizer/audio_engine/engine_methods/render_voice.js

@@ -4,8 +4,9 @@ import { generatorTypes } from "../../../soundfont/basic_soundfont/generator.js"
 import { customControllers } from "../engine_components/controller_tables.js";
 import { absCentsToHz, timecentsToSeconds } from "../engine_components/unit_converter.js";
 import { getLFOValue } from "../engine_components/lfo.js";
-import { interpolationTypes, WavetableOscillator } from "../engine_components/wavetable_oscillator.js";
+import { WavetableOscillator } from "../engine_components/wavetable_oscillator.js";
 import { WorkletLowpassFilter } from "../engine_components/lowpass_filter.js";
+import { interpolationTypes } from "../engine_components/enums.js";
 
 /**
  * Renders a voice to the stereo output buffer

package/src/synthetizer/audio_engine/engine_methods/system_exclusive.js

@@ -5,6 +5,7 @@ import { ALL_CHANNELS_OR_DIFFERENT_ACTION } from "../../synth_constants.js";
 import { isSystemXG } from "../../../utils/xg_hacks.js";
 import { masterParameterType } from "./controller_control/master_parameters.js";
 import { readBytesAsString } from "../../../utils/byte_functions/string.js";
+import { synthDisplayTypes } from "../engine_components/enums.js";
 
 /**
  * KeyNum: tuning
@@ -39,16 +40,6 @@ function getTuning(byte1, byte2, byte3)
     return { midiNote: midiNote, centTuning: fraction * 0.0061 };
 }
 
-/**
- * The text types for the synth display
- * @enum {number}
- */
-export const SynthDisplayType = {
-    SoundCanvasText: 0,
-    XGText: 1,
-    SoundCanvasDotDisplay: 2
-};
-
 
 /**
  * Executes a system exclusive
@@ -547,7 +538,7 @@ export function systemExclusive(messageData, channelOffset = 0)
                             "synthdisplay",
                             {
                                 displayData: text,
-                                displayType: SynthDisplayType.SoundCanvasText
+                                displayType: synthDisplayTypes.SoundCanvasText
                             }
                         );
                     }
@@ -560,7 +551,7 @@ export function systemExclusive(messageData, channelOffset = 0)
                             "synthdisplay",
                             {
                                 displayData: dotMatrixData,
-                                displayType: SynthDisplayType.SoundCanvasDotDisplay
+                                displayType: synthDisplayTypes.SoundCanvasDotDisplay
                             }
                         );
                         SpessaSynthInfo(
@@ -744,7 +735,7 @@ export function systemExclusive(messageData, channelOffset = 0)
                         "synthdisplay",
                         {
                             displayData: textData,
-                            displayType: SynthDisplayType.XGText
+                            displayType: synthDisplayTypes.XGText
                         }
                     );
                 }

package/src/synthetizer/audio_engine/main_processor.js

@@ -13,7 +13,6 @@ import { systemExclusive } from "./engine_methods/system_exclusive.js";
 import { masterParameterType, setMasterParameter } from "./engine_methods/controller_control/master_parameters.js";
 import { resetAllControllers } from "./engine_methods/controller_control/reset_controllers.js";
 import { WorkletSoundfontManager } from "./engine_components/soundfont_manager.js";
-import { interpolationTypes } from "./engine_components/wavetable_oscillator.js";
 import { KeyModifierManager } from "./engine_components/key_modifier_manager.js";
 import { getVoices } from "./engine_components/voice.js";
 import { PAN_SMOOTHING_FACTOR } from "./engine_components/stereo_panner.js";
@@ -30,6 +29,7 @@ import { createMidiChannel } from "./engine_methods/create_midi_channel.js";
 import { FILTER_SMOOTHING_FACTOR } from "./engine_components/lowpass_filter.js";
 import { getEvent, messageTypes } from "../../midi/midi_message.js";
 import { IndexedByteArray } from "../../utils/indexed_array.js";
+import { interpolationTypes } from "./engine_components/enums.js";
 
 
 /**
@@ -95,7 +95,7 @@ import { IndexedByteArray } from "../../utils/indexed_array.js";
 /**
  * @typedef {Object} SynthDisplayCallback
  * @property {Uint8Array} displayData - The data to display.
- * @property {SynthDisplayType} displayType - The type of display.
+ * @property {synthDisplayTypes} displayType - The type of display.
  */
 
 /**