MOD Audio

MOD Plugin Extension

http://moddevices.com/ns/mod#

Overview

The mod: namespace defines properties that plugin developers add to their LV2 .ttl metadata to control how the plugin is presented and behaves on MOD-powered platforms. These properties complement the standard LV2 vocabulary by expressing MOD-specific display preferences, port overrides, and capability declarations.

All properties in this namespace are declared on either the plugin resource or on individual port resources within the plugin's .ttl file. Unless stated otherwise, all properties are optional.

Prefixes

@prefix mod:  <http://moddevices.com/ns/mod#> .
@prefix lv2:  <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .

Plugin Properties

These properties are declared on the plugin resource itself.

Property Type Description
mod:brand string Short brand or manufacturer name displayed in the MOD plugin store and marketplace listings. Should be concise (one word or short phrase). Takes precedence over doap:name for brand display purposes. Example: "MyBrand".
mod:label string Short display label for the plugin, shown in the MOD UI plugin icon and listings. Should be shorter than doap:name — ideally one or two words. Example: "Cab Sim".
mod:fileTypes string (list) Categories of files this plugin can load, used to filter the file browser.
⚠ TODO (Filipe): confirm the full list of valid values. Known values include "audio", "midi", "sf2", "ir". Can multiple values be listed as a comma-separated string or as multiple triples?
mod:supportedExtensions string (list) File extensions this plugin accepts in its file-loading ports. Companion to mod:fileTypes — provides the exact extension filter for the file browser (e.g. "wav", "mp3", "sf2").
⚠ TODO (Filipe): confirm format — space-separated? Multiple triples? Confirm full valid set.
mod:rawMIDIClockAccess boolean When true, declares that this plugin requires raw MIDI clock access rather than the mediated timing information provided through LV2 time features. The host will route raw MIDI clock messages to this plugin.

Port Properties

These properties are declared on individual port resources within the plugin .ttl.

Property Type Description
mod:minimum float MOD-specific minimum value for a control port. Takes precedence over lv2:minimum when the plugin is running on a MOD platform. Use this when the practical range for MOD users differs from the plugin's standard LV2 range.
mod:maximum float MOD-specific maximum value for a control port. Takes precedence over lv2:maximum on MOD platforms.
mod:default float MOD-specific default value for a control port. Takes precedence over lv2:default on MOD platforms.
mod:default_duo float Default value override specific to the MOD Duo device. When present on a device of this type, takes precedence over mod:default and lv2:default.
mod:default_duox float Default value override specific to the MOD Duo X device.
mod:default_dwarf float Default value override specific to the MOD Dwarf device.
mod:rangeSteps integer Number of discrete steps for a control port. When present, the MOD UI renders this port as a stepped control and quantizes user input to the given number of equal steps across the mod:minimum to mod:maximum range. Takes precedence over any LV2 step count.
mod:volts string Voltage range declaration for a CV port. Informs the host of the expected signal level for routing and display purposes.
⚠ TODO (Filipe): confirm valid values and whether this applies to input ports, output ports, or both. Known candidate values: "5" (±5V), "10" (±10V).

Port Classes

Class Description
mod:CVPort Type annotation for CV (Control Voltage) ports. Declare a port as a mod:CVPort , lv2:AudioPort to indicate that it carries CV signals rather than audio. MOD platforms use this to enable CV routing and display the port with CV-specific UI.

Build System Properties

The following properties are set automatically by the MOD Plugin Builder and are not intended to be written by plugin developers. They are documented here for completeness and to assist host implementors reading plugin metadata.

Property Type Description
mod:builderVersion integer Version of the MOD Plugin Builder used to compile this plugin.
mod:releaseNumber integer Release number assigned to this plugin build by the MOD build system.
mod:buildEnvironment string Identifier for the build environment (e.g. target architecture or SDK version).
⚠ TODO (Filipe): confirm valid values.

Example

@prefix mod:  <http://moddevices.com/ns/mod#> .
@prefix lv2:  <http://lv2plug.in/ns/lv2core#> .
@prefix doap: <http://usefulinc.com/ns/doap#> .

<http://example.com/plugins/my-reverb>
    a lv2:Plugin ;
    doap:name "My Reverb Plugin" ;
    mod:brand "MyBrand" ;
    mod:label "Reverb" ;
    lv2:port [
        a lv2:InputPort , lv2:ControlPort ;
        lv2:index 0 ;
        lv2:symbol "decay" ;
        lv2:name "Decay Time" ;
        lv2:minimum 0.1 ;
        lv2:maximum 10.0 ;
        lv2:default 2.0 ;
        mod:minimum 0.1 ;
        mod:maximum 8.0 ;
        mod:default 1.5 ;
        mod:default_dwarf 2.0 ;
        mod:rangeSteps 79 ;
    ] .

CV Port Example

@prefix mod: <http://moddevices.com/ns/mod#> .
@prefix lv2: <http://lv2plug.in/ns/lv2core#> .

<http://example.com/plugins/my-synth>
    a lv2:Plugin ;
    lv2:port [
        a lv2:InputPort , lv2:AudioPort , mod:CVPort ;
        lv2:index 0 ;
        lv2:symbol "cv_pitch" ;
        lv2:name "CV Pitch" ;
        mod:volts "5" ;
    ] .