@openmixer/omx-contract 1.2.1 → 2.0.0

package/data/kernels/rotary.json

@@ -1,186 +1,198 @@
 {
   "$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"
+  "controls": [
+    {
+      "name": "hornSlowHz",
+      "kind": "travel",
+      "global": "ROTARY_HORN_SLOW_RANGE",
+      "doc": "The horn's chorale (slow) rate, Hz.",
+      "travel": {
+        "min": 0.1,
+        "max": 2,
+        "step": 0.01,
+        "unit": "Hz",
+        "default": 0.8,
+        "defaultFrom": "desk"
+      }
+    },
+    {
+      "name": "hornFastHz",
+      "kind": "travel",
+      "global": "ROTARY_HORN_FAST_RANGE",
+      "doc": "The horn's tremolo (fast) rate, Hz.",
+      "travel": {
+        "min": 3,
+        "max": 10,
+        "step": 0.01,
+        "unit": "Hz",
+        "default": 6.8,
+        "defaultFrom": "desk"
+      }
+    },
+    {
+      "name": "drumSlowHz",
+      "kind": "travel",
+      "global": "ROTARY_DRUM_SLOW_RANGE",
+      "doc": "The drum's chorale (slow) rate, Hz.",
+      "travel": {
+        "min": 0.1,
+        "max": 2,
+        "step": 0.01,
+        "unit": "Hz",
+        "default": 0.7,
+        "defaultFrom": "desk"
+      }
+    },
+    {
+      "name": "drumFastHz",
+      "kind": "travel",
+      "global": "ROTARY_DRUM_FAST_RANGE",
+      "doc": "The drum's tremolo (fast) rate, Hz.",
+      "travel": {
+        "min": 3,
+        "max": 10,
+        "step": 0.01,
+        "unit": "Hz",
+        "default": 5.9,
+        "defaultFrom": "desk"
+      }
+    },
+    {
+      "name": "accel",
+      "kind": "travel",
+      "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"
+      }
+    },
+    {
+      "name": "balance",
+      "kind": "travel",
+      "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"
+      }
+    },
+    {
+      "name": "mix",
+      "kind": "travel",
+      "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"
+      }
+    },
+    {
+      "name": "speed",
+      "kind": "choice",
+      "doc": "The rotary speaker's speed settings, in the order of the integer the kernel reads: the rotors stopped, at their chorale (slow) rate, or at their tremolo (fast) rate.",
+      "ids": [
+        "stop",
+        "slow",
+        "fast"
+      ]
     }
-  },
-  "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"
+  ],
+  "aggregates": {
+    "ROTARY_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",
+        "hornFastHz",
+        "drumSlowHz",
+        "drumFastHz",
+        "accel",
+        "balance",
+        "mix"
+      ]
     }
   },
-  "ROTARY_DRUM_FAST_RANGE": {
-    "kind": "travels",
-    "doc": "The drum's tremolo (fast) rate, Hz.",
-    "travel": {
-      "min": 3,
-      "max": 10,
-      "step": 0.01,
+  "constants": {
+    "ROTARY_CROSSOVER_HZ": {
+      "kind": "scalar",
+      "doc": "The complementary split's low-pass corner, Hz: the Leslie 122's passive crossover.",
       "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"
+      "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
     }
-  },
-  "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/rta.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "../../schema/omx-contract.schema.json",
+  "constants": {
+    "RTA_TARGET_BIN_HZ": {
+      "kind": "scalar",
+      "doc": "The RTA's target bin resolution — generated into `omx_contract_limits.h` as `OMX_RTA_TARGET_BIN_HZ`, which `mix_dsp.h` reads; `rta-window-derivation.test.ts` reads it back from the header.",
+      "unit": "Hz",
+      "value": 5.9
+    },
+    "RTA_FFT_SIZE_MAX": {
+      "kind": "scalar",
+      "doc": "The largest RTA FFT the native ring holds — generated into `omx_contract_limits.h` as `OMX_RTA_FFT_SIZE_MAX`.",
+      "unit": "",
+      "value": 32768
+    }
+  }
+}

package/data/kernels/transient.json

@@ -1,42 +1,63 @@
 {
   "$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": {
+  "controls": [
+    {
+      "name": "attackDb",
+      "kind": "travel",
+      "table": "TRANSIENT_LIMITS",
+      "travel": {
         "min": -24,
         "max": 24,
         "step": 0.1,
         "unit": "dB",
         "default": 0,
         "defaultFrom": "desk"
-      },
-      "sustainDb": {
+      }
+    },
+    {
+      "name": "sustainDb",
+      "kind": "travel",
+      "table": "TRANSIENT_LIMITS",
+      "travel": {
         "min": -24,
         "max": 24,
         "step": 0.1,
         "unit": "dB",
         "default": 0,
         "defaultFrom": "desk"
-      },
-      "attackTimeMs": {
+      }
+    },
+    {
+      "name": "attackTimeMs",
+      "kind": "travel",
+      "table": "TRANSIENT_LIMITS",
+      "travel": {
         "min": 2,
         "max": 50,
         "step": 0.1,
         "unit": "ms",
         "default": 10,
         "defaultFrom": "desk"
-      },
-      "sustainTimeMs": {
+      }
+    },
+    {
+      "name": "sustainTimeMs",
+      "kind": "travel",
+      "table": "TRANSIENT_LIMITS",
+      "travel": {
         "min": 50,
         "max": 2000,
         "step": 1,
         "unit": "ms",
         "default": 250,
         "defaultFrom": "desk"
-      },
-      "outputDb": {
+      }
+    },
+    {
+      "name": "outputDb",
+      "kind": "travel",
+      "table": "TRANSIENT_LIMITS",
+      "travel": {
         "min": -24,
         "max": 12,
         "step": 0.1,
@@ -45,29 +66,36 @@
         "defaultFrom": "desk"
       }
     }
+  ],
+  "tables": {
+    "TRANSIENT_LIMITS": {
+      "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)."
+    }
   },
-  "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
+  "constants": {
+    "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

@@ -1,54 +1,65 @@
 {
   "$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"
+  "controls": [
+    {
+      "name": "rateHz",
+      "kind": "travel",
+      "global": "TREMOLO_RATE_RANGE",
+      "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"
       }
+    },
+    {
+      "name": "depth",
+      "kind": "travel",
+      "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"
+      }
+    },
+    {
+      "name": "mix",
+      "kind": "travel",
+      "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"
+      }
+    },
+    {
+      "name": "mode",
+      "kind": "choice",
+      "doc": "What the tremolo's one oscillator modulates, in the order of the integer the kernel reads: the level of both legs in phase (tremolo), or the balance law's position with the legs in opposition (pan).",
+      "ids": [
+        "tremolo",
+        "pan"
+      ],
+      "default": "tremolo"
+    }
+  ],
+  "aggregates": {
+    "TREMOLO_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",
+        "depth",
+        "mix"
+      ]
     }
   }
 }