fractal-midi 0.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,200 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may accept support,
+      warranty, indemnity, or other liability obligations and/or rights
+      consistent with this License. However, in accepting such obligations,
+      You may act only on Your own behalf and on Your sole responsibility,
+      not on behalf of any other Contributor, and only if You agree to
+      indemnify, defend, and hold each Contributor harmless for any
+      liability incurred by, or claims asserted against, such Contributor
+      by reason of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Stephen Staker
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,28 @@
+fractal-midi
+Copyright 2026 Stephen Staker
+
+This product is licensed under the Apache License, Version 2.0.
+See the LICENSE file for the full license text.
+
+---
+
+TRADEMARKS
+
+This project is an unaffiliated community library. "Fractal Audio",
+"AM4", "Axe-Fx", "Axe-Fx II", "Axe-Fx III", "FM3", "FM9", and
+related product names are trademarks of Fractal Audio Systems, Inc.
+
+This project neither claims endorsement from, nor affiliation with,
+Fractal Audio Systems. It is a software library that builds and
+parses MIDI / SysEx wire bytes for Fractal Audio hardware the
+consuming application's user already owns. Decode work is based on
+publicly-documented protocol information, including Fractal Audio's
+own "MIDI for Third-Party Devices" specifications, plus community
+reverse-engineering of editor binaries (JUCE BinaryData extraction,
+Ghidra symbol mining).
+
+The package name `fractal-midi` uses the "Fractal" trademark
+descriptively (nominative fair use) to identify the hardware family
+this library targets. The library does not embed Fractal Audio
+firmware, factory presets, branding assets, or any other Fractal-
+copyrighted material.

package/README.md

