@openmixer/omx-contract 0.0.0 → 1.1.0

package/data/kernels/gate.json

@@ -0,0 +1,81 @@
+{
+  "$schema": "../../schema/omx-contract.schema.json",
+  "GATE_LIMITS": {
+    "kind": "travels",
+    "doc": "The legal range of each gate field (engineering units). The widget clamps drags to these, `normalizeGate` enforces them, the row's codec refuses by them and the travel sheet publishes them — one source of truth. `rangeDb` reaches GATE_RANGE_FLOOR_DB, shown as \"−∞\" in readouts (a gate fully closed is silence).",
+    "fields": {
+      "thresholdDb": {
+        "min": -80,
+        "max": 0,
+        "step": 1,
+        "unit": "dB",
+        "default": -40,
+        "defaultFrom": "desk"
+      },
+      "rangeDb": {
+        "min": -90,
+        "max": 0,
+        "step": 1,
+        "unit": "dB",
+        "default": -90,
+        "defaultFrom": "desk"
+      },
+      "kneeStartDb": {
+        "min": -80,
+        "max": 0,
+        "step": 1,
+        "unit": "dB",
+        "default": -43,
+        "defaultFrom": "desk"
+      },
+      "kneeEndDb": {
+        "min": -80,
+        "max": 0,
+        "step": 1,
+        "unit": "dB",
+        "default": -37,
+        "defaultFrom": "desk"
+      },
+      "attackMs": {
+        "min": 0,
+        "max": 500,
+        "step": 0.5,
+        "unit": "ms",
+        "default": 1,
+        "defaultFrom": "desk"
+      },
+      "holdMs": {
+        "min": 0,
+        "max": 2000,
+        "step": 5,
+        "unit": "ms",
+        "default": 10,
+        "defaultFrom": "desk"
+      },
+      "releaseMs": {
+        "min": 0,
+        "max": 5000,
+        "step": 10,
+        "unit": "ms",
+        "default": 100,
+        "defaultFrom": "desk"
+      },
+      "hysteresisDb": {
+        "min": 0,
+        "max": 24,
+        "step": 0.5,
+        "unit": "dB",
+        "default": 3,
+        "defaultFrom": "desk"
+      },
+      "ratio": {
+        "min": 1,
+        "max": 100,
+        "step": 1,
+        "unit": "",
+        "default": 16,
+        "defaultFrom": "desk"
+      }
+    }
+  }
+}

package/data/kernels/geq.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "../../schema/omx-contract.schema.json",
+  "GEQ_BAND_RANGE": {
+    "kind": "travels",
+    "doc": "One graphic-EQ fader's travel: EQ_GAIN_RANGE by reference (a graphic fader is an EQ gain), with the come-up value it needs as a row field — flat, 0 dB (graphic-eq-31 spec §3).",
+    "travel": {
+      "min": -15,
+      "max": 15,
+      "step": 0.5,
+      "unit": "dB",
+      "default": 0,
+      "defaultFrom": "desk"
+    }
+  },
+  "GEQ_BAND_Q": {
+    "kind": "scalar",
+    "doc": "The graphic EQ's band Q: the ISO third-octave bandwidth, `2^(1/6)/(2^(1/3) − 1) ≈ 4.318`, to one decimal as the M32 GEQ carries it. Read by the `geq31` preset and the graphic EQ's section design (graphic-eq-31 spec §3).",
+    "unit": "",
+    "value": 4.3
+  },
+  "GEQ_PROTO_DB": {
+    "kind": "scalar",
+    "doc": "The prototype gain the `true` solve's first interaction matrix is evaluated at (spec §2, §3): the middle of the travel's magnitude, where a matched-Z section's dB response per dB of gain is closest to its average.",
+    "unit": "dB",
+    "value": 12
+  },
+  "GEQ_DESIGN_GAIN_MAX_DB": {
+    "kind": "scalar",
+    "doc": "The ceiling on a section gain the `true` solve may ask for (spec §3): above the travel's worst case (26.0 dB, the alternating ±15 set) with margin. A solve past it clamps and the row says so (`designClamped`), never silently.",
+    "unit": "dB",
+    "value": 30
+  }
+}

