libadlmidi-js 1.0.0

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you do both of the
+following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, provided that you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,126 @@
+# libadlmidi-js
+
+WebAssembly build of [libADLMIDI](https://github.com/Wohlstand/libADLMIDI) - a free Software MIDI synthesizer library with OPL3 (FM synthesis) emulation.
+
+## Features
+
+- **AudioWorklet Integration**: Runs synthesis in a separate thread to prevent UI stuttering. Interoperates with all the usual browser audio APIs.
+- **WOPL Bank Support**: Load custom FM banks or use the high-quality embedded banks.
+- **Real-time API**: Fine-grained control over MIDI channels, notes, and controllers.
+- **Instrument Editing**: Programmatic access to OPL3 operator parameters.
+
+## Installation
+
+```bash
+npm install libadlmidi-js
+```
+
+## Quick Start (Browser + AudioWorklet)
+
+```javascript
+import { AdlMidi } from 'libadlmidi-js/nuked';
+
+const synth = new AdlMidi();
+await synth.init();
+
+// Play a middle C on channel 0
+synth.noteOn(0, 60, 100);
+
+// Stop it after 1 second
+setTimeout(() => {
+    synth.noteOff(0, 60);
+}, 1000);
+```
+
+## Low-Level API (Node.js / Custom Backends)
+
+For batch rendering, custom audio backends, or non-browser environments:
+
+```javascript
+import { AdlMidiCore } from 'libadlmidi-js/nuked';
+
+const synth = await AdlMidiCore.create();
+
+synth.init(44100);
+synth.setBank(72);
+
+// Real-time synthesis
+synth.noteOn(0, 60, 100);
+const samples = synth.generate(4096);  // Float32Array, stereo interleaved
+
+// Or MIDI file playback
+import { readFileSync } from 'fs';
+synth.loadMidi(readFileSync('song.mid'));
+while (!synth.atEnd) {
+  const audio = synth.play(4096);
+  // ... write to file or audio output
+}
+
+synth.close();
+```
+
+### Slim Builds (No Embedded Banks)
+
+For smaller bundles, use slim variants and load banks at runtime:
+
+```javascript
+import { AdlMidi } from 'libadlmidi-js/nuked/slim';
+
+const synth = new AdlMidi();
+await synth.init();
+await synth.loadBankFile('./mybank.wopl');  // Load WOPL bank
+```
+
+### Struct Utilities
+
+For direct OPL3 instrument manipulation:
+
+```javascript
+import { AdlMidi } from 'libadlmidi-js/nuked';
+import { encodeInstrument, decodeInstrument, defaultInstrument } from 'libadlmidi-js/structs';
+
+const synth = new AdlMidi();
+await synth.init();
+
+// Create a custom instrument from the default template
+const inst = defaultInstrument();
+inst.operators[0].attack = 15;
+inst.operators[0].decay = 8;
+inst.feedback1 = 7;
+
+// Encode and apply to channel 0
+const bytes = encodeInstrument(inst);  // 40-byte Uint8Array
+synth.setCustomInstrument(0, bytes);
+
+// Notes on channel 0 now use the custom instrument
+synth.noteOn(0, 60, 100);
+
+// You can also decode instrument data from a bank
+const decoded = decodeInstrument(bytes);
+```
+
+## Profiles
+
+| Profile | Emulator(s) | Usage |
+|---------|-------------|-------|
+| `nuked` | Nuked OPL3 v1.8 | Maximum accuracy, highest CPU usage. |
+| `dosbox` | DosBox OPL3 | Great balance of speed and accuracy. |
+| `light` | Nuked + DosBox | Flexible for varied performance needs. |
+| `full` | All supported | Includes Opal, Java OPL3, ESFMu, etc. |
+
+## Documentation
+
+See the `examples/` directory for advanced usage, including:
+- `player.html`: MIDI file playback.
+- `keyboard.html`: Real-time interaction.
+- `patch-editor.html`: Live OPL3 patch editing.
+
+## Contributing
+
+Please see [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and rules.
+
+## License
+
+This project is licensed under the **LGPL-3.0**. See the [LICENSE](LICENSE) file for details.
+Upstream libADLMIDI is licensed under a mix of GPL and LGPL; see the `libADLMIDI/LICENSE` for core engine licensing.
+

package/dist/core.d.ts

@@ -0,0 +1,276 @@
+/**
+ * Low-level OPL3 synthesis interface.
+ *
+ * Unlike AdlMidi (which manages AudioWorklet), AdlMidiCore works directly
+ * with the WASM module and returns raw audio samples.
+ *
+ * @example
+ * ```javascript
+ * import { AdlMidiCore } from 'libadlmidi-js/core';
+ *
+ * // Load with specific WASM profile
+ * const synth = await AdlMidiCore.create({
+ *   corePath: './node_modules/libadlmidi-js/dist/libadlmidi.nuked.core.js'
+ * });
+ *
+ * await synth.init(44100);
+ * synth.setBank(72);
+ * synth.noteOn(0, 60, 100);
+ *
+ * // Generate audio
+ * const samples = synth.generate(4096);  // Float32Array, stereo interleaved
+ *
+ * synth.close();
+ * ```
+ */
+export class AdlMidiCore {
+    /**
+     * Create a new AdlMidiCore instance.
+     *
+     * @param {Object} options
+     * @param {string} options.corePath - Path to the .core.js WASM loader module
+     * @param {ArrayBuffer} [options.wasmBinary] - Pre-loaded WASM binary (optional)
+     * @returns {Promise<AdlMidiCore>}
+     */
+    static create(options: {
+        corePath: string;
+        wasmBinary?: ArrayBuffer | undefined;
+    }): Promise<AdlMidiCore>;
+    /** @private @type {any} */
+    private _module;
+    /** @private @type {number|null} */
+    private _player;
+    /** @private @type {number} */
+    private _sampleRate;
+    /** @private @type {Float32Array|null} */
+    private _audioBuffer;
+    /** @private @type {number|null} */
+    private _audioBufferPtr;
+    /**
+     * Initialize the synthesizer.
+     *
+     * @param {number} [sampleRate=44100] - Audio sample rate
+     * @returns {boolean} True if successful
+     */
+    init(sampleRate?: number): boolean;
+    /**
+     * Close the synthesizer and free resources.
+     */
+    close(): void;
+    /**
+     * Reset the synthesizer state (stop all notes).
+     */
+    reset(): void;
+    /**
+     * Panic - immediately stop all notes.
+     */
+    panic(): void;
+    /**
+     * Set the FM bank by index.
+     *
+     * @param {number} bank - Bank index (0-72+ depending on build)
+     * @returns {boolean} True if successful
+     */
+    setBank(bank: number): boolean;
+    /**
+     * Load a custom WOPL bank from data.
+     *
+     * @param {ArrayBuffer|Uint8Array} data - WOPL bank data
+     * @returns {boolean} True if successful
+     */
+    loadBankData(data: ArrayBuffer | Uint8Array): boolean;
+    /**
+     * Get the number of available embedded banks.
+     *
+     * @returns {number} Number of banks
+     */
+    getBankCount(): number;
+    /**
+     * Set the number of emulated OPL3 chips.
+     *
+     * @param {number} count - Number of chips (1-100)
+     * @returns {boolean} True if successful
+     */
+    setNumChips(count: number): boolean;
+    /**
+     * Enable/disable soft stereo panning.
+     *
+     * @param {boolean} enabled
+     */
+    setSoftPan(enabled: boolean): void;
+    /**
+     * Enable/disable deep vibrato.
+     *
+     * @param {boolean} enabled
+     */
+    setDeepVibrato(enabled: boolean): void;
+    /**
+     * Enable/disable deep tremolo.
+     *
+     * @param {boolean} enabled
+     */
+    setDeepTremolo(enabled: boolean): void;
+    /**
+     * Switch OPL3 emulator (if multiple are compiled in).
+     *
+     * @param {number} emulator - Emulator ID (0=Nuked, 2=DosBox, etc.)
+     * @returns {boolean} True if successful
+     */
+    switchEmulator(emulator: number): boolean;
+    /**
+     * Get the current chip emulator name.
+     *
+     * @returns {string} Emulator name
+     */
+    getEmulatorName(): string;
+    /**
+     * Trigger a note on.
+     *
+     * @param {number} channel - MIDI channel (0-15)
+     * @param {number} note - MIDI note (0-127)
+     * @param {number} velocity - Velocity (0-127)
+     */
+    noteOn(channel: number, note: number, velocity: number): void;
+    /**
+     * Trigger a note off.
+     *
+     * @param {number} channel - MIDI channel (0-15)
+     * @param {number} note - MIDI note (0-127)
+     */
+    noteOff(channel: number, note: number): void;
+    /**
+     * Send a pitch bend message.
+     *
+     * @param {number} channel - MIDI channel (0-15)
+     * @param {number} value - Pitch bend value (0-16383, 8192 = center)
+     */
+    pitchBend(channel: number, value: number): void;
+    /**
+     * Send a controller change message.
+     *
+     * @param {number} channel - MIDI channel (0-15)
+     * @param {number} controller - Controller number (0-127)
+     * @param {number} value - Controller value (0-127)
+     */
+    controllerChange(channel: number, controller: number, value: number): void;
+    /**
+     * Send a program change message.
+     *
+     * @param {number} channel - MIDI channel (0-15)
+     * @param {number} program - Program number (0-127)
+     */
+    programChange(channel: number, program: number): void;
+    /**
+     * Generate audio samples (real-time synthesis).
+     *
+     * @param {number} frames - Number of stereo frames to generate
+     * @returns {Float32Array} Stereo interleaved audio samples (-1 to +1)
+     */
+    generate(frames: number): Float32Array;
+    /**
+     * Load a MIDI file from data.
+     *
+     * @param {ArrayBuffer|Uint8Array} data - MIDI file data
+     * @returns {boolean} True if successful
+     */
+    loadMidi(data: ArrayBuffer | Uint8Array): boolean;
+    /**
+     * Play MIDI file and generate audio.
+     *
+     * @param {number} frames - Number of stereo frames to generate
+     * @returns {Float32Array} Stereo interleaved audio samples (-1 to +1)
+     */
+    play(frames: number): Float32Array;
+    /**
+     * Get the current playback position in seconds.
+     *
+     * @returns {number} Position in seconds
+     */
+    get position(): number;
+    /**
+     * Get the total duration in seconds.
+     *
+     * @returns {number} Duration in seconds
+     */
+    get duration(): number;
+    /**
+     * Seek to a position.
+     *
+     * @param {number} seconds - Position in seconds
+     */
+    seek(seconds: number): void;
+    /**
+     * Rewind to the beginning.
+     */
+    rewind(): void;
+    /**
+     * Check if playback has reached the end.
+     *
+     * @returns {boolean} True if at end
+     */
+    get atEnd(): boolean;
+    /**
+     * Enable/disable looping.
+     *
+     * @param {boolean} enabled
+     */
+    setLooping(enabled: boolean): void;
+    /**
+     * Set playback tempo multiplier.
+     *
+     * @param {number} tempo - Tempo multiplier (1.0 = normal)
+     */
+    setTempo(tempo: number): void;
+    /**
+     * Get an instrument from a bank.
+     *
+     * @param {Object} bankId - Bank identifier
+     * @param {number} bankId.percussive - 0 for melodic, 1 for percussion
+     * @param {number} bankId.msb - Bank MSB
+     * @param {number} bankId.lsb - Bank LSB
+     * @param {number} program - Program number (0-127)
+     * @returns {import('./utils/struct.js').Instrument|null} Instrument or null if not found
+     */
+    getInstrument(bankId: {
+        percussive: number;
+        msb: number;
+        lsb: number;
+    }, program: number): import("./utils/struct.js").Instrument | null;
+    /**
+     * Set an instrument in a bank.
+     *
+     * @param {Object} bankId - Bank identifier
+     * @param {number} bankId.percussive - 0 for melodic, 1 for percussion
+     * @param {number} bankId.msb - Bank MSB
+     * @param {number} bankId.lsb - Bank LSB
+     * @param {number} program - Program number (0-127)
+     * @param {import('./utils/struct.js').Instrument} instrument - Instrument to set
+     * @returns {boolean} True if successful
+     */
+    setInstrument(bankId: {
+        percussive: number;
+        msb: number;
+        lsb: number;
+    }, program: number, instrument: import("./utils/struct.js").Instrument): boolean;
+    /**
+     * Get the raw Emscripten module for advanced usage.
+     *
+     * @returns {Object} The raw WASM module
+     */
+    get module(): Object;
+    /**
+     * Get the raw player pointer for advanced usage.
+     *
+     * @returns {number|null} Player pointer
+     */
+    get player(): number | null;
+    /**
+     * Get the sample rate.
+     *
+     * @returns {number} Sample rate in Hz
+     */
+    get sampleRate(): number;
+    /** @private */
+    private _ensurePlayer;
+}
+export default AdlMidiCore;

package/dist/fm_banks/manifest.json

@@ -0,0 +1,60 @@
+{
+  "generated": "2026-01-18T16:02:45.890Z",
+  "categories": {
+    "wopl": {
+      "description": "General WOPL banks",
+      "banks": [
+        {
+          "name": "Apogee-IMF-90",
+          "file": "Apogee-IMF-90.wopl",
+          "size": 16983
+        },
+        {
+          "name": "DMXOPL3-by-sneakernets-GS",
+          "file": "DMXOPL3-by-sneakernets-GS.wopl",
+          "size": 118767
+        },
+        {
+          "name": "GM-By-J.A.Nguyen-and-Wohlstand",
+          "file": "GM-By-J.A.Nguyen-and-Wohlstand.wopl",
+          "size": 16983
+        },
+        {
+          "name": "Wohlstand's-modded-FatMan",
+          "file": "Wohlstand's-modded-FatMan.wopl",
+          "size": 16983
+        },
+        {
+          "name": "fatman-2op",
+          "file": "fatman-2op.wopl",
+          "size": 16983
+        },
+        {
+          "name": "fatman-4op",
+          "file": "fatman-4op.wopl",
+          "size": 16983
+        },
+        {
+          "name": "msadlib",
+          "file": "msadlib.wopl",
+          "size": 16983
+        }
+      ]
+    },
+    "ail": {
+      "description": "AIL (Miles Sound System) banks",
+      "banks": [
+        {
+          "name": "MonopolyDeluxe",
+          "file": "MonopolyDeluxe.wopl",
+          "size": 16983
+        },
+        {
+          "name": "master_of_magic",
+          "file": "master_of_magic.wopl",
+          "size": 25465
+        }
+      ]
+    }
+  }
+}