Libraries, tools and apps
openmixer is the console: a TypeScript server and web UI plus one native engine addon
(pipewire-native). Everything that is not console logic lives in a library or a tool of
its own repository, and the console takes that concern from the library only. This page lists what
each piece is, how openmixer reaches it, which concerns have exactly one home, and where the tree
still differs from that rule.
The pieces
| Piece | Repository | What it is | How openmixer reaches it |
|---|---|---|---|
| omx-contract | Open-Mixer/omx-contract | Declarations as data: the kernel travels (data/kernels/*.json), primitives, rates, and the console limits as a C header (omxcontract/omx_contract_limits.h). |
npm @openmixer/omx-contract (codegen and TypeScript, read by core and declarations). The C header is the same limits for native code, from the installed omx-contract-devel, a range (a floor and a ceiling) in the console's RPM spec (resolved by the native engine's omx-contract.sh); omx_console_limits.h includes it. |
| omx-dsp | Open-Mixer/omx-dsp | DSP primitives, effect kernels and the analysis code (HRP, FBS) as a static library, pkg-config omxdsp. Its .pc requires omx-contract. |
Link (static), the installed omx-dsp-devel, a range (a floor and a ceiling) in the console's RPM spec (resolved by the native engine's omxdsp.sh). |
| omx-plugins | Open-Mixer/omx-plugins | The effects shipped as plugins: each one a thin core over omx-dsp, a CLAP face, an LV2 face and a declaration (*.decl.json) that refers to omx-contract. The output is .clap and .lv2 bundles, and libomxplugins.a: every CLAP face with the table of their entries (<omx-plugins/omx_clap_static.h>, pkg-config omxplugins). |
Link (static): the addon opens the table's plugins by id, the installed omx-plugins-devel, a range (a floor and a ceiling) in the console's RPM spec (resolved by the native engine's omx-plugins.sh). dlopen by the host library (CLAP) and lilv (LV2) for the bundles; the server requires omx-plugins-clap and recommends omx-plugins-lv2. |
| omx-clap-core | Open-Mixer/omx-clap-core | libomx-clap-core, the in-process CLAP host; libomx-clap-lv2, an LV2-to-CLAP adapter that dlopens lilv; the omx-clap-host worker that speaks mod-host's socket protocol; omx-clap-scan. |
Link (pkg-config omx-clap-core), the installed omx-clap-core-devel, a range (a floor and a ceiling) in the console's RPM spec: 0.26.2, the first whose plugin calls all go through the callee-saved register guard (<omx-clap-host/abi_guard.h>, header ABI 20), which the addon's inline RT calls need at build time. |
| plugin-hostd | Open-Mixer/plugin-hostd | The out-of-process plugin supervisor: one mod-host-style socket, each plugin in its own worker (mod-host for LV2, omx-clap-host for CLAP). Its protocol/mod-host.json declares mod-host's wire vocabulary. |
Socket at runtime; the declared protocol is read by codegen and its headers are found by the native engine's plugin-hostd.sh in the installed plugin-hostd-devel, a range (a floor and a ceiling) in the console's RPM spec: 0.15.9, the first that declares the abi_clobber event. |
| plugin-qualify | Open-Mixer/plugin-qualify | Plugin qualification: LV2 and CLAP scan, benchmark, hosting suitability and the hosting codes. CLAP scanning goes through omx-clap-scan. |
npm @openmixer/plugin-qualify from the public registry, ~<floor> in catalog, core, server and pipewire-native; the plugin-qualify package (its clap-qualify prober and interposer), a range (a floor and a ceiling) in the console's RPM spec; library-ranges-conformance.test.ts holds the specifiers to that range. |
| mod-host | mod-audio/mod-host, the freemixer channel's build of the Audinux spec | The LV2 host and its socket protocol. The protocol is split out as libmod-host-protocol.so.0 (mod-host-protocol.pc). |
Exec (the LV2 worker), link (the protocol library). |
| libreac, libreac-transport | FreeREAC/libreac | The REAC protocol (frames, control blocks, head-amp, state machines) and its layer-2 transport. | Never directly: through reac-pw. |
| reac-pw | FreeREAC/reac-pw | The PipeWire daemon that binds enrolled REAC boxes to nodes and properties. | PipeWire node properties (reac.headamp.<channel>.<param>) written by the engine; reac.cfg. |
| reac-protocol | FreeREAC/reac-protocol | The protocol reference; spec/reac.ksy is the grammar's source of truth. |
Documentation and codegen input for libreac. |
| reac-stageboxes | FreeREAC/reac-stageboxes | A GTK4 app for head-amps, through reac-pw node parameters. | None; a sibling client of reac-pw. |
External upstreams openmixer builds against: CLAP headers (1.2.10, resolved by
the native engine's clap-include.sh), LV2 and lilv, PipeWire (libpipewire-0.3), and
the JACK API (omx-clap-host, mod-host).
Dependency graph
==> build or link, --> runtime (exec, socket, dlopen, PipeWire properties), ..> data or
codegen. [P] marks the private repository.
omx-contract
.--------------+------------------.
C header ==> | npm ..> |
v v |
omx-dsp openmixer[P] core / declarations
| |
| ==> | ==> libomxdsp (static, package range)
v | ==> libomx-clap-core (package range)
omx-plugins <==========| ==> libomxplugins (static, package range)
.clap / .lv2 | ==> libmod-host-protocol
| ==> libpipewire-0.3
| | --> dlopen liblilv
| dlopen | --> socket --> plugin-hostd
v | | --> exec mod-host (LV2 worker)
omx-clap-core <---------' | --> exec omx-clap-host (CLAP worker)
(libomx-clap-core, |
libomx-clap-lv2, '--> both link libmod-host-protocol
omx-clap-host, omx-clap-scan)
plugin-hostd/protocol/mod-host.json ..> openmixer declarations (mod-host-protocol-gen.mjs)
plugin-qualify --> exec omx-clap-scan, --> mod-host (sweeps), --> python3-lilv
reac-protocol (reac.ksy) ..> libreac ==> libreac-transport
libreac ==> reac-pw --> PipeWire nodes and reac.headamp.* properties
^ ^
openmixer audio-engine reac-stageboxes
One home per concern
openmixer holds no second implementation of these. A concern that appears in the console tree and in its library is a defect, listed under "Where it still diverges".
| Concern | Taken only from | Through |
|---|---|---|
| DSP kernels and effect math | omx-dsp | static link |
| CLAP hosting (entry lookup, factory, extensions, ring buffers) | omx-clap-core | link; the ratchet clap-host-one-home-conformance.test.ts bans CLAP includes and core definitions in the engine |
| Declarations: travels, limits, kernel values, hosting limits | omx-contract | npm and C header |
| REAC protocol and transport | libreac, reached through reac-pw | PipeWire properties only |
| Plugin qualification: scan, benchmark, RT-safety, hosting verdict | plugin-qualify | npm package |
| mod-host's wire vocabulary | plugin-hostd's protocol/mod-host.json |
codegen |
| mod-host protocol code | libmod-host-protocol | link |
Patches carried against upstream projects are tracked in the project's upstream ledger.
Where it still diverges
Each line is a difference between the rule above and the tree, with its tracking issue.
- DSP. None: the engine holds no copy of omx-dsp code.
tools/omxdsp-held.txtis empty, andtools/omxdsp-tree-check.shcompares every tracked C file with the installed library by content, so a new copy turns it red. - Dynamics controls. The gate's hold and hysteresis, the compressor's mix and the gate's knee pair that omx-dsp 0.5 adds are not reached by the engine, whose dynamics kernel is still its own.
- omx-contract in TypeScript is pinned at 2.2.0 in
coreanddeclarations, while the C render the engine and omx-dsp compile is the installed omx-contract-devel (the spec's range); the limits generator's contract check holds every unit the two share equal. - Effects. The engine walks eleven typed FX stages plus the bus limiter instead of loading
omx-plugins faces, although it links omx-plugins' static table (
libomxplugins.a) and opens its plugins by id in a hosted slot. - LV2 measurement tools. The engine hosts LV2 only through
libomx-clap-lv2, andlv2-host-one-home-conformance.test.tsrefuses an LV2 host in its sources,tools/included. The host probe that drives the exportedomx-hrp.lv2through lilv (npm run test:lv2host) is plugin-qualify'slv2_host_probe(native/lv2-host-probe.c), found bytools/clap-qualify.sh lv2probe. - Qualification. openmixer measures a CLAP with plugin-qualify's prober and RT-safety interposer
(
native/clap-qualify.c,native/rt-interpose.c), taken from the installed plugin-qualify package bytools/clap-qualify.sh. The LV2 measuring hostlv2_measureis plugin-qualify's too (native/lv2-measure.c, v0.6.0), built at the same pin bytools/clap-qualify.sh lv2. The npm package ships nonative/sources; the prober is found throughOMX_CLAP_QUALIFYor plugin-qualify's own package. Itstools/scan.pykeeps a hand-typed unit table that no check holds to the declaration. - Hosting limits. omx-clap-core's
clap_host_limits.his rendered from openmixer's private declarations, not from omx-contract: FreeMixer/omx-contract#21. - Protocol library. The engine links the installed
plugin-hostd-protocol(the parser, dispatcher and verb tables that came out of mod-host's protocol layer), at or above the spec's floor, read bytools/sibling-lib.shlike every OpenMixer library (PLUGIN_HOSTD_PROTOCOL_PREFIXfor a developer build). mod-host's wire vocabulary is generated from that package'smod-host.json; no vendored copy exists. mod-host is no build dependency. The instance ceiling 9990 is spelled in three repositories, among them omx-clap-core: FreeMixer/omx-clap-core#39. - Meters. omx-clap-core reads a plugin's meters through
clap.meters/1, withclap.gain-adjustment-metering/0for a plugin that has none; omx-clap-core 0.4.2 removed the vendor extensionorg.openmixer.meters/1: FreeMixer/omx-clap-core#38. - REAC. reac-pw keeps its own refusal-code list, its own qdisc dump and its own read of
libreac's topology tap; libreac vendors two reac-pw configuration headers.
Tracked in the library repositories: FreeREAC/reac-pw#20, FreeREAC/reac-pw#21, FreeREAC/libreac#8.
The
reac.headamp.property vocabulary is spelled in reac-pw, in the audio engine'sreac-head-amp.tsand in reac-stageboxes, which also restates the head-amp curve: FreeREAC/reac-stageboxes#4.