@openmixer/omx-contract 2.11.0 → 2.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/bin/omx-contract.mjs +1 -1
- package/data/hosting.json +93 -0
- package/data/kernels/chorus.json +5 -5
- package/data/kernels/comp.json +2 -2
- package/data/kernels/deesser.json +1 -1
- package/data/kernels/delay.json +1 -1
- package/data/kernels/drive.json +3 -3
- package/data/kernels/eq.json +1 -1
- package/data/kernels/fbs.json +5 -5
- package/data/kernels/flanger.json +4 -4
- package/data/kernels/geq.json +4 -4
- package/data/kernels/hrp.json +5 -5
- package/data/kernels/mixmatrix.json +1 -1
- package/data/kernels/phaser.json +7 -7
- package/data/kernels/pitch.json +12 -3
- package/data/kernels/rotary.json +1 -1
- package/data/kernels/transient.json +5 -5
- package/data/primitives.json +1 -1
- package/dist/ts/omx-contract.d.ts +124 -46
- package/dist/ts/omx-contract.js +127 -49
- package/include/omxcontract/clap_host_limits.h +66 -0
- package/include/omxcontract/omx_contract_limits.h +20 -0
- package/lib/data.mjs +3 -1
- package/lib/fmt.mjs +3 -2
- package/lib/semver.mjs +11 -3
- package/lib/validate.mjs +21 -1
- package/package.json +1 -1
- package/render/c/clap-host-limits.mjs +78 -0
- package/render/c.mjs +10 -5
- package/render/ts.mjs +1 -1
- package/schema/omx-contract.schema.json +38 -4
- package/share/omx-contract/omx-contract.json +149 -50
package/README.md
CHANGED
|
@@ -49,10 +49,10 @@ pkg-config --cflags omx-contract
|
|
|
49
49
|
```
|
|
50
50
|
|
|
51
51
|
Pin one version and build against its renders instead of keeping a copy: the installed package at exactly
|
|
52
|
-
that version (`pkg-config --exact-version=2.
|
|
52
|
+
that version (`pkg-config --exact-version=2.12.0 omx-contract`), else the npm tarball, unpacked, and
|
|
53
53
|
`omx-contract render --target c --out build/omx-contract/include`. A kernel's controls and readouts, in their
|
|
54
54
|
order, are in `share/omx-contract/omx-contract.json`; how a declaration is written is in
|
|
55
|
-
[docs/kernel-files.md](docs/kernel-files.md), and what a readout is in [docs/readouts.md](docs/readouts.md).
|
|
55
|
+
[docs/kernel-files.md](docs/kernel-files.md), and what a readout is in [docs/readouts.md](docs/readouts.md). The hosting limits, the refusal codes and the `clap_host_limits.h` rendered from them are in [docs/hosting.md](docs/hosting.md).
|
|
56
56
|
|
|
57
57
|
## Building
|
|
58
58
|
|
package/bin/omx-contract.mjs
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
3
3
|
// Copyright (C) 2026 Pau Aliagas <linuxnow@gmail.com>
|
|
4
4
|
/**
|
|
5
|
-
* omx-contract — the declarations as data, validated and rendered
|
|
5
|
+
* omx-contract — the declarations as data, validated and rendered.
|
|
6
6
|
*
|
|
7
7
|
* omx-contract validate [--data <dir>] schema + semantic checks
|
|
8
8
|
* omx-contract fmt [--check] [--data <dir>] the one formatting
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "../schema/omx-contract.schema.json",
|
|
3
|
+
"HOSTED_STAGE_LIMITS": {
|
|
4
|
+
"kind": "sheet",
|
|
5
|
+
"since": "2.12.0",
|
|
6
|
+
"doc": "The numbers a hosted plugin's stage limits itself to: the warm-up before it is published, the blocks of non-finite output that strike it, the level its output is clamped at, the parameter queue and the events one block delivers, the polls and timeouts of the hand-over between threads, the ports the core accepts and the caps on a plugin's state, log and parameter count. These are the stage's safety numbers, not an operator's travel.",
|
|
7
|
+
"value": {
|
|
8
|
+
"warmupBlocks": 64,
|
|
9
|
+
"warmupLevelDbfs": -6,
|
|
10
|
+
"nonFiniteStrikes": 3,
|
|
11
|
+
"clampDbfs": 24,
|
|
12
|
+
"paramQueueDepth": 256,
|
|
13
|
+
"eventsPerBlock": 64,
|
|
14
|
+
"unpublishPollUs": 100,
|
|
15
|
+
"unpublishTimeoutUs": 2000000,
|
|
16
|
+
"workerPollUs": 1000,
|
|
17
|
+
"workerRingBytes": 16384,
|
|
18
|
+
"notesPerBlock": 256,
|
|
19
|
+
"mainPortChannels": 2,
|
|
20
|
+
"auxOutputs": 8,
|
|
21
|
+
"auxInputs": 8,
|
|
22
|
+
"stateMaxBytes": 1048576,
|
|
23
|
+
"logBytes": 256,
|
|
24
|
+
"rolePollUs": 1000,
|
|
25
|
+
"roleTimeoutUs": 200000,
|
|
26
|
+
"paramCountMax": 2048,
|
|
27
|
+
"latencyHoldMs": 250
|
|
28
|
+
},
|
|
29
|
+
"docs": {
|
|
30
|
+
"warmupLevelDbfs": "the level of the warm-up signal, in dBFS",
|
|
31
|
+
"nonFiniteStrikes": "the blocks of non-finite output that strike a stage",
|
|
32
|
+
"clampDbfs": "the level the output is clamped at, in dBFS",
|
|
33
|
+
"paramQueueDepth": "the records the parameter queue holds",
|
|
34
|
+
"eventsPerBlock": "the parameter events delivered in one block",
|
|
35
|
+
"unpublishPollUs": "the poll interval while an unpublish waits for the audio thread, in microseconds",
|
|
36
|
+
"unpublishTimeoutUs": "the longest an unpublish waits for the audio thread, in microseconds",
|
|
37
|
+
"workerPollUs": "how often an LV2 instance's worker thread polls its request ring, in microseconds",
|
|
38
|
+
"workerRingBytes": "the bytes of each of an LV2 instance's two worker rings; a power of two, 16 or more",
|
|
39
|
+
"notesPerBlock": "the note events delivered in one block",
|
|
40
|
+
"mainPortChannels": "the channels the main port is limited to",
|
|
41
|
+
"auxOutputs": "the auxiliary output ports the core accepts",
|
|
42
|
+
"auxInputs": "the auxiliary input ports (side chains) the core accepts",
|
|
43
|
+
"stateMaxBytes": "the largest plugin state the core saves or loads, in bytes",
|
|
44
|
+
"logBytes": "the size of a plugin log message, in bytes",
|
|
45
|
+
"rolePollUs": "the poll interval while the audio role is taken, in microseconds",
|
|
46
|
+
"roleTimeoutUs": "the longest the audio role is waited for, in microseconds",
|
|
47
|
+
"paramCountMax": "the widest parameter count the core trusts",
|
|
48
|
+
"latencyHoldMs": "the hold before a hosted stage's new latency takes effect, in milliseconds"
|
|
49
|
+
}
|
|
50
|
+
},
|
|
51
|
+
"HOSTING_CODES": {
|
|
52
|
+
"kind": "codes",
|
|
53
|
+
"since": "2.12.0",
|
|
54
|
+
"doc": "The refusals the CLAP core returns, by the hosting code a verdict names them by. A code is never reworded.",
|
|
55
|
+
"codes": {
|
|
56
|
+
"headlessFailed": {
|
|
57
|
+
"code": "hosting.clap.headless-failed"
|
|
58
|
+
},
|
|
59
|
+
"notAudioEffect": {
|
|
60
|
+
"code": "hosting.clap.not-audio-effect",
|
|
61
|
+
"doc": "the plugin is not an audio effect"
|
|
62
|
+
},
|
|
63
|
+
"noteInput": {
|
|
64
|
+
"code": "hosting.clap.note-input",
|
|
65
|
+
"doc": "the plugin declares a note input the configuration refuses"
|
|
66
|
+
},
|
|
67
|
+
"noAudioInput": {
|
|
68
|
+
"code": "hosting.topology.no-audio-input",
|
|
69
|
+
"doc": "the plugin has no audio input"
|
|
70
|
+
},
|
|
71
|
+
"noAudioOutput": {
|
|
72
|
+
"code": "hosting.topology.no-audio-output",
|
|
73
|
+
"doc": "the plugin has no audio output"
|
|
74
|
+
},
|
|
75
|
+
"widerThanStrip": {
|
|
76
|
+
"code": "hosting.topology.wider-than-strip",
|
|
77
|
+
"doc": "the plugin is wider than the strip"
|
|
78
|
+
},
|
|
79
|
+
"extraInputs": {
|
|
80
|
+
"code": "hosting.topology.extra-inputs-fed-silence",
|
|
81
|
+
"doc": "the plugin has extra inputs, fed silence"
|
|
82
|
+
},
|
|
83
|
+
"crashedLive": {
|
|
84
|
+
"code": "hosting.stability.crashed-live-on-this-rig",
|
|
85
|
+
"doc": "the plugin crashed live on this rig"
|
|
86
|
+
},
|
|
87
|
+
"outputNonFinite": {
|
|
88
|
+
"code": "hosting.output.non-finite",
|
|
89
|
+
"doc": "the plugin produced non-finite output"
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
}
|
package/data/kernels/chorus.json
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
{
|
|
5
5
|
"name": "spread",
|
|
6
6
|
"kind": "travel",
|
|
7
|
-
"doc": "The chorus's right-leg phase offset, in TURNS of its one oscillator
|
|
7
|
+
"doc": "The chorus's right-leg phase offset, in TURNS of its one oscillator. The right leg's voice k reads the LFO at k/N + spread: 0 is both legs one phase (the stage without the field, bit for bit), 0.25 quadrature, 0.5 the Dimension's opposed sweep. A fraction of a cycle carries no engineering symbol, so the unit is ''.",
|
|
8
8
|
"travel": {
|
|
9
9
|
"min": 0,
|
|
10
10
|
"max": 0.5,
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
{
|
|
18
18
|
"name": "rate",
|
|
19
19
|
"kind": "travel",
|
|
20
|
-
"doc": "The chorus sweep's speed
|
|
20
|
+
"doc": "The chorus sweep's speed. Above ~3 Hz it stops being a chorus and becomes a vibrato.",
|
|
21
21
|
"travel": {
|
|
22
22
|
"min": 0.05,
|
|
23
23
|
"max": 8,
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
{
|
|
31
31
|
"name": "depth",
|
|
32
32
|
"kind": "travel",
|
|
33
|
-
"doc": "The chorus's peak-to-peak excursion above its declared 10 ms base
|
|
33
|
+
"doc": "The chorus's peak-to-peak excursion above its declared 10 ms base.",
|
|
34
34
|
"travel": {
|
|
35
35
|
"min": 0,
|
|
36
36
|
"max": 12,
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
{
|
|
44
44
|
"name": "voices",
|
|
45
45
|
"kind": "travel",
|
|
46
|
-
"doc": "The chorus's tap count — one oscillator read at k/N
|
|
46
|
+
"doc": "The chorus's tap count — one oscillator read at k/N.",
|
|
47
47
|
"travel": {
|
|
48
48
|
"min": 1,
|
|
49
49
|
"max": 4,
|
|
@@ -56,7 +56,7 @@
|
|
|
56
56
|
{
|
|
57
57
|
"name": "mix",
|
|
58
58
|
"kind": "travel",
|
|
59
|
-
"doc": "The chorus's wet/dry, as an instance of DRIVE_MIX_RANGE — the same percent travel, its own come-up value: 35 %, a colour under the dry on a strip
|
|
59
|
+
"doc": "The chorus's wet/dry, as an instance of DRIVE_MIX_RANGE — the same percent travel, its own come-up value: 35 %, a colour under the dry on a strip. The REVERB_LOWCUT_RANGE-over- REVERB_CUT_RANGE shape: one travel, one declared default per field that reads it.",
|
|
60
60
|
"travel": {
|
|
61
61
|
"min": 0,
|
|
62
62
|
"max": 100,
|
package/data/kernels/comp.json
CHANGED
|
@@ -127,7 +127,7 @@
|
|
|
127
127
|
"name": "detectorTopology",
|
|
128
128
|
"kind": "choice",
|
|
129
129
|
"global": "DETECTOR_TOPOLOGY",
|
|
130
|
-
"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
|
|
130
|
+
"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`) and comes up `feedforward`, so a zeroed atom is the compressor every slot runs.",
|
|
131
131
|
"ids": [
|
|
132
132
|
"feedforward",
|
|
133
133
|
"feedback"
|
|
@@ -158,7 +158,7 @@
|
|
|
158
158
|
"constants": {
|
|
159
159
|
"PROGRAM_RELEASE": {
|
|
160
160
|
"kind": "sheet",
|
|
161
|
-
"doc": "The program-dependent release's model constants — the LA-2A's opto cell as DATA
|
|
161
|
+
"doc": "The program-dependent release's model constants — the LA-2A's opto cell as DATA. `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.",
|
|
162
162
|
"value": {
|
|
163
163
|
"chargeMs": 1000,
|
|
164
164
|
"dischargeMs": 5000,
|
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
"name": "deessRange",
|
|
62
62
|
"kind": "travel",
|
|
63
63
|
"global": "DEESS_RANGE_RANGE",
|
|
64
|
-
"doc": "The FLOOR on the reduction, in dB and never positive — the deepest cut the stage may reach however loud the sibilant is (`mix_deesser.h`'s clamp
|
|
64
|
+
"doc": "The FLOOR on the reduction, in dB and never positive — the deepest cut the stage may reach however loud the sibilant is (`mix_deesser.h`'s clamp). 12 dB tames a hard sibilant; past that a voice starts to lisp, and a de-esser with NO floor turns a shouted \"s\" into a hole. The ceiling is 0, which switches the reduction off without switching the stage off — a legitimate thing to want while dialling the band in by ear.",
|
|
65
65
|
"travel": {
|
|
66
66
|
"min": -24,
|
|
67
67
|
"max": 0,
|
package/data/kernels/delay.json
CHANGED
|
@@ -84,7 +84,7 @@
|
|
|
84
84
|
"constants": {
|
|
85
85
|
"FX_DELAY_PINGPONG_DEFAULT": {
|
|
86
86
|
"kind": "scalar",
|
|
87
|
-
"doc": "The FX delay's PING-PONG come-up value — a toggle, so it has no travel, only this. Declared here rather than as a literal in the console's delay default state (which now reads it) so the DPF plugin generator (omx-plugins
|
|
87
|
+
"doc": "The FX delay's PING-PONG come-up value — a toggle, so it has no travel, only this. Declared here rather than as a literal in the console's delay default state (which now reads it) so the DPF plugin generator (omx-plugins) reads the same fact the desk seeds a fresh strip with.",
|
|
88
88
|
"unit": "",
|
|
89
89
|
"value": false
|
|
90
90
|
}
|
package/data/kernels/drive.json
CHANGED
|
@@ -121,7 +121,7 @@
|
|
|
121
121
|
{
|
|
122
122
|
"name": "autoGain",
|
|
123
123
|
"kind": "choice",
|
|
124
|
-
"doc": "The drive's AUTO-GAIN switch: on, the stage measures its own level change and matches it out (`omx_drive.h`'s `struct omx_drive.auto_gain
|
|
124
|
+
"doc": "The drive's AUTO-GAIN switch: on, the stage measures its own level change and matches it out (`omx_drive.h`'s `struct omx_drive.auto_gain`), so turning the drive up adds colour rather than loudness. A field of the console's drive row (`DriveState.autoGain`), on at come-up there and in omx-dsp's drive face.",
|
|
125
125
|
"ids": [
|
|
126
126
|
"off",
|
|
127
127
|
"on"
|
|
@@ -135,7 +135,7 @@
|
|
|
135
135
|
{
|
|
136
136
|
"name": "stereoLink",
|
|
137
137
|
"kind": "choice",
|
|
138
|
-
"doc": "The drive's STEREO LINK switch: on, ONE auto-gain path is driven by both legs' summed energy, so the image cannot shift under the level match; off, each leg matches its own (`omx_drive.h`'s `struct omx_drive.stereo_link
|
|
138
|
+
"doc": "The drive's STEREO LINK switch: on, ONE auto-gain path is driven by both legs' summed energy, so the image cannot shift under the level match; off, each leg matches its own (`omx_drive.h`'s `struct omx_drive.stereo_link`). A field of the console's drive row (`DriveState.stereoLink`), on at come-up there and in omx-dsp's drive face.",
|
|
139
139
|
"ids": [
|
|
140
140
|
"off",
|
|
141
141
|
"on"
|
|
@@ -188,7 +188,7 @@
|
|
|
188
188
|
"constants": {
|
|
189
189
|
"DRIVE_BIAS_MAX": {
|
|
190
190
|
"kind": "scalar",
|
|
191
|
-
"doc": "The bias at `character = +1`, in the SHAPER's own input units — `OMX_DRIVE_BIAS_MAX`. DERIVED, not chosen
|
|
191
|
+
"doc": "The bias at `character = +1`, in the SHAPER's own input units — `OMX_DRIVE_BIAS_MAX`. DERIVED, not chosen. In the saturating limit every knee tends to `sgn`, the output is a rectangular wave of duty `d = ½ + asin(b)/π`, and its `n`th harmonic goes as `sin(nπd)/n` — so `|H2|` is maximal at `d = ¾`, which is `b = sin(π/4) = 1/√2` exactly. Measured too: the H2-maximising bias for a full-scale sine at unity drive is 0.712 (soft), 0.658 (tape), 0.645 (tube), and this one value costs 0.000 / 0.035 / 0.088 dB of H2 against each curve's own optimum. ONE normalised bias for all three knees, not three.",
|
|
192
192
|
"unit": "",
|
|
193
193
|
"value": {
|
|
194
194
|
"derive": "sqrt",
|
package/data/kernels/eq.json
CHANGED
|
@@ -207,7 +207,7 @@
|
|
|
207
207
|
},
|
|
208
208
|
"GEQ_BANDS": {
|
|
209
209
|
"kind": "scalar",
|
|
210
|
-
"doc": "The graphic EQ's section count: DERIVED from ISO_THIRD_OCTAVE_CENTRES_HZ, never a second literal. Generated into `omx_contract_limits.h` as `OMX_GEQ_BANDS`, which sizes `mix_geq.h`'s section array — its OWN budget, never a claimant on EQ_MAX_BANDS (
|
|
210
|
+
"doc": "The graphic EQ's section count: DERIVED from ISO_THIRD_OCTAVE_CENTRES_HZ, never a second literal. Generated into `omx_contract_limits.h` as `OMX_GEQ_BANDS`, which sizes `mix_geq.h`'s section array — its OWN budget, never a claimant on EQ_MAX_BANDS (roster ruling 3).",
|
|
211
211
|
"unit": "",
|
|
212
212
|
"value": {
|
|
213
213
|
"derive": "count",
|
package/data/kernels/fbs.json
CHANGED
|
@@ -69,7 +69,7 @@
|
|
|
69
69
|
},
|
|
70
70
|
"GROWTH_MIN_DB_PER_FRAME": {
|
|
71
71
|
"kind": "scalar",
|
|
72
|
-
"doc": "Minimum least-squares slope, in dB PER FRAME, over GROWTH_WINDOW_FRAMES for a bin to count as \"running away\" rather than merely holding level. Set with real margin on BOTH sides — comfortably above measurement jitter on a held tone or a quiet/broadband mix (well under 0.2 dB/frame in practice) and comfortably below a genuine feedback ramp, which climbs several dB across a handful of ~20 ms hops as it heads toward clipping.
|
|
72
|
+
"doc": "Minimum least-squares slope, in dB PER FRAME, over GROWTH_WINDOW_FRAMES for a bin to count as \"running away\" rather than merely holding level. Set with real margin on BOTH sides — comfortably above measurement jitter on a held tone or a quiet/broadband mix (well under 0.2 dB/frame in practice) and comfortably below a genuine feedback ramp, which climbs several dB across a handful of ~20 ms hops as it heads toward clipping. The acceptance bar is \"arming must never burst-alarm on non-growing content\", so this errs conservative (under-fire a marginal ramp) rather than tight (risk a false alarm) — the ramp gate (`omx_fbs_is_growing`) also requires the window's end to sit above its start, a cheap belt-and-braces check against a fit dragged positive by one mid-window wobble.",
|
|
73
73
|
"unit": "dB",
|
|
74
74
|
"value": 0.8
|
|
75
75
|
},
|
|
@@ -81,19 +81,19 @@
|
|
|
81
81
|
},
|
|
82
82
|
"GROWTH_MIN_TOTAL_RISE_DB": {
|
|
83
83
|
"kind": "scalar",
|
|
84
|
-
"doc": "Minimum END-TO-END rise (dB) across the window. The live-music corpus
|
|
84
|
+
"doc": "Minimum END-TO-END rise (dB) across the window. The live-music corpus showed sustained melody notes drifting up ~4–5 dB over a window without ever being feedback; a loop past unity gains several dB per hop and clears 6 dB in a window trivially. Below this the tone is holding level, not running away.",
|
|
85
85
|
"unit": "dB",
|
|
86
86
|
"value": 6
|
|
87
87
|
},
|
|
88
88
|
"GROWTH_MAX_SINGLE_FRAME_SHARE": {
|
|
89
89
|
"kind": "scalar",
|
|
90
|
-
"doc": "Cap on the share of the window's total rise a SINGLE frame may carry. Feedback is exponential in amplitude ⇒ linear in dB ⇒ its rise is distributed roughly evenly across the window; a musical attack / re-articulation puts almost the whole rise in one hop (the exact shape behind every one of
|
|
90
|
+
"doc": "Cap on the share of the window's total rise a SINGLE frame may carry. Feedback is exponential in amplitude ⇒ linear in dB ⇒ its rise is distributed roughly evenly across the window; a musical attack / re-articulation puts almost the whole rise in one hop (the exact shape behind every one of the 72 live false positives of the live-music corpus). One half is generous to real ramps (an even N-frame ramp puts 1/(N−1) per hop) and fatal to steps. A side effect worth knowing: a 2-sample window can never pass (one hop IS the whole rise), so confirmation always rests on at least three frames of actual ramp evidence.",
|
|
91
91
|
"unit": "",
|
|
92
92
|
"value": 0.5
|
|
93
93
|
},
|
|
94
94
|
"GROWTH_CONFIRM_FRAMES": {
|
|
95
95
|
"kind": "scalar",
|
|
96
|
-
"doc": "How many CONSECUTIVE frames the ramp gate (`omx_fbs_is_growing`) must hold before a bin confirms — the time-domain tiebreak for the one shape a single window cannot judge
|
|
96
|
+
"doc": "How many CONSECUTIVE frames the ramp gate (`omx_fbs_is_growing`) must hold before a bin confirms — the time-domain tiebreak for the one shape a single window cannot judge: a smooth musical crescendo. Within one window a +6 dB swell (live corpus: a C6 at 1 049 Hz, `[-53.7, -51.4, -50.4, -48, -47.3]`) is indistinguishable from slow feedback — the difference is only visible on the NEXT hop, where a crescendo peaks and plateaus (the window's rise collapses) while feedback keeps climbing. Requiring the gate to hold twice in a row costs a clean ramp nothing — its gate is already true while persistence is still arming — and blocks the swell that peaks the very frame it would have confirmed.",
|
|
97
97
|
"unit": "",
|
|
98
98
|
"value": 2
|
|
99
99
|
},
|
|
@@ -130,7 +130,7 @@
|
|
|
130
130
|
},
|
|
131
131
|
"FBS_MAX_NOTCH_DEPTH_DB": {
|
|
132
132
|
"kind": "scalar",
|
|
133
|
-
"doc": "THE NOTCH DEPTH LAW: the deepest cut any machine planter may propose from one reading, in dB. A number, not a literal at the call site, because two planters now lean on it. FBS derives a candidate's depth from the peak-to-average ratio around its bin and stops here; Room Analysis derives a mode's depth from its height above the median curve and is held to the SAME ceiling (the room-analysis design
|
|
133
|
+
"doc": "THE NOTCH DEPTH LAW: the deepest cut any machine planter may propose from one reading, in dB. A number, not a literal at the call site, because two planters now lean on it. FBS derives a candidate's depth from the peak-to-average ratio around its bin and stops here; Room Analysis derives a mode's depth from its height above the median curve and is held to the SAME ceiling (the room-analysis design — \"never more than the FBS notch depth law\"). Written twice as `18` those two bounds would be equal by coincidence and could drift apart in silence. It is a CEILING ON THE PROPOSAL, not the final gain: a band that lands as a rampable BELL is bounded again by `EQ_GAIN_RANGE`, which is tighter. A planter must honour both and REPORT when either bit, never quietly deliver a shallower cut than it was asked for.",
|
|
134
134
|
"unit": "dB",
|
|
135
135
|
"value": 18
|
|
136
136
|
},
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
{
|
|
5
5
|
"name": "rate",
|
|
6
6
|
"kind": "travel",
|
|
7
|
-
"doc": "The flanger's jet sweep
|
|
7
|
+
"doc": "The flanger's jet sweep.",
|
|
8
8
|
"travel": {
|
|
9
9
|
"min": 0.05,
|
|
10
10
|
"max": 5,
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
{
|
|
18
18
|
"name": "depth",
|
|
19
19
|
"kind": "travel",
|
|
20
|
-
"doc": "The flanger's peak-to-peak excursion above its declared 0.5 ms base
|
|
20
|
+
"doc": "The flanger's peak-to-peak excursion above its declared 0.5 ms base.",
|
|
21
21
|
"travel": {
|
|
22
22
|
"min": 0,
|
|
23
23
|
"max": 5,
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
{
|
|
31
31
|
"name": "feedback",
|
|
32
32
|
"kind": "travel",
|
|
33
|
-
"doc": "The flanger's SIGNED resonance
|
|
33
|
+
"doc": "The flanger's SIGNED resonance. The ±0.95 clamp is DECLARED here — a PATCH asking for 1.0 is answered by this travel — and the kernel's own clamp is the enforcement half.",
|
|
34
34
|
"travel": {
|
|
35
35
|
"min": -0.95,
|
|
36
36
|
"max": 0.95,
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
{
|
|
44
44
|
"name": "mix",
|
|
45
45
|
"kind": "travel",
|
|
46
|
-
"doc": "The flanger's wet/dry, as an instance of DRIVE_MIX_RANGE: 50 %, equal dry and wet, where the comb is deepest
|
|
46
|
+
"doc": "The flanger's wet/dry, as an instance of DRIVE_MIX_RANGE: 50 %, equal dry and wet, where the comb is deepest.",
|
|
47
47
|
"travel": {
|
|
48
48
|
"min": 0,
|
|
49
49
|
"max": 100,
|
package/data/kernels/geq.json
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
{
|
|
5
5
|
"name": "band",
|
|
6
6
|
"kind": "travel",
|
|
7
|
-
"doc": "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
|
|
7
|
+
"doc": "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.",
|
|
8
8
|
"travel": {
|
|
9
9
|
"min": -15,
|
|
10
10
|
"max": 15,
|
|
@@ -19,19 +19,19 @@
|
|
|
19
19
|
"constants": {
|
|
20
20
|
"GEQ_BAND_Q": {
|
|
21
21
|
"kind": "scalar",
|
|
22
|
-
"doc": "The graphic EQ's band Q: the ISO third-octave bandwidth, `2^(1/6)/(2^(1/3) − 1) ≈ 4.318`, to one decimal as the M32 GEQ carries it. Read by the `geq31` preset and the graphic EQ's section design
|
|
22
|
+
"doc": "The graphic EQ's band Q: the ISO third-octave bandwidth, `2^(1/6)/(2^(1/3) − 1) ≈ 4.318`, to one decimal as the M32 GEQ carries it. Read by the `geq31` preset and the graphic EQ's section design.",
|
|
23
23
|
"unit": "",
|
|
24
24
|
"value": 4.3
|
|
25
25
|
},
|
|
26
26
|
"GEQ_PROTO_DB": {
|
|
27
27
|
"kind": "scalar",
|
|
28
|
-
"doc": "The prototype gain the `true` solve's first interaction matrix is evaluated at
|
|
28
|
+
"doc": "The prototype gain the `true` solve's first interaction matrix is evaluated at: the middle of the travel's magnitude, where a matched-Z section's dB response per dB of gain is closest to its average.",
|
|
29
29
|
"unit": "dB",
|
|
30
30
|
"value": 12
|
|
31
31
|
},
|
|
32
32
|
"GEQ_DESIGN_GAIN_MAX_DB": {
|
|
33
33
|
"kind": "scalar",
|
|
34
|
-
"doc": "The ceiling on a section gain the `true` solve may ask for
|
|
34
|
+
"doc": "The ceiling on a section gain the `true` solve may ask for: above the travel's worst case (26.0 dB, the alternating ±15 set) with margin. A solve past it clamps and the row says so (`designClamped`), never silently.",
|
|
35
35
|
"unit": "dB",
|
|
36
36
|
"value": 30
|
|
37
37
|
}
|
package/data/kernels/hrp.json
CHANGED
|
@@ -36,31 +36,31 @@
|
|
|
36
36
|
},
|
|
37
37
|
"HRP_EXCESS_THRESHOLD_DB": {
|
|
38
38
|
"kind": "scalar",
|
|
39
|
-
"doc": "How far a partial must stand above its LEARNED BASELINE before HRP calls it a resonance (increment 8
|
|
39
|
+
"doc": "How far a partial must stand above its LEARNED BASELINE before HRP calls it a resonance (increment 8: `deviation = measured − baseline[note][harmonic]`). A partial level tells you nothing on its own; what marks a resonance is a partial louder than THIS instrument normally measures at THIS note. Three decibels is the same order as the feedback detector's peak-to-neighbour gate and for the same reason: below it, an ordinary performance's variation — a bow dug in, a verse sung harder — would be flattened, and flattening expression is not correcting a room. (Before the learned model existed this same threshold gated the placeholder neighbour rule; the number and its reasoning carried over.)",
|
|
40
40
|
"unit": "dB",
|
|
41
41
|
"value": 3
|
|
42
42
|
},
|
|
43
43
|
"HRP_GAIN_STEP_DB": {
|
|
44
44
|
"kind": "scalar",
|
|
45
|
-
"doc": "How far ONE reconcile pass may move an HRP band's gain, in dB —
|
|
45
|
+
"doc": "How far ONE reconcile pass may move an HRP band's gain, in dB — the gain smoothing, done at the control level because the native cascade applies pushed coefficients verbatim and the design forbids interpolating there. An unbounded gain step is a waveform discontinuity — the click heard when a correction entered or left at full depth (found live, 2026-08-20, the evening increment 9 raised the enter/leave rate). Bounded, a correction ENTERS by deepening from silence and LEAVES by walking to exactly 0 dB — the provable parked identity (`eqBandIsIdentity`) — from which removal is bit-identical. Two decibels per pass at the corrector's 10 Hz cadence walks the full HRP_MAX_CUT_DB travel in ~300 ms: the same order as the tracker's stability hold and FBS's lift steps, while each individual move stays below audibility on a Q-5 bell.",
|
|
46
46
|
"unit": "dB",
|
|
47
47
|
"value": 2
|
|
48
48
|
},
|
|
49
49
|
"HRP_COLLISION_CENTS": {
|
|
50
50
|
"kind": "scalar",
|
|
51
|
-
"doc": "How close two correction candidates must sit, in cents, to count as the SAME spectral region
|
|
51
|
+
"doc": "How close two correction candidates must sit, in cents, to count as the SAME spectral region: within it, the stronger candidate is selected and the weaker discarded rather than two near-identical filters being planted. One semitone, and the number follows from HRP_BAND_Q: a Q-5 bell's −3 dB half-width is ~170 cents, so two cuts a semitone apart overlap over most of their travel — the second one deepens the first far more than it shapes anything of its own. The design makes the threshold configurable and tested: declared once here, a parameter everywhere below.",
|
|
52
52
|
"unit": "cents",
|
|
53
53
|
"value": 100
|
|
54
54
|
},
|
|
55
55
|
"HRP_ATTRIBUTION_CENTS": {
|
|
56
56
|
"kind": "scalar",
|
|
57
|
-
"doc": "The ATTRIBUTION window
|
|
57
|
+
"doc": "The ATTRIBUTION window: two partials closer than this are one spectral event as far as the desk can tell — the same ±1 bin `omx_hrp_bin_peak` reads over, expressed musically so it holds across the range. A different law from HRP_COLLISION_CENTS (the SELECTION window, which stays above it): this one is the analyser's resolution, that one the corrector's. Generated into `omx_contract_limits.h` as `OMX_HRP_ATTRIBUTION_CENTS`; `hrp_attribute.h` reads it.",
|
|
58
58
|
"unit": "cents",
|
|
59
59
|
"value": 60
|
|
60
60
|
},
|
|
61
61
|
"HRP_DEFAULT_MAX_AUTO_BANDS": {
|
|
62
62
|
"kind": "scalar",
|
|
63
|
-
"doc": "How many bands HRP may plant on ONE channel — its half of the machine budget, and the number that makes the budget FORECASTABLE rather than emergent. Without it the count is whatever the material happens to provoke: the placement law is sparse, so a clean note plants two bands and a resonant room plants nine, and nobody can answer \"will this fit?\" until it does not. With FBS senior
|
|
63
|
+
"doc": "How many bands HRP may plant on ONE channel — its half of the machine budget, and the number that makes the budget FORECASTABLE rather than emergent. Without it the count is whatever the material happens to provoke: the placement law is sparse, so a clean note plants two bands and a resonant room plants nine, and nobody can answer \"will this fit?\" until it does not. With FBS senior that discovery would happen at showtime, to the junior planter, silently. Declared instead, the whole sum is arithmetic an operator can read before a note is played: operator bands + FBS maxAutoBands + HRP maxAutoBands <= EQ_MAX_BANDS EIGHT — ONE CORRECTION PER VOICE at full polyphony (operator sizing, 2026-09-01). The detector's ceiling is HRP_MAX_VOICES voices, a guitar's six strings and a piano/string voicing's eight, and a budget below the voice count would decide by arithmetic which of the notes actually sounding may be corrected — a limit nobody could read off the desk. Scarcity is handled where it belongs instead: the candidates from every voice meet in ONE globally ranked list and the head of it is what gets planted. It is NOT a claim to seniority, and it is larger than FBS's six. Seniority is the ALLOCATION ORDER — `HrpPlanter` takes only `EQ_MAX_BANDS − others.length`, the remainder after the operator and every other machine — so a bigger junior default cannot reach a senior slot; it only means HRP asks for more of what is left. the engine's conformance test asserts both halves. The per-channel DEFAULT; the row's travel is HRP_AUTO_BANDS_RANGE, so a channel that needs more can have more, as an explicit decision with a visible cost.",
|
|
64
64
|
"unit": "",
|
|
65
65
|
"value": 8
|
|
66
66
|
}
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"constants": {
|
|
4
4
|
"BUS_INPUT_CAP": {
|
|
5
5
|
"kind": "scalar",
|
|
6
|
-
"doc": "The input cap a summing bus can be sized to — **the engine's declared input ceiling**, read from
|
|
6
|
+
"doc": "The input cap a summing bus can be sized to — **the engine's declared input ceiling**, read from the engine's declarations rather than re-typed here. A gig with more than this many inputs needs more than one engine node; below it a bus is sized to `min(N, BUS_INPUT_CAP)`. It was a literal 64 until 2026-09-15, said to mirror the engine's `MAX_BUS_INPUTS` — and it did, but that 64 was the PipeWire builtin mixer's single-tier fan-in (8 × 8), never the engine's bound: the native node has allocated `OMX_MAX_STRIPS` (128) strips all along. Two literals agreeing by hand is how the console came to refuse a 96-channel desk it could carry. the engine's conformance test holds this to the C header; the console allocation design carries the ruling and the measured cost of width.",
|
|
7
7
|
"unit": "",
|
|
8
8
|
"value": 128
|
|
9
9
|
}
|
package/data/kernels/phaser.json
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
"name": "rateHz",
|
|
6
6
|
"kind": "travel",
|
|
7
7
|
"global": "PHASER_RATE_RANGE",
|
|
8
|
-
"doc": "The phaser's sweep speed
|
|
8
|
+
"doc": "The phaser's sweep speed. `omx_lfo_inc` freezes at Nyquist; this travel stays far below.",
|
|
9
9
|
"travel": {
|
|
10
10
|
"min": 0.05,
|
|
11
11
|
"max": 5,
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"name": "baseHz",
|
|
20
20
|
"kind": "travel",
|
|
21
21
|
"global": "PHASER_BASE_RANGE",
|
|
22
|
-
"doc": "The phaser's lowest centre frequency; the sweep runs upward from it
|
|
22
|
+
"doc": "The phaser's lowest centre frequency; the sweep runs upward from it.",
|
|
23
23
|
"travel": {
|
|
24
24
|
"min": 50,
|
|
25
25
|
"max": 2000,
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
"name": "depthOct",
|
|
34
34
|
"kind": "travel",
|
|
35
35
|
"global": "PHASER_DEPTH_RANGE",
|
|
36
|
-
"doc": "The sweep's span above `base`, in octaves; 0 is a static phaser at `base
|
|
36
|
+
"doc": "The sweep's span above `base`, in octaves; 0 is a static phaser at `base`.",
|
|
37
37
|
"travel": {
|
|
38
38
|
"min": 0,
|
|
39
39
|
"max": 6,
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
{
|
|
47
47
|
"name": "stages",
|
|
48
48
|
"kind": "travel",
|
|
49
|
-
"doc": "The phaser's section count per leg — EVEN, 2 … 12 (
|
|
49
|
+
"doc": "The phaser's section count per leg — EVEN, 2 … 12 (two sections per notch). Its ends are the kernel's state capacity (`OMX_PHASER_MAX_STAGES` reads `OMX_PHASER_STAGES_RANGE_MAX`); the row moves it through the closed member set PHASER_STAGE_COUNTS, which is derived from it.",
|
|
50
50
|
"travel": {
|
|
51
51
|
"min": 2,
|
|
52
52
|
"max": 12,
|
|
@@ -59,7 +59,7 @@
|
|
|
59
59
|
{
|
|
60
60
|
"name": "feedback",
|
|
61
61
|
"kind": "travel",
|
|
62
|
-
"doc": "The phaser's SIGNED resonance
|
|
62
|
+
"doc": "The phaser's SIGNED resonance. ±0.9, tighter than the flanger's ±0.95: the loop runs through a time-varying chain. Declared here (the refusal half); the kernel's clamp is the enforcement half.",
|
|
63
63
|
"travel": {
|
|
64
64
|
"min": -0.9,
|
|
65
65
|
"max": 0.9,
|
|
@@ -72,7 +72,7 @@
|
|
|
72
72
|
{
|
|
73
73
|
"name": "mix",
|
|
74
74
|
"kind": "travel",
|
|
75
|
-
"doc": "The phaser's wet/dry, as an instance of DRIVE_MIX_RANGE: 50 %, where the notch is complete
|
|
75
|
+
"doc": "The phaser's wet/dry, as an instance of DRIVE_MIX_RANGE: 50 %, where the notch is complete.",
|
|
76
76
|
"travel": {
|
|
77
77
|
"min": 0,
|
|
78
78
|
"max": 100,
|
|
@@ -85,7 +85,7 @@
|
|
|
85
85
|
],
|
|
86
86
|
"aggregates": {
|
|
87
87
|
"PHASER_TRAVELS": {
|
|
88
|
-
"doc": "The phaser's continuous travels by row field — the ONE map its control bounds and its row travels both read
|
|
88
|
+
"doc": "The phaser's continuous travels by row field — the ONE map its control bounds and its row travels both read. `stages` is not here: it moves through PHASER_STAGE_COUNTS.",
|
|
89
89
|
"fields": [
|
|
90
90
|
"rateHz",
|
|
91
91
|
"baseHz",
|
package/data/kernels/pitch.json
CHANGED
|
@@ -8,7 +8,10 @@
|
|
|
8
8
|
"travel": {
|
|
9
9
|
"min": -12,
|
|
10
10
|
"max": 12,
|
|
11
|
-
"
|
|
11
|
+
"step": 1,
|
|
12
|
+
"unit": "st",
|
|
13
|
+
"default": 0,
|
|
14
|
+
"defaultFrom": "desk"
|
|
12
15
|
}
|
|
13
16
|
},
|
|
14
17
|
{
|
|
@@ -18,7 +21,10 @@
|
|
|
18
21
|
"travel": {
|
|
19
22
|
"min": -50,
|
|
20
23
|
"max": 50,
|
|
21
|
-
"
|
|
24
|
+
"step": 1,
|
|
25
|
+
"unit": "cents",
|
|
26
|
+
"default": 0,
|
|
27
|
+
"defaultFrom": "desk"
|
|
22
28
|
}
|
|
23
29
|
},
|
|
24
30
|
{
|
|
@@ -28,7 +34,10 @@
|
|
|
28
34
|
"travel": {
|
|
29
35
|
"min": 0,
|
|
30
36
|
"max": 100,
|
|
31
|
-
"
|
|
37
|
+
"step": 0.1,
|
|
38
|
+
"unit": "%",
|
|
39
|
+
"default": 100,
|
|
40
|
+
"defaultFrom": "desk"
|
|
32
41
|
}
|
|
33
42
|
}
|
|
34
43
|
],
|
package/data/kernels/rotary.json
CHANGED
|
@@ -86,7 +86,7 @@
|
|
|
86
86
|
{
|
|
87
87
|
"name": "mix",
|
|
88
88
|
"kind": "travel",
|
|
89
|
-
"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
|
|
89
|
+
"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.",
|
|
90
90
|
"travel": {
|
|
91
91
|
"min": 0,
|
|
92
92
|
"max": 100,
|
|
@@ -69,31 +69,31 @@
|
|
|
69
69
|
],
|
|
70
70
|
"tables": {
|
|
71
71
|
"TRANSIENT_LIMITS": {
|
|
72
|
-
"doc": "The legal range of each transient-designer field (engineering units)
|
|
72
|
+
"doc": "The legal range of each transient-designer field (engineering units). Every kind comes up flat: no per-kind default differs. the engine's limits generator emits each as `OMX_TRANSIENT_<FIELD>_{MIN,MAX,DEFAULT}` for `mix_transient.h`'s resolve; the row publishes them on OPTIONS when it lands."
|
|
73
73
|
}
|
|
74
74
|
},
|
|
75
75
|
"constants": {
|
|
76
76
|
"TRANSIENT_FAST_ATTACK_MS": {
|
|
77
77
|
"kind": "scalar",
|
|
78
|
-
"doc": "The fast follower's attack, ms: exactly the dynamics detector's no-oversampling line
|
|
78
|
+
"doc": "The fast follower's attack, ms: exactly the dynamics detector's no-oversampling line.",
|
|
79
79
|
"unit": "ms",
|
|
80
80
|
"value": 0.5
|
|
81
81
|
},
|
|
82
82
|
"TRANSIENT_FAST_RELEASE_MS": {
|
|
83
83
|
"kind": "scalar",
|
|
84
|
-
"doc": "The fast follower's release, ms: one 50 Hz cycle held, a 180 bpm sixteenth forgotten
|
|
84
|
+
"doc": "The fast follower's release, ms: one 50 Hz cycle held, a 180 bpm sixteenth forgotten.",
|
|
85
85
|
"unit": "ms",
|
|
86
86
|
"value": 20
|
|
87
87
|
},
|
|
88
88
|
"TRANSIENT_REF_DB": {
|
|
89
89
|
"kind": "scalar",
|
|
90
|
-
"doc": "The contrast, dB, at which a knob reaches its full value
|
|
90
|
+
"doc": "The contrast, dB, at which a knob reaches its full value.",
|
|
91
91
|
"unit": "dB",
|
|
92
92
|
"value": 6
|
|
93
93
|
},
|
|
94
94
|
"TRANSIENT_FLOOR_LIN": {
|
|
95
95
|
"kind": "scalar",
|
|
96
|
-
"doc": "The detector floor, linear (−100 dBFS): below it both envelopes read the floor and the stage is unity
|
|
96
|
+
"doc": "The detector floor, linear (−100 dBFS): below it both envelopes read the floor and the stage is unity.",
|
|
97
97
|
"unit": "",
|
|
98
98
|
"value": 0.00001
|
|
99
99
|
}
|
package/data/primitives.json
CHANGED
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
},
|
|
30
30
|
"FDELAY_MOD_READ_ORDER": {
|
|
31
31
|
"kind": "scalar",
|
|
32
|
-
"doc": "The order the chorus and flanger construct their lines with (four taps
|
|
32
|
+
"doc": "The order the chorus and flanger construct their lines with (four taps).",
|
|
33
33
|
"unit": "",
|
|
34
34
|
"value": 3
|
|
35
35
|
},
|