fractal-midi 0.1.0-alpha.0

package/dist/axe-fx-iii/blockTypes.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Axe-Fx III block-type catalog with effect IDs from v1.4 PDF Appendix 1.
+ *
+ * Effect IDs are 14-bit values used in the `id id` payload position
+ * of functions 0x0A (SET_BYPASS), 0x0B (SET_CHANNEL), and the
+ * response triples from 0x13 (STATUS_DUMP). Source:
+ * `docs/manuals/AxeFx3-MIDI-3rdParty.txt` Appendix 1.
+ *
+ * Per the PDF, each block-type that supports up to 4 instances has 4
+ * consecutive effect IDs (e.g. `ID_COMP1 = 46, ID_COMP2 = 47,
+ * ID_COMP3 = 48, ID_COMP4 = 49`). Singletons have one ID. This file
+ * exposes the first-instance ID + instance count; resolvers compute
+ * `instance_N_id = firstId + (N-1)`.
+ *
+ * Anomalies / unknowns documented in `docs/SYSEX-MAP-AXE-FX-III.md`:
+ *   - **AMP is absent from v1.4 Appendix 1.** AMP effect IDs are
+ *     either in the 3..34 reserved range or deliberately omitted. The
+ *     AMP block entry below carries `firstId: null` until a STATUS_DUMP
+ *     against a preset containing AMP decodes its ID.
+ *   - **Post-firmware-1.13 blocks have no effect ID in the v1.4 PDF**:
+ *     NAM, Dynamic Distortion, IR Capture (as a block; the Appendix
+ *     has `ID_IRCAPTURE = 36` for the utility), and recent layouts.
+ *     These also carry `firstId: null`.
+ *   - **`ID_DISTORT`** in the PDF maps to what AxeEdit III displays as
+ *     the **Drive** block (DRV). Same hardware, different name.
+ *   - **`ID_FUZZ`** is a separate effect-ID range from `ID_DISTORT`,
+ *     yet AxeEdit III may collapse both under the Drive picker. We
+ *     model FUZZ as its own catalog entry per the spec.
+ */
+/** Confidence tag for each catalog entry's `firstId`. */
+export type ConfidenceTag = 'spec-v1.4' | 'editor-asset' | 'inferred-from-ii' | 'pending-capture';
+export interface AxeFxIIIBlock {
+    /**
+     * First-instance effect ID (e.g. ID_REVERB1 = 66). `null` if the
+     * block isn't in v1.4 Appendix 1. To address instance N (1-based),
+     * compute `firstId + (N - 1)`.
+     */
+    firstId: number | null;
+    /** Number of instances this block-type supports on the III. */
+    instances: number;
+    /** Display name as shown in AxeEdit III. */
+    name: string;
+    /** Three-letter group code Fractal uses internally (AMP, CMP, REV, ...). */
+    groupCode: string;
+    /** Devices that ship this block; absent = all (III + FM9 + FM3). */
+    availability?: 'iii-only' | 'iii+fm9' | 'iii+fm9+fm3' | 'utility-only';
+    /** Confidence tag for this entry. */
+    confidence: ConfidenceTag;
+    /**
+     * False when v1.4 lists the effect ID but the block is NOT controllable
+     * via the 3rd-party MIDI surface (e.g. internal Control/FC/MIDI blocks
+     * that respond to FC interface only). `set_bypass` / `set_channel`
+     * refuse with a clean error for these. Defaults to true when absent.
+     *
+     * Confirmed non-addressable from community RE (forum thread #140602,
+     * 2019):
+     *   - ID_CONTROL (2)          → Controllers
+     *   - ID_MIDIBLOCK (190)      → Scene MIDI
+     *   - ID_FOOTCONTROLLER (199) → Foot Controller
+     *   - ID_PRESET_FC (200)      → Preset FC
+     */
+    addressable?: boolean;
+}
+/**
+ * The Axe-Fx III block-type catalog. Order is roughly the order
+ * AxeEdit III displays them in its block-picker palette. Effect IDs
+ * are from v1.4 Appendix 1 where documented.
+ */
+export declare const AXE_FX_III_BLOCKS: readonly AxeFxIIIBlock[];
+/**
+ * Resolve a user-supplied block reference (display name or group code)
+ * to its block descriptor. Returns `undefined` if not found.
+ */
+export declare function resolveBlock(input: string): AxeFxIIIBlock | undefined;
+/**
+ * Resolve a "block + instance" reference (e.g. "Reverb 1", "Drive 2",
+ * "REV 3") to a concrete effect ID. Returns the effect ID, or throws
+ * with a helpful message if the block is unknown OR has no effect ID
+ * in the v1.4 spec (AMP, NAM, etc.).
+ *
+ * Accepts both:
+ *   - `"Reverb 1"` (display name + instance number)
+ *   - `"REV"` or `"Reverb"` (no instance → defaults to instance 1)
+ *   - `{ block: 'Reverb', instance: 2 }` (object form, see overload)
+ */
+export declare function resolveEffectId(blockName: string, instance?: number): number;
+//# sourceMappingURL=blockTypes.d.ts.map

