spessasynth_lib 3.13.0 → 3.14.0

package/@types/index.d.ts

@@ -5,6 +5,7 @@ import { VOICE_CAP } from './synthetizer/synthetizer.js';
 import { SoundFont2 } from './soundfont/soundfont.js';
 import { trimSoundfont } from './soundfont/write/soundfont_trimmer.js';
 import { modulatorSources } from './soundfont/read/modulators.js';
+import { encodeVorbis } from "./utils/encode_vorbis.js";
 import { MIDI } from './midi_parser/midi_loader.js';
 import { IndexedByteArray } from './utils/indexed_array.js';
 import { writeMIDIFile } from './midi_parser/midi_writer.js';
@@ -31,4 +32,4 @@ import { readBytesAsUintBigEndian } from './utils/byte_functions/big_endian.js';
 import { NON_CC_INDEX_OFFSET } from './synthetizer/worklet_system/worklet_utilities/worklet_processor_channel.js';
 import { ALL_CHANNELS_OR_DIFFERENT_ACTION } from './synthetizer/worklet_system/message_protocol/worklet_message.js';
 import { WORKLET_URL_ABSOLUTE } from './synthetizer/worklet_url.js';
-export { Sequencer, Synthetizer, DEFAULT_PERCUSSION, VOICE_CAP, SoundFont2, trimSoundfont, modulatorSources, OggVorbisEncoder, MIDI, IndexedByteArray, writeMIDIFile, writeRMIDI, applySnapshotToMIDI, modifyMIDI, audioBufferToWav, SpessaSynthLogging, SpessaSynthGroup, SpessaSynthTable, SpessaSynthGroupEnd, SpessaSynthInfo, SpessaSynthWarn, SpessaSynthGroupCollapsed, midiControllers, messageTypes, MIDIDeviceHandler, WebMidiLinkHandler, arrayToHexString, consoleColors, formatTitle, formatTime, readBytesAsUintBigEndian, NON_CC_INDEX_OFFSET, ALL_CHANNELS_OR_DIFFERENT_ACTION, WORKLET_URL_ABSOLUTE };
+export { Sequencer, Synthetizer, DEFAULT_PERCUSSION, VOICE_CAP, SoundFont2, trimSoundfont, modulatorSources, encodeVorbis, MIDI, IndexedByteArray, writeMIDIFile, writeRMIDI, applySnapshotToMIDI, modifyMIDI, audioBufferToWav, SpessaSynthLogging, SpessaSynthGroup, SpessaSynthTable, SpessaSynthGroupEnd, SpessaSynthInfo, SpessaSynthWarn, SpessaSynthGroupCollapsed, midiControllers, messageTypes, MIDIDeviceHandler, WebMidiLinkHandler, arrayToHexString, consoleColors, formatTitle, formatTime, readBytesAsUintBigEndian, NON_CC_INDEX_OFFSET, ALL_CHANNELS_OR_DIFFERENT_ACTION, WORKLET_URL_ABSOLUTE };

package/@types/sequencer/sequencer.d.ts

