@openmixer/omx-contract 0.0.0 → 1.0.0

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/plugins/delay.json

@@ -0,0 +1,48 @@
+{
+  "$schema": "../../schema/omx-contract.schema.json",
+  "DELAY_PLUGIN": {
+    "kind": "plugin",
+    "doc": "The delay plugin's parameters, in append-only order: DPF's parameter index is the CLAP param id and the LV2 port order (omx-plugins-dpf §3b). Moved from openmixer's packages/omx-plugins/tools/params-gen.mjs PLUGINS.delay.",
+    "why": "mix is per instance on the desk (insert or fxReturn); a plugin racked in a foreign host is an INSERT, so it reads the input kind's default (omx-plugins-dpf §3a).",
+    "plugin": "delay",
+    "header": "omx_delay_params.h",
+    "prefix": "OMX_DELAY",
+    "source": "FX_DELAY_TIME_RANGE, FX_DELAY_FEEDBACK_RANGE, DELAY_MIX_RANGE for kind input, DELAY_TONE_RANGE, FX_DELAY_PINGPONG_DEFAULT",
+    "params": [
+      {
+        "symbol": "timeMs",
+        "from": "FX_DELAY_TIME_RANGE",
+        "scale": "linear",
+        "since": "1.0.0"
+      },
+      {
+        "symbol": "feedback",
+        "from": "FX_DELAY_FEEDBACK_RANGE",
+        "scale": "linear",
+        "since": "1.0.0"
+      },
+      {
+        "symbol": "mix",
+        "from": "DELAY_MIX_RANGE",
+        "forKind": "input",
+        "scale": "linear",
+        "since": "1.0.0"
+      },
+      {
+        "symbol": "tone",
+        "from": "DELAY_TONE_RANGE",
+        "scale": "linear",
+        "since": "1.0.0"
+      },
+      {
+        "symbol": "pingpong",
+        "from": "FX_DELAY_PINGPONG_DEFAULT",
+        "flags": [
+          "toggle"
+        ],
+        "scale": "linear",
+        "since": "1.0.0"
+      }
+    ]
+  }
+}

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"
+      }
+    }
+  }
+}

package/data/rates.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "../schema/omx-contract.schema.json",
+  "STANDARD_SAMPLE_RATES": {
+    "kind": "list",
+    "doc": "The standard sample rates (Hz) the desk recognises — the pro-audio superset. One source of truth for the clock controller's `clock.allowed-rates` seed, the force row's validation ceiling and the device-rate probe fallback. What the operator is OFFERED is always the DEVICE's own `supportedRates` (`2026-07-15-clock-rate-honest-force-rate.md`) — this is the ceiling a write is refused by, never a menu.",
+    "unit": "Hz",
+    "values": [
+      44100,
+      48000,
+      88200,
+      96000,
+      176400,
+      192000
+    ]
+  },
+  "RT_HARD_TARGET": {
+    "kind": "sheet",
+    "doc": "THE declaration: 192 kHz at quantum 128.",
+    "value": {
+      "rate": 192000,
+      "quantum": 128
+    }
+  },
+  "DSP_KNOB_REFERENCE_RATE": {
+    "kind": "scalar",
+    "doc": "The rate a unit-range DSP knob is quoted at (R-058): the rate this desk runs (ruling 2026-09-14). A kernel raises the knob to `REF / sr`, so at this rate the exponent is exactly 1 and the response is bit-for-bit the one cut before the law. Emitted to C as `OMX_DSP_KNOB_REFERENCE_RATE`; the reverb damping and FX-delay tone references `#define` from it.",
+    "unit": "Hz",
+    "value": 96000
+  }
+}