package/dist/axe-fx-iii/blockTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blockTypes.d.ts","sourceRoot":"","sources":["../../src/axe-fx-iii/blockTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,yDAAyD;AACzD,MAAM,MAAM,aAAa,GACrB,WAAW,GACX,cAAc,GACd,kBAAkB,GAClB,iBAAiB,CAAC;AAEtB,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,+DAA+D;IAC/D,SAAS,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,YAAY,CAAC,EAAE,UAAU,GAAG,SAAS,GAAG,aAAa,GAAG,cAAc,CAAC;IACvE,qCAAqC;IACrC,UAAU,EAAE,aAAa,CAAC;IAC1B;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,SAAS,aAAa,EAoE5C,CAAC;AAcX;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAMrE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,SAAS,EAAE,MAAM,EACjB,QAAQ,CAAC,EAAE,MAAM,GAChB,MAAM,CAuCR"}

package/dist/axe-fx-iii/blockTypes.js

@@ -0,0 +1,156 @@
+/**
+ * Axe-Fx III block-type catalog with effect IDs from v1.4 PDF Appendix 1.
+ *
+ * Effect IDs are 14-bit values used in the `id id` payload position
+ * of functions 0x0A (SET_BYPASS), 0x0B (SET_CHANNEL), and the
+ * response triples from 0x13 (STATUS_DUMP). Source:
+ * `docs/manuals/AxeFx3-MIDI-3rdParty.txt` Appendix 1.
+ *
+ * Per the PDF, each block-type that supports up to 4 instances has 4
+ * consecutive effect IDs (e.g. `ID_COMP1 = 46, ID_COMP2 = 47,
+ * ID_COMP3 = 48, ID_COMP4 = 49`). Singletons have one ID. This file
+ * exposes the first-instance ID + instance count; resolvers compute
+ * `instance_N_id = firstId + (N-1)`.
+ *
+ * Anomalies / unknowns documented in `docs/SYSEX-MAP-AXE-FX-III.md`:
+ *   - **AMP is absent from v1.4 Appendix 1.** AMP effect IDs are
+ *     either in the 3..34 reserved range or deliberately omitted. The
+ *     AMP block entry below carries `firstId: null` until a STATUS_DUMP
+ *     against a preset containing AMP decodes its ID.
+ *   - **Post-firmware-1.13 blocks have no effect ID in the v1.4 PDF**:
+ *     NAM, Dynamic Distortion, IR Capture (as a block; the Appendix
+ *     has `ID_IRCAPTURE = 36` for the utility), and recent layouts.
+ *     These also carry `firstId: null`.
+ *   - **`ID_DISTORT`** in the PDF maps to what AxeEdit III displays as
+ *     the **Drive** block (DRV). Same hardware, different name.
+ *   - **`ID_FUZZ`** is a separate effect-ID range from `ID_DISTORT`,
+ *     yet AxeEdit III may collapse both under the Drive picker. We
+ *     model FUZZ as its own catalog entry per the spec.
+ */
+/**
+ * The Axe-Fx III block-type catalog. Order is roughly the order
+ * AxeEdit III displays them in its block-picker palette. Effect IDs
+ * are from v1.4 Appendix 1 where documented.
+ */
+export const AXE_FX_III_BLOCKS = [
+    // Compositing utilities (singletons, IDs from PDF Appendix)
+    { firstId: 2, instances: 1, name: 'Controllers', groupCode: 'CTR', confidence: 'spec-v1.4', addressable: false },
+    // (IDs 3-34 reserved or unenumerated in v1.4)
+    { firstId: 35, instances: 1, name: 'Tuner', groupCode: 'TUN', confidence: 'spec-v1.4' },
+    { firstId: 36, instances: 1, name: 'IR Capture', groupCode: 'IRC', availability: 'utility-only', confidence: 'spec-v1.4' },
+    { firstId: 37, instances: 5, name: 'Input', groupCode: 'IN', confidence: 'spec-v1.4' },
+    { firstId: 42, instances: 4, name: 'Output', groupCode: 'OUT', confidence: 'spec-v1.4' },
+    // Signal-chain blocks (4 instances each unless noted)
+    { firstId: 46, instances: 4, name: 'Compressor', groupCode: 'CMP', confidence: 'spec-v1.4' },
+    { firstId: 50, instances: 4, name: 'Graphic EQ', groupCode: 'GEQ', confidence: 'spec-v1.4' },
+    { firstId: 54, instances: 4, name: 'Parametric EQ', groupCode: 'PEQ', confidence: 'spec-v1.4' },
+    { firstId: 58, instances: 4, name: 'Drive', groupCode: 'DRV', confidence: 'spec-v1.4' },
+    { firstId: 62, instances: 4, name: 'Cab', groupCode: 'CAB', confidence: 'spec-v1.4' },
+    { firstId: 66, instances: 4, name: 'Reverb', groupCode: 'REV', confidence: 'spec-v1.4' },
+    { firstId: 70, instances: 4, name: 'Delay', groupCode: 'DLY', confidence: 'spec-v1.4' },
+    { firstId: 74, instances: 4, name: 'Multitap Delay', groupCode: 'MTD', confidence: 'spec-v1.4' },
+    { firstId: 78, instances: 4, name: 'Chorus', groupCode: 'CHO', confidence: 'spec-v1.4' },
+    { firstId: 82, instances: 4, name: 'Flanger', groupCode: 'FLG', confidence: 'spec-v1.4' },
+    { firstId: 86, instances: 4, name: 'Rotary', groupCode: 'ROT', confidence: 'spec-v1.4' },
+    { firstId: 90, instances: 4, name: 'Phaser', groupCode: 'PHA', confidence: 'spec-v1.4' },
+    { firstId: 94, instances: 4, name: 'Wah', groupCode: 'WAH', confidence: 'spec-v1.4' },
+    { firstId: 98, instances: 4, name: 'Formant', groupCode: 'FRM', confidence: 'spec-v1.4' },
+    { firstId: 102, instances: 4, name: 'Volume/Pan', groupCode: 'VOL', confidence: 'spec-v1.4' },
+    { firstId: 106, instances: 4, name: 'Pan/Tremolo', groupCode: 'PTR', confidence: 'spec-v1.4' },
+    { firstId: 110, instances: 4, name: 'Pitch', groupCode: 'PIT', confidence: 'spec-v1.4' },
+    { firstId: 114, instances: 4, name: 'Filter', groupCode: 'FIL', confidence: 'spec-v1.4' },
+    { firstId: 118, instances: 4, name: 'Fuzz', groupCode: 'FUZ', confidence: 'spec-v1.4' },
+    { firstId: 122, instances: 4, name: 'Enhancer', groupCode: 'ENH', confidence: 'spec-v1.4' },
+    { firstId: 126, instances: 4, name: 'Mixer', groupCode: 'MIX', confidence: 'spec-v1.4' },
+    { firstId: 130, instances: 4, name: 'Synth', groupCode: 'SYN', confidence: 'spec-v1.4' },
+    { firstId: 134, instances: 4, name: 'Vocoder', groupCode: 'VOC', availability: 'iii-only', confidence: 'spec-v1.4' },
+    { firstId: 138, instances: 4, name: 'Megatap Delay', groupCode: 'MGD', confidence: 'spec-v1.4' },
+    { firstId: 142, instances: 4, name: 'Crossover', groupCode: 'XOV', availability: 'iii+fm9', confidence: 'spec-v1.4' },
+    { firstId: 146, instances: 4, name: 'Gate/Expander', groupCode: 'GAT', confidence: 'spec-v1.4' },
+    { firstId: 150, instances: 4, name: 'Ring Modulator', groupCode: 'RNG', confidence: 'spec-v1.4' },
+    { firstId: 154, instances: 4, name: 'Multiband Compressor', groupCode: 'MBC', confidence: 'spec-v1.4' },
+    { firstId: 158, instances: 4, name: 'Ten-Tap Delay', groupCode: 'TTD', confidence: 'spec-v1.4' },
+    { firstId: 162, instances: 4, name: 'Resonator', groupCode: 'RES', confidence: 'spec-v1.4' },
+    { firstId: 166, instances: 4, name: 'Looper', groupCode: 'LPR', confidence: 'spec-v1.4' },
+    { firstId: 170, instances: 4, name: 'Tone Match', groupCode: 'TMA', availability: 'iii-only', confidence: 'spec-v1.4' },
+    { firstId: 174, instances: 4, name: 'Real-Time Analyzer', groupCode: 'RTA', availability: 'iii-only', confidence: 'spec-v1.4' },
+    { firstId: 178, instances: 4, name: 'Plex Delay', groupCode: 'PLX', confidence: 'spec-v1.4' },
+    { firstId: 182, instances: 4, name: 'Send', groupCode: 'SND', confidence: 'spec-v1.4' },
+    { firstId: 186, instances: 4, name: 'Return', groupCode: 'RTN', confidence: 'spec-v1.4' },
+    { firstId: 190, instances: 1, name: 'Scene MIDI', groupCode: 'SMI', confidence: 'spec-v1.4', addressable: false },
+    { firstId: 191, instances: 4, name: 'Multiplexer', groupCode: 'MUX', confidence: 'spec-v1.4' },
+    { firstId: 195, instances: 4, name: 'IR Player', groupCode: 'IRP', availability: 'iii-only', confidence: 'spec-v1.4' },
+    { firstId: 199, instances: 1, name: 'Foot Controller', groupCode: 'FC', confidence: 'spec-v1.4', addressable: false },
+    { firstId: 200, instances: 1, name: 'Preset FC', groupCode: 'PFC', confidence: 'spec-v1.4', addressable: false },
+    // ── Blocks NOT in v1.4 Appendix 1 ───────────────────────────────
+    // AMP is mysteriously absent from v1.4 — either in the 3..34
+    // reserved range or deliberately omitted from the 3rd-party MIDI
+    // surface. STATUS_DUMP against a preset containing AMP would
+    // decode the real ID.
+    { firstId: null, instances: 4, name: 'Amp', groupCode: 'AMP', confidence: 'pending-capture' },
+    // Post-firmware-1.13 additions (PDF predates these by ~6 years)
+    { firstId: null, instances: 4, name: 'Dynamic Distortion', groupCode: 'DYD', availability: 'iii-only', confidence: 'pending-capture' },
+    { firstId: null, instances: 4, name: 'NAM', groupCode: 'NAM', availability: 'iii-only', confidence: 'pending-capture' },
+    // Editor-asset-only entries — UI surface exists, no SysEx ID confirmed
+    { firstId: null, instances: 1, name: 'Global Block', groupCode: 'GBK', availability: 'iii-only', confidence: 'editor-asset' },
+    // Shunt is a grid-layout primitive (a pass-through cell); the III
+    // exposes it in the editor but the v1.4 PDF doesn't enumerate it.
+    { firstId: null, instances: 1, name: 'Shunt', groupCode: 'SHT', confidence: 'editor-asset' },
+];
+// ── Lookups ────────────────────────────────────────────────────────
+/** Lookup: lowercase block name → block descriptor. Case-insensitive. */
+const NAMES_BY_LOWER = new Map(AXE_FX_III_BLOCKS.map((b) => [b.name.toLowerCase(), b]));
+/** Lookup: groupCode → block descriptor. */
+const BY_GROUP_CODE = new Map(AXE_FX_III_BLOCKS.map((b) => [b.groupCode, b]));
+/**
+ * Resolve a user-supplied block reference (display name or group code)
+ * to its block descriptor. Returns `undefined` if not found.
+ */
+export function resolveBlock(input) {
+    const trimmed = input.trim();
+    if (trimmed.length === 0)
+        return undefined;
+    return (NAMES_BY_LOWER.get(trimmed.toLowerCase()) ?? BY_GROUP_CODE.get(trimmed.toUpperCase()));
+}
+/**
+ * Resolve a "block + instance" reference (e.g. "Reverb 1", "Drive 2",
+ * "REV 3") to a concrete effect ID. Returns the effect ID, or throws
+ * with a helpful message if the block is unknown OR has no effect ID
+ * in the v1.4 spec (AMP, NAM, etc.).
+ *
+ * Accepts both:
+ *   - `"Reverb 1"` (display name + instance number)
+ *   - `"REV"` or `"Reverb"` (no instance → defaults to instance 1)
+ *   - `{ block: 'Reverb', instance: 2 }` (object form, see overload)
+ */
+export function resolveEffectId(blockName, instance) {
+    // Try parsing trailing instance number out of the name itself.
+    const m = blockName.match(/^(.+?)\s*(\d+)?\s*$/);
+    const baseName = m?.[1]?.trim() ?? blockName;
+    const trailingNum = m?.[2] ? Number.parseInt(m[2], 10) : undefined;
+    const resolvedInstance = instance ?? trailingNum ?? 1;
+    const block = resolveBlock(baseName);
+    if (!block) {
+        throw new Error(`Unknown Axe-Fx III block "${blockName}". Try a name like "Reverb 1", ` +
+            '"Drive 2", or a 3-letter group code like "REV". Call ' +
+            '`axefx3_list_blocks` for the full catalog.');
+    }
+    if (block.firstId === null) {
+        throw new Error(`Axe-Fx III "${block.name}" has no effect ID in the v1.4 spec ` +
+            '(either reserved / unenumerated or added in firmware > 1.13). ' +
+            `${block.confidence === 'pending-capture' ? 'Run axefx3_status_dump against a preset that contains this block to decode its real effect ID.' : 'This block is shipping editor-only and may not be addressable via 3rd-party MIDI.'}`);
+    }
+    if (block.addressable === false) {
+        throw new Error(`Axe-Fx III "${block.name}" (effect ID ${block.firstId}) is listed in ` +
+            'v1.4 Appendix 1 but is NOT controllable via the 3rd-party MIDI ' +
+            "surface — it's an internal / FC-only block. set_bypass and " +
+            'set_channel will not affect it. ' +
+            '(Confirmed: ID_CONTROL=2, ID_MIDIBLOCK=190, ID_FOOTCONTROLLER=199, ' +
+            'ID_PRESET_FC=200.)');
+    }
+    if (resolvedInstance < 1 || resolvedInstance > block.instances) {
+        throw new Error(`Axe-Fx III ${block.name} instance ${resolvedInstance} out of range ` +
+            `(1..${block.instances}).`);
+    }
+    return block.firstId + (resolvedInstance - 1);
+}