@@ -25,6 +25,11 @@ export class Sequencer {
      */
     _playbackRate: number;
     songIndex: number;
+    /**
+     * Indicates if the current midiData property has dummy data in it (not yet loaded)
+     * @type {boolean}
+     */
+    hasDummyData: boolean;
     _loop: boolean;
     /**
      * Indicates whether the sequencer has finished playing a sequence

package/@types/synthetizer/worklet_system/worklet_utilities/worklet_processor_channel.d.ts

@@ -5,6 +5,7 @@
  * @property {Float32Array} customControllers - array of custom (not sf2) control values such as RPN pitch tuning, transpose, modulation depth, etc.
  *
  * @property {number} channelTransposeKeyShift - key shift of the channel
+ * @property {Int8Array} channelOctaveTuning - the tuning for octave on this channel
  * @property {boolean} holdPedal - indicates whether the hold pedal is active
  * @property {boolean} drumChannel - indicates whether the channel is a drum channel
  *
@@ -72,6 +73,10 @@ export type WorkletProcessorChannel = {
      * - key shift of the channel
      */
     channelTransposeKeyShift: number;
+    /**
+     * - the tuning for octave on this channel
+     */
+    channelOctaveTuning: Int8Array;
     /**
      * - indicates whether the hold pedal is active
      */

package/@types/utils/encode_vorbis.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @typedef {function} EncodeVorbisFunction
+ * @param channelAudioData {Float32Array[]}
+ * @param sampleRate {number}
+ * @param channels {number}
+ * @param quality {number} -0.1 to 1
+ * @returns {Uint8Array}
+ */
+export function encodeVorbis(channelAudioData: Float32Array[], channels: number, sampleRate: number, quality: number): Uint8Array;
+export type EncodeVorbisFunction = Function;

package/README.md

@@ -26,6 +26,7 @@ document.getElementById("button").onclick = async () => {
 ```
 
 ## Current Features
+
 ### 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)
@@ -35,32 +36,38 @@ document.getElementById("button").onclick = async () => {
 ### Powerful SoundFont Synthesizer
 - Suitable for both **real-time** and **offline** synthesis
 - **Excellent SoundFont support:**
-- - **Generator Support**
-- - **Modulator Support:** _First (to my knowledge) JavaScript SoundFont synth with that feature!_
-- - **SoundFont3 Support:** Play compressed SoundFonts!
-- - **Can load very large SoundFonts:** up to 4GB! _Note: Only Firefox handles this well; Chromium has a hard-coded memory limit_
+    - **Generator Support**
+    - **Modulator Support:** _First (to my knowledge) JavaScript SoundFont synth with that feature!_
+    - **SoundFont3 Support:** Play compressed SoundFonts!
+    - **Can load very large SoundFonts:** up to 4GB! _Note: Only Firefox handles this well; Chromium has a hard-coded memory limit_
 - **Reverb and chorus support:** [customizable!](https://github.com/spessasus/SpessaSynth/wiki/Synthetizer-Class#effects-configuration-object)
 - **Export audio files** using [OfflineAudioContext](https://developer.mozilla.org/en-US/docs/Web/API/OfflineAudioContext)
 - **[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, works perfectly in Firefox and Chrome!
+- **Written using AudioWorklets:**
+    - Runs in a **separate thread** for maximum performance
+    - Supported by all modern browsers
 - **Unlimited channel count:** Your CPU is the limit!
 - **Various MIDI Standards Support:**
-- - **MIDI Controller Support:** Default supported controllers [here](https://github.com/spessasus/SpessaSynth/wiki/MIDI-Implementation#supported-controllers)
-- - [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)
+    - **MIDI Controller Support:** Default supported controllers [here](https://github.com/spessasus/SpessaSynth/wiki/MIDI-Implementation#supported-controllers)
+    - **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 ;)_
-- **Written in pure JavaScript using the WebAudio API:** Supported by all modern browsers!
 
 ### 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_
 - **[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!)
 - **Lyrics support:** Add karaoke to your program!
-- **Raw lyrics available:** Decode in any encoding! (Kanji? No problem!)
+- **Raw lyrics available:** Decode in any encoding! *(Kanji? No problem!)*
+- **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
 - **Smart name detection:** Handles incorrectly formatted and non-standard track names
+- **Raw name available:** Decode in any encoding! *(Kanji? No problem!)*
 - **Port detection during load time:** Manage ports and channels easily!
 - **Used channels on track:** Quickly determine which channels are used
 - **Key range detection:** Detect the key range of the MIDI
@@ -70,15 +77,18 @@ document.getElementById("button").onclick = async () => {
 - **Easy saving:** Save with just [one function!](https://github.com/spessasus/SpessaSynth/wiki/Writing-MIDI-Files#writemidifile)
 #### Read and write [RMID files with embedded SF2 soundfonts](https://github.com/spessasus/SpessaSynth/wiki/About-RMIDI)
 - **Compression and trimming support:** Reduce a MIDI file with a 1GB soundfont to **as small as 5MB**!
+- **Automatic bank shifting and validation:** Every soundfont *just works!*
+- **Metadata support:** Add title, artist, album name and cover and more! And of course read them too! *(In any encoding!)*
+- **Compatible with [Falcosoft Midi Player 6!](https://falcosoft.hu/softwares.html#midiplayer)**
 - **Easy saving:** [As simple as saving a MIDI file!](https://github.com/spessasus/SpessaSynth/wiki/Writing-MIDI-Files#writermidi)
 #### Read and write SoundFont2 files
-- **Smart trimming:** Trim the SoundFont to only include samples used in the MIDI (down to key and velocity!)
-- **sf3 conversion:** Compress SoundFont2 files to SoundFont3!
+- **Easy info access:** Just an [object of strings!](https://github.com/spessasus/SpessaSynth/wiki/SoundFont2-Class#soundfontinfo)
+- **Smart trimming:** Trim the SoundFont 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://github.com/spessasus/SpessaSynth/wiki/SoundFont2-Class#write)
 #### Read and write SoundFont3 files
 - Same features as SoundFont2 but with now with **Ogg Vorbis compression!**
 - **Variable compression quality:** You choose between file size and quality!
 - **Compression preserving:** Avoid decompressing and recompressing uncompressed samples for minimal quality loss!
-
 ## License
 MIT License, except for the stbvorbis_sync.js in the `externals` folder which is licensed under the Apache-2.0 license.

package/index.js

@@ -26,8 +26,8 @@ import { NON_CC_INDEX_OFFSET } from './synthetizer/worklet_system/worklet_utilit
 import { modulatorSources } from './soundfont/read/modulators.js';
 import { ALL_CHANNELS_OR_DIFFERENT_ACTION } from './synthetizer/worklet_system/message_protocol/worklet_message.js';
 import { trimSoundfont } from './soundfont/write/soundfont_trimmer.js';
-import { OggVorbisEncoder } from './externals/libvorbis/OggVorbisEncoder.min.js';
 import { WORKLET_URL_ABSOLUTE } from './synthetizer/worklet_url.js'
+import { encodeVorbis} from "./utils/encode_vorbis.js";
 
 // Export modules
 export {
@@ -41,7 +41,7 @@ export {
     SoundFont2,
     trimSoundfont,
     modulatorSources,
-    OggVorbisEncoder,
+    encodeVorbis,
 
     // MIDI
     MIDI,

package/midi_parser/rmidi_writer.js

@@ -27,7 +27,7 @@ export const RMIDINFOChunks = {
 }
 
 const FORCED_ENCODING = "utf-8";
-const DEFAULT_COPYRIGHT = "Created by SpessaSynth";
+const DEFAULT_COPYRIGHT = "Created using SpessaSynth";
 
 /**
  * @typedef {Object} RMIDMetadata

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spessasynth_lib",
-  "version": "3.13.0",
+  "version": "3.14.0",
   "description": "No compromise MIDI and SoundFont2 Synthesizer library",
   "browser": "index.js",
   "types": "@types/index.d.ts",

package/sequencer/sequencer.js

@@ -69,6 +69,12 @@ export class Sequencer
 
         this.songIndex = 0;
 
+        /**
+         * Indicates if the current midiData property has dummy data in it (not yet loaded)
+         * @type {boolean}
+         */
+        this.hasDummyData = true;
+
         this._loop = true;
 
         /**
@@ -206,6 +212,7 @@ export class Sequencer
                 let songChangeData = messageData[0];
                 this.songIndex = messageData[1];
                 this.midiData = songChangeData;
+                this.hasDummyData = false;
                 this.absoluteStartTime = 0;
                 this.duration = this.midiData.duration;
                 Object.entries(this.onSongChange).forEach((callback) => callback[1](songChangeData));
@@ -327,6 +334,7 @@ export class Sequencer
         this.pause();
         // add some dummy data
         this.midiData = DUMMY_MIDI_DATA;
+        this.hasDummyData = true;
         this.duration = 99999;
         this._sendMessage(WorkletSequencerMessageType.loadNewSongList, midiBuffers);
         this.songIndex = 0;