@openmixer/omx-contract 2.6.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.6.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/dist/ts/omx-contract.d.ts

@@ -1012,6 +1012,25 @@ 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

package/dist/ts/omx-contract.js

@@ -1172,6 +1172,25 @@ 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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmixer/omx-contract",
-  "version": "2.6.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.6.0",
+  "version": "2.7.0",
   "items": {
     "PAN_RANGE": {
       "rel": "data/kernels/balance.json",
@@ -1347,6 +1347,26 @@
         }
       }
     },
+    "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",
@@ -3027,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": [