package/dist/axe-fx-iii/enumOverlay.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Axe-Fx III enum vocabulary overlay.
+ *
+ * The III params catalog (`params.ts`) tags each enum-typed parameter
+ * with `unit: 'enum'` but cannot ship a `enumValues: {0: 'OFF', ...}`
+ * table inline — III enum vocabularies are not in the public v1.4 spec
+ * and have not been mined from the Axe-Edit III binary's `.rdata`
+ * string pools yet (a substantial Ghidra workstream).
+ *
+ * This overlay fills the gap with three layers of evidence-tagged data:
+ *
+ *   1. **Hardware-verified AM4 join**. Symbols whose stem matches an
+ *      AM4 entry with a confirmed `enumValues` table are reused
+ *      verbatim. Tag: `'am4-shared'`. Caveat: III firmware may extend
+ *      these (e.g. adding amp models post-AM4); the AM4 vocabulary
+ *      is the verified *subset*, not necessarily the complete list.
+ *   2. **Universal Fractal convention** (suffix-driven). Every
+ *      Fractal device uses the same vocabulary for binary toggles
+ *      (`_BYP`, `_MUTE`, `_ENABLE`), channel pickers (A/B/C/D),
+ *      slope tables, and standard LFO waveforms. Tag: `'fractal-
+ *      convention'`. Confidence: high — these vocabularies are
+ *      stable across every Fractal product since the original
+ *      Axe-Fx Standard (2006).
+ *   3. **III-specific direct entries**. Hand-curated for III-only
+ *      params with values lifted from the v1.4 PDF (where it documents
+ *      a vocabulary inline) or from the AxeEdit III XML when
+ *      `<EditorControl type="dropdown*">` carries an inline value
+ *      list. Tag: `'iii-spec'`.
+ *
+ * Consumers use `resolveEnumValues(paramName)` to look up the
+ * vocabulary; the function checks direct names first, then suffix
+ * conventions.
+ *
+ * **Hardware verification is the user's responsibility.** A wrong
+ * label in this overlay produces a misleading display but does NOT
+ * misroute wire bytes (the codec layer uses raw integer values). File
+ * a GitHub issue with a capture if your III shows a different label
+ * for a given wire value.
+ */
+/** Provenance tag for each overlay entry. */
+export type EnumProvenance = 'am4-shared' | 'fractal-convention' | 'iii-spec';
+/** Overlay entry — values map + provenance. */
+export interface EnumOverlayEntry {
+    values: Readonly<Record<number, string>>;
+    provenance: EnumProvenance;
+    /** Optional note explaining the entry's limitations / sources. */
+    note?: string;
+}
+/**
+ * Look up an enum vocabulary for an III parameter by its symbol name.
+ *
+ *   resolveEnumValues('GLOBAL_TUNERMUTE')
+ *     → { values: { 0: 'OFF', 1: 'ON' }, provenance: 'fractal-convention' }
+ *
+ *   resolveEnumValues('REVERB_LFO1TYPE')
+ *     → { values: { 0: 'Sine', ... }, provenance: 'am4-shared', note: ... }
+ *
+ *   resolveEnumValues('NOT_A_REAL_PARAM')
+ *     → undefined
+ *
+ * Lookup order: direct overrides first, then suffix rules in
+ * declaration order.
+ */
+export declare function resolveEnumValues(name: string): EnumOverlayEntry | undefined;
+/**
+ * Audit-friendly statistics for a calibration verifier or coverage
+ * report. Returns the number of entries in each tier.
+ */
+export declare function enumOverlayStats(): {
+    directOverrides: number;
+    suffixRules: number;
+};
+//# sourceMappingURL=enumOverlay.d.ts.map