package/data/kernels/limiter.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "../../schema/omx-contract.schema.json",
+  "LIMITER_LIMITS": {
+    "kind": "travels",
+    "doc": "The precision limiter's travels (`2026-09-27-precision-limiter.md` §2), rendered into `omx_contract_limits.h` as `OMX_LIMITER_*` by `harness/contract-limits-gen.mjs`, so `mix_limiter.h` reads them and never restates one (R-094). The ceiling is a TRUE peak in dBFS (the ×4 detector); the look-ahead sets the declared latency; the release is the envelope's time constant on the gain depth.",
+    "fields": {
+      "ceilingDb": {
+        "min": -12,
+        "max": 0,
+        "step": 0.1,
+        "unit": "dBFS",
+        "default": -1,
+        "defaultFrom": "desk"
+      },
+      "lookaheadMs": {
+        "min": 0.5,
+        "max": 5,
+        "step": 0.1,
+        "unit": "ms",
+        "default": 1.5,
+        "defaultFrom": "desk"
+      },
+      "releaseMs": {
+        "min": 1,
+        "max": 1000,
+        "step": 1,
+        "unit": "ms",
+        "default": 50,
+        "defaultFrom": "desk"
+      }
+    }
+  }
+}

package/data/kernels/phaser.json

@@ -0,0 +1,109 @@
+{
+  "$schema": "../../schema/omx-contract.schema.json",
+  "PHASER_RATE_RANGE": {
+    "kind": "travels",
+    "doc": "The phaser's sweep speed (§3). `omx_lfo_inc` freezes at Nyquist; this travel stays far below.",
+    "travel": {
+      "min": 0.05,
+      "max": 5,
+      "step": 0.01,
+      "unit": "Hz",
+      "default": 0.5,
+      "defaultFrom": "desk"
+    }
+  },
+  "PHASER_BASE_RANGE": {
+    "kind": "travels",
+    "doc": "The phaser's lowest centre frequency; the sweep runs upward from it (§3).",
+    "travel": {
+      "min": 50,
+      "max": 2000,
+      "step": 1,
+      "unit": "Hz",
+      "default": 200,
+      "defaultFrom": "desk"
+    }
+  },
+  "PHASER_DEPTH_RANGE": {
+    "kind": "travels",
+    "doc": "The sweep's span above `base`, in octaves; 0 is a static phaser at `base` (§3).",
+    "travel": {
+      "min": 0,
+      "max": 6,
+      "step": 0.1,
+      "unit": "oct",
+      "default": 4,
+      "defaultFrom": "desk"
+    }
+  },
+  "PHASER_STAGES_RANGE": {
+    "kind": "travels",
+    "doc": "The phaser's section count per leg — EVEN, 2 … 12 (§2: two sections per notch). Its ends are the kernel's state capacity (`OMX_PHASER_MAX_STAGES` reads `OMX_PHASER_STAGES_RANGE_MAX`); the row moves it through the closed member set PHASER_STAGE_COUNTS, which is derived from it.",
+    "travel": {
+      "min": 2,
+      "max": 12,
+      "step": 2,
+      "unit": "",
+      "default": 6,
+      "defaultFrom": "desk"
+    }
+  },
+  "PHASER_STAGE_COUNTS": {
+    "kind": "list",
+    "doc": "The member set the `stages` field accepts: PHASER_STAGES_RANGE walked by its step.",
+    "unit": "",
+    "values": [
+      2,
+      4,
+      6,
+      8,
+      10,
+      12
+    ]
+  },
+  "PHASER_FEEDBACK_RANGE": {
+    "kind": "travels",
+    "doc": "The phaser's SIGNED resonance (§3). ±0.9, tighter than the flanger's ±0.95: the loop runs through a time-varying chain. Declared here (the refusal half); the kernel's clamp is the enforcement half.",
+    "travel": {
+      "min": -0.9,
+      "max": 0.9,
+      "step": 0.01,
+      "unit": "",
+      "default": 0.4,
+      "defaultFrom": "desk"
+    }
+  },
+  "PHASER_MIX_RANGE": {
+    "kind": "travels",
+    "doc": "The phaser's wet/dry, as an instance of DRIVE_MIX_RANGE: 50 %, where the notch is complete (§3).",
+    "travel": {
+      "min": 0,
+      "max": 100,
+      "step": 0.1,
+      "unit": "%",
+      "default": 50,
+      "defaultFrom": "desk"
+    }
+  },
+  "PHASER_TRAVELS": {
+    "kind": "travels",
+    "doc": "The phaser's continuous travels by row field — the ONE map its control bounds and its row travels both read (§3). `stages` is not here: it moves through PHASER_STAGE_COUNTS.",
+    "fields": {
+      "rateHz": {
+        "ref": "PHASER_RATE_RANGE"
+      },
+      "baseHz": {
+        "ref": "PHASER_BASE_RANGE"
+      },
+      "depthOct": {
+        "ref": "PHASER_DEPTH_RANGE"
+      },
+      "feedback": {
+        "ref": "PHASER_FEEDBACK_RANGE"
+      },
+      "mix": {
+        "ref": "PHASER_MIX_RANGE"
+      }
+    }
+  }
+}

