@openmixer/omx-contract 2.5.0 → 2.7.0

package/README.md

@@ -49,7 +49,7 @@ pkg-config --cflags omx-contract
 ```
 
 Pin one version and build against its renders instead of keeping a copy: the installed package at exactly
-that version (`pkg-config --exact-version=2.5.0 omx-contract`), else the npm tarball, unpacked, and
+that version (`pkg-config --exact-version=2.7.0 omx-contract`), else the npm tarball, unpacked, and
 `omx-contract render --target c --out build/omx-contract/include`. A kernel's controls and readouts, in their
 order, are in `share/omx-contract/omx-contract.json`; how a declaration is written is in
 [docs/kernel-files.md](docs/kernel-files.md), and what a readout is in [docs/readouts.md](docs/readouts.md).

package/data/kernels/gate.json

@@ -126,6 +126,28 @@
         "default": 16,
         "defaultFrom": "desk"
       }
+    },
+    {
+      "name": "hpHz",
+      "kind": "travel",
+      "table": "GATE_KEY_LIMITS",
+      "travel": {
+        "min": 0,
+        "max": 20000,
+        "step": 1,
+        "unit": "Hz"
+      }
+    },
+    {
+      "name": "lpHz",
+      "kind": "travel",
+      "table": "GATE_KEY_LIMITS",
+      "travel": {
+        "min": 0,
+        "max": 20000,
+        "step": 1,
+        "unit": "Hz"
+      }
     }
   ],
   "readouts": [
@@ -146,6 +168,9 @@
   "tables": {
     "GATE_LIMITS": {
       "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)."
+    },
+    "GATE_KEY_LIMITS": {
+      "doc": "The travel of each edge of the keyed gate's detector filter, 0 (off) up to 20 kHz in whole Hz, as the console's `/channel/{kind}/{index}/gate/key` row serves them (the console's GATE_KEY_LIMITS). A property of the detector filter, not of any desk: no come-up value is declared."
     }
   }
 }

package/data/kernels/generator.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "../../schema/omx-contract.schema.json",
+  "controls": [
+    {
+      "name": "kind",
+      "kind": "choice",
+      "doc": "The generator kinds, in surface order: its position is the integer omx-dsp's omx_gen_fill takes as its kind (OMX_GEN_OSC, OMX_GEN_WHITE, OMX_GEN_PINK).",
+      "ids": [
+        "oscillator",
+        "white",
+        "pink"
+      ]
+    },
+    {
+      "name": "waveform",
+      "kind": "choice",
+      "global": "WAVEFORMS",
+      "doc": "The selectable oscillator waveforms, in surface order: its position is the integer omx-dsp's omx_gen_osc takes (OMX_WAVE_SINE, OMX_WAVE_SQUARE, OMX_WAVE_SAW, OMX_WAVE_TRIANGLE).",
+      "ids": [
+        "sine",
+        "square",
+        "saw",
+        "triangle"
+      ]
+    }
+  ]
+}

package/data/kernels/src.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "../../schema/omx-contract.schema.json",
+  "constants": {
+    "SRC_TAPS": {
+      "kind": "scalar",
+      "doc": "Taps per phase. 64 puts the design's transition band comfortably inside what a Kaiser of this beta can hold at every standard rate pair, and costs 64 multiply-adds per output sample — about 12 M flops per track-minute at 48 kHz, which is nothing offline.",
+      "unit": "",
+      "value": 64
+    },
+    "SRC_STOPBAND_DB": {
+      "kind": "scalar",
+      "doc": "Stopband attenuation the window is designed for, in dB. 96 dB is below the noise floor of any take this console can capture (float capture of a 24-bit converter), so the conversion is not what limits the file.",
+      "unit": "dB",
+      "value": 96
+    },
+    "SRC_ROLLOFF": {
+      "kind": "scalar",
+      "doc": "How much of the shared Nyquist the passband keeps. The remaining 8 % is the transition band the window needs to reach its stopband: at 48 kHz that puts the corner at 22.08 kHz and the stopband in place by 24 kHz.",
+      "unit": "",
+      "value": 0.92
+    },
+    "SRC_MAX_L": {
+      "kind": "scalar",
+      "doc": "The largest interpolation factor a plan may carry. 44.1 kHz -> 192 kHz is 640/147, the widest pair the console's standard rates produce; the cap refuses an exotic pair before it allocates a table nobody budgeted for, rather than discovering it as a bad_alloc.",
+      "unit": "",
+      "value": 1024
+    }
+  }
+}

package/dist/ts/omx-contract.d.ts

@@ -1012,6 +1012,37 @@ export declare const GATE_LIMITS: {
   };
 };
 
+/**
+ * The travel of each edge of the keyed gate's detector filter, 0 (off) up to 20 kHz in whole Hz, as the console's `/channel/{kind}/{index}/gate/key` row serves them (the console's GATE_KEY_LIMITS). A property of the detector filter, not of any desk: no come-up value is declared.
+ * @see data/kernels/gate.json
+ */
+export declare const GATE_KEY_LIMITS: {
+  readonly hpHz: {
+    readonly min: 0;
+    readonly max: 20000;
+    readonly step: 1;
+    readonly unit: "Hz";
+  };
+  readonly lpHz: {
+    readonly min: 0;
+    readonly max: 20000;
+    readonly step: 1;
+    readonly unit: "Hz";
+  };
+};
+
+/**
+ * The generator kinds, in surface order: its position is the integer omx-dsp's omx_gen_fill takes as its kind (OMX_GEN_OSC, OMX_GEN_WHITE, OMX_GEN_PINK).
+ * @see data/kernels/generator.json
+ */
+export declare const GENERATOR_KINDS: readonly ["oscillator", "white", "pink"];
+
+/**
+ * The selectable oscillator waveforms, in surface order: its position is the integer omx-dsp's omx_gen_osc takes (OMX_WAVE_SINE, OMX_WAVE_SQUARE, OMX_WAVE_SAW, OMX_WAVE_TRIANGLE).
+ * @see data/kernels/generator.json
+ */
+export declare const WAVEFORMS: readonly ["sine", "square", "saw", "triangle"];
+
 /**
  * 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).
  * @see data/kernels/geq.json
@@ -1725,6 +1756,30 @@ export declare const RTA_TARGET_BIN_HZ: 5.9;
  */
 export declare const RTA_FFT_SIZE_MAX: 32768;
 
+/**
+ * Taps per phase. 64 puts the design's transition band comfortably inside what a Kaiser of this beta can hold at every standard rate pair, and costs 64 multiply-adds per output sample — about 12 M flops per track-minute at 48 kHz, which is nothing offline.
+ * @see data/kernels/src.json
+ */
+export declare const SRC_TAPS: 64;
+
+/**
+ * Stopband attenuation the window is designed for, in dB. 96 dB is below the noise floor of any take this console can capture (float capture of a 24-bit converter), so the conversion is not what limits the file.
+ * @see data/kernels/src.json
+ */
+export declare const SRC_STOPBAND_DB: 96;
+
+/**
+ * How much of the shared Nyquist the passband keeps. The remaining 8 % is the transition band the window needs to reach its stopband: at 48 kHz that puts the corner at 22.08 kHz and the stopband in place by 24 kHz.
+ * @see data/kernels/src.json
+ */
+export declare const SRC_ROLLOFF: 0.92;
+
+/**
+ * The largest interpolation factor a plan may carry. 44.1 kHz -> 192 kHz is 640/147, the widest pair the console's standard rates produce; the cap refuses an exotic pair before it allocates a table nobody budgeted for, rather than discovering it as a bad_alloc.
+ * @see data/kernels/src.json
+ */
+export declare const SRC_MAX_L: 1024;
+
 /**
  * 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).
  * @see data/kernels/transient.json

package/dist/ts/omx-contract.js

@@ -1172,6 +1172,46 @@ export const GATE_LIMITS = {
   }
 };
 
+/**
+ * The travel of each edge of the keyed gate's detector filter, 0 (off) up to 20 kHz in whole Hz, as the console's `/channel/{kind}/{index}/gate/key` row serves them (the console's GATE_KEY_LIMITS). A property of the detector filter, not of any desk: no come-up value is declared.
+ * @see data/kernels/gate.json
+ */
+export const GATE_KEY_LIMITS = {
+  "hpHz": {
+    "min": 0,
+    "max": 20000,
+    "step": 1,
+    "unit": "Hz"
+  },
+  "lpHz": {
+    "min": 0,
+    "max": 20000,
+    "step": 1,
+    "unit": "Hz"
+  }
+};
+
+/**
+ * The generator kinds, in surface order: its position is the integer omx-dsp's omx_gen_fill takes as its kind (OMX_GEN_OSC, OMX_GEN_WHITE, OMX_GEN_PINK).
+ * @see data/kernels/generator.json
+ */
+export const GENERATOR_KINDS = [
+  "oscillator",
+  "white",
+  "pink"
+];
+
+/**
+ * The selectable oscillator waveforms, in surface order: its position is the integer omx-dsp's omx_gen_osc takes (OMX_WAVE_SINE, OMX_WAVE_SQUARE, OMX_WAVE_SAW, OMX_WAVE_TRIANGLE).
+ * @see data/kernels/generator.json
+ */
+export const WAVEFORMS = [
+  "sine",
+  "square",
+  "saw",
+  "triangle"
+];
+
 /**
  * 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).
  * @see data/kernels/geq.json
@@ -1902,6 +1942,30 @@ export const RTA_TARGET_BIN_HZ = 5.9;
  */
 export const RTA_FFT_SIZE_MAX = 32768;
 
+/**
+ * Taps per phase. 64 puts the design's transition band comfortably inside what a Kaiser of this beta can hold at every standard rate pair, and costs 64 multiply-adds per output sample — about 12 M flops per track-minute at 48 kHz, which is nothing offline.
+ * @see data/kernels/src.json
+ */
+export const SRC_TAPS = 64;
+
+/**
+ * Stopband attenuation the window is designed for, in dB. 96 dB is below the noise floor of any take this console can capture (float capture of a 24-bit converter), so the conversion is not what limits the file.
+ * @see data/kernels/src.json
+ */
+export const SRC_STOPBAND_DB = 96;
+
+/**
+ * How much of the shared Nyquist the passband keeps. The remaining 8 % is the transition band the window needs to reach its stopband: at 48 kHz that puts the corner at 22.08 kHz and the stopband in place by 24 kHz.
+ * @see data/kernels/src.json
+ */
+export const SRC_ROLLOFF = 0.92;
+
+/**
+ * The largest interpolation factor a plan may carry. 44.1 kHz -> 192 kHz is 640/147, the widest pair the console's standard rates produce; the cap refuses an exotic pair before it allocates a table nobody budgeted for, rather than discovering it as a bad_alloc.
+ * @see data/kernels/src.json
+ */
+export const SRC_MAX_L = 1024;
+
 /**
  * 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).
  * @see data/kernels/transient.json

package/include/omxcontract/omx_contract_limits.h

@@ -64,6 +64,11 @@
 #define OMX_GATE_RATIO_MAX 100.0f
 #define OMX_GATE_RATIO_DEFAULT 16.0f
 
+#define OMX_GATE_KEY_HP_HZ_MIN 0.0f
+#define OMX_GATE_KEY_HP_HZ_MAX 20000.0f
+#define OMX_GATE_KEY_LP_HZ_MIN 0.0f
+#define OMX_GATE_KEY_LP_HZ_MAX 20000.0f
+
 #define OMX_LIMITER_CEILING_DB_MIN -12.0f
 #define OMX_LIMITER_CEILING_DB_MAX 0.0f
 #define OMX_LIMITER_CEILING_DB_DEFAULT -1.0f
@@ -570,6 +575,11 @@
 #define OMX_RTA_TARGET_BIN_HZ_DOUBLE 5.9
 #define OMX_RT_HARD_TARGET_QUANTUM 128
 #define OMX_RT_HARD_TARGET_RATE 192000
+#define OMX_SRC_MAX_L 1024
+#define OMX_SRC_ROLLOFF 0.92f
+#define OMX_SRC_ROLLOFF_DOUBLE 0.92
+#define OMX_SRC_STOPBAND_DB 96
+#define OMX_SRC_TAPS 64
 #define OMX_SUBHARMONIC_RADIUS_BINS 2
 #define OMX_TRANSIENT_FAST_ATTACK_MS 0.5f
 #define OMX_TRANSIENT_FAST_ATTACK_MS_DOUBLE 0.5
@@ -730,6 +740,12 @@ enum omx_gate_key_sources {
   OMX_GATE_KEY_SOURCES_SIDECHAIN = 1,
 };
 #define OMX_GATE_KEY_SOURCES_COUNT 2u
+enum omx_generator_kinds {
+  OMX_GENERATOR_KINDS_OSCILLATOR = 0,
+  OMX_GENERATOR_KINDS_WHITE = 1,
+  OMX_GENERATOR_KINDS_PINK = 2,
+};
+#define OMX_GENERATOR_KINDS_COUNT 3u
 enum omx_param_scales {
   OMX_PARAM_SCALES_LINEAR = 0,
   OMX_PARAM_SCALES_LOG = 1,
@@ -757,6 +773,13 @@ enum omx_tremolo_modes {
 };
 #define OMX_TREMOLO_MODES_COUNT 2u
 #define OMX_TREMOLO_MODES_DEFAULT OMX_TREMOLO_MODES_TREMOLO
+enum omx_waveforms {
+  OMX_WAVEFORMS_SINE = 0,
+  OMX_WAVEFORMS_SQUARE = 1,
+  OMX_WAVEFORMS_SAW = 2,
+  OMX_WAVEFORMS_TRIANGLE = 3,
+};
+#define OMX_WAVEFORMS_COUNT 4u
 
 /* Every kernel's readouts, the meters a host draws (docs/readouts.md): an enum of the readouts at their position,
  * `OMX_<KERNEL>_READOUT_COUNT`, and per readout its display range (_MIN, _MAX), _RATE_HZ, _SCALE (an OMX_PARAM_SCALES_*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmixer/omx-contract",
-  "version": "2.5.0",
+  "version": "2.7.0",
   "description": "The FreeMixer declarations as data: a JSON Schema, the data, and one CLI that renders them into C, TypeScript and JSON",
   "type": "module",
   "license": "GPL-3.0-or-later",

package/render/c/contract-limits-render.mjs

@@ -41,7 +41,10 @@ function genLimitBlock(prefix, table) {
     const c = fieldConstName(field);
     lines.push(`#define OMX_${prefix}_${c}_MIN ${numLiteral(limit.min)}f`);
     lines.push(`#define OMX_${prefix}_${c}_MAX ${numLiteral(limit.max)}f`);
