libadlmidi-js 1.0.0

package/dist/profiles/dosbox.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Pre-configured AdlMidi for dosbox profile.
+ *
+ * @example
+ * ```javascript
+ * import { AdlMidi } from 'libadlmidi-js/dosbox';
+ *
+ * const synth = new AdlMidi();
+ * await synth.init();  // No paths needed!
+ * synth.noteOn(0, 60, 100);
+ * ```
+ */
+export class AdlMidi extends BaseAdlMidi {
+    /**
+     * Initialize the synthesizer with this profile's WASM.
+     *
+     * @param {string} [processorUrl] - Override processor URL (optional)
+     * @param {string} [wasmUrl] - Override WASM URL (optional)
+     * @returns {Promise<void>}
+     */
+    init(processorUrl?: string, wasmUrl?: string): Promise<void>;
+}
+/**
+ * Pre-configured AdlMidiCore for dosbox profile.
+ *
+ * @example
+ * ```javascript
+ * import { AdlMidiCore } from 'libadlmidi-js/dosbox/core';
+ *
+ * const synth = await AdlMidiCore.create();  // No paths needed!
+ * synth.init(44100);
+ * synth.noteOn(0, 60, 100);
+ * const samples = synth.generate(4096);
+ * ```
+ */
+export class AdlMidiCore {
+    /**
+     * Create a new AdlMidiCore instance with this profile's WASM.
+     *
+     * @param {{corePath?: string}} [options] - Options (corePath is pre-configured)
+     * @returns {Promise<BaseAdlMidiCore>}
+     */
+    static create(options?: {
+        corePath?: string;
+    }): Promise<BaseAdlMidiCore>;
+}
+import { AdlMidi as BaseAdlMidi } from '../libadlmidi.js';
+import { AdlMidiCore as BaseAdlMidiCore } from '../core.js';
+export { encodeInstrument, decodeInstrument, defaultInstrument, encodeOperator, decodeOperator, defaultOperator } from "../utils/struct.js";

package/dist/profiles/dosbox.slim.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Pre-configured AdlMidi for dosbox slim profile.
+ *
+ * @example
+ * ```javascript
+ * import { AdlMidi } from 'libadlmidi-js/dosbox.slim';
+ *
+ * const synth = new AdlMidi();
+ * await synth.init();  // No paths needed!
+ * synth.noteOn(0, 60, 100);
+ * ```
+ */
+export class AdlMidi extends BaseAdlMidi {
+    /**
+     * Initialize the synthesizer with this profile's WASM.
+     *
+     * @param {string} [processorUrl] - Override processor URL (optional)
+     * @param {string} [wasmUrl] - Override WASM URL (optional)
+     * @returns {Promise<void>}
+     */
+    init(processorUrl?: string, wasmUrl?: string): Promise<void>;
+}
+/**
+ * Pre-configured AdlMidiCore for dosbox slim profile.
+ *
+ * @example
+ * ```javascript
+ * import { AdlMidiCore } from 'libadlmidi-js/dosbox.slim/core';
+ *
+ * const synth = await AdlMidiCore.create();  // No paths needed!
+ * synth.init(44100);
+ * synth.noteOn(0, 60, 100);
+ * const samples = synth.generate(4096);
+ * ```
+ */
+export class AdlMidiCore {
+    /**
+     * Create a new AdlMidiCore instance with this profile's WASM.
+     *
+     * @param {{corePath?: string}} [options] - Options (corePath is pre-configured)
+     * @returns {Promise<BaseAdlMidiCore>}
+     */
+    static create(options?: {
+        corePath?: string;
+    }): Promise<BaseAdlMidiCore>;
+}
+import { AdlMidi as BaseAdlMidi } from '../libadlmidi.js';
+import { AdlMidiCore as BaseAdlMidiCore } from '../core.js';
+export { encodeInstrument, decodeInstrument, defaultInstrument, encodeOperator, decodeOperator, defaultOperator } from "../utils/struct.js";