package/data/kernels/pitch.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "../../schema/omx-contract.schema.json",
+  "PITCH_LIMITS": {
+    "kind": "travels",
+    "doc": "PITCH_LIMITS, moved from openmixer.",
+    "fields": {
+      "semitones": {
+        "min": -12,
+        "max": 12,
+        "default": 0
+      },
+      "cents": {
+        "min": -50,
+        "max": 50,
+        "default": 0
+      },
+      "mix": {
+        "min": 0,
+        "max": 100,
+        "default": 100
+      }
+    }
+  },
+  "PITCH_KERNEL": {
+    "kind": "sheet",
+    "doc": "PITCH_KERNEL, moved from openmixer.",
+    "value": {
+      "windowMs": 40,
+      "prefilterCeilingHz": 20000,
+      "prefilterQ": {
+        "ref": "BUTTERWORTH_Q"
+      }
+    }
+  }
+}

package/data/kernels/reverb.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "../../schema/omx-contract.schema.json",
+  "REVERB_PLATE_MOD_DEPTH_RANGE": {
+    "kind": "travels",
+    "doc": "PLATE's tank MODULATION DEPTH, in percent of Dattorro's own excursion (±8 samples at his 29 761 Hz tuning rate, scaled to the live rate the way the tank lengths are). 100 is the depth the plate has always run at, so the come-up is bit-identical to the plate before the field; 0 brings back the unmodulated tank's ring; 400 is the wide, chorused EMT-style swing. The rate stays 1 Hz. Only PLATE reads it (`2026-09-26-native-fx-catalogue.md` §2, Reverb).",
+    "travel": {
+      "min": 0,
+      "max": 400,
+      "step": 1,
+      "unit": "%",
+      "default": 100,
+      "defaultFrom": "desk"
+    }
+  }
+}

package/data/kernels/rotary.json