-    lines.push(`#define OMX_${prefix}_${c}_DEFAULT ${numLiteral(limit.default)}f`);
+    // a field with no come-up value (the gate key filter's edges) has no DEFAULT, as in genCoreLimitBlock
+    if (limit.default !== undefined) {
+      lines.push(`#define OMX_${prefix}_${c}_DEFAULT ${numLiteral(limit.default)}f`);
+    }
   }
   return lines.join('\n');
 }

package/share/omx-contract/omx-contract.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmixer/omx-contract",
-  "version": "2.5.0",
+  "version": "2.7.0",
   "items": {
     "PAN_RANGE": {
       "rel": "data/kernels/balance.json",
@@ -1347,6 +1347,47 @@
         }
       }
     },
+    "GATE_KEY_LIMITS": {
+      "rel": "data/kernels/gate.json",
+      "kind": "travels",
+      "doc": "The travel of each edge of the keyed gate's detector filter, 0 (off) up to 20 kHz in whole Hz, as the console's `/channel/{kind}/{index}/gate/key` row serves them (the console's GATE_KEY_LIMITS). A property of the detector filter, not of any desk: no come-up value is declared.",
+      "shape": "table",
+      "value": {
+        "hpHz": {
+          "min": 0,
+          "max": 20000,
+          "step": 1,
+          "unit": "Hz"
+        },
+        "lpHz": {
+          "min": 0,
+          "max": 20000,
+          "step": 1,
+          "unit": "Hz"
+        }
+      }
+    },
+    "GENERATOR_KINDS": {
+      "rel": "data/kernels/generator.json",
+      "kind": "set",
+      "doc": "The generator kinds, in surface order: its position is the integer omx-dsp's omx_gen_fill takes as its kind (OMX_GEN_OSC, OMX_GEN_WHITE, OMX_GEN_PINK).",
+      "value": [
+        "oscillator",
+        "white",
+        "pink"
+      ]
+    },
+    "WAVEFORMS": {
+      "rel": "data/kernels/generator.json",
+      "kind": "set",
+      "doc": "The selectable oscillator waveforms, in surface order: its position is the integer omx-dsp's omx_gen_osc takes (OMX_WAVE_SINE, OMX_WAVE_SQUARE, OMX_WAVE_SAW, OMX_WAVE_TRIANGLE).",
+      "value": [
+        "sine",
+        "square",
+        "saw",
+        "triangle"
+      ]
+    },
     "GEQ_BAND_RANGE": {
       "rel": "data/kernels/geq.json",
       "kind": "travels",
@@ -2137,6 +2178,34 @@
       "unit": "",
       "value": 32768
     },