package/dist/profiles/full.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Pre-configured AdlMidi for full profile.
+ *
+ * @example
+ * ```javascript
+ * import { AdlMidi } from 'libadlmidi-js/full';
+ *
+ * const synth = new AdlMidi();
+ * await synth.init();  // No paths needed!
+ * synth.noteOn(0, 60, 100);
+ * ```
+ */
+export class AdlMidi extends BaseAdlMidi {
+    /**
+     * Initialize the synthesizer with this profile's WASM.
+     *
+     * @param {string} [processorUrl] - Override processor URL (optional)
+     * @param {string} [wasmUrl] - Override WASM URL (optional)
+     * @returns {Promise<void>}
+     */
+    init(processorUrl?: string, wasmUrl?: string): Promise<void>;
+}
+/**
+ * Pre-configured AdlMidiCore for full profile.
+ *
+ * @example
+ * ```javascript
+ * import { AdlMidiCore } from 'libadlmidi-js/full/core';
+ *
+ * const synth = await AdlMidiCore.create();  // No paths needed!
+ * synth.init(44100);
+ * synth.noteOn(0, 60, 100);
+ * const samples = synth.generate(4096);
+ * ```
+ */
+export class AdlMidiCore {
+    /**
+     * Create a new AdlMidiCore instance with this profile's WASM.
+     *
+     * @param {{corePath?: string}} [options] - Options (corePath is pre-configured)
+     * @returns {Promise<BaseAdlMidiCore>}
+     */
+    static create(options?: {
+        corePath?: string;
+    }): Promise<BaseAdlMidiCore>;
+}
+import { AdlMidi as BaseAdlMidi } from '../libadlmidi.js';
+import { AdlMidiCore as BaseAdlMidiCore } from '../core.js';
+export { encodeInstrument, decodeInstrument, defaultInstrument, encodeOperator, decodeOperator, defaultOperator } from "../utils/struct.js";

package/dist/profiles/full.slim.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Pre-configured AdlMidi for full slim profile.
+ *
+ * @example
+ * ```javascript
+ * import { AdlMidi } from 'libadlmidi-js/full.slim';
+ *
+ * const synth = new AdlMidi();
+ * await synth.init();  // No paths needed!
+ * synth.noteOn(0, 60, 100);
+ * ```
+ */
+export class AdlMidi extends BaseAdlMidi {
+    /**
+     * Initialize the synthesizer with this profile's WASM.
+     *
+     * @param {string} [processorUrl] - Override processor URL (optional)
+     * @param {string} [wasmUrl] - Override WASM URL (optional)
+     * @returns {Promise<void>}
+     */
+    init(processorUrl?: string, wasmUrl?: string): Promise<void>;
+}
+/**
+ * Pre-configured AdlMidiCore for full slim profile.
+ *
+ * @example
+ * ```javascript
+ * import { AdlMidiCore } from 'libadlmidi-js/full.slim/core';
+ *
+ * const synth = await AdlMidiCore.create();  // No paths needed!
+ * synth.init(44100);
+ * synth.noteOn(0, 60, 100);
+ * const samples = synth.generate(4096);
+ * ```
+ */
+export class AdlMidiCore {
+    /**
+     * Create a new AdlMidiCore instance with this profile's WASM.
+     *
+     * @param {{corePath?: string}} [options] - Options (corePath is pre-configured)
+     * @returns {Promise<BaseAdlMidiCore>}
+     */
+    static create(options?: {
+        corePath?: string;
+    }): Promise<BaseAdlMidiCore>;
+}
+import { AdlMidi as BaseAdlMidi } from '../libadlmidi.js';
+import { AdlMidiCore as BaseAdlMidiCore } from '../core.js';
+export { encodeInstrument, decodeInstrument, defaultInstrument, encodeOperator, decodeOperator, defaultOperator } from "../utils/struct.js";

package/dist/profiles/light.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Pre-configured AdlMidi for light profile.
+ *
+ * @example
+ * ```javascript
+ * import { AdlMidi } from 'libadlmidi-js/light';
+ *
+ * const synth = new AdlMidi();
+ * await synth.init();  // No paths needed!
+ * synth.noteOn(0, 60, 100);
+ * ```
+ */
+export class AdlMidi extends BaseAdlMidi {
+    /**
+     * Initialize the synthesizer with this profile's WASM.
+     *
+     * @param {string} [processorUrl] - Override processor URL (optional)
+     * @param {string} [wasmUrl] - Override WASM URL (optional)
+     * @returns {Promise<void>}
+     */
+    init(processorUrl?: string, wasmUrl?: string): Promise<void>;
+}
+/**
+ * Pre-configured AdlMidiCore for light profile.
+ *
+ * @example
+ * ```javascript
+ * import { AdlMidiCore } from 'libadlmidi-js/light/core';
+ *
+ * const synth = await AdlMidiCore.create();  // No paths needed!
+ * synth.init(44100);
+ * synth.noteOn(0, 60, 100);
+ * const samples = synth.generate(4096);
+ * ```
+ */
+export class AdlMidiCore {
+    /**
+     * Create a new AdlMidiCore instance with this profile's WASM.
+     *
+     * @param {{corePath?: string}} [options] - Options (corePath is pre-configured)
+     * @returns {Promise<BaseAdlMidiCore>}
+     */
+    static create(options?: {
+        corePath?: string;
+    }): Promise<BaseAdlMidiCore>;
+}
+import { AdlMidi as BaseAdlMidi } from '../libadlmidi.js';
+import { AdlMidiCore as BaseAdlMidiCore } from '../core.js';
+export { encodeInstrument, decodeInstrument, defaultInstrument, encodeOperator, decodeOperator, defaultOperator } from "../utils/struct.js";

