spessasynth_core 1.0.11 → 1.1.0

package/README.md

@@ -2,7 +2,7 @@
 A SoundFont2 synthesizer library, made for use with node.js. 
 A fork of [SpessaSynth](https://github.com/spessasus/SpessaSynth).
 
-[Jump to documentation](#api-reference)
+[Jump to the API reference](#api-reference)
 
 `npm install --save spessasynth_core`
 
@@ -19,7 +19,7 @@ A fork of [SpessaSynth](https://github.com/spessasus/SpessaSynth).
 - No SoundFont size limit
 - No dependencies
 
-### Example: render midi file to wav
+### Example: Render a MIDI file to a .wav file
 ```js
 const fs = require('fs');
 // spessasynth_core is an es6 module
@@ -53,6 +53,89 @@ import("spessasynth_core").then(core => {
 });
 ```
 
+### Example 2: play a MIDI file to speakers
+via npm package `speaker`
+```js
+const fs = require('fs');
+const Speaker = require("speaker");
+const SAMPLE_RATE = 44100; // hertz
+const BLOCK_SIZE = 128; // samples
+
+// usage: node test.js <sf path> <midi path>
+import("spessasynth_core").then(core => {
+    // Disable logging
+    core.SpessaSynthLogging(false, false, false, false);
+
+    // Read arguments and load the input files
+    const [,, soundfontName, midiName] = process.argv;
+    const soundfont = fs.readFileSync(soundfontName);
+    const mid = new core.MIDI(fs.readFileSync(midiName)); // parse the midi
+
+
+    // Initialize synth and sequencer
+    const synth = new core.Synthesizer(soundfont, SAMPLE_RATE, BLOCK_SIZE);
+    const seq = new core.Sequencer(synth);
+
+    // Load new song and disable the loop
+    seq.loadNewSongList([mid]);
+    seq.loop = false;
+
+    // make the program stop after the sequence is finished
+    const time = seq.duration + 1
+    let isPlaying = true;
+    setTimeout(() => isPlaying = false, time * 1000);
+    console.log(`Playing "${mid.midiName || "<unnamed song>"}"`);
+
+    // Calculate length and allocate buffers
+    const outLeft = new Float32Array(BLOCK_SIZE);
+    const outRight = new Float32Array(BLOCK_SIZE);
+
+    // Wait for sf3 support to load and render
+    synth.sf3supportReady.then(() => {
+        const speakerOut = new Speaker({
+            channels: 2,
+            bitDepth: 16,
+            sampleRate: SAMPLE_RATE,
+        });
+
+        function render()
+        {
+            // Render audio samples from the synthesizer
+            synth.render([outLeft, outRight]);
+
+            // Prepare buffer for WAV output
+            const wavData = new Int16Array(outLeft.length * 2); // 2 channels
+
+            // Interleave audio data
+            let offset = 0;
+            for (let i = 0; i < outLeft.length; i++)
+            {
+                // Float ranges from -1 to 1, int16 ranges from -32768 to 32767, convert it here
+                const sampleL = Math.max(-1, Math.min(1, outLeft[i])) * 32767;
+                const sampleR = Math.max(-1, Math.min(1, outRight[i])) * 32767;
+
+                // Interleave data: L, R, L, R, etc...
+                wavData[offset++] = sampleL;
+                wavData[offset++] = sampleR;
+            }
+            // Write WAV data to speaker
+            speakerOut.write(wavData);
+
+            if(isPlaying)
+            {
+                setImmediate(render);
+            }
+            else
+            {
+                process.exit(0);
+            }
+        }
+
+        render();
+    });
+});
+```
+
 ## API reference
 ### Contents
  - [Importing the library](#importing-the-library)
@@ -207,12 +290,12 @@ synth.muteChannel(channel, isMuted);
 - channel - the channel to mute/unmute. Usually ranges from 0 to 15, but it depends on the channel count.
 - isMuted - if the channel should be muted. boolean.
 
-### transpose
+### transposeAllChannels
 
 Transposes the synth up or down in semitones. Floating point values can be used for more precise tuning.
 
 ```js
-synth.transpose(semitones);
+synth.transposeAllChannels(semitones);
 ```
 
 - semitones - the amount of semitones to transpose the synth by. Can be positive or negative or zero. Zero resets the pitch.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spessasynth_core",
-  "version": "1.0.11",
+  "version": "1.1.0",
   "description": "SoundFont2 synthesizer library for node.js",
   "main": "index.js",
   "type": "module",

package/spessasynth_core/synthetizer/worklet_system/worklet_methods/controller_control.js

@@ -12,9 +12,10 @@ import { SpessaSynthInfo } from '../../../utils/loggin.js'
 import { SYNTHESIZER_GAIN } from '../../synthesizer.js'
 
 /**
- * @param channel {number}
- * @param controllerNumber {number}
- * @param controllerValue {number}
+ * Changes a MIDI controller
+ * @param channel {number} - The MIDI Channel to use
+ * @param controllerNumber {number} - The MIDI controller number
+ * @param controllerValue {number} - The new value
  * @this {Synthesizer}
  */
 export function controllerChange(channel, controllerNumber, controllerValue)
@@ -141,6 +142,7 @@ export function controllerChange(channel, controllerNumber, controllerValue)
 }
 
 /**
+ * Resets all controllers and programs
  * @this {Synthesizer}
  */
 export function resetAllControllers()
@@ -176,7 +178,7 @@ export function resetAllControllers()
 
 /**
  * Resets all controllers for channel
- * @param channel {number}
+ * @param channel {number} - The MIDI Channel to use
  * @this {Synthesizer}
  */
 export function resetControllers(channel)
@@ -248,7 +250,8 @@ export function resetParameters(channel)
 }
 
 /**
- * @param volume {number} 0-1
+ * Sets the main volume of the synthesizer
+ * @param volume {number} - 0-1 the volume
  * @this {Synthesizer}
  */
 export function setMainVolume(volume)
@@ -258,10 +261,10 @@ export function setMainVolume(volume)
 }
 
 /**
- * @param pan {number} -1 to 1
+ * Sets the master stereo panning of the synthesizer
+ * @param pan {number} - -1 to 1 the pan, -1 is left, 0 is the middle, 1 is right
  * @this {Synthesizer}
  */
-
 export function setMasterPan(pan)
 {
     this.pan = pan;
@@ -272,8 +275,9 @@ export function setMasterPan(pan)
 }
 
 /**
- * @param channel {number}
- * @param isMuted {boolean}
+ * Mutes/unmutes a channel
+ * @param channel {number} - The MIDI channel to use
+ * @param isMuted {boolean} - If the channel should be muted or not
  * @this {Synthesizer}
  */
 export function muteChannel(channel, isMuted)

package/spessasynth_core/synthetizer/worklet_system/worklet_methods/note_off.js

@@ -3,9 +3,9 @@ import { consoleColors } from '../../../utils/other.js'
 import { SpessaSynthInfo, SpessaSynthWarn } from '../../../utils/loggin.js'
 
 /**
- * Release a note
- * @param channel {number}
- * @param midiNote {number}
+ * Releases a note
+ * @param channel {number} - The MIDI channel to use
+ * @param midiNote {number} - The MIDI key number
  * @this {Synthesizer}
  */
 export function noteOff(channel, midiNote)
@@ -46,8 +46,8 @@ export function noteOff(channel, midiNote)
 
 /**
  * Stops a note nearly instantly
- * @param channel {number}
- * @param midiNote {number}
+ * @param channel {number} - The MIDI channel to use
+ * @param midiNote {number} - The MIDI key number
  * @this {Synthesizer}
  */
 export function killNote(channel, midiNote)
@@ -64,8 +64,8 @@ export function killNote(channel, midiNote)
 
 /**
  * stops all notes
- * @param channel {number}
- * @param force {boolean}
+ * @param channel {number} - The MIDI channel to use
+ * @param force {boolean} - If the notes should stop instantly or release normally
  * @this {Synthesizer}
  */
 export function stopAll(channel, force = false)
@@ -91,7 +91,7 @@ export function stopAll(channel, force = false)
 
 /**
  * @this {Synthesizer}
- * @param force {boolean}
+ * @param force {boolean} - If the notes should stop instantly or release normally
  */
 export function stopAllChannels(force = false)
 {

package/spessasynth_core/synthetizer/worklet_system/worklet_methods/note_on.js

@@ -5,11 +5,11 @@ import { VOICE_CAP } from "../../synthesizer.js";
 import { SpessaSynthWarn } from '../../../utils/loggin.js'
 
 /**
- * Append the voices
- * @param channel {number}
- * @param midiNote {number}
- * @param velocity {number}
- * @param enableDebugging {boolean}
+ * Starts playing a MIDI note
+ * @param channel {number} - The MIDI Channel to use
+ * @param midiNote {number} - The MIDI key number
+ * @param velocity {number} - The velocity (how hard is the key pressed)
+ * @param enableDebugging {boolean} - used internally, ignore
  * @this {Synthesizer}
  */
 export function noteOn(channel, midiNote, velocity, enableDebugging = false)

package/spessasynth_core/synthetizer/worklet_system/worklet_methods/program_control.js

@@ -5,12 +5,11 @@ import { generatorTypes } from '../../../soundfont/chunk/generators.js'
 
 /**
  * executes a program change
- * @param channel {number}
- * @param programNumber {number}
- * @param userChange {boolean}
+ * @param channel {number} - The MIDI Channel to use
+ * @param programNumber {number} - The MIDI program number
  * @this {Synthesizer}
  */
-export function programChange(channel, programNumber, userChange=false)
+export function programChange(channel, programNumber)
 {
     /**
      * @type {WorkletProcessorChannel}
@@ -48,8 +47,8 @@ export function setPreset(channel, preset)
 
 /**
  * Toggles drums on a given channel
- * @param channel {number}
- * @param isDrum {boolean}
+ * @param channel {number} - The MIDI Channel to use
+ * @param isDrum {boolean} - boolean, if the channel should be drums
  * @this {Synthesizer}
  */
 export function setDrums(channel, isDrum)
@@ -68,7 +67,8 @@ export function setDrums(channel, isDrum)
 }
 
 /**
- * @param buffer {ArrayBuffer}
+ * Reloads the soundfont, stops all voices
+ * @param buffer {ArrayBuffer} - the new soundfont buffer
  * @this {Synthesizer}
  */
 export function reloadSoundFont(buffer)

package/spessasynth_core/synthetizer/worklet_system/worklet_methods/system_exclusive.js

@@ -2,8 +2,8 @@ import { arrayToHexString, consoleColors } from '../../../utils/other.js'
 import { SpessaSynthInfo, SpessaSynthWarn } from '../../../utils/loggin.js'
 /**
  * Executes a system exclusive
- * @param messageData {number[]} - the message data without f0
- * @param channelOffset {number}
+ * @param messageData {number[]} - The binary message data without f0
+ * @param channelOffset {number} - Channel offset (for midi ports). Defaults to 0.
  * @this {Synthesizer}
  */
 

package/spessasynth_core/synthetizer/worklet_system/worklet_methods/tuning_control.js

@@ -1,8 +1,8 @@
-import { customControllers, NON_CC_INDEX_OFFSET } from '../worklet_utilities/worklet_processor_channel.js'
-import { consoleColors } from '../../../utils/other.js'
-import { modulatorSources } from '../../../soundfont/chunk/modulators.js'
-import { computeModulators } from '../worklet_utilities/worklet_modulator.js'
-import { SpessaSynthInfo } from '../../../utils/loggin.js'
+import {customControllers, NON_CC_INDEX_OFFSET} from '../worklet_utilities/worklet_processor_channel.js'
+import {consoleColors} from '../../../utils/other.js'
+import {modulatorSources} from '../../../soundfont/chunk/modulators.js'
+import {computeModulators} from '../worklet_utilities/worklet_modulator.js'
+import {SpessaSynthInfo} from '../../../utils/loggin.js'
 
 /**
  * Transposes all channels by given amount of semitones
@@ -22,9 +22,9 @@ export function transposeAllChannels(semitones, force = false)
 /**
  * Transposes the channel by given amount of semitones
  * @this {Synthesizer}
- * @param channel {number}
- * @param semitones {number} Can be float
- * @param force {boolean} defaults to false, if true transposes the channel even if it's a drum channel
+ * @param channel {number} - The MIDI Channel to use
+ * @param semitones {number} - Can be a float
+ * @param force {boolean} - defaults to false, if true transposes the channel even if it's a drum channel
  */
 export function transposeChannel(channel, semitones, force=false)
 {
@@ -99,7 +99,6 @@ export function setModulationDepth(channel, cents)
  */
 export function pitchWheel(channel, MSB, LSB)
 {
-    const bend = (LSB | (MSB << 7));
-    this.workletProcessorChannels[channel].midiControllers[NON_CC_INDEX_OFFSET + modulatorSources.pitchWheel] = bend;
+    this.workletProcessorChannels[channel].midiControllers[NON_CC_INDEX_OFFSET + modulatorSources.pitchWheel] = (LSB | (MSB << 7));
     this.workletProcessorChannels[channel].voices.forEach(v => computeModulators(v, this.workletProcessorChannels[channel].midiControllers));
 }

package/spessasynth_core/synthetizer/worklet_system/worklet_utilities/worklet_processor_channel.js

@@ -28,6 +28,7 @@ import { modulatorSources } from '../../../soundfont/chunk/modulators.js'
  */
 
 /**
+ * Adds a new channel
  * @this {Synthesizer}
  */
 export function addNewChannel()