@@ -0,0 +1,147 @@
+# fractal-midi
+
+Pure-TypeScript codec and parameter dictionaries for Fractal Audio
+guitar processors. Build and parse the SysEx wire bytes a Fractal
+device speaks, without pulling in a MIDI transport library.
+
+> **Status — pre-release.** The first published version (`0.1.0`)
+> covers AM4 and Axe-Fx II at hardware-verified parity, plus the
+> Axe-Fx III at codec + calibration ✅ via public-capture
+> verification and JUCE-BinaryData mining (hardware-verification
+> stays community-driven — see the III notes in the coverage table).
+> FM3 / FM9 ship next via mechanical ports of the III pipeline.
+> Don't depend on this package from production code yet — APIs may
+> shift before `0.1.0`.
+
+> **Unaffiliated community library.** "Fractal Audio", "AM4",
+> "Axe-Fx", "Axe-Fx II", "Axe-Fx III", "FM3", and "FM9" are
+> trademarks of Fractal Audio Systems, Inc. This project neither
+> claims endorsement from, nor affiliation with, Fractal Audio
+> Systems. The package name uses the "Fractal" trademark
+> descriptively (nominative fair use) to identify the hardware
+> family this library targets. See [`NOTICE`](./NOTICE) for the
+> full trademark statement.
+
+## What this is
+
+- **JSON-shaped parameter dictionaries** — every block-and-param the
+  device understands, with display unit, value range, and the
+  paramId that goes on the wire. Reverse-engineered against real
+  hardware and Fractal's own published 3rd-party MIDI specs.
+- **Pure-TypeScript codec** — display value in (`gain: 7.5`,
+  `'Plexi 100W High'`), SysEx bytes out (`Uint8Array`). No MIDI
+  library required.
+- **Parsers / validators** — given captured bytes, parse back to
+  display values for round-trip equality testing.
+- **Reference data** — Fractal's amp / cab / drive lineage tables
+  (the "the JC-120 model is based on this real-world amp" data),
+  factory bank metadata, applicability tables.
+
+## What this is not
+
+- **Not a MIDI library.** Routing bytes to and from your hardware
+  is your responsibility. Use `node-midi`, `webmidi`,
+  `easymidi`, JUCE, RtMidi, CoreMIDI, ALSA — whatever fits.
+- **Not a preset editor.** This package gives you the wire-level
+  primitives a preset editor would be built on top of.
+- **Not affiliated with Fractal Audio Systems.** See the trademark
+  notice above and [`NOTICE`](./NOTICE).
+
+## Install
+
+```bash
+npm install fractal-midi
+```
+
+Node >= 18. ESM-only.
+
+## Usage
+
+> The shape below is the target API. Until `0.1.0` ships, the
+> module surface may differ.
+
+```ts
+import { buildSetParam, parseSetParam } from 'fractal-midi/am4/codec';
+import { params, blocks } from 'fractal-midi/am4';
+
+// Build the SysEx bytes for "set amp gain to 7.5"
+const bytes = buildSetParam({ block: 'amp', param: 'gain', value: 7.5 });
+// → Uint8Array starting with 0xF0 ... 0xF7
+
+// Round-trip: parse captured bytes back to display values
+const display = parseSetParam(bytes);
+// → { block: 'amp', param: 'gain', value: 7.5 }
+
+// Inspect the dictionary directly
+console.log(params.amp.gain);
+// → { unit: 'knob-0-10', range: [0, 10], pidHigh: ..., pidLow: ..., ... }
+```
+
+The Axe-Fx II and Axe-Fx III sub-paths follow the same shape:
+
+```ts
+import { buildSetParam } from 'fractal-midi/axe-fx-ii/codec';
+import { params } from 'fractal-midi/axe-fx-iii';
+```
+
+## Per-device coverage
+
+| Device | Catalog | Codec | Calibration | Hardware-verified |
+|---|---|---|---|---|
+| AM4 | ✅ | ✅ | ✅ | ✅ |
+| Axe-Fx II | ✅ | ✅ | ✅ | ✅ |
+| Axe-Fx III | ✅ (2216 params) | ✅ ([see note](#axe-fx-iii-codec-note)) | ✅ ([see note](#axe-fx-iii-calibration-note)) | 🟡 community beta ([see note](#axe-fx-iii-hardware-note)) |
+| FM3 | ❌ | ❌ | ❌ | ❌ |
+| FM9 | ❌ | ❌ | ❌ | ❌ |
+
+### Coverage notes
+
+#### Axe-Fx III codec note
+
+The III's SET_PARAMETER wire envelope (fn=0x01, sub-action `09 00`,
+23-byte frame) is byte-verified against 10 public community captures
+spanning two effect blocks and two sub-action codes — see the
+`axe-fx-iii/setparam` test goldens (302 cases: 36 envelope vectors +
+264 round-trip `build → parse → equality` cases + 2
+`parseStateBroadcast` assertions). The GET-response shape is
+hypothesis-only (no public capture exists); the parser handles both
+the `09 00` / `52 00` set-echo shape and the async `04 01`
+STATE_BROADCAST shape via `parseSetGetParameterResponse` /
+`parseStateBroadcast`.
+
+#### Axe-Fx III calibration note
+
+III calibration = 100% of catalog entries carry a non-`'unverified'`
+unit tag (16 string-typed `_NAME` / `_LABEL` / `_MSG` entries are
+exempted by the calibration gate — they have no `'string'` unit in
+the `Param` type). Enum vocabularies are resolved at runtime via
+`resolveEnumValues(name)` from `enumOverlay.ts`, which carries a
+`provenance` field on every entry — `'am4-shared'` (AM4-verified,
+shared with III), `'fractal-convention'` (universal Fractal-family
+convention like OFF/ON / channel pickers), or `'iii-spec'` (hand-
+curated for III-only params). Coverage of enum vocabularies and
+numeric display ranges is partial — `resolveEnumValues` returns
+`undefined` for params not yet mapped, and many XML-derived numeric
+entries carry a unit tag but no `displayMin` / `displayMax`. Treat
+the catalog as the wire-level truth; treat the calibration overlay
+as display guidance the user can correct via GitHub issue.
+
+#### Axe-Fx III hardware note
+
+The 🟡 hardware-verified status means the maintainer does not own an
+Axe-Fx III for round-trip confirmation. Community users running the
+device are invited to file GitHub issues against any wire or label
+that disagrees with their hardware.
+
+#### FM3 / FM9
+
+FM3 and FM9 share the III protocol family (model bytes `0x11` /
+`0x12` vs III's `0x10`, identical envelope per Fractal's v1.4 MIDI
+spec). Catalog + codec + calibration for those devices are planned as
+mechanical ports of the III pipeline once the FM3-Edit / FM9-Edit
+JUCE binaries are mined for parameterName + dispatcher tables.
+
+## License
+
+[Apache License 2.0](./LICENSE). See [`NOTICE`](./NOTICE) for the
+trademark statement.

package/dist/am4/applicability.d.ts

@@ -0,0 +1,61 @@
+import { type Applicability, type ApplicabilityGate } from './typeApplicability.js';
+export declare function getApplicability(blockDotName: string): Applicability | undefined;
+/**
+ * One-line summary of a parameter's applicability for the agent — appears
+ * in `list_params` row decoration. Returns `undefined` for the common
+ * "no applicability data" case (out-of-band registers, params not yet
+ * decoded by the type-applicability extractor) — caller should treat as
+ * always-on. Empty string for confirmed-always-on with no special-case
+ * gates (no decoration needed).
+ */
+export declare function describeApplicability(blockDotName: string): string | undefined;
+/** State the agent passes when checking applicability — current active type per block. */
+export interface ActiveTypeContext {
+    /** Block name (e.g. `amp`, `delay`) → wire enum index of its currently active type. */
+    readonly currentTypes?: Readonly<Record<string, number>>;
+}
+/**
+ * Predicate: is this parameter applicable on the active type?
+ *
+ * Returns:
+ *   - { applicable: true } when always-on, OR when at least one gate
+ *     matches the current type.
+ *   - { applicable: false, reason } when the parameter is strictly
+ *     type-gated and none of its gates match.
+ *   - { applicable: 'unknown' } when we don't have applicability data
+ *     for this key (caller should treat as applicable).
+ */
+export type ApplicabilityCheck = {
+    applicable: true;
+} | {
+    applicable: false;
+    gates: readonly ApplicabilityGate[];
+} | {
+    applicable: 'unknown';
+};
+export declare function checkApplicability(blockDotName: string, ctx: ActiveTypeContext): ApplicabilityCheck;
+/**
+ * find_compatible_types: which `block.type` enum values expose every
+ * param in `paramNames`? Used by the unified-surface MCP tool of the
+ * same name so the agent can pick a type compatible with the knobs
+ * it plans to write, BEFORE apply_preset → no "dropped X param"
+ * warning round-trip.
+ *
+ * Algorithm: start with the full type enum, intersect down per param.
+ * Params with no applicability data, or only sub-mode gates (e.g.
+ * CABINET_MODE), can't narrow on the primary-type axis — skipped.
+ * Params with primary-type gates narrow the accepted-types set to the
+ * gate value list.
+ *
+ * Returns `applicability_known: false` when NONE of the listed params
+ * have primary-type gates — caller knows the result is the unfiltered
+ * full list and should treat it as "try and see" rather than "these
+ * are the only valid choices."
+ */
+export declare function findCompatibleTypes(block: string, paramNames: readonly string[]): {
+    compatible_types: readonly string[];
+    total_types: number;
+    applicability_known: boolean;
+    note?: string;
+};
+//# sourceMappingURL=applicability.d.ts.map

package/dist/am4/applicability.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"applicability.d.ts","sourceRoot":"","sources":["../../src/am4/applicability.ts"],"names":[],"mappings":"AAwBA,OAAO,EAEL,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACvB,MAAM,wBAAwB,CAAC;AA6BhC,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAEhF;AAWD;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAe9E;AAED,0FAA0F;AAC1F,MAAM,WAAW,iBAAiB;IAChC,uFAAuF;IACvF,QAAQ,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAC1D;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,kBAAkB,GAC1B;IAAE,UAAU,EAAE,IAAI,CAAA;CAAE,GACpB;IAAE,UAAU,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,SAAS,iBAAiB,EAAE,CAAA;CAAE,GAC1D;IAAE,UAAU,EAAE,SAAS,CAAA;CAAE,CAAC;AAE9B,wBAAgB,kBAAkB,CAChC,YAAY,EAAE,MAAM,EACpB,GAAG,EAAE,iBAAiB,GACrB,kBAAkB,CA2CpB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,SAAS,MAAM,EAAE,GAC5B;IACD,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAkEA"}