Browse Source

- Removed all the unsigned char garbage from the API

- Updated types in lv2.h to be non-machine-dependant (removed unsigned long in favour of uint32_t)
- Updated schema
- Updated example plugin to work with the above (partially)


git-svn-id: http://svn.drobilla.net/lad/libslv2@101 a436a847-0d15-0410-975c-d299462d15a1
add_opts_to_lv2apply
David Robillard 16 years ago
parent
commit
2cd84e4209
  1. 3
      AUTHORS
  2. 15
      examples/hosts/jack_host.c
  3. 69
      examples/hosts/test_host.c
  4. 0
      examples/plugins/Amp-slv2.lv2/Makefile
  5. 26
      examples/plugins/Amp-slv2.lv2/amp.c
  6. 57
      examples/plugins/Amp-slv2.lv2/amp.ttl
  7. 6
      examples/plugins/Amp-slv2.lv2/manifest.ttl
  8. 68
      examples/plugins/Amp-swh.lv2/amp.ttl
  9. 12
      include/lv2.h
  10. 721
      include/lv2.ttl
  11. 17
      slv2/plugin.h
  12. 6
      slv2/plugininstance.h
  13. 8
      slv2/pluginlist.h
  14. 33
      slv2/port.h
  15. 15
      slv2/private_types.h
  16. 8
      slv2/query.h
  17. 7
      slv2/types.h
  18. 42
      src/plugin.c
  19. 10
      src/plugininstance.c
  20. 57
      src/pluginlist.c
  21. 58
      src/port.c
  22. 50
      src/query.c
  23. 30
      src/util.c
  24. 19
      src/util.h

3
AUTHORS

@ -2,3 +2,6 @@ Author:
Dave Robillard <mailto:drobilla@connect.carleton.ca>
(Note that this library is completely distinct from the LV2 specification
itself, which many more were involved in)

15
examples/hosts/jack_host.c

