[{"data":1,"prerenderedAt":33},["ShallowReactive",2],{"note-the-libraries-that-read-our-plugins-en":3},{"slug":4,"order":5,"title":6,"summary":7,"measured":8,"topic":9,"toc":10,"html":32},"the-libraries-that-read-our-plugins",75,"The libraries that read our plugins","Every owner ships the reader of what it writes, in the languages it is read from. Per owner and per language, what to install, the entry point and one call, copied from the owner's repository.","read from each owner's repository on its main branch, its tests and its README.","zynthian",[11,13,15,17,19,21,23,25,27,29],{"id":12,"title":12},"omx-contract",{"id":14,"title":14},"omx-dsp",{"id":16,"title":16},"omx-clap-core",{"id":18,"title":18},"plugin-hostd-protocol",{"id":20,"title":20},"plugin-hostd",{"id":22,"title":22},"plugin-db",{"id":24,"title":24},"plugin-qualify",{"id":26,"title":26},"omx-panel",{"id":28,"title":28},"omx-plugins",{"id":30,"title":31},"not-there-yet","Not there yet","\u003Cp>Each piece of OpenMixer writes one kind of data: omx-contract the vocabulary and the scales, plugin-hostd's protocol the\nwords of the wire, plugin-db and plugin-qualify the records and the pins, omx-panel the layouts, omx-plugins the\ndescriptors and presets of its own plugins. Each one also ships the reader of what it writes. A program that shows a\nplugin, as Zynthian's interface does, reads through those readers and keeps no copy of its own.\u003C\u002Fp>\n\u003Cp>This note lists them, per owner and per language: what to install, the entry point, and one call. Every call below is\ncopied from the owner's repository, with the file and line it comes from. Where the repository has no example, the note\nsays so rather than make one up.\u003C\u002Fp>\n\u003Cp>\u003Cimg src=\"\u002Ftechnical-notes\u002Fthe-libraries-that-read-our-plugins\u002Fowners-and-readers.svg\" alt=\"Each owner and the readers it ships, by language\">\u003C\u002Fp>\n\u003Cp>The packages are named rpm first, then deb. Every dependency between these packages states a floor and a ceiling, the\nnext minor below 1.0 and \u003Ccode>&lt; 4\u003C\u002Fcode> for omx-contract; the rule is written down once, in plugin-hostd's\n\u003Ccode>tests\u002Fclap_core_floor.py\u003C\u002Fcode>.\u003C\u002Fp>\n\u003Ch2 id=\"omx-contract\">omx-contract\u003C\u002Fh2>\n\u003Cp>The vocabulary, the units and scales, and the contract directory every other owner installs its words into.\u003C\u002Fp>\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>language\u003C\u002Fth>\n\u003Cth>install\u003C\u002Fth>\n\u003Cth>entry point\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>C\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>omx-contract-devel\u003C\u002Fcode> \u002F \u003Ccode>libomx-contract-dev\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>&lt;omxcontract\u002Fomx_contract_limits.h&gt;\u003C\u002Fcode> and the other headers under \u003Ccode>\u002Fusr\u002Finclude\u002Fomxcontract\u002F\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>data\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>omx-contract-data\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>\u002Fusr\u002Fshare\u002Fomx-contract\u002F\u003C\u002Fcode>, the contract directory \u003Ccode>contract.d\u002F3\u002F&lt;owner&gt;\u002F\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>Python\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>omx-contract-data\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>omx_contract_catalog.py\u003C\u002Fcode>, \u003Ccode>omx_contract_scale.py\u003C\u002Fcode> in \u003Ccode>\u002Fusr\u002Fshare\u002Fomx-contract\u002F\u003C\u002Fcode>, loaded by path\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>TypeScript\u003C\u002Ftd>\n\u003Ctd>npm \u003Ccode>@openmixer\u002Fomx-contract\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>\u002Fcatalog\u003C\u002Fcode>, \u003Ccode>\u002Fscale\u003C\u002Fcode>, \u003Ccode>\u002Fdescriptor\u003C\u002Fcode>, \u003Ccode>\u002Fvalidate\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003Cp>C, from the README (\u003Ccode>README.md:31,35\u003C\u002Fcode>):\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-c\">#include &lt;omxcontract\u002Fomx_contract_limits.h&gt;\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cpre>\u003Ccode class=\"language-sh\">cc -c app.c $(pkg-config --cflags omx-contract)\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cp>A catalog sentence in TypeScript, from \u003Ccode>test\u002Fcatalog.test.mjs:65-66\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-js\">const ca = loadCatalog('omx-contract', 'ca', root);\nassert.equal(fill(sentenceOf(ca, CODE, 'No contract directory at {path}'), { path: '\u002Fx' }), 'Cap directori de contracte a \u002Fx');\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cp>A position on a scale, from \u003Ccode>test\u002Fscale-position.test.mjs:52-53\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-js\">const travel = { scale: 'log', min: 20, max: 20000 };\nassert.equal(scalePosition(travel, 1000).toFixed(4), '0.5663');\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cp>The Python modules are not on \u003Ccode>sys.path\u003C\u002Fcode>: a program loads them by their file. plugin-db does it for the catalog reader,\nin \u003Ccode>python\u002Fplugin_db\u002Ftext.py:28,35-37\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-python\">READER = _installed(&quot;share&quot;, &quot;omx-contract&quot;, &quot;omx_contract_catalog.py&quot;)\n        spec = importlib.util.spec_from_file_location(&quot;omx_contract_catalog&quot;, READER)\n        _reader = importlib.util.module_from_spec(spec)\n        spec.loader.exec_module(_reader)\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cp>and omx-contract's own test reads the scale that way, in \u003Ccode>test\u002Fscale-position-py.test.mjs:121-122\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-python\">t = {&quot;scale&quot;: &quot;log&quot;, &quot;min&quot;: 20, &quot;max&quot;: 20000}\nprint(m[&quot;scale_position&quot;](t, 20))\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cp>Overriding a descriptor, from \u003Ccode>test\u002Fdescriptor-export.test.mjs:9,17\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-js\">import { applyOverride } from '@openmixer\u002Fomx-contract\u002Fdescriptor';\nconst r = applyOverride(read('examples\u002Fdescriptors\u002Fscanned-clap-unknown.json'), [read('test\u002Ffixtures\u002Foverrides\u002Fgood.json')], { paramsFingerprint: '5f0c' });\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cp>\u003Ccode>\u002Fvalidate\u003C\u002Fcode> and the generated \u003Ccode>omx_contract.py\u003C\u002Fcode> (\u003Ccode>CLAP_IDS\u003C\u002Fcode>, \u003Ccode>CLAP_NUMBERS\u003C\u002Fcode>): no example in the repository.\u003C\u002Fp>\n\u003Ch2 id=\"omx-dsp\">omx-dsp\u003C\u002Fh2>\n\u003Cp>The DSP kernels, and their TypeScript twins for drawing what a kernel does.\u003C\u002Fp>\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>language\u003C\u002Fth>\n\u003Cth>install\u003C\u002Fth>\n\u003Cth>entry point\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>C\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>omx-dsp-devel\u003C\u002Fcode> \u002F \u003Ccode>libomxdsp-dev\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>&lt;omxdsp\u002Fomxdsp.h&gt;\u003C\u002Fcode>, \u003Ccode>omxdsp\u002F{fx,analysis,mix}\u002F*.h\u003C\u002Fcode>: static inline kernels\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>TypeScript\u003C\u002Ftd>\n\u003Ctd>npm \u003Ccode>@openmixer\u002Fomx-dsp\u003C\u002Fcode> (npm only)\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>dbToLinearGain\u003C\u002Fcode>, \u003Ccode>linearGainToDb\u003C\u002Fcode>, \u003Ccode>biquadMagnitudeDb\u003C\u002Fcode>, \u003Ccode>curvePoints\u003C\u002Fcode>, the meter views\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003Cp>C, from the README (\u003Ccode>README.md:32,36-37\u003C\u002Fcode>):\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-c\">#include &lt;omxdsp\u002Ffx\u002Fomx_delay.h&gt;\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cpre>\u003Ccode class=\"language-sh\">cc $(pkg-config --cflags omxdsp) -c my_plugin.c\ncc -shared -o my_plugin.so my_plugin.o $(pkg-config --libs omxdsp)\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cp>A twin, from \u003Ccode>ts\u002Ftest\u002Fagreement.test.mjs:70\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-js\">assert.equal(linearGainToDb(0), -Infinity);\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Ch2 id=\"omx-clap-core\">omx-clap-core\u003C\u002Fh2>\n\u003Cp>The CLAP host library, the LV2 adapter, and the tables of its codes for a program in JavaScript.\u003C\u002Fp>\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>language\u003C\u002Fth>\n\u003Cth>install\u003C\u002Fth>\n\u003Cth>entry point\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>C\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>omx-clap-core\u003C\u002Fcode> + \u003Ccode>-devel\u003C\u002Fcode> \u002F \u003Ccode>libomx-clap-core1\u003C\u002Fcode> + \u003Ccode>-dev\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>&lt;omx-clap-host\u002Fclap_host.h&gt;\u003C\u002Fcode>: \u003Ccode>omx_clap_host_config_default\u003C\u002Fcode>, \u003Ccode>omx_clap_host_configure\u003C\u002Fcode>, \u003Ccode>omx_clap_host_open\u003C\u002Fcode>, \u003Ccode>omx_clap_host_activate\u003C\u002Fcode>, \u003Ccode>omx_clap_host_close\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>C, LV2\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>omx-clap-lv2-devel\u003C\u002Fcode> \u002F \u003Ccode>libomx-clap-lv2-dev\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>&lt;omx_clap_lv2.h&gt;\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>JavaScript\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>omx-clap-core\u003C\u002Fcode> \u002F \u003Ccode>libomx-clap-core1\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>omx-clap-core-vocabulary.js\u003C\u002Fcode>, \u003Ccode>omx-clap-core-hosting.js\u003C\u002Fcode> in \u003Ccode>pkg-config --variable=tsdir omx-clap-core\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003Cp>From \u003Ccode>tests\u002Factive_race_test.c:66-68,77,83\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-c\">    omx_clap_host_config_default(&amp;config);\n    config.lane_channels = 0;\n    if (omx_clap_host_configure(&amp;config) != 0 || omx_clap_host_open(argv[1], STEREO_MONO, &amp;in, why) != 0 || !in)\n    \u002F\u002F …\n        if (omx_clap_host_activate(in, SAMPLE_RATE, BLOCK, why) != 0)\n    \u002F\u002F …\n    omx_clap_host_close(in);\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cp>The JavaScript tables have no example in the repository; plugin-qualify reads them in its \u003Ccode>tools\u002Fclap-core-tsdir.mjs\u003C\u002Fcode>.\u003C\u002Fp>\n\u003Ch2 id=\"plugin-hostd-protocol\">plugin-hostd-protocol\u003C\u002Fh2>\n\u003Cp>The words of the wire, as a C header and as the table both clients read.\u003C\u002Fp>\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>language\u003C\u002Fth>\n\u003Cth>install\u003C\u002Fth>\n\u003Cth>entry point\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>C\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>plugin-hostd-protocol\u003C\u002Fcode> + \u003Ccode>-devel\u003C\u002Fcode> \u002F \u003Ccode>libplugin-hostd-protocol0\u003C\u002Fcode> + \u003Ccode>-dev\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>&lt;plugin-hostd\u002Fprotocol.h&gt;\u003C\u002Fcode>: the pin path codec \u003Ccode>phd_pin_path_encode\u003C\u002Fcode>, \u003Ccode>phd_pin_path_decode\u003C\u002Fcode>; the X-macro tables \u003Ccode>PHD_VERBS\u003C\u002Fcode>, \u003Ccode>PHD_ERRORS\u003C\u002Fcode>, \u003Ccode>PHD_EVENTS\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>data\u003C\u002Ftd>\n\u003Ctd>the runtime package\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>\u002Fusr\u002Fshare\u002Fplugin-hostd-protocol\u002Fplugin-hostd-protocol.json\u003C\u002Fcode>, the table (\u003Ccode>pkg-config --variable=table plugin-hostd-protocol\u003C\u002Fcode>)\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003Cp>From \u003Ccode>tests\u002Fprotocol_test.c:816\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-c\">if (phd_pin_path_decode(&quot;Surge%20xt%2c.clap&quot;, back, sizeof(back)) != 0 || strcmp(back, &quot;Surge xt,.clap&quot;))\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Ch2 id=\"plugin-hostd\">plugin-hostd\u003C\u002Fh2>\n\u003Cp>The daemon's two clients, one codec over the table above.\u003C\u002Fp>\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>language\u003C\u002Fth>\n\u003Cth>install\u003C\u002Fth>\n\u003Cth>entry point\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>TypeScript\u003C\u002Ftd>\n\u003Ctd>npm \u003Ccode>@openmixer\u002Fplugin-hostd-client\u003C\u002Fcode> (npm only)\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>class Protocol\u003C\u002Fcode>: \u003Ccode>encode\u003C\u002Fcode>, \u003Ccode>decode\u003C\u002Fcode>, \u003Ccode>parse\u003C\u002Fcode>, \u003Ccode>code\u003C\u002Fcode>, \u003Ccode>name\u003C\u002Fcode>, \u003Ccode>sentence\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>Python\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>python3-plugin-hostd-protocol\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>plugin_hostd_protocol\u003C\u002Fcode>: \u003Ccode>Protocol\u003C\u002Fcode>, with the same calls\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>C\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>plugin-hostd-devel\u003C\u002Fcode> \u002F \u003Ccode>plugin-hostd-dev\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>&lt;plugin-hostd\u002Fplugin_hostd_vocabulary.h&gt;\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003Cp>TypeScript, from \u003Ccode>clients\u002Fts\u002FREADME.md:26-39\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-ts\">import { Protocol } from '@openmixer\u002Fplugin-hostd-client';\n\nconst protocol = new Protocol();            \u002F\u002F the installed table and vocabulary\n\u002F\u002F …\nprotocol.encode('add', ['clap:...', 0]);     \u002F\u002F the line to send, by the table's form\n\u002F\u002F …\nprotocol.parse('resp 0');                     \u002F\u002F what the host answered: a reply, feedback or a protocol error\n\u002F\u002F …\nprotocol.sentence(-2, 'ca');                  \u002F\u002F its sentence in a listed language, English when the catalog lacks it\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cp>Python, from \u003Ccode>clients\u002Fpython\u002Ftests\u002Ftest_codec.py:10,28,58\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-python\">from plugin_hostd_protocol import RETRY_REASONS, Protocol, ProtocolError, format_number\n# …\n        cls.protocol = Protocol()\n# …\n        reply = self.protocol.parse(line)\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cp>The two clients are held to the same answers by \u003Ccode>tests\u002Fclients_agree.py\u003C\u002Fcode>.\u003C\u002Fp>\n\u003Ch2 id=\"plugin-db\">plugin-db\u003C\u002Fh2>\n\u003Cp>The records of what each plugin is on this machine, and the verdict a surface shows.\u003C\u002Fp>\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>language\u003C\u002Fth>\n\u003Cth>install\u003C\u002Fth>\n\u003Cth>entry point\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>Python\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>python3-plugin-db\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>plugin_db\u003C\u002Fcode>: \u003Ccode>query(address, here)\u003C\u002Fcode>, \u003Ccode>read(entry, here)\u003C\u002Fcode>, \u003Ccode>why(answer, lang)\u003C\u002Fcode>, \u003Ccode>vocabulary\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>C\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>plugin-db-devel\u003C\u002Fcode> \u002F \u003Ccode>plugin-db-dev\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>&lt;plugin-db\u002Fdb.h&gt;\u003C\u002Fcode>, \u003Ccode>&lt;plugin-db\u002Fpin.h&gt;\u003C\u002Fcode>: \u003Ccode>pdb_address_parse\u003C\u002Fcode>, \u003Ccode>pdb_state\u003C\u002Fcode>, \u003Ccode>pdb_check\u003C\u002Fcode>, \u003Ccode>pdb_word\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>command\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>plugin-db\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>plugin-db query --json\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003Cp>Python, from \u003Ccode>README.md:101-105\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-python\">from plugin_db import query, read, why, vocabulary as v\n\nanswer = query(&quot;lv2:http:\u002F\u002Fexample.org\u002Fplugins\u002Famp&quot;, here)   # asks the command plugin-db\nif answer[&quot;state&quot;] == v.states.qualified: ...\nwhy(answer, &quot;ca&quot;)                                            # the sentence of its reason, in Catalan\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cp>C, from \u003Ccode>tests\u002Fconsumer.c:11,33-35\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-c\">#include &lt;plugin-db\u002Fdb.h&gt;\n\u002F\u002F …\n    if (pdb_address_parse(&quot;lv2:http:\u002F\u002Fexample.org\u002Famp&quot;, &amp;address) != 0)\n        return 1;\n    printf(&quot;%s\\n&quot;, pdb_word(formats, PDB_ADDRESS_FORMATS_COUNT, address.format));\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cp>Its TypeScript twin is private and not published.\u003C\u002Fp>\n\u003Ch2 id=\"plugin-qualify\">plugin-qualify\u003C\u002Fh2>\n\u003Cp>The qualification records and the pins file the daemon reads.\u003C\u002Fp>\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>language\u003C\u002Fth>\n\u003Cth>install\u003C\u002Fth>\n\u003Cth>entry point\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>TypeScript\u003C\u002Ftd>\n\u003Ctd>npm \u003Ccode>@openmixer\u002Fplugin-qualify\u003C\u002Fcode>; the \u003Ccode>plugin-qualify\u003C\u002Fcode> package carries it\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>parsePinLine\u003C\u002Fcode>, \u003Ccode>pinLine\u003C\u002Fcode>; \u003Ccode>recordFigures\u003C\u002Fcode>; \u003Ccode>readDistributedLayer\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>data\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>plugin-qualify\u003C\u002Fcode> writes, \u003Ccode>plugin-qualification-records\u003C\u002Fcode> ships\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>\u002Fvar\u002Flib\u002Fomx\u002Fqualified.pins\u003C\u002Fcode>, \u003Ccode>\u002Fvar\u002Flib\u002Fomx\u002Fqualification\u002F\u003C\u002Fcode>, \u003Ccode>\u002Fusr\u002Fshare\u002Fomx\u002Fqualification\u002F\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003Cp>A pin line, from \u003Ccode>src\u002Fpins-file.test.ts:89\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-ts\">const p = parsePinLine(pinLine(entry(&quot;clap:\u002Fp\u002Fx.clap#id&quot;, { verdict: &quot;isolated&quot; }))!);\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cp>A record's figures, from \u003Ccode>src\u002Frecord-figures.test.ts:28\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-ts\">const figures = recordFigures(rec, 48000, 128);\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cp>\u003Ccode>readDistributedLayer\u003C\u002Fcode>: no example in the repository. There is no Python reader of records or of the pins file.\u003C\u002Fp>\n\u003Ch2 id=\"omx-panel\">omx-panel\u003C\u002Fh2>\n\u003Cp>The layout of a plugin's pages, its gestures and its looks, and the renderer that draws them.\u003C\u002Fp>\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>language\u003C\u002Fth>\n\u003Cth>install\u003C\u002Fth>\n\u003Cth>entry point\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>TypeScript\u003C\u002Ftd>\n\u003Ctd>npm \u003Ccode>@openmixer\u002Fomx-panel\u003C\u002Fcode>; the \u003Ccode>omx-panel\u003C\u002Fcode> package carries it\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>\u002Fdescribe\u003C\u002Fcode>: \u003Ccode>describe\u003C\u002Fcode>; \u003Ccode>\u002Fpanel-description\u003C\u002Fcode>: \u003Ccode>pagesOf\u003C\u002Fcode>; \u003Ccode>\u002Fgestures\u003C\u002Fcode>; \u003Ccode>\u002Flook\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>C\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>omx-panel-render\u003C\u002Fcode> + \u003Ccode>-devel\u003C\u002Fcode> \u002F \u003Ccode>libomx-panel-render0\u003C\u002Fcode> + \u003Ccode>-dev\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>&lt;omx_panel_render.h&gt;\u003C\u002Fcode>: \u003Ccode>omx_panel_view_create_from_files\u003C\u002Fcode>, \u003Ccode>omx_panel_word_name\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>data\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>omx-panel\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>\u002Fusr\u002Fshare\u002Fomx-panel\u002Fschema\u002Fgestures.json\u003C\u002Fcode>, \u003Ccode>schema\u002Flook-roles.json\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003Cp>From \u003Ccode>test\u002Fdescribe.test.mjs:35\u003C\u002Fcode> and \u003Ccode>test\u002Fpages.test.mjs:17\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-js\">  const { description, refusals } = describe(descriptor(dyn(), lv2('lv2:CompressorPlugin')));\n  \u002F\u002F …\n  const eight = pagesOf(x, { perPage: 8 });\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cp>C, from \u003Ccode>renderer\u002Fsrc\u002Fcli.c:386\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-c\">omx_panel_view_t *v = omx_panel_view_create_from_files(desc, data, err, sizeof err);\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Cp>No Python reader is shipped; the repository's \u003Ccode>test\u002Fhost_reads.py\u003C\u002Fcode> reads the word names from the C library with ctypes.\u003C\u002Fp>\n\u003Ch2 id=\"omx-plugins\">omx-plugins\u003C\u002Fh2>\n\u003Cp>OpenMixer's own plugins: their descriptors, presets and pins, and the static entry of each CLAP plugin.\u003C\u002Fp>\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>language\u003C\u002Fth>\n\u003Cth>install\u003C\u002Fth>\n\u003Cth>entry point\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>data\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>omx-plugins-contract\u003C\u002Fcode>, \u003Ccode>omx-plugins\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>descriptors \u003Ccode>contract.d\u002F3\u002Fomx-plugins\u002Fplugins\u002F&lt;stem&gt;.json\u003C\u002Fcode>; presets \u003Ccode>\u002Fusr\u002Fshare\u002Fomx\u002Fpresets\u002F&lt;plugin id&gt;\u002F&lt;preset id&gt;.json\u003C\u002Fcode>; pins \u003Ccode>\u002Fusr\u002Fshare\u002Fplugin-hostd\u002Fpins.d\u002Fomx-plugins.pins\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>C\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>omx-plugins-devel\u003C\u002Fcode> \u002F \u003Ccode>omx-plugins-dev\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>\u003Ccode>&lt;omx-plugins\u002Fomx_clap_static.h&gt;\u003C\u002Fcode>: \u003Ccode>omx_clap_static_find\u003C\u002Fcode>; \u003Ccode>&lt;omx-plugins\u002Fomx_preset_file.h&gt;\u003C\u002Fcode>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003Cp>From \u003Ccode>docs\u002Fcatalogue.md:690-695\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cpre>\u003Ccode class=\"language-c\">#include &lt;omx-plugins\u002Fomx_clap_static.h&gt;\n\nconst clap_plugin_entry_t *e = omx_clap_static_find(&quot;org.openmixer.delay&quot;);\ne-&gt;init(&quot;&quot;);\nconst clap_plugin_factory_t *f = e-&gt;get_factory(CLAP_PLUGIN_FACTORY_ID);\nconst clap_plugin_t *delay = f-&gt;create_plugin(f, host, &quot;org.openmixer.delay&quot;);\n\u003C\u002Fcode>\u003C\u002Fpre>\n\u003Ch2 id=\"not-there-yet\">Not there yet\u003C\u002Fh2>\n\u003Cul>\n\u003Cli>plugin-qualify cites a Python reader of record figures for Zynthian (\u003Ccode>tools\u002Frecord_figures.py\u003C\u002Fcode>) that does not exist:\nthere is no Python reader of records or of the pins file.\u003C\u002Fli>\n\u003Cli>omx-contract's Python modules are not on \u003Ccode>sys.path\u003C\u002Fcode>; every program loads them by their file, as plugin-db's\n\u003Ccode>text.py\u003C\u002Fcode> does. A package is on its way, \u003Ccode>python3-omx-contract\u003C\u002Fcode> (\u003Ccode>import omx_contract.catalog\u003C\u002Fcode>).\u003C\u002Fli>\n\u003Cli>Three kinds of name a client compares against are not constants of their owner's reader yet, so the Zynthian fork\nwrites them as text on a few listed lines, each naming the owner's issue: which refusals are transient\n(plugin-hostd-protocol), the verbs and the reply codes in the Python client (plugin-hostd-protocol) and the grouping\nreasons of \u003Ccode>grouping.json\u003C\u002Fcode> (plugin-hostd).\u003C\u002Fli>\n\u003Cli>omx-contract's \u003Ccode>\u002Fvalidate\u003C\u002Fcode> export, its generated \u003Ccode>omx_contract.py\u003C\u002Fcode> and plugin-qualify's \u003Ccode>readDistributedLayer\u003C\u002Fcode> have\nno example in their repositories.\u003C\u002Fli>\n\u003Cli>omx-dsp's TypeScript twins and plugin-hostd's TypeScript client are on npm only, not in the rpm or deb packages;\nplugin-db's TypeScript twin is private.\u003C\u002Fli>\n\u003C\u002Ful>\n",1794788729268]