spessasynth_core 1.0.3 → 1.0.5

package/README.md

@@ -4,7 +4,7 @@ A fork of [SpessaSynth](https://github.com/spessasus/SpessaSynth).
 
 `npm install --save spessasynth_core`
 
-> [!TIP]
+
 > Looking for a browser version? Try [SpessaSynth](https://github.com/spessasus/SpessaSynth).
 
 ## Features:
@@ -59,6 +59,7 @@ import("spessasynth_core").then(core => {
  - [Sequencer](#sequencer)
  - [MIDI](#midi)
  - [SoundFont2](#soundfont2)
+ - [How to disable console output](#logging)
 
 ### Importing the library
 spessasynth_core is an es6 package.
@@ -95,8 +96,8 @@ synth.render(outputChannels, reverbOutputChannels, chorusOutputChannels);
 - outputChannels - two `Float32Arrays` that get filled with the audio data. Left is the left channel and right is the right channel. Can be any length. (except zero)
 - reverbOutputChannels - two `Float32Arrays` that get filled with the unprocessed audio data for reverb processing. Left is the left channel and right is the right channel. Can be undefined.
 - reverbOutputChannels - two `Float32Arrays` that get filled with the unprocessed audio data for chorus processing. Left is the left channel and right is the right channel. Can be undefined.
-> [!IMPORTANT]
-> All arrays must be the same length.
+
+**All arrays must be the same length.**
 
 ### noteOn
 
@@ -121,7 +122,6 @@ synth.noteOff(channel, midiNote);
 
 - channel - the MIDI channel to use. Usually ranges from 0 to 15, but it depends on the channel count.
 - midiNote - the note to play. Ranges from 0 to 127.
-> [!TIP]
 > To stop a note instantly, use `synth.killNote` (takes the same arguments)
 
 ### stopAllChannels
@@ -132,7 +132,6 @@ Stops all notes. Equivalent of MIDI "panic".
 synth.stopAllChannels(force);
 ```
 - force - `boolean`, if true, ignores the release time and stops everything instantly. Defaults to false.
-> [!TIP]
 > To stop all notes on a specific channel, use `synth.stopAll(channel, force)`. channel is the channel number.
 
 ### programChange
@@ -145,7 +144,6 @@ synth.programChange(channel, programNumber);
 
 - channel - the MIDI channel to change. Usually ranges from 0 to 15, but it depends on the channel count.
 - programNumber - the MIDI program number to use. Ranges from 0 to 127. To use other banks, go to [controllerChange](#controllerchange).
-> [!TIP]
 > To lock the preset (prevent MIDI file from changing it) use `synth.workletProcessorChannels[channel].lockPreset = true;`
 
 ### pitchWheel
@@ -158,7 +156,6 @@ synth.pitchWheel(channel, MSB, LSB);
 
 - channel - the MIDI channel to use. Usually ranges from 0 to 15, but it depends on the channel count.
 - MSB and LSB. 7-bit numbers that form a 14-bit pitch bend value.
-> [!TIP]
 > [I highly recommend this article for more info.](https://www.recordingblogs.com/wiki/midi-pitch-wheel-message)
 
 ### systemExclusive
@@ -170,7 +167,6 @@ synth.systemExclusive(messageData);
 ```
 
 - message data - Uint8Array, the message byte data **Excluding the 0xF0 byte!**
-> [!TIP]
 > Refer to [this table](https://github.com/spessasus/SpessaSynth/wiki/Synthetizer-Class#supported-system-exclusives) for the list of supported System Exclusives.
 
 ### setMainVolume
@@ -231,7 +227,6 @@ synth.controllerChange(channel, controllerNumber, controllerValue);
 - channel - the MIDI channel to use. Usually ranges from 0 to 15, but it depends on the channel count.
 - controllerName - the MIDI CC number. Refer to [this table](https://github.com/spessasus/SpessaSynth/wiki/Synthetizer-Class#default-supported-controllers) for the list of controllers supported by default.
 - controllerValue - the value to set the given controller to. Ranges from 0 to 127.
-> [!NOTE]
 > Note that theoreticallly all controllers are supported as it depends on the SoundFont's modulators.
 
 ### resetAllControllers
@@ -379,4 +374,17 @@ console.log(`The track lasts for ${sequencer.duration} seconds!`);
 See [MIDI on SpessaSynth wiki](https://github.com/spessasus/SpessaSynth/wiki/MIDI-Class)
 
 ## SoundFont2
-See [SoundFont2 on SpessaSynth wiki](https://github.com/spessasus/SpessaSynth/wiki/SoundFont2-Class)
+See [SoundFont2 on SpessaSynth wiki](https://github.com/spessasus/SpessaSynth/wiki/SoundFont2-Class)
+
+## Logging
+By default, SpessaSynth prints out a lot of stuff to console.
+Here's how you can disable it:
+```js
+// import (or require) here
+SpessaSynthLogging(enableInfo, enableWarning, enableGroup, enableTable);
+```
+All the input variables are booleans corresponding to the things SpessaSynth logs.
+- Info - all general info such as parsing soundfonts, midi files, RPN changes, etc.
+- Warnings - all messages unrecognized by the synthesizer, other warnings
+- group - the groups for parsing the soundfont and midi files.
+- table - the debug table `when enableDebugging` is set to `true` for `synth.noteOn`

package/index.js

@@ -3,5 +3,6 @@ import {Sequencer} from "./spessasynth_core/sequencer/sequencer.js";
 import {MIDI} from "./spessasynth_core/midi_parser/midi_loader.js";
 import {rawDataToWav} from "./spessasynth_core/utils/buffer_to_wav.js";
 import {SoundFont2} from "./spessasynth_core/soundfont/soundfont_parser.js";
+import {SpessaSynthLogging} from "./spessasynth_core/utils/loggin.js";
 
-export { Synthesizer, Sequencer, MIDI, SoundFont2, rawDataToWav };
+export { Synthesizer, Sequencer, MIDI, SoundFont2, rawDataToWav, SpessaSynthLogging };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spessasynth_core",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "SoundFont2 synthesizer library for node.js",
   "main": "index.js",
   "type": "module",
@@ -9,7 +9,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/spessasus/spessasynth_core.git"
+    "url": "git+https://github.com/spessasus/spessasynth_core.git"
   },
   "keywords": [
     "sf2",