@@ -0,0 +1,186 @@
+{
+  "$schema": "../../schema/omx-contract.schema.json",
+  "ROTARY_HORN_SLOW_RANGE": {
+    "kind": "travels",
+    "doc": "The horn's chorale (slow) rate, Hz.",
+    "travel": {
+      "min": 0.1,
+      "max": 2,
+      "step": 0.01,
+      "unit": "Hz",
+      "default": 0.8,
+      "defaultFrom": "desk"
+    }
+  },
+  "ROTARY_HORN_FAST_RANGE": {
+    "kind": "travels",
+    "doc": "The horn's tremolo (fast) rate, Hz.",
+    "travel": {
+      "min": 3,
+      "max": 10,
+      "step": 0.01,
+      "unit": "Hz",
+      "default": 6.8,
+      "defaultFrom": "desk"
+    }
+  },
+  "ROTARY_DRUM_SLOW_RANGE": {
+    "kind": "travels",
+    "doc": "The drum's chorale (slow) rate, Hz.",
+    "travel": {
+      "min": 0.1,
+      "max": 2,
+      "step": 0.01,
+      "unit": "Hz",
+      "default": 0.7,
+      "defaultFrom": "desk"
+    }
+  },
+  "ROTARY_DRUM_FAST_RANGE": {
+    "kind": "travels",
+    "doc": "The drum's tremolo (fast) rate, Hz.",
+    "travel": {
+      "min": 3,
+      "max": 10,
+      "step": 0.01,
+      "unit": "Hz",
+      "default": 5.9,
+      "defaultFrom": "desk"
+    }
+  },
+  "ROTARY_ACCEL_RANGE": {
+    "kind": "travels",
+    "doc": "The scale on every speed-change time constant (`ROTARY_*_ACCEL_MS`/`_DECEL_MS`): 2 is twice as slow.",
+    "travel": {
+      "min": 0.25,
+      "max": 4,
+      "step": 0.01,
+      "unit": "x",
+      "default": 1,
+      "defaultFrom": "desk"
+    }
+  },
+  "ROTARY_BALANCE_RANGE": {
+    "kind": "travels",
+    "doc": "The drum/horn balance, percent: −100 drum only, +100 horn only; the law attenuates, never boosts.",
+    "travel": {
+      "min": -100,
+      "max": 100,
+      "step": 1,
+      "unit": "%",
+      "default": 0,
+      "defaultFrom": "desk"
+    }
+  },
+  "ROTARY_MIX_RANGE": {
+    "kind": "travels",
+    "doc": "The rotary's wet/dry, as an instance of DRIVE_MIX_RANGE: 100 %, because a rotary on an insert IS the sound (it replaces the cabinet) and an `fxReturn` wants it wet too (§3).",
+    "travel": {
+      "min": 0,
+      "max": 100,
+      "step": 0.1,
+      "unit": "%",
+      "default": 100,
+      "defaultFrom": "desk"
+    }
+  },
+  "ROTARY_TRAVELS": {
+    "kind": "travels",
+    "doc": "The rotary's numeric travels, field → declaration: the ONE map the row's state, its bounds, its OPTIONS and its controller read (`speed` is a member set, ROTARY_SPEEDS, beside it).",
+    "fields": {
+      "hornSlowHz": {
+        "ref": "ROTARY_HORN_SLOW_RANGE"
+      },
+      "hornFastHz": {
+        "ref": "ROTARY_HORN_FAST_RANGE"
+      },
+      "drumSlowHz": {
+        "ref": "ROTARY_DRUM_SLOW_RANGE"
+      },
+      "drumFastHz": {
+        "ref": "ROTARY_DRUM_FAST_RANGE"
+      },
+      "accel": {
+        "ref": "ROTARY_ACCEL_RANGE"
+      },
+      "balance": {
+        "ref": "ROTARY_BALANCE_RANGE"
+      },
+      "mix": {
+        "ref": "ROTARY_MIX_RANGE"
+      }
+    }
+  },
+  "ROTARY_CROSSOVER_HZ": {
+    "kind": "scalar",
+    "doc": "The complementary split's low-pass corner, Hz: the Leslie 122's passive crossover.",
+    "unit": "Hz",
+    "value": 800
+  },
+  "ROTARY_BASE_MS": {
+    "kind": "scalar",
+    "doc": "The shortest Doppler read, ms — above the order-3 read's one-sample reach at every rate.",
+    "unit": "ms",
+    "value": 0.1
+  },
+  "ROTARY_HORN_DOPPLER_MS": {
+    "kind": "scalar",
+    "doc": "The horn's Doppler excursion `D_horn`, ms: a 0.15 m radius over 343 m/s.",
+    "unit": "ms",
+    "value": 0.44
+  },
+  "ROTARY_DRUM_DOPPLER_MS": {
+    "kind": "scalar",
+    "doc": "The drum's Doppler excursion `D_drum`, ms: its baffle turns over a fixed woofer.",
+    "unit": "ms",
+    "value": 0.29
+  },
+  "ROTARY_HORN_AM": {
+    "kind": "scalar",
+    "doc": "The horn's amplitude swing `m_horn` (a −6 dB directivity dip), a ratio.",
+    "unit": "",
+    "value": 0.5
+  },
+  "ROTARY_DRUM_AM": {
+    "kind": "scalar",
+    "doc": "The drum baffle's amplitude swing `m_drum`, a ratio.",
+    "unit": "",
+    "value": 0.3
+  },
+  "ROTARY_HORN_ACCEL_MS": {
+    "kind": "scalar",
+    "doc": "The horn rotor's speed-up time constant, ms (at `accel` 1).",
+    "unit": "ms",
+    "value": 330
+  },
+  "ROTARY_HORN_DECEL_MS": {
+    "kind": "scalar",
+    "doc": "The horn rotor's slow-down time constant, ms (at `accel` 1).",
+    "unit": "ms",
+    "value": 500
+  },
+  "ROTARY_DRUM_ACCEL_MS": {
+    "kind": "scalar",
+    "doc": "The drum rotor's speed-up time constant, ms (at `accel` 1).",
+    "unit": "ms",
+    "value": 1700
+  },
+  "ROTARY_DRUM_DECEL_MS": {
+    "kind": "scalar",
+    "doc": "The drum rotor's slow-down time constant, ms (at `accel` 1).",
+    "unit": "ms",
+    "value": 1800
+  },
+  "ROTARY_STOP_EPS": {
+    "kind": "scalar",
+    "doc": "Below this rate, Hz, a rotor coasting toward `stop` is snapped to exactly 0.",
+    "unit": "",
+    "value": 0.0001
+  },
+  "ROTARY_RING_FLOATS": {
+    "kind": "scalar",
+    "doc": "One inline ring per rotor per leg, floats — at least the 192 kHz need of the horn's sweep.",
+    "unit": "",
+    "value": 256
+  }
+}