package/dist/profiles/light.slim.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Pre-configured AdlMidi for light slim profile.
+ *
+ * @example
+ * ```javascript
+ * import { AdlMidi } from 'libadlmidi-js/light.slim';
+ *
+ * const synth = new AdlMidi();
+ * await synth.init();  // No paths needed!
+ * synth.noteOn(0, 60, 100);
+ * ```
+ */
+export class AdlMidi extends BaseAdlMidi {
+    /**
+     * Initialize the synthesizer with this profile's WASM.
+     *
+     * @param {string} [processorUrl] - Override processor URL (optional)
+     * @param {string} [wasmUrl] - Override WASM URL (optional)
+     * @returns {Promise<void>}
+     */
+    init(processorUrl?: string, wasmUrl?: string): Promise<void>;
+}
+/**
+ * Pre-configured AdlMidiCore for light slim profile.
+ *
+ * @example
+ * ```javascript
+ * import { AdlMidiCore } from 'libadlmidi-js/light.slim/core';
+ *
+ * const synth = await AdlMidiCore.create();  // No paths needed!
+ * synth.init(44100);
+ * synth.noteOn(0, 60, 100);
+ * const samples = synth.generate(4096);
+ * ```
+ */
+export class AdlMidiCore {
+    /**
+     * Create a new AdlMidiCore instance with this profile's WASM.
+     *
+     * @param {{corePath?: string}} [options] - Options (corePath is pre-configured)
+     * @returns {Promise<BaseAdlMidiCore>}
+     */
+    static create(options?: {
+        corePath?: string;
+    }): Promise<BaseAdlMidiCore>;
+}
+import { AdlMidi as BaseAdlMidi } from '../libadlmidi.js';
+import { AdlMidiCore as BaseAdlMidiCore } from '../core.js';
+export { encodeInstrument, decodeInstrument, defaultInstrument, encodeOperator, decodeOperator, defaultOperator } from "../utils/struct.js";

package/dist/profiles/nuked.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Pre-configured AdlMidi for nuked profile.
+ *
+ * @example
+ * ```javascript
+ * import { AdlMidi } from 'libadlmidi-js/nuked';
+ *
+ * const synth = new AdlMidi();
+ * await synth.init();  // No paths needed!
+ * synth.noteOn(0, 60, 100);
+ * ```
+ */
+export class AdlMidi extends BaseAdlMidi {
+    /**
+     * Initialize the synthesizer with this profile's WASM.
+     *
+     * @param {string} [processorUrl] - Override processor URL (optional)
+     * @param {string} [wasmUrl] - Override WASM URL (optional)
+     * @returns {Promise<void>}
+     */
+    init(processorUrl?: string, wasmUrl?: string): Promise<void>;
+}
+/**
+ * Pre-configured AdlMidiCore for nuked profile.
+ *
+ * @example
+ * ```javascript
+ * import { AdlMidiCore } from 'libadlmidi-js/nuked/core';
+ *
+ * const synth = await AdlMidiCore.create();  // No paths needed!
+ * synth.init(44100);
+ * synth.noteOn(0, 60, 100);
+ * const samples = synth.generate(4096);
+ * ```
+ */
+export class AdlMidiCore {
+    /**
+     * Create a new AdlMidiCore instance with this profile's WASM.
+     *
+     * @param {{corePath?: string}} [options] - Options (corePath is pre-configured)
+     * @returns {Promise<BaseAdlMidiCore>}
+     */
+    static create(options?: {
+        corePath?: string;
+    }): Promise<BaseAdlMidiCore>;
+}
+import { AdlMidi as BaseAdlMidi } from '../libadlmidi.js';
+import { AdlMidiCore as BaseAdlMidiCore } from '../core.js';
+export { encodeInstrument, decodeInstrument, defaultInstrument, encodeOperator, decodeOperator, defaultOperator } from "../utils/struct.js";

