@openmixer/omx-contract 1.0.0 → 1.2.0

package/data/kernels/reverb.json

@@ -11,5 +11,140 @@
       "default": 100,
       "defaultFrom": "desk"
     }
+  },
+  "REVERB_MIX_RANGE": {
+    "kind": "travels",
+    "doc": "The REVERB's wet/dry. An insert keeps the dry signal (0.3); an `fxReturn` is wet-only (1), so the return carries only the effect. Both numbers live HERE and nowhere else: the row's `mix` limit, `ReverbController`'s seed and its fresh state read them through limitForKind.",
+    "travel": {
+      "min": 0,
+      "max": 1,
+      "step": 0,
+      "unit": "",
+      "default": 0.3,
+      "defaultFrom": "desk",
+      "byKind": {
+        "fxReturn": 1
+      }
+    }
+  },
+  "REVERB_SIZE_RANGE": {
+    "kind": "travels",
+    "doc": "The reverb's SIZE/DAMPING/WIDTH — each a NORMALIZED_RANGE instance with its own come-up value, matching `DEFAULT_REVERB_STATE`. Three separate constants rather than one shared default on `NORMALIZED_RANGE`: that range is the bare 0..1 REPRESENTATION, reused by fields across the whole console whose come-up values disagree (a fader position is not a reverb's damping), so a default belongs on the NAMED field, never on the shape it borrows.",
+    "travel": {
+      "min": 0,
+      "max": 1,
+      "step": 0,
+      "unit": "",
+      "default": 0.7,
+      "defaultFrom": "desk"
+    }
+  },
+  "REVERB_DAMPING_RANGE": {
+    "kind": "travels",
+    "doc": "The reverb's DAMPING — a NORMALIZED_RANGE instance with its own come-up value, matching `DEFAULT_REVERB_STATE`. Declared with SIZE and WIDTH (see REVERB_SIZE_RANGE for why each is a named constant rather than a default on the shared 0..1 shape).",
+    "travel": {
+      "min": 0,
+      "max": 1,
+      "step": 0,
+      "unit": "",
+      "default": 0.5,
+      "defaultFrom": "desk"
+    }
+  },
+  "REVERB_WIDTH_RANGE": {
+    "kind": "travels",
+    "doc": "The reverb's stereo WIDTH — a NORMALIZED_RANGE instance with its own come-up value, matching `DEFAULT_REVERB_STATE`. Declared with SIZE and DAMPING (see REVERB_SIZE_RANGE for why each is a named constant rather than a default on the shared 0..1 shape).",
+    "travel": {
+      "min": 0,
+      "max": 1,
+      "step": 0,
+      "unit": "",
+      "default": 1,
+      "defaultFrom": "desk"
+    }
+  },
+  "REVERB_PREDELAY_RANGE": {
+    "kind": "travels",
+    "doc": "The reverb's PRE-DELAY travel — the gap before the first reflection, in milliseconds. Declared here so the unit crosses with the bounds: a `finiteNumber(0, 100)` codec publishes `unit: ''`, and a surface binding that draws a millisecond control it cannot label. The panel knowing better than the wire is the wrong way round.",
+    "travel": {
+      "min": 0,
+      "max": 100,
+      "step": 1,
+      "unit": "ms",
+      "default": 0,
+      "defaultFrom": "desk"
+    }
+  },
+  "REVERB_LOWCUT_RANGE": {
+    "kind": "travels",
+    "doc": "The reverb's LOW cut, as an instance of REVERB_CUT_RANGE — same bounds, its own come-up value. `0` reads as \"none\" (`mix_reverb.h`), which is also `DEFAULT_REVERB_STATE`'s seed, so a fresh reverb's low cut and its declared default are the same fact stated once. Split from REVERB_CUT_RANGE rather than adding `default` there: the low and high cut share ONE travel (the C imposes one constraint on both) but do NOT share one come-up value, and a `default` on the shared range could only be honest for one of the two fields that read it.",
+    "travel": {
+      "min": 0,
+      "max": 20000,
+      "step": 10,
+      "unit": "Hz",
+      "default": 0,
+      "defaultFrom": "desk"
+    }
+  },
+  "REVERB_HIGHCUT_RANGE": {
+    "kind": "travels",
+    "doc": "The reverb's HIGH cut, as an instance of REVERB_CUT_RANGE — same bounds, its own come-up value. The top of the travel reads as \"open\" (`mix_reverb.h`), matching `DEFAULT_REVERB_STATE`'s seed.",
+    "travel": {
+      "min": 0,
+      "max": 20000,
+      "step": 10,
+      "unit": "Hz",
+      "default": 20000,
+      "defaultFrom": "desk"
+    }
+  },
+  "REVERB_REVERSE_RANGE": {
+    "kind": "travels",
+    "doc": "REVERSE's MIRROR WINDOW — how long a slice of the wet is played backward, in milliseconds (`2026-07-15-native-delay-reverb.md`, Amendment 2026-09-17 §B). A DECLARED travel and never derived from `size`'s RT60: an RT60 of seconds cannot be buffered at 192 kHz, and a window silently clamped to fit is the silent-clamp defect. The ceiling is what `mix_reverb.h`'s pool budgets a ring for (`OMX_REVERB_REVERSE_MAX_MS`), so the console offers exactly the travel the kernel accepts — nothing wider, nothing narrower.",
+    "travel": {
+      "min": 50,
+      "max": 500,
+      "step": 10,
+      "unit": "ms",
+      "default": 300,
+      "defaultFrom": "desk"
+    }
+  },
+  "REVERB_HOLD_RANGE": {
+    "kind": "travels",
+    "doc": "GATED's HOLD — how long the wet stays at full level after the key falls away, in milliseconds. The Phil-Collins tail is cut where the operator puts the cut, so this is the control that decides the effect's length; `size` still decides what is being cut off.",
+    "travel": {
+      "min": 10,
+      "max": 2000,
+      "step": 10,
+      "unit": "ms",
+      "default": 120,
+      "defaultFrom": "desk"
+    }
+  },
+  "REVERB_RELEASE_RANGE": {
+    "kind": "travels",
+    "doc": "GATED's RELEASE — how long the held wet takes to reach zero, in milliseconds. A straight line down, short by design: a long release is a reverb tail again, which is the thing a gated reverb exists to remove.",
+    "travel": {
+      "min": 1,
+      "max": 500,
+      "step": 1,
+      "unit": "ms",
+      "default": 20,
+      "defaultFrom": "desk"
+    }
+  },
+  "REVERB_GATE_THRESHOLD_RANGE": {
+    "kind": "travels",
+    "doc": "GATED's ARM THRESHOLD — the level the reverb's own mono feed must reach to arm the hold, in dBFS. Declared, because the alternative is a hidden onset detector: the kernel compares `|input|` against exactly this number and nothing else.",
+    "travel": {
+      "min": -80,
+      "max": 0,
+      "step": 1,
+      "unit": "dBFS",
+      "default": -40,
+      "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/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

@@ -43,5 +43,79 @@
         "ref": "FDELAY_MOD_READ_ORDER"
       }
     }
