This is a little project for a websocket server that:
- serves LV2 plugin information to clients
- stores received data from clients in a persistent way
- translates that data into mod-host commands
mod-connector uses /websocket entry point in port 13371.
Connecting clients will receive the current state as json with this data model:
{
"version": 0,
"type": "state",
"plugins": [
{
"uri": "",
"name": "",
"category": "",
"ports": [
{
"symbol": "in",
"name": "In",
"flags": ["audio"]
},
{
"symbol": "out",
"name": "Out",
"flags": ["audio","output"]
},
{
"symbol": "param",
"name": "Param",
"flags": ["control"],
"default": 0.0,
"minimum": 0.0,
"maximum": 1.0,
}
]
},
// ...
],
"state": {
"bank": 1,
"banks": {
"1": {
"presets": {
"1": {
"blocks": {
"1": {
"binding": "gain",
"uri": "http://kxstudio.sf.net/carla/plugins/audiogain",
"parameters": {
"1": {
"symbol": "gain",
"value": 0
},
// ...
}
},
// ...
}
},
// ...
}
},
// ...
}
}
}
The plugin category can be one of these values:
- "None"
- "Filter"
- "Reverb"
- "Utility"
The plugin port flags will contain at least one of these types:
- "audio"
- "control"
Additionally they can also contain "output" flag. For audio ports this means an audio output (otherwise it is an audio input). For control ports this means a meter-like output value, basically a read-only value which cannot be changed by the host or UI.
Additional flags are available for control ports:
- "toggled" (on/off switch based on minimum and maximum values, minimum = off and maximum = on)
- "integer" (port values are always real, integer numbers)
- "hidden" (port value can be read and/or changed but should not be displayed to the user)
This project uses cmake. You can configure and build it in release mode by using:
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build
The build dependencies are:
- cmake >= 3.15
- lilv
- LV2
- Qt with QtWebsockets (either Qt5 or Qt6)
- systemd (optional, enables "notify" systemd event)
The behaviour of this tool can be controlled with the following environment variables:
Path to where LV2 plugins are stored.
Do not create a connection to mod-host, simulate one by returning success to all host queries.
Can be used during development or when just wanting to have the non-host functionality from this tool.
The TCP port the tool expects mod-host to be using, defaults to 5555 if unset.