package/dist/profiles/nuked.slim.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Pre-configured AdlMidi for nuked slim profile.
+ *
+ * @example
+ * ```javascript
+ * import { AdlMidi } from 'libadlmidi-js/nuked.slim';
+ *
+ * const synth = new AdlMidi();
+ * await synth.init();  // No paths needed!
+ * synth.noteOn(0, 60, 100);
+ * ```
+ */
+export class AdlMidi extends BaseAdlMidi {
+    /**
+     * Initialize the synthesizer with this profile's WASM.
+     *
+     * @param {string} [processorUrl] - Override processor URL (optional)
+     * @param {string} [wasmUrl] - Override WASM URL (optional)
+     * @returns {Promise<void>}
+     */
+    init(processorUrl?: string, wasmUrl?: string): Promise<void>;
+}
+/**
+ * Pre-configured AdlMidiCore for nuked slim profile.
+ *
+ * @example
+ * ```javascript
+ * import { AdlMidiCore } from 'libadlmidi-js/nuked.slim/core';
+ *
+ * const synth = await AdlMidiCore.create();  // No paths needed!
+ * synth.init(44100);
+ * synth.noteOn(0, 60, 100);
+ * const samples = synth.generate(4096);
+ * ```
+ */
+export class AdlMidiCore {
+    /**
+     * Create a new AdlMidiCore instance with this profile's WASM.
+     *
+     * @param {{corePath?: string}} [options] - Options (corePath is pre-configured)
+     * @returns {Promise<BaseAdlMidiCore>}
+     */
+    static create(options?: {
+        corePath?: string;
+    }): Promise<BaseAdlMidiCore>;
+}
+import { AdlMidi as BaseAdlMidi } from '../libadlmidi.js';
+import { AdlMidiCore as BaseAdlMidiCore } from '../core.js';
+export { encodeInstrument, decodeInstrument, defaultInstrument, encodeOperator, decodeOperator, defaultOperator } from "../utils/struct.js";

package/dist/utils/struct.d.ts

