@datamoc/mw_games 0.44.2 → 0.45.0

package/dist/audio/SoundFont.js

@@ -1,862 +0,0 @@
-import { scheduleMidi } from './Midi.js';
-import { MAX_SAMPLE_FRAMES, MAX_SAMPLE_RATE, MAX_TOTAL_FRAMES, MIN_SAMPLE_RATE, webAudioSampleDecoder, } from './SampleDecoder.js';
-/**
- * A SoundFont 2 reader: presets to instruments to sample zones, enough to play
- * General MIDI music with real samples. Supported: key and velocity ranges, root key
- * and tuning, sample loop modes, the volume envelope (attack, hold, decay, sustain,
- * release), pan and attenuation, with the global-zone and preset-plus-instrument
- * layering rules. Not supported: modulators, filters and LFOs, 24-bit samples, or
- * stereo-linked sample pairs beyond playing each side as its own mono voice.
- *
- * A SoundFont file is only data (recorded samples plus preset tables), so reading one
- * is ordinary format engineering; the licence that matters is the font's own, checked
- * before it ships, never here.
- *
- * `subsetSoundFont` answers the shipping side: a game that plays five instruments
- * should not carry all 128. It takes the programs the game's MIDI files actually use
- * (see `collectSoundFontUsage`) and writes a smaller, valid SoundFont 2 file with the
- * same voices for those programs: zones, ranges, tuning, envelopes and sample loops
- * survive byte-identical, while unused presets, instruments and samples are gone and
- * the library, genre and morphology metadata is zeroed.
- */
-const GENERATORS = {
-    keyRange: 43,
-    velRange: 44,
-    instrument: 41,
-    sampleId: 53,
-    rootKey: 58,
-    coarseTune: 51,
-    fineTune: 52,
-    sampleModes: 54,
-    attenuation: 48,
-    pan: 17,
-    attack: 34,
-    hold: 35,
-    decay: 36,
-    sustain: 37,
-    release: 38,
-};
-/** seconds for a SoundFont timecents value */
-function timecents(value) {
-    return 2 ** (value / 1200);
-}
-function toBytes(data) {
-    return data instanceof ArrayBuffer
-        ? new Uint8Array(data)
-        : new Uint8Array(data.buffer, data.byteOffset, data.byteLength);
-}
-function decodeName(bytes, at) {
-    let name = '';
-    for (let i = 0; i < 20; i++) {
-        const code = bytes[at + i];
-        if (code === 0)
-            break;
-        name += String.fromCharCode(code);
-    }
-    return name;
-}
-function readTables(bytes) {
-    const view = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);
-    const fourcc = (at) => String.fromCharCode(bytes[at], bytes[at + 1], bytes[at + 2], bytes[at + 3]);
-    if (fourcc(0) !== 'RIFF' || fourcc(8) !== 'sfbk')
-        throw new Error('not a SoundFont 2 file');
-    const chunks = new Map();
-    const lists = new Map();
-    const walk = (start, end) => {
-        let at = start;
-        while (at + 8 <= end) {
-            const id = fourcc(at);
-            const size = view.getUint32(at + 4, true);
-            if (id === 'LIST') {
-                lists.set(fourcc(at + 8), { at, size });
-                walk(at + 12, at + 8 + size);
-            }
-            else
-                chunks.set(id, { at: at + 8, size });
-            at += 8 + size + (size & 1);
-        }
-    };
-    walk(12, bytes.length);
-    for (const required of ['phdr', 'pbag', 'pgen', 'inst', 'ibag', 'igen', 'shdr', 'smpl']) {
-        if (!chunks.has(required))
-            throw new Error(`SoundFont is missing "${required}"`);
-    }
-    const records = (name, size, read) => {
-        const chunk = chunks.get(name);
-        const out = [];
-        for (let at = chunk.at; at + size <= chunk.at + chunk.size; at += size)
-            out.push(read(at));
-        return out;
-    };
-    const generators = (name) => records(name, 4, (at) => ({
-        oper: view.getUint16(at, true),
-        lo: bytes[at + 2],
-        hi: bytes[at + 3],
-        amount: view.getInt16(at + 2, true),
-    }));
-    const bags = (name) => records(name, 4, (at) => view.getUint16(at, true));
-    const presets = records('phdr', 38, (at) => ({
-        name: decodeName(bytes, at),
-        preset: view.getUint16(at + 20, true),
-        bank: view.getUint16(at + 22, true),
-        bag: view.getUint16(at + 24, true),
-    }));
-    const instruments = records('inst', 22, (at) => ({
-        name: decodeName(bytes, at),
-        bag: view.getUint16(at + 20, true),
-    }));
-    const samples = records('shdr', 46, (at) => ({
-        name: decodeName(bytes, at),
-        start: view.getUint32(at + 20, true),
-        end: view.getUint32(at + 24, true),
-        loopStart: view.getUint32(at + 28, true),
-        loopEnd: view.getUint32(at + 32, true),
-        rate: view.getUint32(at + 36, true),
-        rootKey: bytes[at + 40],
-        correction: view.getInt8(at + 41),
-        link: view.getUint16(at + 42, true),
-        type: view.getUint16(at + 44, true),
-    }));
-    const smplChunk = chunks.get('smpl');
-    const smplBytes = bytes.slice(smplChunk.at, smplChunk.at + smplChunk.size);
-    //ROM and empty samples have no data here; the rest must agree on what their offsets count
-    const sampled = samples.filter((sample) => sample.end > sample.start && !(sample.type & 0x8000));
-    const compressed = sampled.some((sample) => sample.type & 0x10);
-    if (compressed && !sampled.every((sample) => sample.type & 0x10)) {
-        throw new Error('SoundFont mixes compressed and plain samples, which it cannot address consistently');
-    }
-    //the offsets come from the file, so a lying header must not reach beyond the sample data
-    const limit = compressed ? smplBytes.length : smplBytes.length >> 1;
-    if (sampled.some((sample) => sample.end > limit)) {
-        throw new Error('a sample points outside the sample data: the SoundFont is damaged');
-    }
-    const smpl = compressed ? new Int16Array(0) : new Int16Array(smplBytes.buffer, 0, smplBytes.length >> 1);
-    const info = lists.get('INFO') ?? null;
-    return {
-        bytes,
-        presets,
-        presetBags: bags('pbag'),
-        presetGens: generators('pgen'),
-        instruments,
-        instBags: bags('ibag'),
-        instGens: generators('igen'),
-        samples,
-        smplBytes,
-        smpl,
-        compressed,
-        info: info ? bytes.slice(info.at, info.at + 8 + info.size + (info.size & 1)) : null,
-    };
-}
-/** the generators of one bag, in file order */
-function bagGens(bagList, gens, bag) {
-    return gens.slice(bagList[bag], bagList[bag + 1] ?? gens.length);
-}
-//Zones of one header entry: [{ gens: Map(oper -> generator) }...]; a first zone lacking the terminal generator is global.
-function zonesOf(headers, bagList, gens, index, terminal) {
-    const first = headers[index].bag;
-    const last = headers[index + 1]?.bag ?? bagList.length - 1;
-    const zones = [];
-    let global = null;
-    for (let bag = first; bag < last; bag++) {
-        const slice = bagGens(bagList, gens, bag);
-        const map = new Map();
-        for (const generator of slice)
-            map.set(generator.oper, generator);
-        if (!map.has(terminal)) {
-            if (bag === first)
-                global = map;
-            continue;
-        }
-        zones.push({ gens: map, global });
-    }
-    return zones;
-}
-function generatorOf(zone, oper) {
-    return zone.gens.get(oper) ?? zone.global?.get(oper) ?? null;
-}
-function presetIndexOf(presets, bank, program, missing = 'piano') {
-    return (presets.get(`${bank}:${program}`) ??
-        (bank === 128 ? presets.get('128:0') : presets.get(`0:${program}`)) ??
-        (missing === 'piano' ? presets.get('0:0') : undefined));
-}
-/**
- * Reads SoundFont 2 bytes into layered preset voices.
- *
- * @example
- * ```ts
- * import { parseSoundFont, parseMidi, renderMidiToBuffer } from '@datamoc/mw_games/audio';
- *
- * declare const soundfontBytes: ArrayBuffer;
- * declare const midiBytes: ArrayBuffer;
- *
- * const font = parseSoundFont(soundfontBytes);
- * const rendered = renderMidiToBuffer(parseMidi(midiBytes), { soundfont: font });
- * console.log(font.presetCount, rendered.duration);
- * ```
- */
-export function parseSoundFont(data, options = {}) {
-    const tables = readTables(toBytes(data));
-    if (tables.compressed) {
-        throw new Error('SoundFont 3 (Ogg Vorbis samples) needs decoding first: use loadSoundFont() or decodeSoundFont(), or convert it with "mwg-soundfonts convert <in.sf3> <out.sf2>"');
-    }
-    const sampleCache = new Map();
-    const tuning = new Map();
-    const sampleOf = (id) => {
-        if (sampleCache.has(id))
-            return sampleCache.get(id);
-        const header = tables.samples[id];
-        if (!header || header.end <= header.start || header.type & 0x8000) {
-            sampleCache.set(id, null); //ROM samples live outside the file and cannot play
-            return null;
-        }
-        const frames = new Float32Array(header.end - header.start);
-        for (let index = 0; index < frames.length; index++) {
-            frames[index] = tables.smpl[header.start + index] / 32768;
-        }
-        const sample = {
-            data: frames,
-            rate: header.rate || 22050,
-            loopStart: header.loopStart - header.start,
-            loopEnd: header.loopEnd - header.start,
-        };
-        sampleCache.set(id, sample);
-        tuning.set(id, {
-            rootKey: header.rootKey === 255 ? 60 : header.rootKey,
-            correction: header.correction,
-        });
-        return sample;
-    };
-    const presets = new Map();
-    for (let index = 0; index < tables.presets.length - 1; index++) {
-        presets.set(`${tables.presets[index].bank}:${tables.presets[index].preset}`, index);
-    }
-    //Zones that sound for (bank, program, key, velocity), each with the resolved playback recipe.
-    function voices(bank, program, key, velocity) {
-        const presetIndex = presetIndexOf(presets, bank, program, options.missingProgram);
-        if (presetIndex === undefined)
-            return [];
-        const out = [];
-        const within = (zone, oper, value) => {
-            const generator = generatorOf(zone, oper);
-            return !generator || (value >= generator.lo && value <= generator.hi);
-        };
-        for (const presetZone of zonesOf(tables.presets, tables.presetBags, tables.presetGens, presetIndex, GENERATORS.instrument)) {
-            if (!within(presetZone, GENERATORS.keyRange, key) || !within(presetZone, GENERATORS.velRange, velocity)) {
-                continue;
-            }
-            const instrument = generatorOf(presetZone, GENERATORS.instrument).amount;
-            if (!tables.instruments[instrument + 1])
-                continue;
-            for (const zone of zonesOf(tables.instruments, tables.instBags, tables.instGens, instrument, GENERATORS.sampleId)) {
-                if (!within(zone, GENERATORS.keyRange, key) || !within(zone, GENERATORS.velRange, velocity)) {
-                    continue;
-                }
-                const sampleId = generatorOf(zone, GENERATORS.sampleId).amount;
-                const sample = sampleOf(sampleId);
-                if (!sample)
-                    continue;
-                const both = (oper, fallback = 0) => (generatorOf(zone, oper)?.amount ?? fallback) + (generatorOf(presetZone, oper)?.amount ?? 0);
-                const root = generatorOf(zone, GENERATORS.rootKey)?.amount;
-                const modes = generatorOf(zone, GENERATORS.sampleModes)?.amount ?? 0;
-                const native = tuning.get(sampleId);
-                out.push({
-                    sample,
-                    rootKey: root !== undefined && root >= 0 ? root : native.rootKey,
-                    cents: both(GENERATORS.coarseTune) * 100 + both(GENERATORS.fineTune) + native.correction,
-                    loop: (modes & 3) === 1 || (modes & 3) === 3,
-                    gain: 10 ** (-Math.max(0, both(GENERATORS.attenuation)) / 200),
-                    pan: Math.max(-1, Math.min(1, both(GENERATORS.pan) / 500)),
-                    attack: timecents(both(GENERATORS.attack, -12000)),
-                    hold: timecents(both(GENERATORS.hold, -12000)),
-                    decay: timecents(both(GENERATORS.decay, -12000)),
-                    sustain: 10 ** (-Math.max(0, both(GENERATORS.sustain)) / 200),
-                    release: timecents(both(GENERATORS.release, -12000)),
-                });
-            }
-        }
-        return out;
-    }
-    return {
-        voices,
-        hasPreset: (bank, program) => presets.has(`${bank}:${program}`) || presets.has(`0:${program}`),
-        presetCount: presets.size,
-    };
-}
-/**
- * Every sampled voice the given MIDI files can request, as (bank, program) pairs:
- * the channel voice in effect at each scheduled note, with drums mapped to bank 128
- * the same way the renderer maps them. A game's compile step feeds this straight
- * into `subsetSoundFont` so the shipped font carries only these programs.
- *
- * @example
- * ```ts
- * import { parseMidi, collectSoundFontUsage } from '@datamoc/mw_games/audio';
- *
- * declare const midiBytes: ArrayBuffer;
- *
- * const usage = collectSoundFontUsage([parseMidi(midiBytes)]);
- * console.log(usage.length);
- * ```
- */
-export function collectSoundFontUsage(files) {
-    const seen = new Set();
-    const out = [];
-    for (const file of files) {
-        for (const note of scheduleMidi(file)) {
-            const bank = note.channel === 9 ? 128 : note.bank;
-            const key = `${bank}:${note.program}`;
-            if (!seen.has(key)) {
-                seen.add(key);
-                out.push({ bank, program: note.program });
-            }
-        }
-    }
-    return out;
-}
-/**
- * The programs of `usage` the font does not carry, so a game can tell at build time which of the
- * instruments its MIDI files ask for would be missing. A bank without the program counts as carried
- * when bank 0 has it (the fallback every player makes), a drum kit only when the font has that exact
- * kit. What plays for a missing one is the `missingProgram` policy of `parseSoundFont`. Works on a
- * SoundFont 2 or 3.
- *
- * @example
- * ```ts
- * import { missingSoundFontPrograms, parseMidi, collectSoundFontUsage } from '@datamoc/mw_games/audio';
- *
- * declare const soundfontBytes: ArrayBuffer;
- * declare const midiBytes: ArrayBuffer;
- *
- * const usage = collectSoundFontUsage([parseMidi(midiBytes)]);
- * for (const { bank, program } of missingSoundFontPrograms(soundfontBytes, usage)) {
- * 	console.log(`bank ${bank} program ${program} is not in the font`);
- * }
- * ```
- */
-export function missingSoundFontPrograms(data, usage) {
-    const carried = new Set(readTables(toBytes(data))
-        .presets.slice(0, -1)
-        .map((preset) => `${preset.bank}:${preset.preset}`));
-    const seen = new Set();
-    const missing = [];
-    for (const { bank, program } of usage) {
-        const key = `${bank}:${program}`;
-        if (seen.has(key))
-            continue;
-        seen.add(key);
-        if (carried.has(key) || (bank !== 128 && carried.has(`0:${program}`)))
-            continue;
-        missing.push({ bank, program });
-    }
-    return missing;
-}
-function u16le(value) {
-    return [value & 0xff, (value >> 8) & 0xff];
-}
-function u32le(value) {
-    return [value & 0xff, (value >> 8) & 0xff, (value >> 16) & 0xff, (value >> 24) & 0xff];
-}
-function encodeName(name) {
-    const codes = [...name].map((char) => char.charCodeAt(0) & 0xff).slice(0, 20);
-    return [...codes, ...new Array(20 - codes.length).fill(0)];
-}
-function asciiBytes(text) {
-    return [...text].map((char) => char.charCodeAt(0));
-}
-/** one chunk as bytes: kept samples run to megabytes, so this allocates instead of spreading */
-function chunkBytes(id, payload) {
-    const out = new Uint8Array(8 + payload.length + (payload.length & 1));
-    out.set(asciiBytes(id), 0);
-    new DataView(out.buffer).setUint32(4, payload.length, true);
-    out.set(payload, 8);
-    return out;
-}
-function concat(parts) {
-    let length = 0;
-    for (const part of parts)
-        length += part.length;
-    const out = new Uint8Array(length);
-    let at = 0;
-    for (const part of parts) {
-        out.set(part, at);
-        at += part.length;
-    }
-    return out;
-}
-function listBytes(type, subs) {
-    const body = concat([new Uint8Array(asciiBytes(type)), ...subs]);
-    return concat([new Uint8Array(asciiBytes('LIST')), new Uint8Array(u32le(body.length)), body]);
-}
-/**
- * Joins several SoundFont 2 files into one, presets in the order given. When two files
- * carry the same (bank, program) the first wins and the other's preset, instruments
- * and samples are dropped, so the result never holds a voice nothing can reach. This is
- * how single-instrument files (a per-program font collection) become the one file a game
- * ships; `subsetSoundFont` then trims it like any other.
- *
- * @example
- * ```ts
- * import { mergeSoundFonts, parseSoundFont } from '@datamoc/mw_games/audio';
- *
- * declare const pianoBytes: ArrayBuffer;
- * declare const drumsBytes: ArrayBuffer;
- *
- * const merged = mergeSoundFonts([pianoBytes, drumsBytes]);
- * console.log(parseSoundFont(merged).presetCount);
- * ```
- */
-export function mergeSoundFonts(fonts) {
-    if (fonts.length === 0)
-        throw new Error('mergeSoundFonts needs at least one SoundFont');
-    const sources = fonts.map((font) => readTables(toBytes(font)));
-    const compressed = sources[0].compressed;
-    if (sources.some((source) => source.compressed !== compressed)) {
-        throw new Error('cannot merge a SoundFont 3 with a SoundFont 2: decode it first with decodeSoundFont()');
-    }
-    const merged = {
-        bytes: new Uint8Array(0),
-        presets: [],
-        presetBags: [],
-        presetGens: [],
-        instruments: [],
-        instBags: [],
-        instGens: [],
-        samples: [],
-        smplBytes: new Uint8Array(0),
-        smpl: new Int16Array(0),
-        compressed,
-        info: sources[0].info,
-    };
-    const parts = [];
-    let smplLength = 0; //bytes so far
-    for (const source of sources) {
-        const instrumentBase = merged.instruments.length;
-        const sampleBase = merged.samples.length;
-        const presetBagBase = merged.presetBags.length;
-        const presetGenBase = merged.presetGens.length;
-        const instBagBase = merged.instBags.length;
-        const instGenBase = merged.instGens.length;
-        //a plain font's sample offsets count frames, a SoundFont 3's count bytes (and its loops stay relative)
-        const offsetBase = compressed ? smplLength : smplLength >> 1;
-        //each table ends in a terminal record that only the joined result keeps
-        merged.presets.push(...source.presets.slice(0, -1).map((preset) => ({ ...preset, bag: preset.bag + presetBagBase })));
-        merged.presetBags.push(...source.presetBags.slice(0, -1).map((gen) => gen + presetGenBase));
-        merged.presetGens.push(...source.presetGens
-            .slice(0, source.presetBags[source.presetBags.length - 1])
-            .map((generator) => generator.oper === GENERATORS.instrument
-            ? { ...generator, amount: generator.amount + instrumentBase }
-            : generator));
-        merged.instruments.push(...source.instruments
-            .slice(0, -1)
-            .map((instrument) => ({ ...instrument, bag: instrument.bag + instBagBase })));
-        merged.instBags.push(...source.instBags.slice(0, -1).map((gen) => gen + instGenBase));
-        merged.instGens.push(...source.instGens
-            .slice(0, source.instBags[source.instBags.length - 1])
-            .map((generator) => generator.oper === GENERATORS.sampleId
-            ? { ...generator, amount: generator.amount + sampleBase }
-            : generator));
-        merged.samples.push(...source.samples.slice(0, -1).map((sample) => ({
-            ...sample,
-            start: sample.start + offsetBase,
-            end: sample.end + offsetBase,
-            loopStart: compressed ? sample.loopStart : sample.loopStart + offsetBase,
-            loopEnd: compressed ? sample.loopEnd : sample.loopEnd + offsetBase,
-            link: sample.link + sampleBase,
-        })));
-        //a plain font's chunk can end on an odd byte, which would shift every frame after it
-        const part = compressed ? source.smplBytes : source.smplBytes.subarray(0, source.smplBytes.length & ~1);
-        parts.push(part);
-        smplLength += part.length;
-    }
-    merged.presetBags.push(merged.presetGens.length);
-    merged.instBags.push(merged.instGens.length);
-    merged.presets.push({ name: 'EOS', preset: 0, bank: 0, bag: merged.presetBags.length - 1 });
-    merged.instruments.push({ name: 'EOS', bag: merged.instBags.length - 1 });
-    merged.samples.push({
-        name: 'EOS',
-        start: 0,
-        end: 0,
-        loopStart: 0,
-        loopEnd: 0,
-        rate: 0,
-        rootKey: 0,
-        correction: 0,
-        link: 0,
-        type: 0,
-    });
-    merged.smplBytes = concat(parts);
-    if (!compressed)
-        merged.smpl = new Int16Array(merged.smplBytes.slice().buffer);
-    return writeSoundFont(merged, distinctPresets(merged));
-}
-/** the presets of `tables` (indices) with each (bank, program) once, the first occurrence winning */
-function distinctPresets(tables) {
-    const seen = new Set();
-    const out = [];
-    for (let index = 0; index < tables.presets.length - 1; index++) {
-        const key = `${tables.presets[index].bank}:${tables.presets[index].preset}`;
-        if (seen.has(key))
-            continue;
-        seen.add(key);
-        out.push(index);
-    }
-    return out;
-}
-/**
- * Decodes a SoundFont 3 into a plain SoundFont 2: every Ogg Vorbis sample a preset reaches goes
- * through `decode` (one call per sample, mono 16-bit frames at the rate the header states) into
- * the sample chunk, and the loop points a SoundFont 3 states relative to its sample become the
- * absolute ones SoundFont 2 uses. A SoundFont 2 comes back unchanged and `decode` is never called.
- * The result feeds everything that takes SoundFont 2 bytes, `renderMidiToBufferAsync` included.
- * A loop that ends past the decoded frames is cut to them. `limits` raises or lowers what a sample and
- * the whole font may decode to (see `SoundFontLimits`).
- *
- * @example
- * ```ts
- * import { decodeSoundFont, webAudioSampleDecoder } from '@datamoc/mw_games/audio';
- *
- * declare const sf3Bytes: ArrayBuffer;
- *
- * const sf2 = await decodeSoundFont(sf3Bytes, webAudioSampleDecoder());
- * console.log(sf2.byteLength);
- * ```
- */
-export async function decodeSoundFont(data, decode, limits = {}) {
-    const maxSample = limits.sampleFrames ?? MAX_SAMPLE_FRAMES;
-    const maxTotal = limits.totalFrames ?? MAX_TOTAL_FRAMES;
-    const bytes = toBytes(data);
-    const tables = readTables(bytes);
-    if (!tables.compressed)
-        return bytes.slice().buffer;
-    //prune first, so a sample no preset reaches is never decoded
-    const reachable = readTables(new Uint8Array(writeSoundFont(tables, distinctPresets(tables))));
-    const frames = [];
-    const placed = new Map();
-    let total = 0;
-    const samples = [];
-    for (const sample of reachable.samples) {
-        if (!(sample.end > sample.start) || sample.type & 0x8000) {
-            samples.push(sample);
-            continue;
-        }
-        const key = `${sample.start}:${sample.end}`;
-        let at = placed.get(key);
-        if (!at) {
-            if (!(sample.rate >= MIN_SAMPLE_RATE && sample.rate <= MAX_SAMPLE_RATE)) {
-                throw new Error(`a sample states ${sample.rate} Hz, which no SoundFont does: the font is damaged`);
-            }
-            const pcm = await decode(reachable.smplBytes.subarray(sample.start, sample.end), sample.rate);
-            //what a decoder returns is bounded too: a few bytes of Ogg can name a very long sound
-            if (pcm.length > maxSample || total + pcm.length > maxTotal) {
-                throw new Error('the decoded sample data is larger than the limits allow: subset the font, or raise `limits`');
-            }
-            at = { start: total, length: pcm.length };
-            placed.set(key, at);
-            frames.push(pcm);
-            total += pcm.length;
-        }
-        samples.push({
-            ...sample,
-            start: at.start,
-            end: at.start + at.length,
-            loopStart: at.start + Math.min(sample.loopStart, at.length),
-            loopEnd: at.start + Math.min(sample.loopEnd, at.length),
-            type: sample.type & ~0x10,
-        });
-    }
-    const smpl = new Int16Array(total);
-    let offset = 0;
-    for (const pcm of frames) {
-        smpl.set(pcm, offset);
-        offset += pcm.length;
-    }
-    const plain = {
-        ...reachable,
-        samples,
-        smpl,
-        smplBytes: new Uint8Array(smpl.buffer),
-        compressed: false,
-    };
-    return writeSoundFont(plain, distinctPresets(plain));
-}
-/**
- * Reads a SoundFont 2 or 3 into layered preset voices: `parseSoundFont` for a plain font, and a
- * SoundFont 3 decoded first through `decode`, `webAudioSampleDecoder()` (the browser) unless one
- * is given. This is what a game calls on the bytes it ships, whichever kind they are.
- *
- * @example
- * ```ts
- * import { loadSoundFont, parseMidi, renderMidiToBuffer } from '@datamoc/mw_games/audio';
- *
- * declare const fontBytes: ArrayBuffer;
- * declare const midiBytes: ArrayBuffer;
- *
- * const font = await loadSoundFont(fontBytes);
- * const rendered = renderMidiToBuffer(parseMidi(midiBytes), { soundfont: font });
- * console.log(rendered.duration);
- * ```
- */
-export async function loadSoundFont(data, options = {}) {
-    const decode = options.decode ?? webAudioSampleDecoder(undefined, options.limits);
-    return parseSoundFont(await decodeSoundFont(data, decode, options.limits), options);
-}
-/**
- * Writes a smaller, valid SoundFont 2 file carrying only the used programs: their
- * presets (names kept), instruments and samples, with zones, ranges, tuning,
- * envelopes and sample loops copied verbatim and every index remapped. Zones that
- * reference samples missing from the file (ROM samples) are dropped, matching what
- * the reader voices for the full font; the library, genre and morphology metadata
- * is zeroed and the INFO list, when present, rides along untouched. Modulator lists
- * are emptied and 24-bit upper bits are dropped: the reader voices neither, so what
- * it plays is unchanged, while a third-party player would miss those.
- *
- * @example
- * ```ts
- * import { parseMidi, collectSoundFontUsage, subsetSoundFont } from '@datamoc/mw_games/audio';
- *
- * declare const midiBytes: ArrayBuffer;
- * declare const soundfontBytes: ArrayBuffer;
- *
- * const usage = collectSoundFontUsage([parseMidi(midiBytes)]);
- * const pruned = subsetSoundFont(soundfontBytes, usage);
- * console.log(usage.length, pruned.byteLength);
- * ```
- */
-export function subsetSoundFont(data, usage) {
-    const tables = readTables(toBytes(data));
-    const presetIndex = new Map();
-    for (let index = 0; index < tables.presets.length - 1; index++) {
-        presetIndex.set(`${tables.presets[index].bank}:${tables.presets[index].preset}`, index);
-    }
-    //Used presets in file order, resolved through the same fallback the reader voices.
-    const seenPresets = new Set();
-    const usedPresets = [];
-    for (const { bank, program } of usage) {
-        const index = presetIndexOf(presetIndex, bank, program);
-        if (index !== undefined && !seenPresets.has(index)) {
-            seenPresets.add(index);
-            usedPresets.push(index);
-        }
-    }
-    usedPresets.sort((a, b) => a - b);
-    return writeSoundFont(tables, usedPresets);
-}
-/** writes the presets of `tables` listed in `usedPresets` (indices) with everything they reach, remapped */
-function writeSoundFont(tables, usedPresets) {
-    const usableSample = (id) => {
-        const header = tables.samples[id];
-        return !!header && header.end > header.start && !(header.type & 0x8000);
-    };
-    //A bag's generators verbatim, except instrument and sample ids are remapped.
-    const remapIds = (gens, oper, ids) => gens.map((generator) => generator.oper === oper
-        ? {
-            oper,
-            lo: ids.get(generator.amount) & 0xff,
-            hi: (ids.get(generator.amount) >> 8) & 0xff,
-            amount: ids.get(generator.amount),
-        }
-        : generator);
-    //Instruments in first-use order, with zones that lost their sample dropped.
-    const instrumentOrder = [];
-    const instrumentZones = new Map();
-    {
-        const seen = new Set();
-        for (const preset of usedPresets) {
-            const first = tables.presets[preset].bag;
-            const last = tables.presets[preset + 1]?.bag ?? tables.presetBags.length - 1;
-            for (let bag = first; bag < last; bag++) {
-                const gens = bagGens(tables.presetBags, tables.presetGens, bag);
-                if (!gens.some((generator) => generator.oper === GENERATORS.instrument))
-                    continue;
-                const instrument = gens.find((generator) => generator.oper === GENERATORS.instrument).amount;
-                if (!tables.instruments[instrument + 1])
-                    continue; // same guard the reader voices with
-                if (!seen.has(instrument)) {
-                    seen.add(instrument);
-                    instrumentOrder.push(instrument);
-                }
-            }
-        }
-    }
-    const instrumentNew = new Map(instrumentOrder.map((old, index) => [old, index]));
-    for (const instrument of instrumentOrder) {
-        const first = tables.instruments[instrument].bag;
-        const last = tables.instruments[instrument + 1]?.bag ?? tables.instBags.length - 1;
-        const zones = [];
-        for (let bag = first; bag < last; bag++) {
-            const gens = bagGens(tables.instBags, tables.instGens, bag);
-            if (!gens.some((generator) => generator.oper === GENERATORS.sampleId))
-                continue;
-            const sample = gens.find((generator) => generator.oper === GENERATORS.sampleId).amount;
-            if (!usableSample(sample))
-                continue;
-            zones.push(gens);
-        }
-        instrumentZones.set(instrument, zones);
-    }
-    //Samples in first-use order, chasing stereo links one hop so none dangles.
-    const sampleOrder = [];
-    {
-        const seen = new Set();
-        const keep = (id) => {
-            if (seen.has(id) || !usableSample(id))
-                return;
-            seen.add(id);
-            sampleOrder.push(id);
-            const link = tables.samples[id].link;
-            if (link !== id)
-                keep(link);
-        };
-        for (const instrument of instrumentOrder) {
-            for (const zone of instrumentZones.get(instrument)) {
-                keep(zone.find((generator) => generator.oper === GENERATORS.sampleId).amount);
-            }
-        }
-    }
-    const sampleNew = new Map(sampleOrder.map((old, index) => [old, index]));
-    const genRecord = (generator) => [...u16le(generator.oper), generator.lo, generator.hi];
-    const bagRecord = (genIndex) => [...u16le(genIndex), ...u16le(0)];
-    //Presets: global zone first when the source has one, then its instrument zones.
-    const newPresetBags = [];
-    const newPresetGens = [];
-    const newPresets = [];
-    for (const preset of usedPresets) {
-        const source = tables.presets[preset];
-        const bagStart = newPresetBags.length;
-        const first = source.bag;
-        const last = tables.presets[preset + 1]?.bag ?? tables.presetBags.length - 1;
-        for (let bag = first; bag < last; bag++) {
-            const gens = bagGens(tables.presetBags, tables.presetGens, bag);
-            const isGlobal = bag === first && !gens.some((generator) => generator.oper === GENERATORS.instrument);
-            if (!isGlobal && !gens.some((generator) => generator.oper === GENERATORS.instrument))
-                continue;
-            newPresetBags.push(newPresetGens.length);
-            newPresetGens.push(...remapIds(gens, GENERATORS.instrument, instrumentNew));
-        }
-        newPresets.push({ name: source.name, preset: source.preset, bank: source.bank, bag: bagStart });
-    }
-    newPresetBags.push(newPresetGens.length);
-    //Instruments: same shape, sample ids remapped, sample zones already pruned above.
-    const newInstBags = [];
-    const newInstGens = [];
-    const newInstruments = [];
-    for (const instrument of instrumentOrder) {
-        const bagStart = newInstBags.length;
-        const zones = instrumentZones.get(instrument);
-        //An instrument whose zones all lost their samples keeps its header with no
-        //bags: it voices nothing, exactly like the full font did.
-        //A global zone (first bag without a sample id) rides along when present.
-        const first = tables.instruments[instrument].bag;
-        const last = tables.instruments[instrument + 1]?.bag ?? tables.instBags.length - 1;
-        for (let bag = first; bag < last; bag++) {
-            const gens = bagGens(tables.instBags, tables.instGens, bag);
-            if (bag === first && !gens.some((generator) => generator.oper === GENERATORS.sampleId)) {
-                newInstBags.push(newInstGens.length);
-                newInstGens.push(...gens);
-            }
-        }
-        for (const zone of zones) {
-            newInstBags.push(newInstGens.length);
-            newInstGens.push(...remapIds(zone, GENERATORS.sampleId, sampleNew));
-        }
-        newInstruments.push({ name: tables.instruments[instrument].name, bag: bagStart });
-    }
-    newInstBags.push(newInstGens.length);
-    //Samples: data concatenated, offsets and links remapped, headers otherwise intact.
-    const newSamples = [];
-    const sampleData = [];
-    for (const old of sampleOrder) {
-        const header = tables.samples[old];
-        const self = sampleNew.get(old);
-        if (tables.compressed) {
-            //Ogg bytes copied as they are: offsets count bytes and the loop points stay relative to the sample
-            const start = sampleData.length;
-            for (let index = header.start; index < header.end; index++)
-                sampleData.push(tables.smplBytes[index]);
-            newSamples.push({
-                ...header,
-                start,
-                end: start + (header.end - header.start),
-                link: sampleNew.get(header.link) ?? self,
-            });
-            continue;
-        }
-        const start = sampleData.length / 2;
-        for (let index = header.start; index < header.end; index++) {
-            const word = tables.smpl[index];
-            sampleData.push(word & 0xff, (word >> 8) & 0xff);
-        }
-        newSamples.push({
-            ...header,
-            start,
-            end: start + (header.end - header.start),
-            loopStart: start + (header.loopStart - header.start),
-            loopEnd: start + (header.loopEnd - header.start),
-            link: sampleNew.get(header.link) ?? self,
-        });
-    }
-    const presetRecords = (entry) => [
-        ...encodeName(entry.name),
-        ...u16le(entry.preset),
-        ...u16le(entry.bank),
-        ...u16le(entry.bag),
-        ...new Array(12).fill(0),
-    ];
-    const terminalPreset = tables.presets[tables.presets.length - 1];
-    const phdr = chunkBytes('phdr', [
-        ...newPresets.flatMap(presetRecords),
-        ...presetRecords({
-            name: terminalPreset?.name ?? 'EOS',
-            preset: 0,
-            bank: 0,
-            bag: newPresetBags.length - 1,
-        }),
-    ]);
-    const pbag = chunkBytes('pbag', newPresetBags.flatMap(bagRecord));
-    const pgen = chunkBytes('pgen', newPresetGens.flatMap(genRecord));
-    const pmod = chunkBytes('pmod', new Array(10).fill(0));
-    const instRecords = (entry) => [
-        ...encodeName(entry.name),
-        ...u16le(entry.bag),
-    ];
-    const terminalInst = tables.instruments[tables.instruments.length - 1];
-    const inst = chunkBytes('inst', [
-        ...newInstruments.flatMap(instRecords),
-        ...instRecords({ name: terminalInst?.name ?? 'EOS', bag: newInstBags.length - 1 }),
-    ]);
-    const ibag = chunkBytes('ibag', newInstBags.flatMap(bagRecord));
-    const igen = chunkBytes('igen', newInstGens.flatMap(genRecord));
-    const imod = chunkBytes('imod', new Array(10).fill(0));
-    const sampleRecords = (header) => [
-        ...encodeName(header.name),
-        ...u32le(header.start),
-        ...u32le(header.end),
-        ...u32le(header.loopStart),
-        ...u32le(header.loopEnd),
-        ...u32le(header.rate),
-        header.rootKey,
-        header.correction & 0xff,
-        ...u16le(header.link),
-        ...u16le(header.type),
-    ];
-    const terminalSample = {
-        name: '',
-        start: 0,
-        end: 0,
-        loopStart: 0,
-        loopEnd: 0,
-        rate: 0,
-        rootKey: 0,
-        correction: 0,
-        link: 0,
-        type: 0,
-    };
-    const shdr = chunkBytes('shdr', [...newSamples.flatMap(sampleRecords), ...sampleRecords(terminalSample)]);
-    const smpl = chunkBytes('smpl', sampleData);
-    const sdta = listBytes('sdta', [smpl]);
-    const pdta = listBytes('pdta', [phdr, pbag, pmod, pgen, inst, ibag, imod, igen, shdr]);
-    const body = concat([new Uint8Array(asciiBytes('sfbk')), ...(tables.info ? [tables.info] : []), sdta, pdta]);
-    const bytes = concat([new Uint8Array(asciiBytes('RIFF')), new Uint8Array(u32le(body.length)), body]);
-    return bytes.buffer;
-}
-//# sourceMappingURL=SoundFont.js.map