package/dist/axe-fx-iii/enumOverlay.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enumOverlay.d.ts","sourceRoot":"","sources":["../../src/axe-fx-iii/enumOverlay.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AAEH,6CAA6C;AAC7C,MAAM,MAAM,cAAc,GAAG,YAAY,GAAG,oBAAoB,GAAG,UAAU,CAAC;AAE9E,+CAA+C;AAC/C,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACzC,UAAU,EAAE,cAAc,CAAC;IAC3B,kEAAkE;IAClE,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AA4LD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAO5E;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI;IAClC,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;CACrB,CAKA"}

package/dist/axe-fx-iii/enumOverlay.js

@@ -0,0 +1,236 @@
+/**
+ * Axe-Fx III enum vocabulary overlay.
+ *
+ * The III params catalog (`params.ts`) tags each enum-typed parameter
+ * with `unit: 'enum'` but cannot ship a `enumValues: {0: 'OFF', ...}`
+ * table inline — III enum vocabularies are not in the public v1.4 spec
+ * and have not been mined from the Axe-Edit III binary's `.rdata`
+ * string pools yet (a substantial Ghidra workstream).
+ *
+ * This overlay fills the gap with three layers of evidence-tagged data:
+ *
+ *   1. **Hardware-verified AM4 join**. Symbols whose stem matches an
+ *      AM4 entry with a confirmed `enumValues` table are reused
+ *      verbatim. Tag: `'am4-shared'`. Caveat: III firmware may extend
+ *      these (e.g. adding amp models post-AM4); the AM4 vocabulary
+ *      is the verified *subset*, not necessarily the complete list.
+ *   2. **Universal Fractal convention** (suffix-driven). Every
+ *      Fractal device uses the same vocabulary for binary toggles
+ *      (`_BYP`, `_MUTE`, `_ENABLE`), channel pickers (A/B/C/D),
+ *      slope tables, and standard LFO waveforms. Tag: `'fractal-
+ *      convention'`. Confidence: high — these vocabularies are
+ *      stable across every Fractal product since the original
+ *      Axe-Fx Standard (2006).
+ *   3. **III-specific direct entries**. Hand-curated for III-only
+ *      params with values lifted from the v1.4 PDF (where it documents
+ *      a vocabulary inline) or from the AxeEdit III XML when
+ *      `<EditorControl type="dropdown*">` carries an inline value
+ *      list. Tag: `'iii-spec'`.
+ *
+ * Consumers use `resolveEnumValues(paramName)` to look up the
+ * vocabulary; the function checks direct names first, then suffix
+ * conventions.
+ *
+ * **Hardware verification is the user's responsibility.** A wrong
+ * label in this overlay produces a misleading display but does NOT
+ * misroute wire bytes (the codec layer uses raw integer values). File
+ * a GitHub issue with a capture if your III shows a different label
+ * for a given wire value.
+ */
+// ── Universal Fractal vocabularies ───────────────────────────────
+/** Binary OFF/ON toggle — every Fractal product uses this. */
+const BINARY_OFF_ON = {
+    values: { 0: 'OFF', 1: 'ON' },
+    provenance: 'fractal-convention',
+};
+/** Bypassed/engaged toggle — bypass state. */
+const BYPASS_STATE = {
+    values: { 0: 'ENGAGED', 1: 'BYPASSED' },
+    provenance: 'fractal-convention',
+};
+/** Channel A/B/C/D picker — block-channel selector. */
+const CHANNEL_PICKER = {
+    values: { 0: 'A', 1: 'B', 2: 'C', 3: 'D' },
+    provenance: 'fractal-convention',
+};
+/** Slope table — filter slopes in dB/octave. */
+const FILTER_SLOPE = {
+    values: { 0: '6 dB/OCT', 1: '12 dB/OCT', 2: '24 dB/OCT', 3: '36 dB/OCT' },
+    provenance: 'fractal-convention',
+};
+/** Reverb low/high cut slope — Normal/Steep (AM4-verified, shared with III). */
+const REVERB_CUT_SLOPE = {
+    values: { 0: 'Normal', 1: 'Steep' },
+    provenance: 'am4-shared',
+};
+/** Input-select stereo picker (L+R / L / R). */
+const INPUT_SELECT_3WAY = {
+    values: { 0: 'L+R', 1: 'LEFT', 2: 'RIGHT' },
+    provenance: 'fractal-convention',
+};
+/** Input-select stereo picker (LEFT / RIGHT / SUM L+R). */
+const INPUT_SELECT_SUM = {
+    values: { 0: 'LEFT', 1: 'RIGHT', 2: 'SUM L+R' },
+    provenance: 'fractal-convention',
+};
+/** Mute/thru toggle. */
+const MUTE_THRU = {
+    values: { 0: 'Thru', 1: 'Mute' },
+    provenance: 'fractal-convention',
+};
+/** Pre/Post/Mid/End/Pre-Mid block placement. */
+const PRE_POST_MID = {
+    values: { 0: 'PRE', 1: 'POST', 2: 'MID', 3: 'END', 4: 'PRE-MID' },
+    provenance: 'fractal-convention',
+};
+/** Pan / NONE / RIGHT / LEFT / BOTH. */
+const PAN_4WAY = {
+    values: { 0: 'NONE', 1: 'RIGHT', 2: 'LEFT', 3: 'BOTH' },
+    provenance: 'fractal-convention',
+};
+/**
+ * Standard LFO waveform table — shared across every Fractal block that
+ * uses an LFO. Order is the AM4 / II / III canonical layout (verified
+ * against AM4 hardware Session 42; III uses the same ordering per
+ * AxeEdit III's XML `dropdownLFOType` control).
+ */
+const LFO_WAVEFORMS = {
+    values: {
+        0: 'Sine',
+        1: 'Triangle',
+        2: 'Square',
+        3: 'Saw Up',
+        4: 'Saw Down',
+        5: 'Random',
+        6: 'Smooth',
+        7: 'Log',
+        8: 'Exp',
+        9: 'Pulse',
+    },
+    provenance: 'am4-shared',
+    note: 'LFO_WAVEFORMS_VALUES from AM4; III preserves the ordering per AxeEdit III XML.',
+};
+/**
+ * Tempo divisions — 79-entry table (0..78) shared across every Fractal
+ * tempo-sync widget. AM4-verified.
+ */
+const TEMPO_DIVISIONS_PARTIAL = {
+    values: {
+        0: 'None',
+        1: '4x Whole', 2: '2x Whole', 3: 'Whole', 4: 'Whole Triplet',
+        5: 'Half Dotted', 6: 'Half', 7: 'Half Triplet',
+        8: 'Quarter Dotted', 9: 'Quarter', 10: 'Quarter Triplet',
+        11: '8th Dotted', 12: '8th', 13: '8th Triplet',
+        14: '16th Dotted', 15: '16th', 16: '16th Triplet',
+        17: '32nd Dotted', 18: '32nd', 19: '32nd Triplet',
+        20: '64th Dotted', 21: '64th', 22: '64th Triplet',
+    },
+    provenance: 'am4-shared',
+    note: 'Top 23 entries from AM4 TEMPO_DIVISIONS_VALUES; full 79-entry table available via AM4 import.',
+};
+// ── Suffix → vocabulary map ─────────────────────────────────────
+//
+// Order matters: more-specific suffixes first, then catch-alls.
+// Each tuple is [suffix, entry] — matched against the *end* of a
+// param's `name` field. The first match wins.
+const SUFFIX_RULES = [
+    // Most specific first.
+    ['_LOWCUTSLOPE', REVERB_CUT_SLOPE],
+    ['_HIGHCUTSLOPE', REVERB_CUT_SLOPE],
+    ['_LOW_CUT_SLOPE', REVERB_CUT_SLOPE],
+    ['_HIGH_CUT_SLOPE', REVERB_CUT_SLOPE],
+    ['_LFO1TYPE', LFO_WAVEFORMS],
+    ['_LFO2TYPE', LFO_WAVEFORMS],
+    ['_LFO3TYPE', LFO_WAVEFORMS],
+    ['_LFO4TYPE', LFO_WAVEFORMS],
+    ['_LFO_1_TYPE', LFO_WAVEFORMS],
+    ['_LFO_2_TYPE', LFO_WAVEFORMS],
+    ['_LFO_3_TYPE', LFO_WAVEFORMS],
+    ['_LFO_4_TYPE', LFO_WAVEFORMS],
+    ['_LFO_TYPE', LFO_WAVEFORMS],
+    ['_LFOTYPE', LFO_WAVEFORMS],
+    ['_TEMPO', TEMPO_DIVISIONS_PARTIAL],
+    ['_SLOPE', FILTER_SLOPE],
+    ['_CHANNEL', CHANNEL_PICKER],
+    ['_CHAN', CHANNEL_PICKER],
+    ['_INPUT_SELECT', INPUT_SELECT_3WAY],
+    ['_INPUTSELECT', INPUT_SELECT_3WAY],
+    ['_INSEL', INPUT_SELECT_3WAY],
+    // Binary toggles — catch-all suffix tail. Apply last so more-specific
+    // suffixes win.
+    ['_BYP', BYPASS_STATE],
+    ['_BYPASS', BYPASS_STATE],
+    ['_MUTE', MUTE_THRU],
+    ['_MUTE1', MUTE_THRU],
+    ['_MUTE2', MUTE_THRU],
+    ['_MUTE3', MUTE_THRU],
+    ['_MUTE4', MUTE_THRU],
+    ['_ENABLE', BINARY_OFF_ON],
+    ['_DISABLE', BINARY_OFF_ON],
+    ['_AUTOON', BINARY_OFF_ON],
+    ['_AUTOENABLE', BINARY_OFF_ON],
+    ['_AUTO', BINARY_OFF_ON],
+    ['_INVERT', BINARY_OFF_ON],
+    ['_HOLD', BINARY_OFF_ON],
+];
+// ── Direct-name overrides ────────────────────────────────────────
+//
+// Hand-curated entries for III-specific params where a suffix rule
+// would be wrong or where the vocabulary is non-standard.
+const DIRECT_OVERRIDES = {
+    GLOBAL_CABINETBYP: BYPASS_STATE,
+    GLOBAL_PWRAMPBYP: BYPASS_STATE,
+    GLOBAL_TUNERMUTE: BINARY_OFF_ON,
+    GLOBAL_DELAYSPILL: BINARY_OFF_ON,
+    GLOBAL_USETUNEOFFSETS: BINARY_OFF_ON,
+    REVERB_HOLD: {
+        values: { 0: 'OFF', 1: 'STACK', 2: 'HOLD' },
+        provenance: 'am4-shared',
+    },
+    REVERB_NUMSPRINGS: {
+        values: { 0: '1', 1: '2', 2: '3' },
+        provenance: 'iii-spec',
+        note: 'Inferred from spring-reverb editor presentation; III-untested.',
+    },
+    PRESET_BAND: {
+        values: { 0: 'Low', 1: 'Mid', 2: 'High' },
+        provenance: 'iii-spec',
+        note: 'Multiband processor band-index — inferred from editor layout.',
+    },
+};
+// ── Public API ────────────────────────────────────────────────────
+/**
+ * Look up an enum vocabulary for an III parameter by its symbol name.
+ *
+ *   resolveEnumValues('GLOBAL_TUNERMUTE')
+ *     → { values: { 0: 'OFF', 1: 'ON' }, provenance: 'fractal-convention' }
+ *
+ *   resolveEnumValues('REVERB_LFO1TYPE')
+ *     → { values: { 0: 'Sine', ... }, provenance: 'am4-shared', note: ... }
+ *
+ *   resolveEnumValues('NOT_A_REAL_PARAM')
+ *     → undefined
+ *
+ * Lookup order: direct overrides first, then suffix rules in
+ * declaration order.
+ */
+export function resolveEnumValues(name) {
+    const direct = DIRECT_OVERRIDES[name];
+    if (direct)
+        return direct;
+    for (const [suffix, entry] of SUFFIX_RULES) {
+        if (name.endsWith(suffix))
+            return entry;
+    }
+    return undefined;
+}
+/**
+ * Audit-friendly statistics for a calibration verifier or coverage
+ * report. Returns the number of entries in each tier.
+ */
+export function enumOverlayStats() {
+    return {
+        directOverrides: Object.keys(DIRECT_OVERRIDES).length,
+        suffixRules: SUFFIX_RULES.length,
+    };
+}

