spessasynth_lib 0.0.1

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

@@ -0,0 +1,32 @@
+/**
+ * other.js
+ * purpose: contains some useful functions that don't belong in any specific category
+ */
+/**
+ * Formats the given seconds to nice readable time
+ * @param totalSeconds {number} time in seconds
+ * @return {{seconds: number, minutes: number, time: string}}
+ */
+export function formatTime(totalSeconds: number): {
+    seconds: number;
+    minutes: number;
+    time: string;
+};
+/**
+ * @param fileName {string}
+ * @returns {string}
+ */
+export function formatTitle(fileName: string): string;
+/**
+ * Does what it says
+ * @param arr {number[]}
+ * @returns {string}
+ */
+export function arrayToHexString(arr: number[]): string;
+export namespace consoleColors {
+    let warn: string;
+    let unrecognized: string;
+    let info: string;
+    let recognized: string;
+    let value: string;
+}

package/package/LICENSE

@@ -0,0 +1,26 @@
+Main program is licensed under the MIT License:
+MIT License
+
+Copyright (c) 2024 Spessasus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+Apache 2.0 License
+The following file(s) in this project are licensed under the Apache License 2.0:
+- externals/stbvorbis_sync.js

package/package/README.md

@@ -0,0 +1,84 @@
+# spessasynth_lib
+**A powerful soundfont/MIDI JavaScript library for the browsers.**
+
+```shell
+npm install --save spessasynth_lib
+```
+
+### [Project site (consider giving it a star!)](https://github.com/spessasus/SpessaSynth)
+### [Demo](https://spessasus.github.io/SpessaSynth)
+
+### [Complete documentation](https://github.com/spessasus/SpessaSynth/wiki/Usage-As-Library)
+
+#### Basic example: play a single note
+```js
+import {Synthetizer} from "spessasynth_lib"
+const sfont = await (await fetch("soundfont.sf3")).arrayBuffer();
+const ctx = new AudioContext();
+// make sure you copied the worklet processor!
+await ctx.audioWorklet.addModule("./worklet_processor.min.js");
+const synth = new Synthetizer(ctx.destination, sfont);
+document.getElementById("button").onclick = async () => {
+    await ctx.resume();
+    synth.programChange(0, 48); // strings ensemble
+    synth.noteOn(0, 52, 127);
+}
+```
+
+## 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)
+- **Easy to Use:** basic setup is just [two lines of code!](https://github.com/spessasus/SpessaSynth/wiki/Usage-As-Library#minimal-setup)
+- **No dependencies:** _batteries included!_
+
+### 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_
+- **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!
+- **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)
+- **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!)
+
+### 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
+- **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
+- **Easy MIDI editing:** Use [helper functions](https://github.com/spessasus/SpessaSynth/wiki/Writing-MIDI-Files#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!
+- **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**!
+- **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 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/package/externals/NOTICE

@@ -0,0 +1,9 @@
+LICENSE is for stbvorbis_sync.js which is licensed under Apache-2.0
+
+Modifications made to stbvorbis_sync.js
+1. minified the code
+2. added types declaration
+
+OggVorbisEncoder (https://github.com/higuma/ogg-vorbis-encoder-js)
+is licensed under MIT.
+The file provided is a slight modification to work with es6.

package/package/externals/libvorbis/@types/OggVorbisEncoder.d.ts

@@ -0,0 +1,34 @@
+/**
+ * initializes libvorbis
+ * @returns {null}
+ */
+export namespace libvorbis {
+
+    /**
+     * Represents an Ogg Vorbis encoder.
+     */
+    class OggVorbisEncoder {
+        /**
+         * Creates an instance of Encoder
+         * @param {number} sampleRate - The sample rate of the audio in Hz
+         * @param {number} channels - The number of audio channels (e.g., 1 for mono, 2 for stereo)
+         * @param {number} quality - The quality of the encoding, between -0.1 and 1
+         */
+        constructor(sampleRate: number, channels: number, quality: number);
+
+        /**
+         * Encodes audio data
+         * @param {Float32Array[]} audioData - An array of Float32Arrays, where each Float32Array represents a block of audio samples
+         * @returns {null}
+         */
+        encode(audioData: Float32Array[]): null;
+
+        /**
+         * Finishes the encoding process and retrieves the encoded data
+         * @returns {Uint8Array[]} An array of Uint8Arrays representing the encoded audio data
+         */
+        finish(): Uint8Array[];
+    }
+
+    function init(): null
+}