@@ -0,0 +1,209 @@
+/**
+ * @typedef {Object} Operator
+ * @property {boolean} am - Amplitude modulation (tremolo)
+ * @property {boolean} vibrato - Vibrato (frequency modulation)
+ * @property {boolean} sustaining - Sustaining (EG type)
+ * @property {boolean} ksr - Key scale rate
+ * @property {number} freqMult - Frequency multiplier (0-15)
+ * @property {number} keyScaleLevel - Key scale level (0-3)
+ * @property {number} totalLevel - Total level / attenuation (0-63, 0 = loudest)
+ * @property {number} attack - Attack rate (0-15)
+ * @property {number} decay - Decay rate (0-15)
+ * @property {number} sustain - Sustain level (0-15, 0 = loudest)
+ * @property {number} release - Release rate (0-15)
+ * @property {number} waveform - Waveform select (0-7)
+ */
+/**
+ * Decode an OPL3 operator from raw register bytes to named properties
+ * @param {Uint8Array | number[]} bytes - 5 bytes of operator register data
+ * @returns {Operator} Decoded operator with named properties
+ */
+export function decodeOperator(bytes: Uint8Array | number[]): Operator;
+/**
+ * Encode named operator properties to raw register bytes
+ * @param {Operator} op - Operator with named properties
+ * @returns {Uint8Array} 5 bytes of operator register data
+ */
+export function encodeOperator(op: Operator): Uint8Array;
+/**
+ * Default operator values (silent)
+ * @returns {Operator} A silent operator configuration
+ */
+export function defaultOperator(): Operator;
+/**
+ * Complete OPL3 instrument definition
+ * @typedef {Object} Instrument
+ * @property {number} [version] - Instrument version
+ * @property {number} [noteOffset1] - Note offset for voice 1
+ * @property {number} [noteOffset2] - Note offset for voice 2
+ * @property {number} [velocityOffset] - MIDI velocity offset
+ * @property {number} [secondVoiceDetune] - Detune for second voice
+ * @property {number} [percussionKey] - Percussion key number
+ * @property {boolean} [is4op] - 4-operator mode enabled
+ * @property {boolean} [isPseudo4op] - Pseudo 4-op (two 2-op voices)
+ * @property {boolean} [isBlank] - Blank/unused instrument
+ * @property {number} [rhythmMode] - Rhythm mode (0-7)
+ * @property {number} [feedback1] - Feedback for voice 1 (0-7)
+ * @property {number} [connection1] - Connection type for voice 1 (0-1)
+ * @property {number} [feedback2] - Feedback for voice 2 (0-7)
+ * @property {number} [connection2] - Connection type for voice 2 (0-1)
+ * @property {[Operator, Operator, Operator, Operator]} operators - Four operators
+ * @property {number} [delayOnMs] - Delay before note-on (ms)
+ * @property {number} [delayOffMs] - Delay before note-off (ms)
+ */
+/**
+ * Decode an ADL_Instrument from raw bytes to JS object
+ * @param {Uint8Array} bytes - 40 bytes of instrument data
+ * @returns {Instrument} Decoded instrument with named properties
+ */
+export function decodeInstrument(bytes: Uint8Array): Instrument;
+/**
+ * Encode a JS instrument object to raw bytes
+ * @param {Instrument} inst - Instrument with named properties
+ * @returns {Uint8Array} 40 bytes of instrument data
+ */
+export function encodeInstrument(inst: Instrument): Uint8Array;
+/**
+ * Default instrument values (blank/silent)
+ * @returns {Instrument} A blank instrument configuration
+ */
+export function defaultInstrument(): Instrument;
+/**
+ * OPL3 struct serialization utilities
+ * Shared between processor and tests
+ *
+ * @module utils/struct
+ */
+/** Size of ADL_Operator struct (5 register bytes) */
+export const SIZEOF_ADL_OPERATOR: 5;
+/** Size of ADL_Instrument struct */
+export const SIZEOF_ADL_INSTRUMENT: 40;
+/** Size of ADL_Bank struct (3 pointers × 4 bytes in 32-bit WASM) */
+export const SIZEOF_ADL_BANK: 12;
+/** Size of ADL_BankId struct (3 bytes + padding) */
+export const SIZEOF_ADL_BANK_ID: 4;
+/** Offset where operators start within ADL_Instrument */
+export const OPERATOR_OFFSET: 14;
+export type Operator = {
+    /**
+     * - Amplitude modulation (tremolo)
+     */
+    am: boolean;
+    /**
+     * - Vibrato (frequency modulation)
+     */
+    vibrato: boolean;
+    /**
+     * - Sustaining (EG type)
+     */
+    sustaining: boolean;
+    /**
+     * - Key scale rate
+     */
+    ksr: boolean;
+    /**
+     * - Frequency multiplier (0-15)
+     */
+    freqMult: number;
+    /**
+     * - Key scale level (0-3)
+     */
+    keyScaleLevel: number;
+    /**
+     * - Total level / attenuation (0-63, 0 = loudest)
+     */
+    totalLevel: number;
+    /**
+     * - Attack rate (0-15)
+     */
+    attack: number;
+    /**
+     * - Decay rate (0-15)
+     */
+    decay: number;
+    /**
+     * - Sustain level (0-15, 0 = loudest)
+     */
+    sustain: number;
+    /**
+     * - Release rate (0-15)
+     */
+    release: number;
+    /**
+     * - Waveform select (0-7)
+     */
+    waveform: number;
+};
+/**
+ * Complete OPL3 instrument definition
+ */
+export type Instrument = {
+    /**
+     * - Instrument version
+     */
+    version?: number | undefined;
+    /**
+     * - Note offset for voice 1
+     */
+    noteOffset1?: number | undefined;
+    /**
+     * - Note offset for voice 2
+     */
+    noteOffset2?: number | undefined;
+    /**
+     * - MIDI velocity offset
+     */
+    velocityOffset?: number | undefined;
+    /**
+     * - Detune for second voice
+     */
+    secondVoiceDetune?: number | undefined;
+    /**
+     * - Percussion key number
+     */
+    percussionKey?: number | undefined;
+    /**
+     * - 4-operator mode enabled
+     */
+    is4op?: boolean | undefined;
+    /**
+     * - Pseudo 4-op (two 2-op voices)
+     */
+    isPseudo4op?: boolean | undefined;
+    /**
+     * - Blank/unused instrument
+     */
+    isBlank?: boolean | undefined;
+    /**
+     * - Rhythm mode (0-7)
+     */
+    rhythmMode?: number | undefined;
+    /**
+     * - Feedback for voice 1 (0-7)
+     */
+    feedback1?: number | undefined;
+    /**
+     * - Connection type for voice 1 (0-1)
+     */
+    connection1?: number | undefined;
+    /**
+     * - Feedback for voice 2 (0-7)
+     */
+    feedback2?: number | undefined;
+    /**
+     * - Connection type for voice 2 (0-1)
+     */
+    connection2?: number | undefined;
+    /**
+     * - Four operators
+     */
+    operators: [Operator, Operator, Operator, Operator];
+    /**
+     * - Delay before note-on (ms)
+     */
+    delayOnMs?: number | undefined;
+    /**
+     * - Delay before note-off (ms)
+     */
+    delayOffMs?: number | undefined;
+};