package/dist/axe-fx-iii/index.d.ts

@@ -0,0 +1,9 @@
+export { AXE_FX_III_BLOCKS, resolveBlock, resolveEffectId, } from './blockTypes.js';
+export type { AxeFxIIIBlock, ConfidenceTag } from './blockTypes.js';
+export { PARAMS, PARAMS_BY_FAMILY, PARAM_BY_KEY, FAMILIES } from './params.js';
+export type { Unit, Param } from './params.js';
+export { resolveEnumValues, enumOverlayStats } from './enumOverlay.js';
+export type { EnumOverlayEntry, EnumProvenance } from './enumOverlay.js';
+export { AXE_FX_III_MODEL_ID, FN_SET_GET_BYPASS, FN_SET_GET_CHANNEL, FN_SET_GET_SCENE, FN_QUERY_PATCH_NAME, FN_QUERY_SCENE_NAME, FN_SET_GET_LOOPER, FN_TEMPO_TAP, FN_TUNER_ON_OFF, FN_STATUS_DUMP, FN_SET_GET_TEMPO, FN_MULTIPURPOSE_RESPONSE, FN_PARAMETER_SETGET, QUERY_SENTINEL, packValue16, unpackValue16, buildSetParameter, buildGetParameter, buildSetParameterBypass, isSetGetParameterResponse, parseSetGetParameterResponse, buildSetGridCell, buildSetPresetName, buildStorePreset, buildSwitchPresetPC, buildSetBypass, buildGetBypass, buildSetChannel, buildGetChannel, buildSetScene, buildGetScene, buildQueryPatchName, buildQuerySceneName, buildSetLooper, buildGetLooperState, buildTempoTap, buildSetTuner, buildStatusDump, buildSetTempo, buildGetTempo, isSetGetBypassResponse, isSetGetChannelResponse, isSetGetSceneResponse, isQueryPatchNameResponse, isQuerySceneNameResponse, isSetGetLooperResponse, isStatusDumpResponse, isSetGetTempoResponse, isMultipurposeResponse, parseBypassResponse, parseChannelResponse, parseSceneResponse, parseQueryPatchNameResponse, parseQuerySceneNameResponse, parseLooperStateResponse, parseTempoResponse, parseMultipurposeResponse, describeMultipurposeResultCode, parseStatusDumpResponse, parseStateBroadcast, } from './setParam.js';
+export type { LooperAction, LooperState, StatusDumpEntry, AxeFxIIIParameterFrameKind, } from './setParam.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/axe-fx-iii/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/axe-fx-iii/index.ts"],"names":[],"mappings":"AAYA,OAAO,EACL,iBAAiB,EACjB,YAAY,EACZ,eAAe,GAChB,MAAM,iBAAiB,CAAC;AACzB,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC/E,YAAY,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAK/C,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACvE,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAIzE,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,YAAY,EACZ,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,wBAAwB,EACxB,mBAAmB,EACnB,cAAc,EACd,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,uBAAuB,EACvB,yBAAyB,EACzB,4BAA4B,EAC5B,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACnB,cAAc,EACd,cAAc,EACd,eAAe,EACf,eAAe,EACf,aAAa,EACb,aAAa,EACb,mBAAmB,EACnB,mBAAmB,EACnB,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,aAAa,EACb,eAAe,EACf,aAAa,EACb,aAAa,EACb,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,wBAAwB,EACxB,wBAAwB,EACxB,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACtB,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,2BAA2B,EAC3B,2BAA2B,EAC3B,wBAAwB,EACxB,kBAAkB,EAClB,yBAAyB,EACzB,8BAA8B,EAC9B,uBAAuB,EACvB,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,YAAY,EACV,YAAY,EACZ,WAAW,EACX,eAAe,EACf,0BAA0B,GAC3B,MAAM,eAAe,CAAC"}