+    "SRC_TAPS": {
+      "rel": "data/kernels/src.json",
+      "kind": "scalar",
+      "doc": "Taps per phase. 64 puts the design's transition band comfortably inside what a Kaiser of this beta can hold at every standard rate pair, and costs 64 multiply-adds per output sample — about 12 M flops per track-minute at 48 kHz, which is nothing offline.",
+      "unit": "",
+      "value": 64
+    },
+    "SRC_STOPBAND_DB": {
+      "rel": "data/kernels/src.json",
+      "kind": "scalar",
+      "doc": "Stopband attenuation the window is designed for, in dB. 96 dB is below the noise floor of any take this console can capture (float capture of a 24-bit converter), so the conversion is not what limits the file.",
+      "unit": "dB",
+      "value": 96
+    },
+    "SRC_ROLLOFF": {
+      "rel": "data/kernels/src.json",
+      "kind": "scalar",
+      "doc": "How much of the shared Nyquist the passband keeps. The remaining 8 % is the transition band the window needs to reach its stopband: at 48 kHz that puts the corner at 22.08 kHz and the stopband in place by 24 kHz.",
+      "unit": "",
+      "value": 0.92
+    },
+    "SRC_MAX_L": {
+      "rel": "data/kernels/src.json",
+      "kind": "scalar",
+      "doc": "The largest interpolation factor a plan may carry. 44.1 kHz -> 192 kHz is 640/147, the widest pair the console's standard rates produce; the cap refuses an exotic pair before it allocates a table nobody budgeted for, rather than discovering it as a bad_alloc.",
+      "unit": "",
+      "value": 1024
+    },
     "TRANSIENT_LIMITS": {
       "rel": "data/kernels/transient.json",
       "kind": "travels",
@@ -2978,6 +3047,18 @@
           "kind": "travel",
           "global": "GATE_LIMITS",
           "table": "GATE_LIMITS"
+        },
+        {
+          "name": "hpHz",
+          "kind": "travel",
+          "global": "GATE_KEY_LIMITS",
+          "table": "GATE_KEY_LIMITS"
+        },
+        {
+          "name": "lpHz",
+          "kind": "travel",
+          "global": "GATE_KEY_LIMITS",
+          "table": "GATE_KEY_LIMITS"
         }
       ],
       "readouts": [
@@ -2992,6 +3073,20 @@
         }
       ]
     },
+    "generator": {
+      "controls": [
+        {
+          "name": "kind",
+          "kind": "choice",
+          "global": "GENERATOR_KINDS"
+        },
+        {
+          "name": "waveform",
+          "kind": "choice",
+          "global": "WAVEFORMS"
+        }
+      ]
+    },
     "geq": {
       "controls": [
         {
@@ -3220,6 +3315,9 @@
     "rta": {
       "controls": []
     },
+    "src": {
+      "controls": []
+    },
     "transient": {
       "controls": [
         {