@ -18,6 +18,7 @@
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <slv2/slv2.h>
#include <jack/jack.h>
@ -27,14 +28,14 @@ struct JackHost {
jack_client_t* jack_client; /**< Jack client */
SLV2Plugin* plugin; /**< Plugin "class" (actually just a few strings) */
SLV2Instance* instance; /**< Plugin "instance" (loaded shared lib) */
unsigned long num_ports; /**< Size of the two following arrays: */
size_t num_ports; /**< Size of the two following arrays: */
jack_port_t** jack_ports; /**< For audio ports, otherwise NULL */
float* controls; /**< For control ports, otherwise 0.0f */
};
void die(const char* msg);
void create_port(struct JackHost* host, unsigned long port_index);
void create_port(struct JackHost* host, uint32_t port_index);
int jack_process_cb(jack_nframes_t nframes, void* data);
void list_plugins(SLV2List list);
@ -99,7 +100,7 @@ main(int argc, char** argv)
host.jack_ports = calloc(host.num_ports, sizeof(jack_port_t*));
host.controls = calloc(host.num_ports, sizeof(float*));
for (unsigned long i=0; i < host.num_ports; ++i)
for (size_t i=0; i < host.num_ports; ++i)
create_port(&host, i);
/* Activate plugin and JACK */
@ -146,10 +147,10 @@ die(const char* msg)
*/
void
create_port(struct JackHost* host,
unsigned long port_index)
uint32_t port_index)
{
/* Make sure this is a float port */
uchar* type = slv2_port_get_data_type(host->plugin, port_index);
char* type = slv2_port_get_data_type(host->plugin, port_index);
if (strcmp(type, SLV2_DATA_TYPE_FLOAT))
die("Unrecognized data type, aborting.");
free(type);
@ -197,7 +198,7 @@ jack_process_cb(jack_nframes_t nframes, void* data)
struct JackHost* host = (struct JackHost*)data;
/* Connect plugin ports directly to JACK buffers */
for (unsigned long i=0; i < host->num_ports; ++i)
for (size_t i=0; i < host->num_ports; ++i)
if (host->jack_ports[i] != NULL)
slv2_instance_connect_port(host->instance, i,
jack_port_get_buffer(host->jack_ports[i], nframes));
@ -212,7 +213,7 @@ jack_process_cb(jack_nframes_t nframes, void* data)
void
list_plugins(SLV2List list)
{
for (int i=0; i < slv2_list_get_length(list); ++i) {
for (size_t i=0; i < slv2_list_get_length(list); ++i) {
const SLV2Plugin* const p = slv2_list_get_plugin_by_index(list, i);
printf("%s\n", slv2_plugin_get_uri(p));
}

69
examples/hosts/test_host.c

@ -61,7 +61,7 @@ create_audio_output()
void
create_port(SLV2Plugin* plugin,
SLV2Instance* instance,
unsigned long port_index)
uint32_t port_index)
{
enum SLV2PortClass class = slv2_port_get_class(plugin, port_index);
@ -102,14 +102,14 @@ main()
const SLV2Plugin* p = slv2_list_get_plugin_by_uri(plugins, plugin_uri);
if (p) {
/* Get the plugin's name */
unsigned char* name = slv2_plugin_get_name(p);
char* name = slv2_plugin_get_name(p);
printf("Name:\t%s\n", name);
free(name);
unsigned long num_ports = slv2_plugin_get_num_ports(p);
uint32_t num_ports = slv2_plugin_get_num_ports(p);
//printf("Number of ports: %ld\n", num_ports);
for (unsigned long i=0; i < num_ports; ++i) {
for (uint32_t i=0; i < num_ports; ++i) {
enum SLV2PortClass class = slv2_port_get_class(p, i);
switch (class) {
@ -134,7 +134,7 @@ main()
}
SLV2Property prop;
for (unsigned long i=0; i < num_ports; ++i) {
for (uint32_t i=0; i < num_ports; ++i) {
const char* property = "a";
prop = slv2_port_get_property(p, i, property);
if (prop)
@ -167,65 +167,6 @@ main()
slv2_list_free(plugins);
#if 0
/* Display all plugins found in path */
if (plugins)
printf("Plugins found: %ld\n", slv2_list_get_size(plugins));
else
printf("No plugins found in %s\n", path);
for (unsigned long i=0; 1; ++i) {
const SLV2Plugin* p =
slv2_list_get_plugin_by_index(plugins, i);
if (!p)
break;
else
printf("\t%s\n", slv2_plugin_get_uri(p));
}
#endif
#if 0
const uchar* bundle_url = (const uchar*)"file:/home/dave/code/ladspa2/ladspa2_sdk/examples/plugins/Amp-swh.ladspa2/";
LV2Bundle* b = slv2_bundle_load(bundle_url);
if (b != NULL) {
printf("Loaded bundle %s\n", slv2_bundle_get_url(b));
for (unsigned long i=0; i < slv2_bundle_get_num_plugins(b); ++i) {
const SLV2Plugin* p = slv2_bundle_get_plugin_by_index(b, i);
//printf("Plugin: %s\n", p->plugin_uri);
//printf("Lib: %s\n", p->lib_url);
//printf("Data: %s\n", p->data_url);
printf("\n");
const uchar* property = (uchar*)"doap:name";
printf("%s\t%s\n", slv2_plugin_get_uri(p), property);
struct SLV2Property* result = slv2_plugin_get_property(p, property);
if (result) {
for (int i=0; i < result->num_values; ++i)
printf("\t%s\n", result->values[i]);
} else {
printf("No results.\n");
}
printf("\n");
/* Instantiate plugin */
SLV2PluginInstance* instance = slv2_plugin_instantiate(
p, 48000, NULL);
if (instance != NULL) {
printf("Successfully instantiated %s\n", slv2_plugin_get_uri(p));
slv2_plugin_instance_free(instance);
}
}
} else {
printf("Failed to load bundle %s\n", bundle_url);
}
#endif
return 0;
}

0
examples/plugins/Amp-swh.lv2/Makefile → examples/plugins/Amp-slv2.lv2/Makefile

26
examples/plugins/Amp-swh.lv2/amp.c → examples/plugins/Amp-slv2.lv2/amp.c

@ -11,7 +11,7 @@
#define SYMBOL_EXPORT
#endif
#define AMP_URI "http://plugin.org.uk/swh-plugins/amp";
#define AMP_URI "http://codeson.net/plugins/amp"
#define AMP_GAIN 0
#define AMP_INPUT 1
#define AMP_OUTPUT 2
@ -24,11 +24,15 @@ typedef struct {
float *output;
} Amp;
static void cleanupAmp(LV2_Handle instance) {
static void
cleanupAmp(LV2_Handle instance) {
free(instance);
}
static void connectPortAmp(LV2_Handle instance, unsigned long port,
static void
connectPortAmp(LV2_Handle instance, unsigned long port,
void *data) {
Amp *plugin = (Amp *)instance;
@ -45,16 +49,20 @@ static void connectPortAmp(LV2_Handle instance, unsigned long port,
}
}
static LV2_Handle instantiateAmp(const LV2_Descriptor *descriptor,
static LV2_Handle
instantiateAmp(const LV2_Descriptor *descriptor,
unsigned long s_rate, const char *path , const LV2_Host_Feature **features) {
Amp *plugin_data = (Amp *)malloc(sizeof(Amp));
return (LV2_Handle)plugin_data;
}
#define DB_CO(g) ((g) > -90.0f ? powf(10.0f, (g) * 0.05f) : 0.0f)
static void runAmp(LV2_Handle instance, unsigned long sample_count) {
static void
runAmp(LV2_Handle instance, unsigned long sample_count) {
Amp *plugin_data = (Amp *)instance;
const float gain = *(plugin_data->gain);
@ -69,7 +77,9 @@ static void runAmp(LV2_Handle instance, unsigned long sample_count) {
}
}
static void init() {
static void
init() {
ampDescriptor =
(LV2_Descriptor *)malloc(sizeof(LV2_Descriptor));
@ -82,8 +92,10 @@ static void init() {
ampDescriptor->run = runAmp;
}
SYMBOL_EXPORT
const LV2_Descriptor *lv2_descriptor(unsigned long index) {
const LV2_Descriptor*
lv2_descriptor(unsigned long index) {
if (!ampDescriptor) init();
switch (index) {

57
examples/plugins/Amp-slv2.lv2/amp.ttl

@ -0,0 +1,57 @@
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix lv2: <http://lv2plug.in/ontology#> .
@prefix foaf: <http://xmlns.com/foaf/0.1/> .
@prefix doap: <http://usefulinc.com/ns/doap#> .
<http://codeson.net/plugins/amp> a lv2:Plugin ;
a lv2:AmplifierPlugin ;
doap:maintainer [
foaf:name "Dave Robillard";
foaf:homepage <http://codeson.net/> ;
foaf:mbox <mailto:drobilla@connect.carleton.ca>
] ;
doap:name "Simple Amplifier" ;
doap:name "Einfacher Verst¿¿rker"@de ;
doap:licence <http://usefulinc.com/doap/licenses/gpl> ;
lv2:property lv2:hardRTCapable ;
lv2:port [
a lv2:ControlRateInputPort ;
lv2:datatype lv2:float ;
lv2:index 0 ;
lv2:symbol "gain" ;
lv2:name "Gain" ;
lv2:name "Gewinn"@de ;
lv2:default [ rdf:value 0.0 ] ;
lv2:minimum [ rdf:value -90.0 ] ;
lv2:maximum [ rdf:value 24.0 ] ;
lv2:scalePoint [
rdfs:label "+5" ;
rdf:value 5.0
] , [
rdfs:label "Unity" ;
rdf:value 1.0
] , [
rdfs:label "-5" ;
rdf:value -5.0
] , [
rdfs:label "-10" ;
rdf:value -10.0
]
] , [
a lv2:AudioRateInputPort ;
lv2:datatype lv2:float ;
lv2:index 1 ;
lv2:symbol "in" ;
lv2:name "Input"
] , [
a lv2:AudioRateOutputPort ;
lv2:datatype lv2:float ;
lv2:index 2 ;
lv2:symbol "out" ;
lv2:name "Output"
]
.

6
examples/plugins/Amp-swh.lv2/manifest.ttl → examples/plugins/Amp-slv2.lv2/manifest.ttl

@ -4,6 +4,8 @@
@prefix lv2: <http://lv2plug.in/ontology#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://plugin.org.uk/swh-plugins/amp> lv2:binary <amp.so> ;
rdfs:seeAlso <amp.ttl> .
<http://codeson.net/plugins/amp>
lv2:binary <amp.so> ;
rdfs:seeAlso <amp.ttl> .

68
examples/plugins/Amp-swh.lv2/amp.ttl

@ -1,68 +0,0 @@
@prefix lv2: <http://lv2plug.in/ontology#> .
@prefix foaf: <http://xmlns.com/foaf/0.1/> .
@prefix doap: <http://usefulinc.com/ns/doap#> .
<http://plugin.org.uk/swh-plugins/amp> a lv2:Plugin ;
a lv2:AmplifierPlugin ;
doap:maintainer [
foaf:name "Steve Harris";
foaf:homepage <http://plugin.org.uk/> ;
foaf:mbox <mailto:steve@plugin.org.uk> ;
] ;
doap:name "Simple amplifier" ;
doap:name "简单放大器"@ch ;
doap:name "Einfacher Verstärker"@de ;
doap:name "Simple amp"@en-gb-gb ;
doap:name "Amplificador simple"@es ;
doap:name "Amplificateur de base"@fr ;
doap:name "Amplificatore semplice"@it ;
doap:name "簡単なアンプ"@jp ;
doap:name "Просто усилитель"@ru ;
doap:licence <http://usefulinc.com/doap/licenses/gpl> ;
lv2:property lv2:hardRtCapable ;
lv2:port [
a lv2:InputControlRatePort ;
lv2:datatype lv2:float ;
lv2:index 0 ;
lv2:symbol "gain" ;
lv2:name "gain" ;
lv2:name "收益"@ch ;
lv2:name "gewinn"@de ;
lv2:name "gain"@en-gb-gb ;
lv2:name "aumento"@es ;
lv2:name "gain"@fr ;
lv2:name "guadagno"@it ;
lv2:name "利益"@jp ;
lv2:name "увеличение"@ru ;
lv2:default 0.0 ;
lv2:minimum -90.0 ;
lv2:maximum 24.0 ;
lv2:scalePoint [
lv2:label "+5" ;
lv2:value 5.0 ;
] , [
lv2:label "0" ;
lv2:value 0.0 ;
] , [
lv2:label "-5" ;
lv2:value -5.0 ;
] , [
lv2:label "-10" ;
lv2:value -10.0 ;
]
] , [
a lv2:InputAudioRatePort ;
lv2:datatype lv2:float ;
lv2:index 1 ;
lv2:symbol "in" ;
lv2:name "in" ;
] , [
a lv2:OutputAudioRatePort ;
lv2:datatype lv2:float ;
lv2:index 2 ;
lv2:symbol "out" ;
lv2:name "out" ;
]
.

12
include/lv2.h

@ -24,6 +24,8 @@
#ifndef LV2_INCLUDED
#define LV2_INCLUDED
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
@ -153,7 +155,7 @@ typedef struct _LV2_Descriptor {
* activate() rather than here. If a host calls instantiate, it MUST
* call cleanup() at some point in the future. */
LV2_Handle (*instantiate)(const struct _LV2_Descriptor * Descriptor,
unsigned long SampleRate,
uint32_t SampleRate,
const char * BundlePath,
const LV2_Host_Feature** HostFeatures);
@ -184,7 +186,7 @@ typedef struct _LV2_Descriptor {
* However, overlapped buffers or use of a single buffer for both
* audio and control data may result in unexpected behaviour. */
void (*connect_port)(LV2_Handle Instance,
unsigned long Port,
uint32_t Port,
void * DataLocation);
/** Function pointer that initialises a plugin instance and activates
@ -226,7 +228,7 @@ typedef struct _LV2_Descriptor {
* there are various things that the plugin MUST NOT do within the run()
* function (see above). */
void (*run)(LV2_Handle Instance,
unsigned long SampleCount);
uint32_t SampleCount);
/** This is the counterpart to activate() (see above). If there is
* nothing for deactivate() to do then the plugin writer may provide
@ -287,12 +289,12 @@ typedef struct _LV2_Descriptor {
* index that results in NULL being returned. Index has no meaning,
* hosts MUST NOT depend on it remaining constant (ie when serialising)
* in any way. */
const LV2_Descriptor * lv2_descriptor(unsigned long Index);
const LV2_Descriptor * lv2_descriptor(uint32_t Index);
/** Datatype corresponding to the lv2_descriptor() function. */
typedef const LV2_Descriptor *
(*LV2_Descriptor_Function)(unsigned long Index);
(*LV2_Descriptor_Function)(uint32_t Index);
/* ******************************************************************** */

721
include/lv2.ttl

@ -1,263 +1,459 @@
# RDF Schema file for LV2 plugins
# RDF Schema for LV2 plugins
# *** PROVISIONAL ***
#
# This document describes the classes and properties that are defined by the
# core LV2 specification.
# core LV2 specification. See <http://lv2plug.in> for more information.
#
# Copyright (C) 2006 Steve Harris, Dave Robillard
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
@prefix : <http://lv2plug.in/ontology#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix dc: <http://purl.org/dc/elements/1.1/> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema> .
@prefix doap: <http://usefulinc.com/ns/doap#> .
@prefix foaf: <http://xmlns.com/foaf/0.1/> .
<> dc:creator "Steve Harris" ;
dc:date "2006-04-26" .
<> doap:license <http://usefulinc.com/doap/licenses/mit> .
#
# Classes
#
<> doap:release [ doap:Version
[ doap:revision "0.9" ; doap:created "2006-07-24" ] ] .
<> doap:maintainer [ foaf:Person
[ foaf:name "Steve Harris" ;
rdfs:seeAlso "http://inanna.ecs.soton.ac.uk/swh.xrdf" ] ] .
##################
## Plugin Class ##
##################
:Plugin a rdfs:Class ;
rdfs:label "Plugin" ;
rdfs:comment """
This is the class that represents an LV2 plugin.
In order for it to be used by a host it must have at least one occurance of the
following properties:
rdf:type (with object :Plugin)
doap:name (one without language tag)
doap:licence
lv2:port
This can be determined by the following SPARQL query:
PREFIX : <http://lv2plug.in/ontology#>
PREFIX doap: <http://usefulinc.com/ns/doap#>
SELECT DISTINCT ?uri WHERE {
?uri a :Plugin ;
doap:name ?name ;
doap:licence ?rights ;
:port ?port .
FILTER( LANG(?name) = "" )
}
rdfs:label "Plugin" ;
rdfs:comment """
The class that represents an LV2 plugin.
To be used by a host a Plugin must have at least the following properties:
rdf:type (with object :Plugin)
doap:name (one without language tag)
doap:licence
lv2:port
""" .
##################
## Port Classes ##
##################
:Port a rdfs:Class ;
rdfs:label "Port" ;
rdfs:comment """
This is the class that represents an LV2 port
In order for it to be used by a host it must have at least the following
properties:
rdf:type (where object is exactly one of :InputControlRatePort,
:OutputControlRatePort, :InputAudioRatePort or :OututAudioRatePort)
:datatype
:index
:symbol
:name
rdfs:label "Port" ;
rdfs:comment """
The class that represents an LV2 port
In order for it to be used by a host it must have at least
the following properties:
rdf:type (where object is exactly one of
:InputControlRatePort, :OutputControlRatePort,
:InputAudioRatePort, :OututAudioRatePort)
:dataType
:index
:symbol
:name
""" .
:InputPort a rdfs:Class ;
rdfs:subClassOf :Port .
rdfs:subClassOf :Port .
:OutputPort a rdfs:Class ;
rdfs:subClassOf :Port .
rdfs:subClassOf :Port .
:ControlRatePort a rdfs:Class ;
rdfs:subClassOf :Port .
rdfs:subClassOf :Port .
:AudioRatePort a rdfs:Class ;
rdfs:subClassOf :Port .
rdfs:subClassOf :Port .
:InputControlRatePort a rdfs:Class ;
rdfs:label "Input control port" ;
rdfs:subClassOf :ControlRatePort ;
rdfs:subClassOf :InputPort ;
rdfs:comment """
:ControlRateInputPort a rdfs:Class ;
rdfs:label "Control-rate input port" ;
rdfs:subClassOf :ControlRatePort ;
rdfs:subClassOf :InputPort ;
rdfs:comment """
Ports of this type will be connected to a pointer to a single value of the type
defined by the :datatype property.
defined by the :dataType property.
Plugins will read values from this pointer during thier run method.
Plugins will read values from this pointer during their run method.
""" .
:OutputControlRatePort a rdfs:Class ;
rdfs:label "Output control port" ;
rdfs:subClassOf :ControlRatePort ;
rdfs:subClassOf :OutputPort ;
rdfs:comment """
:ControlRateOutputPort a rdfs:Class ;
rdfs:label "Control-rate output port" ;
rdfs:subClassOf :ControlRatePort ;
rdfs:subClassOf :OutputPort ;
rdfs:comment """
Ports of this type will be connected to a pointer to a single value of the type
defined by the :datatype property.
defined by the :dataType property.
Plugins will write values to this pointer during thier run method.
Plugins will write values to this pointer during their run method.
""" .
:InputAudioRatePort a rdfs:Class ;
rdfs:label "Input audio port" ;
rdfs:subClassOf :AudioRatePort ;
rdfs:subClassOf :InputPort ;
rdfs:comment """
Ports of this type will be connected to a an array of values of length
SampleCount and of the type defined by the :datatype property.
:AudioRateInputPort a rdfs:Class ;
rdfs:label "Audio-rate input port" ;
rdfs:subClassOf :AudioRatePort ;
rdfs:subClassOf :InputPort ;
rdfs:comment """
Ports of this type will be connected to an array of values of length
SampleCount and of the type defined by the :dataType property.
Plugins will read values from this array during their run method.
""" .
:OutputAudioRatePort a rdfs:Class ;
rdfs:label "Output audio port" ;
rdfs:subClassOf :AudioRatePort ;
rdfs:subClassOf :OutputPort ;
rdfs:comment """
Ports of this type will be connected to a an array of values of length
SampleCount and of the type defined by the :datatype property.
:AudioRateOutputPort a rdfs:Class ;
rdfs:label "Audio-rate output port" ;
rdfs:subClassOf :AudioRatePort ;
rdfs:subClassOf :OutputPort ;
rdfs:comment """
Ports of this type will be connected to an array of values of length
SampleCount and of the type defined by the :dataType property.
Plugins will write values to this array during their run method.
""" .
:ScalePoint a rdfs:Class ;
rdfs:label "Scale point" ;
rdfs:comment """
Used to describe interesting values in a Port's range.
It has two properties neccesary for use, :label and :value.
""" .
:Property a rdfs:Class ;
rdfs:label "Property" ;
rdfs:comment """
Used to inform the host of the capabilities of the Plugin.
""" .
#################################
# Mandatory Port RDF:Properties #
#################################
:Hint a rdfs:Class ;
rdfs:label "Hint" ;
rdfs:comment """
Used to hint to the host various things which can make interacting with the
Port more natural.
""" .
:Datatype a rdfs:Class ;
rdfs:comment "A data type that can be stored in an LV2 port." .
:HostFeature a rdfs:Class ;
rdfs:label "Host feature" ;
:dataType a rdf:Property ;
rdfs:domain :Port ;
rdfs:range lv2:DataType ;
rdfs:label "Port Data type" ;
rdfs:comment """
Used to describe a host feature which plugin may use or require.
""" .
#
# Properties
#
:property a rdf:Property ;
rdfs:domain :Plugin ;
rdfs:range :Property ;
rdfs:label "property" ;
rdfs:comment "Relates Plugins to Properties." .
:requiredHostFeature a rdf:Property ;
rdfs:domain :Plugin ;
rdfs:range :HostFeature ;
rdfs:label "Required host feature" ;
rdfs:comment """
Signifies that plugin requires a certain host feature to function.
The plugin will fail to instantiate if a required host feature is not present;
hosts SHOULD always check this before attempting to instantiate a plugin.
""" .
:hint a rdf:Property ;
rdfs:domain :Port ;
rdfs:range :Hint ;
rdfs:label "hint" ;
rdfs:comment "Relates Ports to Hints." .
:datatype a rdf:Property ;
rdfs:domain :Port ;
rdfs:range :Datatype ;
rdfs:label "datatype" ;
rdfs:comment """
Relates a Port to the datatype(s) is can accept. Currently the only specified
datatype is :float, which specfies IEEE-754 32bit floating point values.
Hosts that do not support a specfied datatype MUST NOT instantiate the plugin.
Relates a Port to the data type(s) it can accept. Hosts that do not support
a specfied datatype MUST NOT instantiate the plugin, unless that port has
the connectionOptional hint set (in which case the host can simply "connect"
that port to NULL).
If multiple datatypes are specfied the plugin must have some way to distinguish
the values.
the values (any extension that defines a new data-type which wishes to allow
this must deal with this issue somehow).
""" .
# FIXME: rdfs:range = xsd:nonNegativeInteger?
:index a rdf:Property ;
rdfs:domain :Port ;
rdfs:label "index" ;
rdfs:comment """
rdfs:domain :Port ;
rdfs:range xsd:nonNegativeInteger ;
rdfs:label "index" ;
rdfs:comment """
Specifies the index of the port, passed as an argument to the connect port
function. This number uniqely identifies the port within the plugin.
The plugin author MUST change the plugin URI if a port index is changed.
""" .
# FIXME: rdfs:range = xsd:NCName? Closest thing xsd: has..
:symbol a rdf:Property ;
rdfs:domain :Port ;
rdfs:label "symbol" ;
rdfs:comment """
rdfs:domain :Port ;
rdfs:label "symbol" ;
rdfs:comment """
A short name used to identify the port in an easily machine and human readable way.
The first character must be one of _, a-z or A-Z and subsequenct characters can
be from _, a-z, A-Z and 0-9.
No language tag should be used on this property.
A language tag MUST NOT be used on this property. The plugin author MUST change
the plugin URI if a port symbol is changed.
""" .
# FIXME: This isn't really fundamental like :index and :symbol
:name a rdf:Property ;
rdfs:domain :Port ;
rdfs:label "name" ;
rdfs:comment """
rdfs:domain :Port ;
rdfs:label "name" ;
rdfs:comment """
A display name for labeling the Port in a user interface.
This property is required for Ports, but should not be used by the host for
This property is required for Ports, but MUST NOT be used by the host for
port identification. The plugin author may change the values of this
property without changing the Plugin URI.
""" .
:default a rdf:Property ;
rdfs:domain :ControlRatePort ;
rdfs:label "default" ;
rdfs:comment """
The default value that the host SHOULD set this port to when there is not other
information available. Only meaningful for Ports with a :datatype of :float.
""" .
:minimum a rdf:Property ;
rdfs:domain :Port ;
rdfs:label "minimum" ;
rdfs:comment """
A hint to the host for the minimum useful value that the port will use. The
plugin is required to accept all values in the range of :float.
""" .
:minimum a rdf:Property ;
rdfs:domain :Port ;
rdfs:label "maximum" ;
#############################################
# Port Additional RDF:Properties (Optional) #
#############################################
:Point a rdfs:Class ;
rdfs:label "Port value point" ;
rdfs:comment """
A hint to the host for the maximum useful value that the port will use. The
plugin is required to accept all values in the range of :float.
Used to describe interesting values in a Port's range. To be valid it requires
two rdf:properties, rdfs:label and rdf:value.
There are 3 specially defined Points in the LV2 specification (default,
minimum, and maximum), though future extensions may define more.
""" .
:ScalePoint a rdfs:Class ;
rdfs:subClassOf :Point ;
rdfs:comment "A single :float Point (for control inputs)" .
:scalePoint a rdf:Property ;
rdfs:domain :Port ;
rdfs:range :ScalePoint ;
rdfs:label "scale point" ;
rdfs:label "Scale point" ;
rdfs:comment "Relates a Port to its ScalePoints." .
:default a rdf:Property ;
rdfs:subPropertyOf :scalePoint ;
rdfs:label "Default value" ;
rdfs:comment """
The default value that the host SHOULD set this port to when there is no other
information available.
""" .
#
# Instances
#
:minimum a rdf:Property ;
rdfs:subPropertyOf :scalePoint ;
rdfs:label "Minimum value" ;
rdfs:comment """
A hint to the host for the minimum useful value that the port will use.
This is a "soft" limit - the plugin is required to gracefully accept all
values in the range of :Float.
""" .
:maximum a rdf:Property ;
rdfs:subPropertyOf :scalePoint ;
rdfs:label "Maximum value" ;
rdfs:comment """
A hint to the host for the maximum useful value that the port will use.
This is a "soft" limit - the plugin is required to gracefully accept all
values in the range of :Float.
""" .
#############
# Data Type #
#############
:Float a rdfs:DataType ;
rdfs:label "32-bit Floating Point" ;
rdfs:comment """
Value conforming to the 32bit IEEE-754 floating point specification.""".
###################
## Host Features ##
###################
:HostFeature a rdfs:Class ;
rdfs:label "Host feature" ;
rdfs:comment "A host feature which a plugin may use (possibly require).".
:toggled a :Hint ;
rdfs:label "toggled" ;
:supportedHostFeature a rdf:Property ;
rdfs:domain :Plugin ;
rdfs:range :HostFeature ;
rdfs:label "Supported (optional) host feature" ;
rdfs:comment """
Signifies that a plugin is able to make use of a certain host feature.
The plugin MUST NOT fail to instantiate if a supported (but not required)
host feature is not present.""" .
:requiredHostFeature a rdf:Property ;
rdfs:domain :Plugin ;
rdfs:range :HostFeature ;
rdfs:label "Required host feature" ;
rdfs:comment """
Signifies that a plugin requires a certain host feature to function.
The plugin MUST fail to instantiate if a required host feature is not present;
hosts SHOULD always check this before attempting to instantiate a plugin
(eg discovery by attempting to instantiate is strongly discouraged).
""" .
####################
## LV2 Properties ##
####################
:Property a rdfs:Class ;
rdfs:label "Property" ;
rdfs:comment """
An LV2 Property. A host MUST NOT ignore the presence of a Property
(eg if it does, something catastrophic will happen and the plugin will not
function). If a piece of information can be ignored by the host and the
plugin can still function correctly, it is NOT a Property, it is a Hint.
""" .
:PluginProperty a rdfs:Class ;
rdfs:label "Plugin property" ;
rdfs:subClassOf :Property ;
rdfs:comment "Property of a Plugin." .
:PortProperty a rdfs:Class ;
rdfs:label "Port property" ;
rdfs:subClassOf :Property ;
rdfs:comment "Property of a Port." .
:pluginProperty a rdf:Property ;
rdfs:domain :Plugin ;
rdfs:range :PluginProperty ;
rdfs:label "Plugin property" ;
rdfs:comment "Relates Plugins to PluginProperties." .
:portProperty a rdf:Property ;
rdfs:domain :Port ;
rdfs:range :PortProperty ;
rdfs:label "hint" ;
rdfs:comment "Relates Ports to PortProperties." .
###############
## LV2 Hints ##
###############
:Hint a rdfs:Class ;
rdfs:label "Hint" ;
rdfs:comment """
An LV2 Hint - a useful piece of information that allows a host to make more
sensible decisions (eg to provide a better interface). Unlike a Property
a Hint may be ignored without catastrophic effects (though this doesn't mean
a Hint is less "important" than a Property, whether or not it can be safely
ignored and have the plugin still function correctly is the sole distinction).
""" .
:PluginHint a rdfs:Class ;
rdfs:label "Plugin hint" ;
rdfs:subClassOf :Hint ;
rdfs:comment "Hint for a Plugin." .
:PortHint a rdfs:Class ;
rdfs:label "Port hint" ;
rdfs:subClassOf :Hint ;
rdfs:comment "Hint for a Port." .
:pluginHint a rdf:Property ;
rdfs:domain :Plugin ;
rdfs:range :PluginHint ;
rdfs:label "Plugin hint" ;
rdfs:comment "Relates Plugins to PluginHints." .
:portHint a rdf:Property ;
rdfs:domain :Port ;
rdfs:range :PortHint ;
rdfs:label "Port hint" ;
rdfs:comment "Relates Ports to PortHints." .
#############################
# Standard PluginProperties #
#############################
:isLive a :PluginProperty ;
rdfs:label "Has a live (realtime) dependency" ;
rdfs:comment """
Indicates that the plugin has a real-time dependency (e.g. queues data from a
socket) and so its output must not be cached or subject to significant latency,
and calls to the run method should be done in rapid succession.
""" .
:hardRTCapable a :PluginProperty ;
rdfs:label "Hard realtime capable" ;
rdfs:comment """
Indicates that the plugin is capable of running not only in a conventional host
but also in a "hard real-time" environment. To qualify for this the plugin must
satisfy all of the following:
(1) The plugin must not use malloc(), free() or other heap memory
management within its run() or run_adding() functions. All new
memory used in run() must be managed via the stack. These
restrictions only apply to the run() function.
(2) The plugin will not attempt to make use of any library
functions with the exceptions of functions in the ANSI standard C
and C maths libraries, which the host is expected to provide.
(3) The plugin will not access files, devices, pipes, sockets, IPC
or any other mechanism that might result in process or thread
blocking.
(4) The plugin will take an amount of time to execute a run() or
run_adding() call approximately of form (A+B*SampleCount) where A
and B depend on the machine and host in use. This amount of time
may not depend on input signals or plugin state. The host is left
the responsibility to perform timings to estimate upper bounds for
A and B.
""" .
:inplaceBroken a :PluginProperty ;
rdfs:label "in-place broken" ;
rdfs:comment """
Indicates that the plugin may cease to work correctly if the host elects to use
the same data location for both input and output. Plugins that will fail to
work correctly if ANY input buffer is set to the same location as ANY output
buffer (with connect_port()) MUST set this property. Doing so should be
avoided as enabling this flag makes it impossible for hosts to use the plugin
to process audio "in-place".
""" .
######################
# Standard PortHints #
######################
:connectionOptional a :PortHint ;
rdfs:label "Optionally connected port" ;
rdfs:comment """
Indicates that this port does not have to be connected to valid data by the
host. If it is to be disconnected then the port MUST set to NULL with a call
to the connectPort method.
""" .
:reportsLatency a :PortHint ;
rdfs:label "Latency reporting port" ;
rdfs:comment """
Indicates that the port is used to express the processing latency incurred by
the plugin, expressed in samples. The latency may be affected by the current
sample rate, plugin settings, or other factors, and may be changed by the
plugin at any time. Where the latency is frequency dependent the plugin may
choose any appropriate value. If a plugin introduces latency it MUST provide
EXACTLY ONE port with this hint set which informs the host of the "correct"
latency. In "fuzzy" cases the value output should be the most reasonable based
on user expectation of input/output alignment (eg. musical delay/echo plugins
should not report their delay as latency, as it is an intentional effect).
""".
:toggled a :PortHint ;
rdfs:label "Toggled" ;
rdfs:comment """
Indicates that the data item should be considered a Boolean toggle. Data less
than or equal to zero should be considered `off' or `false,' and data above
zero should be considered `on' or `true.'
than or equal to zero should be considered "off" or "false", and data above
zero should be considered "on" or "true".
""" .
:sampleRate a :Hint ;
rdfs:label "sample rate" ;
:sampleRate a :PortHint ;
rdfs:label "Sample rate" ;
rdfs:comment """
Indicates that any bounds specified should be interpreted as multiples of the
sample rate. For instance, a frequency range from 0Hz to the Nyquist frequency
@ -266,61 +462,146 @@ sample rate. For instance, a frequency range from 0Hz to the Nyquist frequency
this hint to retain meaning.
""" .
:integer a :Hint ;
rdfs:label "integer" ;
:integer a :PortHint ;
rdfs:label "Integer" ;
rdfs:comment """
Indicates that a user interface would probably wish to provide a stepped
control taking only integer values.
Indicates that a port's reasonable values are integers (eg. a user interface
would likely wish to provide a stepped control allowing only integer input).
A plugin MUST operate reasonably even if such a port has a non-integer input.
""" .
:realtime a :Property ;
rdfs:label "realtime" ;
rdfs:comment """
Indicates that the plugin has a real-time dependency (e.g. listens to a MIDI
device) and so its output must not be cached or subject to significant latency.
""" .
:inplaceBroken a :Property ;
rdfs:label "in-place broken" ;
rdfs:comment """
Indicates that the plugin may cease to work correctly if the host elects to use
the same data location for both input and output (see connect_port()). This
should be avoided as enabling this flag makes it impossible for hosts to use
the plugin to process audio `in-place.'
###############################
# Plugin Categories (Classes) #
###############################
:UtilityPlugin a rdfs:Class ;
rdfs:subClassOf :Plugin ;
rdfs:label "Utilities" ;
rdfs:comment """
Includes things like mathematical functions and non-musical delays.
""" .
:hardRtCapable a :Property ;
rdfs:label "hard realtime capable" ;
rdfs:comment """
Indicates that the plugin is capable of running not only in a conventional host
but also in a `hard real-time' environment. To qualify for this the plugin must
satisfy all of the following:
:GeneratorPlugin a rdfs:Class ;
rdfs:subClassOf :Plugin ;
rdfs:label "Generators" ;
rdfs:comment """
Any plugin that generates sound internally, rather than processing its input.
""" .
(1) The plugin must not use malloc(), free() or other heap memory
management within