@openmixer/omx-contract 2.2.0 → 2.3.0

package/README.md

@@ -17,6 +17,7 @@ declared here is declared nowhere else: the EQ band budget that 1.2.0 left in op
 2.2.0 declares the controls an instance has that were missing: the delay's ping-pong, the drive's auto-gain, stereo
 link and HF roll-off, the compressor's kind and detector oversampling, and an EQ instance's switches, slopes and
 per-band controls (a control's `count`, a use, `of` and `when`, and a default by reference).
+2.3.0 declares the input trim as a kernel, `trim`, whose one control is the console's TRIM_RANGE.
 
 ```
 data/                        the declaration, one file per group, edited by hand
@@ -127,9 +128,9 @@ share/omx-contract` and `render --target ts --out test/golden/ts`; CI holds all
 
 ## Consuming it
 
-Pin one version (`omx-contract 2.2.0` in `.github/pins.txt`) and build against its renders, committing
+Pin one version (`omx-contract 2.3.0` in `.github/pins.txt`) and build against its renders, committing
 none: the installed `omx-contract-devel` / `libomx-contract-dev` at exactly that version
-(`pkg-config --exact-version=2.2.0 omx-contract`), else the release's npm tarball, unpacked, and
+(`pkg-config --exact-version=2.3.0 omx-contract`), else the release's npm tarball, unpacked, and
 `omx-contract render --target c --out build/omx-contract/include`. Include
 `<omxcontract/omx_contract_limits.h>`. A plugin's parameter header is rendered by omx-plugins from its
 declaration, by reference to the kernel travels here (since 1.1.0).

package/data/kernels/trim.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "../../schema/omx-contract.schema.json",
+  "controls": [
+    {
+      "name": "trimDb",
+      "kind": "travel",
+      "global": "TRIM_RANGE",
+      "doc": "The digital input trim, in dB: the console's fine head gain, applied first in a channel's lane as a click-free ramp from the last block's gain to this one (openmixer's TRIM_RANGE, -24..+24 dB in 0.1 dB steps, spelled minDb/maxDb/stepDb there). It comes up at 0 dB, the trim a channel has when none is set. omx-dsp's trim face takes it as `trim_db`.",
+      "travel": {
+        "min": -24,
+        "max": 24,
+        "step": 0.1,
+        "unit": "dB",
+        "default": 0,
+        "defaultFrom": "desk"
+      }
+    }
+  ],
+  "aggregates": {
+    "TRIM_TRAVELS": {
+      "doc": "The trim as a table with the one field `trimDb`, the name the trim row and the omx-strip plugin store; generated from the trim kernel's control, so the travel has one home.",
+      "fields": [
+        "trimDb"
+      ]
+    }
+  }
+}

package/data/primitives.json

@@ -104,20 +104,6 @@
       }
     }
   },
-  "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"
-      }
-    }
-  },
   "PARAM_SCALES": {
     "kind": "set",
     "since": "1.3.0",

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

@@ -1860,6 +1860,34 @@ export declare const TREMOLO_TRAVELS: {
   };
 };
 