package/data/kernels/transient.json

@@ -0,0 +1,73 @@
+{
+  "$schema": "../../schema/omx-contract.schema.json",
+  "TRANSIENT_LIMITS": {
+    "kind": "travels",
+    "doc": "The legal range of each transient-designer field (engineering units), transient spec §3. Every kind comes up flat: no per-kind default differs. `harness/contract-limits-gen.mjs` emits each as `OMX_TRANSIENT_<FIELD>_{MIN,MAX,DEFAULT}` for `mix_transient.h`'s resolve; the row publishes them on OPTIONS when it lands (issue #921).",
+    "fields": {
+      "attackDb": {
+        "min": -24,
+        "max": 24,
+        "step": 0.1,
+        "unit": "dB",
+        "default": 0,
+        "defaultFrom": "desk"
+      },
+      "sustainDb": {
+        "min": -24,
+        "max": 24,
+        "step": 0.1,
+        "unit": "dB",
+        "default": 0,
+        "defaultFrom": "desk"
+      },
+      "attackTimeMs": {
+        "min": 2,
+        "max": 50,
+        "step": 0.1,
+        "unit": "ms",
+        "default": 10,
+        "defaultFrom": "desk"
+      },
+      "sustainTimeMs": {
+        "min": 50,
+        "max": 2000,
+        "step": 1,
+        "unit": "ms",
+        "default": 250,
+        "defaultFrom": "desk"
+      },
+      "outputDb": {
+        "min": -24,
+        "max": 12,
+        "step": 0.1,
+        "unit": "dB",
+        "default": 0,
+        "defaultFrom": "desk"
+      }
+    }
+  },
+  "TRANSIENT_FAST_ATTACK_MS": {
+    "kind": "scalar",
+    "doc": "The fast follower's attack, ms: exactly the dynamics detector's no-oversampling line (transient spec §3, L7).",
+    "unit": "ms",
+    "value": 0.5
+  },
+  "TRANSIENT_FAST_RELEASE_MS": {
+    "kind": "scalar",
+    "doc": "The fast follower's release, ms: one 50 Hz cycle held, a 180 bpm sixteenth forgotten (transient spec §3).",
+    "unit": "ms",
+    "value": 20
+  },
+  "TRANSIENT_REF_DB": {
+    "kind": "scalar",
+    "doc": "The contrast, dB, at which a knob reaches its full value (transient spec §2, §3).",
+    "unit": "dB",
+    "value": 6
+  },
+  "TRANSIENT_FLOOR_LIN": {
+    "kind": "scalar",
+    "doc": "The detector floor, linear (−100 dBFS): below it both envelopes read the floor and the stage is unity (transient spec §3).",
+    "unit": "",
+    "value": 0.00001
+  }
+}

