@openmixer/omx-contract 1.2.1 → 1.3.0

package/render/c.mjs

@@ -4,17 +4,13 @@
  * The `c` target: `omxcontract/omx_contract_limits.h`. Every define is spelled by openmixer's
  * renderer, moved unchanged (c/contract-limits-render.mjs); only the frame (banner, section
  * comments) is this repository's. A plugin's parameter header is rendered by omx-plugins from its
- * declaration; c/params-generate.mjs stays here only for renderSheetC, the frozen fixture of the
- * round-trip proof.
+ * declaration, by reference to the items here.
  */
-import { readFileSync } from 'node:fs';
 import {
   genCoreLimitBlock, genDeclaredListsBlock, genDeclaredRates, genDeclaredScalarsBlock, genLimitBlock, renderContractLimits,
 } from './c/contract-limits-render.mjs';
-import { generate } from './c/params-generate.mjs';
 import { doors } from './doors.mjs';
 
-const PLUGIN_PARAM_H = readFileSync(new URL('./c/omx_plugin_param.h', import.meta.url), 'utf8');
 const defined = (text) => new Set([...text.matchAll(/^#define (OMX_\w+)/gm)].map((m) => m[1]));
 
 /** The rate tail of openmixer's header, outside the include guard, byte for byte. */
@@ -39,6 +35,71 @@ static inline int omx_declared_rates_multiple_of(unsigned base, int *out, int ca
 `;
 }
 
+const constCase = (s) => String(s).replace(/([a-z0-9])([A-Z])/g, '$1_$2').toUpperCase();
+
+/** The enumerator names of one set, in order: `OMX_<SET>_<ID>`. */
+export const setEnumerators = (set) => set.ids.map((id) => `OMX_${set.name}_${constCase(id)}`);
+
+/**
+ * Every set as a C enum: the id's position is its value for named ids, the number itself for numeric
+ * ids; `OMX_<SET>_COUNT`, and `OMX_<SET>_DEFAULT` when the set names a default.
+ */
+function genDeclaredSetsEnums(sets) {
+  return sets.map((set) => {
+    const names = setEnumerators(set);
+    const numeric = typeof set.ids[0] === 'number';
+    const members = set.ids.map((id, i) => `  ${names[i]} = ${numeric ? id : i},`);
+    const lines = [`enum omx_${set.name.toLowerCase()} {`, ...members, '};', `#define OMX_${set.name}_COUNT ${set.ids.length}u`];
+    if (set.default !== undefined) lines.push(`#define OMX_${set.name}_DEFAULT ${names[set.ids.indexOf(set.default)]}`);
+    return lines.join('\n');
+  }).join('\n');
+}
+
+/**
+ * The default band centres of an EQ (lib/eq-defaults.mjs is the rule; this is its C spelling, held
+ * equal to it for every count by test/eq-defaults.test.mjs). Writes \`count\` centres to \`out\` and returns
+ * \`count\`, or returns 0 for a count that is 0 or has no distinct preferred centres.
+ */
+function eqCentresFunction() {
+  return `static inline unsigned omx_eq_default_centres(unsigned count, float *out) {
+  static const double r10[] = OMX_ISO_THIRD_OCTAVE_CENTRES_HZ_INIT;
+  static const double r20[] = OMX_EQ_CENTRE_SERIES_R20_HZ_INIT;
+  static const double four[] = OMX_EQ_DEFAULT_CENTRES_FOUR_BAND_HZ_INIT;
+  if (count == 0) return 0;
+  if (count == 4) {
+    for (unsigned i = 0; i < 4; i++) out[i] = (float)four[i];
+    return 4;
+  }
+  const double lo = log((double)OMX_EQ_FREQ_RANGE_MIN);
+  const double span = log((double)OMX_EQ_FREQ_RANGE_MAX / (double)OMX_EQ_FREQ_RANGE_MIN);
+  for (unsigned s = 0; s < 2; s++) {
+    const double *series = s ? r20 : r10;
+    const unsigned n = s ? OMX_EQ_CENTRE_SERIES_R20_HZ_COUNT : OMX_ISO_THIRD_OCTAVE_CENTRES_HZ_COUNT;
+    int distinct = count <= n;
+    for (unsigned i = 0; distinct && i < count; i++) {
+      const double t = lo + span * ((double)i + 0.5) / (double)count;
+      unsigned best = 0;
+      double best_d = 1e300;
+      for (unsigned k = 0; k < n; k++) {
+        const double d = fabs(log(series[k]) - t);
+        if (d < best_d) { best_d = d; best = k; }
+      }
+      out[i] = (float)series[best];
+      if (i > 0 && out[i] == out[i - 1]) distinct = 0;
+    }
+    if (distinct) return count;
+  }
+  return 0;
+}
+
+/* The default type of band \`index\` of an EQ with \`count\` bands: a low shelf first, a high shelf last, bells
+ * between (a single band is a bell). An OMX_EQ_BAND_TYPES_* member. */
+static inline int omx_eq_default_type(unsigned index, unsigned count) {
+  if (count < 2) return OMX_EQ_BAND_TYPES_BELL;
+  return index == 0 ? OMX_EQ_BAND_TYPES_LOW_SHELF : index == count - 1 ? OMX_EQ_BAND_TYPES_HIGH_SHELF : OMX_EQ_BAND_TYPES_BELL;
+}`;
+}
+
 /** The limits header of the resolved data. */
 export function renderLimitsHeader(resolved) {
   const d = doors(resolved);
@@ -48,6 +109,8 @@ export function renderLimitsHeader(resolved) {
   const above = defined([tables, aliases].join('\n'));
   const scalars = d.DECLARED_SCALARS.length ? genDeclaredScalarsBlock(d.DECLARED_SCALARS, above) : '';
   const lists = d.DECLARED_LISTS.length ? genDeclaredListsBlock(d.DECLARED_LISTS, defined([tables, aliases, scalars].join('\n'))) : '';
+  const sets = d.DECLARED_SET_ITEMS.length ? genDeclaredSetsEnums(d.DECLARED_SET_ITEMS) : '';
+  const centres = resolved.has('EQ_DEFAULT_CENTRES_FOUR_BAND_HZ') ? eqCentresFunction() : '';
   const sections = [
     [tables, `/* Per-parameter numeric travel, one block per \`travels\` table named <PREFIX>_LIMITS:
  * OMX_<PREFIX>_<FIELD>_MIN/_MAX/_DEFAULT, float literals. */`],
@@ -56,11 +119,16 @@ export function renderLimitsHeader(resolved) {
     [scalars, `/* Every scalar, sheet leaf and single travel's numbers, one block sorted by macro. An integer value
  * is an integer literal, any other a float literal AND its OMX_<macro>_DOUBLE spelling. */`],
     [lists, `/* Every list rendered to C, sorted by list: OMX_<LIST>_COUNT and OMX_<LIST>_INIT { a, b, … }. */`],
+    [sets, `/* Every set rendered to C, sorted by set: an enum of the ids (a named id's position, or a numeric id's number), \`OMX_<SET>_COUNT\` and,
+ * where the set names a default, \`OMX_<SET>_DEFAULT\`. */`],
+    [centres, `/* The default bands of an EQ with \`count\` bands: THE one rule, for every strip, host and count (omx-contract's
+ * lib/eq-defaults.mjs; the ts render exports the same as eqDefaultCentres and eqDefaultTypes). Needs -lm. */`],
   ].filter(([body]) => body);
   return `// SPDX-License-Identifier: GPL-3.0-or-later
 // Copyright (C) 2026 Pau Aliagas <linuxnow@gmail.com>
 #ifndef OMX_CONTRACT_LIMITS_H
 #define OMX_CONTRACT_LIMITS_H
+#include <math.h>
 /*
  * GENERATED — DO NOT EDIT BY HAND.
  * Produced by \`omx-contract render --target c\` from FreeMixer/omx-contract's data/, the declaration
@@ -82,13 +150,11 @@ export function renderC(resolved) {
 }
 
 /**
- * The `c` target of a frozen openmixer sheet (test/fixtures/): `{ sheet, plugins: [{ header, prefix,
- * source, params }] }` rendered by openmixer's own renderer, for the round-trip proof (spec §4.4 step 1).
+ * The `c` target of a frozen openmixer sheet (test/fixtures/): `{ sheet }` rendered by openmixer's own
+ * renderer, for the round-trip proof (spec §4.4 step 1).
  */
 export function renderSheetC(fixture) {
   const s = fixture.sheet;
   const sheet = { ...s, CORE_LIMITS: new Map(Object.entries(s.CORE_LIMITS)) };
-  const files = [{ path: 'omxcontract/omx_contract_limits.h', text: renderContractLimits(sheet) }];
-  for (const p of fixture.plugins) files.push({ path: `omxcontract/params/${p.header}`, text: generate(p, p.params) });
-  return files;
+  return [{ path: 'omxcontract/omx_contract_limits.h', text: renderContractLimits(sheet) }];
 }

package/render/doors.mjs

@@ -5,7 +5,7 @@
  * (packages/core/src/native-limit-tables.ts, declared-scalars.ts, declared-lists.ts): a `travels`
  * table named <PREFIX>_LIMITS is a native table; every scalar, sheet and single travel is scalars
  * (its finite-number leaves, a travel's `unit`/`defaultFrom` labels skipped); a list is a declared
- * list unless its item says `"c": { "render": false }`; a `c.alias` is the core-limit spelling.
+ * list unless its item says `"c": { "render": false }`; a set is an enum; a `c.alias` is the core-limit spelling.
  */
 
 const constantCase = (key) => key.replace(/([a-z0-9])([A-Z])/g, '$1_$2').toUpperCase();
@@ -38,7 +38,7 @@ export function doors(resolved) {
     .sort(([a], [b]) => a.localeCompare(b));
   const byMacro = new Map();
   for (const r of items) {
-    if (isNativeTable(r) || r.kind === 'list') continue;
+    if (isNativeTable(r) || r.kind === 'list' || r.kind === 'set') continue;
     const leaves = numberLeaves(r.value, r.name, r.name.replace(/_(KERNEL|LIMITS)$/, ''));
     if (leaves === undefined) continue;
     for (const s of leaves) {
@@ -51,6 +51,9 @@ export function doors(resolved) {
   const DECLARED_LISTS = items.filter((r) => r.kind === 'list' && r.c?.render !== false)
     .map((r) => ({ name: r.name, values: r.value }))
     .sort((a, b) => (a.name < b.name ? -1 : a.name > b.name ? 1 : 0));
+  const DECLARED_SET_ITEMS = items.filter((r) => r.kind === 'set')
+    .map((r) => ({ name: r.name, ids: r.value, default: r.default }))
+    .sort((a, b) => (a.name < b.name ? -1 : a.name > b.name ? 1 : 0));
   const ALIASES = new Map();
   for (const r of items) {
     if (!r.c?.alias) continue;
@@ -59,5 +62,5 @@ export function doors(resolved) {
     ALIASES.get(fact)[field] = r.value;
   }
   const STANDARD_SAMPLE_RATES = resolved.get('STANDARD_SAMPLE_RATES')?.value;
-  return { NATIVE_LIMIT_TABLES, DECLARED_SCALARS, DECLARED_LISTS, ALIASES, STANDARD_SAMPLE_RATES };
+  return { NATIVE_LIMIT_TABLES, DECLARED_SCALARS, DECLARED_LISTS, DECLARED_SET_ITEMS, ALIASES, STANDARD_SAMPLE_RATES };
 }

package/render/ts.mjs

@@ -1,5 +1,7 @@
 // SPDX-License-Identifier: GPL-3.0-or-later
 // Copyright (C) 2026 Pau Aliagas <linuxnow@gmail.com>
+import { eqDefaultBands, eqDefaultCentres, eqDefaultParams, eqDefaultTypes } from '../lib/eq-defaults.mjs';
+
 /**
  * The `ts` target: one ESM module and its type declarations, every item exported under its own
  * name with its literal type (`as const`), so a re-export in openmixer keeps names, values and types.
@@ -32,10 +34,46 @@ const BANNER = `// SPDX-License-Identifier: GPL-3.0-or-later
 // GENERATED by \`omx-contract render --target ts\` from FreeMixer/omx-contract's data/ — do not edit.
 `;
 
+/**
+ * The default EQ rule (lib/eq-defaults.mjs) as functions of the module: the library's own source,
+ * with the declared parameters bound, so the ts reader runs the code the tests hold equal to the c one.
+ */
+function eqRule(resolved) {
+  if (!resolved.has('EQ_DEFAULT_CENTRES_FOUR_BAND_HZ')) return { js: '', dts: '' };
+  const bound = JSON.stringify(eqDefaultParams(resolved), null, 2);
+  const fn = (f, as) => f.toString().replace(`function ${f.name}(`, `function ${as}(`);
+  const js = `
+/** The declared parameters of the default EQ rule: the four-band set, the preferred series, the band frequency travel, the band gain and Q. */
+const EQ_DEFAULT_RULE = ${bound};
+${fn(eqDefaultCentres, 'centres')}
+${fn(eqDefaultTypes, 'types')}
+${fn(eqDefaultBands, 'bands')}
+
+/** The default band centres (Hz) of an EQ with \`count\` bands: THE one rule, for every strip, host and count. */
+export function eqDefaultCentres(count) { return centres(count, EQ_DEFAULT_RULE); }
+
+/** The default band types, by EQ_BAND_TYPES id: a low shelf, bells, a high shelf (a single band is a bell). */
+export function eqDefaultTypes(count) { return types(count); }
+
+/** Every default band of an EQ with \`count\` bands: type, centre, gain and Q. */
+export function eqDefaultBands(count) { return bands(count, EQ_DEFAULT_RULE); }
+`;
+  const dts = `
+/** The default band centres (Hz) of an EQ with \`count\` bands: THE one rule, for every strip, host and count. */
+export declare function eqDefaultCentres(count: number): number[];
+/** The default band types, by EQ_BAND_TYPES id: a low shelf, bells, a high shelf (a single band is a bell). */
+export declare function eqDefaultTypes(count: number): string[];
+/** Every default band of an EQ with \`count\` bands: type, centre, gain and Q. */
+export declare function eqDefaultBands(count: number): { type: string; freqHz: number; gainDb: number; q: number }[];
+`;
+  return { js, dts };
+}
+
 /** Every file of the `ts` target: `[{ path, text }]`. */
 export function renderTs(resolved) {
   const items = [...resolved.values()];
-  const js = BANNER + items.map((r) => `\n${docComment(r)}\nexport const ${r.name} = ${JSON.stringify(tsValue(r), null, 2)};\n`).join('');
-  const dts = BANNER + items.map((r) => `\n${docComment(r)}\nexport declare const ${r.name}: ${tsType(tsValue(r))};\n`).join('');
+  const rule = eqRule(resolved);
+  const js = BANNER + items.map((r) => `\n${docComment(r)}\nexport const ${r.name} = ${JSON.stringify(tsValue(r), null, 2)};\n`).join('') + rule.js;
+  const dts = BANNER + items.map((r) => `\n${docComment(r)}\nexport declare const ${r.name}: ${tsType(tsValue(r))};\n`).join('') + rule.dts;
   return [{ path: 'omx-contract.js', text: js }, { path: 'omx-contract.d.ts', text: dts }];
 }

package/schema/omx-contract.schema.json

@@ -2,7 +2,7 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://github.com/FreeMixer/omx-contract/raw/main/schema/omx-contract.schema.json",
   "title": "omx-contract data file",
-  "description": "A map from an export name to one item: a scalar, a travels table or travel, a sheet or a list. GPL-3.0-or-later.",
+  "description": "A map from an export name to one item: a scalar, a travels table or travel, a sheet, a list or a set. GPL-3.0-or-later.",
   "type": "object",
   "properties": {
     "$schema": { "type": "string" }
@@ -15,6 +15,7 @@
       "enum": ["dB", "dBFS", "ms", "s", "min", "Hz", "oct", "cents", "%", "x", ""]
     },
     "text": { "type": "string", "minLength": 1 },
+    "since": { "type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+$", "description": "The release that first carried an item declared outside the kernels (rates.json, primitives.json); a kernel's items record it in recipes/answers/." },
     "name": { "type": "string", "pattern": "^[A-Z][A-Z0-9_]*$" },
     "ref": {
       "type": "object",
@@ -37,6 +38,15 @@
           "required": ["derive", "of"],
           "additionalProperties": false
         },
+        {
+          "type": "object",
+          "properties": {
+            "derive": { "const": "ceilSum" },
+            "of": { "type": "array", "items": { "$ref": "#/$defs/number" }, "minItems": 2 }
+          },
+          "required": ["derive", "of"],
+          "additionalProperties": false
+        },
         {
           "type": "object",
           "properties": {
@@ -58,6 +68,7 @@
         "unit": { "$ref": "#/$defs/unit" },
         "default": { "$ref": "#/$defs/number" },
         "defaultFrom": { "enum": ["desk"] },
+        "scale": { "type": "string", "pattern": "^[a-z]+$", "description": "How a host draws the travel: an id of PARAM_SCALES." },
         "byKind": {
           "type": "object",
           "propertyNames": { "pattern": "^[a-z][A-Za-z0-9]*$" },
@@ -80,6 +91,7 @@
       "type": "object",
       "properties": {
         "kind": { "const": "scalar" },
+        "since": { "$ref": "#/$defs/since" },
         "doc": { "$ref": "#/$defs/text" },
         "why": { "$ref": "#/$defs/text" },
         "unit": { "$ref": "#/$defs/unit" },
@@ -92,6 +104,7 @@
       "type": "object",
       "properties": {
         "kind": { "const": "travels" },
+        "since": { "$ref": "#/$defs/since" },
         "doc": { "$ref": "#/$defs/text" },
         "why": { "$ref": "#/$defs/text" },
         "fields": {
@@ -125,6 +138,7 @@
       "type": "object",
       "properties": {
         "kind": { "const": "sheet" },
+        "since": { "$ref": "#/$defs/since" },
         "doc": { "$ref": "#/$defs/text" },
         "why": { "$ref": "#/$defs/text" },
         "value": { "$ref": "#/$defs/sheetValue" }
@@ -136,6 +150,7 @@
       "type": "object",
       "properties": {
         "kind": { "const": "list" },
+        "since": { "$ref": "#/$defs/since" },
         "doc": { "$ref": "#/$defs/text" },
         "why": { "$ref": "#/$defs/text" },
         "unit": { "$ref": "#/$defs/unit" },
@@ -149,15 +164,36 @@
       "required": ["kind", "doc", "unit", "values"],
       "additionalProperties": false
     },
+    "set": {
+      "type": "object",
+      "description": "Ordered ids with an optional default and labels. The ids and their order are the contract: all strings (the id is the name, its position the value) or all non-negative integers (the id is the value). Labels are face text and optional.",
+      "properties": {
+        "kind": { "const": "set" },
+        "since": { "$ref": "#/$defs/since" },
+        "doc": { "$ref": "#/$defs/text" },
+        "why": { "$ref": "#/$defs/text" },
+        "ids": {
+          "oneOf": [
+            { "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9]*$" }, "minItems": 1, "uniqueItems": true },
+            { "type": "array", "items": { "type": "integer", "minimum": 0 }, "minItems": 1, "uniqueItems": true }
+          ]
+        },
+        "default": { "oneOf": [{ "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9]*$" }, { "type": "integer", "minimum": 0 }] },
+        "labels": { "type": "array", "items": { "$ref": "#/$defs/text" }, "minItems": 1 }
+      },
+      "required": ["kind", "doc", "ids"],
+      "additionalProperties": false
+    },
     "item": {
       "type": "object",
       "required": ["kind"],
-      "properties": { "kind": { "enum": ["scalar", "travels", "sheet", "list"] } },
+      "properties": { "kind": { "enum": ["scalar", "travels", "sheet", "list", "set"] } },
       "allOf": [
         { "if": { "properties": { "kind": { "const": "scalar" } } }, "then": { "$ref": "#/$defs/scalar" } },
         { "if": { "properties": { "kind": { "const": "travels" } } }, "then": { "$ref": "#/$defs/travels" } },
         { "if": { "properties": { "kind": { "const": "sheet" } } }, "then": { "$ref": "#/$defs/sheet" } },
-        { "if": { "properties": { "kind": { "const": "list" } } }, "then": { "$ref": "#/$defs/list" } }
+        { "if": { "properties": { "kind": { "const": "list" } } }, "then": { "$ref": "#/$defs/list" } },
+        { "if": { "properties": { "kind": { "const": "set" } } }, "then": { "$ref": "#/$defs/set" } }
       ]
     }
   }