@openmixer/omx-contract 2.4.0 → 2.5.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.4.0 omx-contract`), else the npm tarball, unpacked, and
+that version (`pkg-config --exact-version=2.5.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/comp.json

@@ -122,6 +122,17 @@
         "Off",
         "4x"
       ]
+    },
+    {
+      "name": "detectorTopology",
+      "kind": "choice",
+      "global": "DETECTOR_TOPOLOGY",
+      "doc": "Where the compressor's detector listens: `feedforward` hears the slot's input (or its key), `feedback` hears the slot's own pre-make-up output DYN_FB_LOOP_DELAY_SAMPLES late, through one envelope stage, and a keyed slot stays feed-forward (omx-dsp's OMX_DYN_TOPOLOGY_FEEDFORWARD 0 and _FEEDBACK 1, in that order; the set is named for its control, so C spells them OMX_DETECTOR_TOPOLOGY_*). The console's comp row carries it (`detectorTopology`, openmixer's ssl-bus-compressor spec §3a) and comes up `feedforward`, so a zeroed atom is the compressor every slot runs.",
+      "ids": [
+        "feedforward",
+        "feedback"
+      ],
+      "default": "feedforward"
     }
   ],
   "readouts": [
@@ -160,6 +171,12 @@
           }
         }
       }
+    },
+    "DYN_FB_LOOP_DELAY_SAMPLES": {
+      "kind": "scalar",
+      "doc": "The feedback detector's loop delay, in samples: the output y[n] depends on the gain at n, so the detector can only have heard y[n - 1]. Not a latency: the audio is never delayed by it. omx-dsp's feedback state holds exactly this many output samples per leg.",
+      "unit": "",
+      "value": 1
     }
   }
 }

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

@@ -254,6 +254,12 @@ export declare const COMP_KINDS: readonly ["comp", "limiter"];
  */
 export declare const DETECTOR_OVERSAMPLINGS: readonly ["auto", "off", "x4"];
 