+  },
+  "GATE_CONTINUOUS_TRAVELS": {
+    "kind": "travels",
+    "doc": "The gate's threshold, range, release and ratio as a plugin host draws them: GATE_LIMITS' bounds, units and defaults with no step. The console's row quantises these four to whole steps (1 dB, 10 ms, 1:1), and a travel whose step is 1 or more reads as an integer control; the omx-strip plugin has always offered them continuous, so it reads this table instead. Every number but the step is GATE_LIMITS', held equal by test/continuous-travels.test.mjs. Not rendered to C: no C reader needs a second spelling of the gate's bounds.",
+    "fields": {
+      "thresholdDb": {
+        "min": -80,
+        "max": 0,
+        "step": 0,
+        "unit": "dB",
+        "default": -40,
+        "defaultFrom": "desk"
+      },
+      "rangeDb": {
+        "min": -90,
+        "max": 0,
+        "step": 0,
+        "unit": "dB",
+        "default": -90,
+        "defaultFrom": "desk"
+      },
+      "releaseMs": {
+        "min": 0,
+        "max": 5000,
+        "step": 0,
+        "unit": "ms",
+        "default": 100,
+        "defaultFrom": "desk"
+      },
+      "ratio": {
+        "min": 1,
+        "max": 100,
+        "step": 0,
+        "unit": "",
+        "default": 16,
+        "defaultFrom": "desk"
+      }
+    }
+  },
+  "COMP_CONTINUOUS_TRAVELS": {
+    "kind": "travels",
+    "doc": "The compressor's threshold and release as a plugin host draws them: COMP_LIMITS' bounds, units and defaults with no step. The console's row quantises them to whole steps (1 dB, 10 ms), and a travel whose step is 1 or more reads as an integer control; the omx-strip plugin has always offered them continuous, so it reads this table instead. Every number but the step is COMP_LIMITS', held equal by test/continuous-travels.test.mjs. Not rendered to C: no C reader needs a second spelling of the compressor's bounds.",
+    "fields": {
+      "thresholdDb": {
+        "min": -60,
+        "max": 0,
+        "step": 0,
+        "unit": "dB",
+        "default": -18,
+        "defaultFrom": "desk"
+      },
+      "releaseMs": {
+        "min": 5,
+        "max": 3000,
+        "step": 0,
+        "unit": "ms",
+        "default": 200,
+        "defaultFrom": "desk"
+      }
+    }
+  },
+  "TRIM_TRAVELS": {
+    "kind": "travels",
+    "doc": "The digital input trim as a travel: openmixer's TRIM_RANGE (packages/declarations, -24..+24 dB in 0.1 dB steps, spelled minDb/maxDb/stepDb there and OMX_TRIM_RANGE_*_DB in omx-dsp's header), coming up at 0 dB, the trim a channel has when none is set. The omx-strip plugin's trim reads it. A table with the one field `trimDb`, the name the trim row and the plugin store; not rendered to C, which already spells TRIM_RANGE its own way.",
+    "fields": {
+      "trimDb": {
+        "min": -24,
+        "max": 24,
+        "step": 0.1,
+        "unit": "dB",
+        "default": 0,
+        "defaultFrom": "desk"
+      }
+    }
   }
 }