package/dist/axe-fx-iii/index.js

@@ -0,0 +1,20 @@
+// Barrel for fractal-midi/axe-fx-iii.
+//
+// **Status: 🟡 community beta.** The III protocol layer is scaffolded
+// from Fractal's published "Axe-Fx III MIDI for Third-Party Devices"
+// v1.4 PDF and the AxeEdit III editor assets. Wire envelopes are
+// byte-verified against 10 public captures (FC-12, gabbernutter
+// forum); per-effect param-ID calibration is sparse (~11%) because
+// Fractal deliberately omits per-block param IDs from the public
+// spec. Use with that caveat.
+// Data — block roster + flat param table (2017 params from AxeEdit
+// III's `__block_layout.xml` mining).
+export { AXE_FX_III_BLOCKS, resolveBlock, resolveEffectId, } from './blockTypes.js';
+export { PARAMS, PARAMS_BY_FAMILY, PARAM_BY_KEY, FAMILIES } from './params.js';
+// Enum vocabulary overlay — universal Fractal conventions + AM4-
+// verified shared symbols + III-specific direct overrides. See
+// `enumOverlay.ts` for evidence chain and provenance tagging.
+export { resolveEnumValues, enumOverlayStats } from './enumOverlay.js';
+// Codec — wire-byte builders + parsers. Function-code constants
+// re-exported for callers building custom envelopes.
+export { AXE_FX_III_MODEL_ID, FN_SET_GET_BYPASS, FN_SET_GET_CHANNEL, FN_SET_GET_SCENE, FN_QUERY_PATCH_NAME, FN_QUERY_SCENE_NAME, FN_SET_GET_LOOPER, FN_TEMPO_TAP, FN_TUNER_ON_OFF, FN_STATUS_DUMP, FN_SET_GET_TEMPO, FN_MULTIPURPOSE_RESPONSE, FN_PARAMETER_SETGET, QUERY_SENTINEL, packValue16, unpackValue16, buildSetParameter, buildGetParameter, buildSetParameterBypass, isSetGetParameterResponse, parseSetGetParameterResponse, buildSetGridCell, buildSetPresetName, buildStorePreset, buildSwitchPresetPC, buildSetBypass, buildGetBypass, buildSetChannel, buildGetChannel, buildSetScene, buildGetScene, buildQueryPatchName, buildQuerySceneName, buildSetLooper, buildGetLooperState, buildTempoTap, buildSetTuner, buildStatusDump, buildSetTempo, buildGetTempo, isSetGetBypassResponse, isSetGetChannelResponse, isSetGetSceneResponse, isQueryPatchNameResponse, isQuerySceneNameResponse, isSetGetLooperResponse, isStatusDumpResponse, isSetGetTempoResponse, isMultipurposeResponse, parseBypassResponse, parseChannelResponse, parseSceneResponse, parseQueryPatchNameResponse, parseQuerySceneNameResponse, parseLooperStateResponse, parseTempoResponse, parseMultipurposeResponse, describeMultipurposeResultCode, parseStatusDumpResponse, parseStateBroadcast, } from './setParam.js';