+/**
+ * Where the compressor's detector listens: `feedforward` hears the slot's input (or its key), `feedback` hears the slot's own pre-make-up output DYN_FB_LOOP_DELAY_SAMPLES late, through one envelope stage, and a keyed slot stays feed-forward (omx-dsp's OMX_DYN_TOPOLOGY_FEEDFORWARD 0 and _FEEDBACK 1, in that order; the set is named for its control, so C spells them OMX_DETECTOR_TOPOLOGY_*). The console's comp row carries it (`detectorTopology`, openmixer's ssl-bus-compressor spec §3a) and comes up `feedforward`, so a zeroed atom is the compressor every slot runs.
+ * @see data/kernels/comp.json
+ */
+export declare const DETECTOR_TOPOLOGY: readonly ["feedforward", "feedback"];
+
 /**
  * The program-dependent release's model constants — the LA-2A's opto cell as DATA (`docs/design/specs/2026-09-26-compressor-models.md` §3b). `chargeMs`/`dischargeMs` are the word's memory constants, shared by every profile; each profile's `fastMs`, `slowMinMs`, `slowMaxMs` and `share` fit the unit's published two-stage recovery. Not operator controls: generated into `omx_contract_limits.h` as `OMX_PROGRAM_RELEASE_*`, which libomxdsp's `omx_env_program_release` reads.
  * @see data/kernels/comp.json
@@ -271,6 +277,12 @@ export declare const PROGRAM_RELEASE: {
   };
 };
 
+/**
+ * The feedback detector's loop delay, in samples: the output y[n] depends on the gain at n, so the detector can only have heard y[n - 1]. Not a latency: the audio is never delayed by it. omx-dsp's feedback state holds exactly this many output samples per leg.
+ * @see data/kernels/comp.json
+ */
+export declare const DYN_FB_LOOP_DELAY_SAMPLES: 1;
+
 /**
  * The detector band's CENTRE, in Hz. Sibilance lives at 5–10 kHz on most voices; 7 kHz with the default width covers 4 950–9 900 Hz, which is where an "s" and a "t" sit on a close vocal mic. The travel is wider than the come-up on both sides on purpose: a bright female vocal wants the band up near 9 kHz and a chesty male one down at 5, and a surface narrower than the row removes reach the console genuinely has (the same reasoning core's `REVERB_CUT_RANGE` records).
  * @see data/kernels/deesser.json

package/dist/ts/omx-contract.js

@@ -264,6 +264,15 @@ export const DETECTOR_OVERSAMPLINGS = [
   "x4"
 ];
 
+/**
+ * Where the compressor's detector listens: `feedforward` hears the slot's input (or its key), `feedback` hears the slot's own pre-make-up output DYN_FB_LOOP_DELAY_SAMPLES late, through one envelope stage, and a keyed slot stays feed-forward (omx-dsp's OMX_DYN_TOPOLOGY_FEEDFORWARD 0 and _FEEDBACK 1, in that order; the set is named for its control, so C spells them OMX_DETECTOR_TOPOLOGY_*). The console's comp row carries it (`detectorTopology`, openmixer's ssl-bus-compressor spec §3a) and comes up `feedforward`, so a zeroed atom is the compressor every slot runs.
+ * @see data/kernels/comp.json
+ */
+export const DETECTOR_TOPOLOGY = [
+  "feedforward",
+  "feedback"
+];
+
 /**
  * The program-dependent release's model constants — the LA-2A's opto cell as DATA (`docs/design/specs/2026-09-26-compressor-models.md` §3b). `chargeMs`/`dischargeMs` are the word's memory constants, shared by every profile; each profile's `fastMs`, `slowMinMs`, `slowMaxMs` and `share` fit the unit's published two-stage recovery. Not operator controls: generated into `omx_contract_limits.h` as `OMX_PROGRAM_RELEASE_*`, which libomxdsp's `omx_env_program_release` reads.
  * @see data/kernels/comp.json
@@ -281,6 +290,12 @@ export const PROGRAM_RELEASE = {
   }
 };
 
+/**
+ * The feedback detector's loop delay, in samples: the output y[n] depends on the gain at n, so the detector can only have heard y[n - 1]. Not a latency: the audio is never delayed by it. omx-dsp's feedback state holds exactly this many output samples per leg.
+ * @see data/kernels/comp.json
+ */
+export const DYN_FB_LOOP_DELAY_SAMPLES = 1;
+
 /**
  * The detector band's CENTRE, in Hz. Sibilance lives at 5–10 kHz on most voices; 7 kHz with the default width covers 4 950–9 900 Hz, which is where an "s" and a "t" sit on a close vocal mic. The travel is wider than the come-up on both sides on purpose: a bright female vocal wants the band up near 9 kHz and a chesty male one down at 5, and a surface narrower than the row removes reach the console genuinely has (the same reasoning core's `REVERB_CUT_RANGE` records).
  * @see data/kernels/deesser.json

package/include/omxcontract/omx_contract_limits.h

@@ -279,6 +279,7 @@
 #define OMX_DRIVE_TRIM_RANGE_STEP 0.1f
 #define OMX_DRIVE_TRIM_RANGE_STEP_DOUBLE 0.1
 #define OMX_DSP_KNOB_REFERENCE_RATE 96000
+#define OMX_DYN_FB_LOOP_DELAY_SAMPLES 1
 #define OMX_EQ_BAND_COUNTS_CHANNEL_DEFAULT 4
 #define OMX_EQ_BAND_COUNTS_CHANNEL_MAX 24
 #define OMX_EQ_BAND_COUNTS_EQ16_DEFAULT 16
@@ -652,6 +653,12 @@ enum omx_detector_oversamplings {
 };
 #define OMX_DETECTOR_OVERSAMPLINGS_COUNT 3u
 #define OMX_DETECTOR_OVERSAMPLINGS_DEFAULT OMX_DETECTOR_OVERSAMPLINGS_AUTO
+enum omx_detector_topology {
+  OMX_DETECTOR_TOPOLOGY_FEEDFORWARD = 0,
+  OMX_DETECTOR_TOPOLOGY_FEEDBACK = 1,
+};
+#define OMX_DETECTOR_TOPOLOGY_COUNT 2u
+#define OMX_DETECTOR_TOPOLOGY_DEFAULT OMX_DETECTOR_TOPOLOGY_FEEDFORWARD
 enum omx_drive_auto_gains {
   OMX_DRIVE_AUTO_GAINS_OFF = 0,
   OMX_DRIVE_AUTO_GAINS_ON = 1,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmixer/omx-contract",
-  "version": "2.4.0",
+  "version": "2.5.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.4.0",
+  "version": "2.5.0",
   "items": {
     "PAN_RANGE": {
       "rel": "data/kernels/balance.json",
@@ -299,6 +299,16 @@
         "x4"
       ]
     },
+    "DETECTOR_TOPOLOGY": {
+      "rel": "data/kernels/comp.json",
+      "kind": "set",
+      "doc": "Where the compressor's detector listens: `feedforward` hears the slot's input (or its key), `feedback` hears the slot's own pre-make-up output DYN_FB_LOOP_DELAY_SAMPLES late, through one envelope stage, and a keyed slot stays feed-forward (omx-dsp's OMX_DYN_TOPOLOGY_FEEDFORWARD 0 and _FEEDBACK 1, in that order; the set is named for its control, so C spells them OMX_DETECTOR_TOPOLOGY_*). The console's comp row carries it (`detectorTopology`, openmixer's ssl-bus-compressor spec §3a) and comes up `feedforward`, so a zeroed atom is the compressor every slot runs.",
+      "default": "feedforward",
+      "value": [
+        "feedforward",
+        "feedback"
+      ]
+    },
     "PROGRAM_RELEASE": {
       "rel": "data/kernels/comp.json",
       "kind": "sheet",
@@ -316,6 +326,13 @@
         }
       }
     },
+    "DYN_FB_LOOP_DELAY_SAMPLES": {
+      "rel": "data/kernels/comp.json",
+      "kind": "scalar",
+      "doc": "The feedback detector's loop delay, in samples: the output y[n] depends on the gain at n, so the detector can only have heard y[n - 1]. Not a latency: the audio is never delayed by it. omx-dsp's feedback state holds exactly this many output samples per leg.",
+      "unit": "",
+      "value": 1
+    },
     "DEESS_FREQ_RANGE": {
       "rel": "data/kernels/deesser.json",
       "kind": "travels",
@@ -2646,6 +2663,11 @@
           "name": "detectorOversampling",
           "kind": "choice",
           "global": "DETECTOR_OVERSAMPLINGS"
+        },
+        {
+          "name": "detectorTopology",
+          "kind": "choice",
+          "global": "DETECTOR_TOPOLOGY"
         }
       ],
       "readouts": [