package/data/kernels/tremolo.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "../../schema/omx-contract.schema.json",
+  "TREMOLO_RATE_RANGE": {
+    "kind": "travels",
+    "doc": "The tremolo's LFO rate (the catalogue row's 0.1..20 Hz); 4 Hz is the classic amp tremolo.",
+    "travel": {
+      "min": 0.1,
+      "max": 20,
+      "step": 0.01,
+      "unit": "Hz",
+      "default": 4,
+      "defaultFrom": "desk"
+    }
+  },
+  "TREMOLO_DEPTH_RANGE": {
+    "kind": "travels",
+    "doc": "The tremolo's modulation depth: the gain's trough is `1 − mix·depth`.",
+    "travel": {
+      "min": 0,
+      "max": 100,
+      "step": 0.1,
+      "unit": "%",
+      "default": 50,
+      "defaultFrom": "desk"
+    }
+  },
+  "TREMOLO_MIX_RANGE": {
+    "kind": "travels",
+    "doc": "The tremolo's wet/dry, as an instance of DRIVE_MIX_RANGE: 100 %. The kernel folds the wet/dry into its one gain, so a strip tremolo IS the sound (as the rotary's mix 100 % is).",
+    "travel": {
+      "min": 0,
+      "max": 100,
+      "step": 0.1,
+      "unit": "%",
+      "default": 100,
+      "defaultFrom": "desk"
+    }
+  },
+  "TREMOLO_TRAVELS": {
+    "kind": "travels",
+    "doc": "The tremolo's numeric travels, field → declaration: the ONE map the row's state, its bounds, its OPTIONS and its controller read (`mode` is a member set, TREMOLO_MODES, beside it).",
+    "fields": {
+      "rateHz": {
+        "ref": "TREMOLO_RATE_RANGE"
+      },
+      "depth": {
+        "ref": "TREMOLO_DEPTH_RANGE"
+      },
+      "mix": {
+        "ref": "TREMOLO_MIX_RANGE"
+      }
+    }
+  }
+}

package/data/primitives.json

@@ -0,0 +1,47 @@
+{
+  "$schema": "../schema/omx-contract.schema.json",
+  "BUTTERWORTH_Q": {
+    "kind": "scalar",
+    "doc": "The Q of a second-order Butterworth section, 1/√2 — maximally flat, the one value every Butterworth biquad in the tree designs at: the LR4 crossover section, the pitch pre-filter and the drive's tilt / band / HF sections, in TS and (as `OMX_BUTTERWORTH_Q`) in C (§7, the scalar door).",
+    "unit": "",
+    "value": {
+      "derive": "sqrt",
+      "of": 0.5
+    }
+  },
+  "ALLPASS_LIMITS": {
+    "kind": "sheet",
+    "doc": "ALLPASS_LIMITS, moved from openmixer.",
+    "value": {
+      "unityTolerance": 0.0001
+    }
+  },
+  "XOVER_LIMITS": {
+    "kind": "sheet",
+    "doc": "XOVER_LIMITS, moved from openmixer.",
+    "value": {
+      "lr2SectionQ": 0.5,
+      "lr4SectionQ": {
+        "ref": "BUTTERWORTH_Q"
+      },
+      "partitionTolerance": 0.00001
+    }
+  },
+  "FDELAY_MOD_READ_ORDER": {
+    "kind": "scalar",
+    "doc": "The order the chorus and flanger construct their lines with (four taps; the fdelay spec §1).",
+    "unit": "",
+    "value": 3
+  },
+  "FDELAY_READ_L1_NORM": {
+    "kind": "scalar",
+    "doc": "`Λ` for the chorus/flanger read — ONE value; the header and every law read this.",
+    "unit": "",
+    "value": {
+      "derive": "lagrangeReadL1",
+      "order": {
+        "ref": "FDELAY_MOD_READ_ORDER"
+      }
+    }
+  }
+}