+/**
+ * The digital input trim, in dB: the console's fine head gain, applied first in a channel's lane as a click-free ramp from the last block's gain to this one (openmixer's TRIM_RANGE, -24..+24 dB in 0.1 dB steps, spelled minDb/maxDb/stepDb there). It comes up at 0 dB, the trim a channel has when none is set. omx-dsp's trim face takes it as `trim_db`.
+ * @see data/kernels/trim.json
+ */
+export declare const TRIM_RANGE: {
+  readonly min: -24;
+  readonly max: 24;
+  readonly step: 0.1;
+  readonly unit: "dB";
+  readonly default: 0;
+  readonly defaultFrom: "desk";
+};
+
+/**
+ * The trim as a table with the one field `trimDb`, the name the trim row and the omx-strip plugin store; generated from the trim kernel's control, so the travel has one home.
+ * @see data/kernels/trim.json
+ */
+export declare const TRIM_TRAVELS: {
+  readonly trimDb: {
+    readonly min: -24;
+    readonly max: 24;
+    readonly step: 0.1;
+    readonly unit: "dB";
+    readonly default: 0;
+    readonly defaultFrom: "desk";
+  };
+};
+
 /**
  * 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).
  * @see data/primitives.json
@@ -1958,21 +1986,6 @@ export declare const COMP_CONTINUOUS_TRAVELS: {
   };
 };
 
-/**
- * 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.
- * @see data/primitives.json
- */
-export declare const TRIM_TRAVELS: {
-  readonly trimDb: {
-    readonly min: -24;
-    readonly max: 24;
-    readonly step: 0.1;
-    readonly unit: "dB";
-    readonly default: 0;
-    readonly defaultFrom: "desk";
-  };
-};
-
 /**
  * How a host draws a parameter: linear, logarithmic (a frequency, a time) or in discrete steps. The words omx-plugins' declarations and plugin-hostd's protocol use; a travel names its own with `scale`.
  * @see data/primitives.json

package/dist/ts/omx-contract.js

@@ -2037,6 +2037,34 @@ export const TREMOLO_TRAVELS = {
   }
 };
 
+/**
+ * The digital input trim, in dB: the console's fine head gain, applied first in a channel's lane as a click-free ramp from the last block's gain to this one (openmixer's TRIM_RANGE, -24..+24 dB in 0.1 dB steps, spelled minDb/maxDb/stepDb there). It comes up at 0 dB, the trim a channel has when none is set. omx-dsp's trim face takes it as `trim_db`.
+ * @see data/kernels/trim.json
+ */
+export const TRIM_RANGE = {
+  "min": -24,
+  "max": 24,
+  "step": 0.1,
+  "unit": "dB",
+  "default": 0,
+  "defaultFrom": "desk"
+};
+
+/**
+ * The trim as a table with the one field `trimDb`, the name the trim row and the omx-strip plugin store; generated from the trim kernel's control, so the travel has one home.
+ * @see data/kernels/trim.json
+ */
+export const TRIM_TRAVELS = {
+  "trimDb": {
+    "min": -24,
+    "max": 24,
+    "step": 0.1,
+    "unit": "dB",
+    "default": 0,
+    "defaultFrom": "desk"
+  }
+};
+
 /**
  * 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).
  * @see data/primitives.json
@@ -2135,21 +2163,6 @@ export const COMP_CONTINUOUS_TRAVELS = {
   }
 };
 
-/**
- * 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.
- * @see data/primitives.json
- */
-export const TRIM_TRAVELS = {
-  "trimDb": {
-    "min": -24,
-    "max": 24,
-    "step": 0.1,
-    "unit": "dB",
-    "default": 0,
-    "defaultFrom": "desk"
-  }
-};
-
 /**
  * How a host draws a parameter: linear, logarithmic (a frequency, a time) or in discrete steps. The words omx-plugins' declarations and plugin-hostd's protocol use; a travel names its own with `scale`.
  * @see data/primitives.json

package/include/omxcontract/omx_contract_limits.h

@@ -591,6 +591,11 @@
 #define OMX_TREMOLO_RATE_RANGE_MIN_DOUBLE 0.1
 #define OMX_TREMOLO_RATE_RANGE_STEP 0.01f
 #define OMX_TREMOLO_RATE_RANGE_STEP_DOUBLE 0.01
+#define OMX_TRIM_RANGE_DEFAULT 0
+#define OMX_TRIM_RANGE_MAX 24
+#define OMX_TRIM_RANGE_MIN -24
+#define OMX_TRIM_RANGE_STEP 0.1f
+#define OMX_TRIM_RANGE_STEP_DOUBLE 0.1
 #define OMX_XOVER_LR2_SECTION_Q 0.5f
 #define OMX_XOVER_LR2_SECTION_Q_DOUBLE 0.5
 #define OMX_XOVER_LR4_SECTION_Q 0.7071067811865476f

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmixer/omx-contract",
-  "version": "2.2.0",
+  "version": "2.3.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/share/omx-contract/omx-contract.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmixer/omx-contract",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "items": {
     "PAN_RANGE": {
       "rel": "data/kernels/balance.json",
@@ -2280,6 +2280,36 @@
         }
       }
     },
+    "TRIM_RANGE": {
+      "rel": "data/kernels/trim.json",
+      "kind": "travels",
+      "doc": "The digital input trim, in dB: the console's fine head gain, applied first in a channel's lane as a click-free ramp from the last block's gain to this one (openmixer's TRIM_RANGE, -24..+24 dB in 0.1 dB steps, spelled minDb/maxDb/stepDb there). It comes up at 0 dB, the trim a channel has when none is set. omx-dsp's trim face takes it as `trim_db`.",
+      "shape": "travel",
+      "value": {
+        "min": -24,
+        "max": 24,
+        "step": 0.1,
+        "unit": "dB",
+        "default": 0,
+        "defaultFrom": "desk"
+      }
+    },
+    "TRIM_TRAVELS": {
+      "rel": "data/kernels/trim.json",
+      "kind": "travels",
+      "doc": "The trim as a table with the one field `trimDb`, the name the trim row and the omx-strip plugin store; generated from the trim kernel's control, so the travel has one home.",
+      "shape": "table",
+      "value": {
+        "trimDb": {
+          "min": -24,
+          "max": 24,
+          "step": 0.1,
+          "unit": "dB",
+          "default": 0,
+          "defaultFrom": "desk"
+        }
+      }
+    },
     "BUTTERWORTH_Q": {
       "rel": "data/primitives.json",
       "kind": "scalar",
@@ -2383,22 +2413,6 @@
         }
       }
     },
-    "TRIM_TRAVELS": {
-      "rel": "data/primitives.json",
-      "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.",
-      "shape": "table",
-      "value": {
-        "trimDb": {
-          "min": -24,
-          "max": 24,
-          "step": 0.1,
-          "unit": "dB",
-          "default": 0,
-          "defaultFrom": "desk"
-        }
-      }
-    },
     "PARAM_SCALES": {
       "rel": "data/primitives.json",
       "kind": "set",
@@ -3190,6 +3204,15 @@
           "global": "TREMOLO_MODES"
         }
       ]
+    },
+    "trim": {
+      "controls": [
+        {
+          "name": "trimDb",
+          "kind": "travel",
+          "global": "TRIM_RANGE"
+        }
+      ]
     }
   }
 }