From e70d7b5ae641d8d9619e888e6f2501eea964b37f Mon Sep 17 00:00:00 2001 From: David Robillard Date: Sun, 8 Oct 2006 05:08:55 +0000 Subject: Moved slv2 directory for consistency git-svn-id: http://svn.drobilla.net/lad/slv2@165 a436a847-0d15-0410-975c-d299462d15a1 --- include/Makefile.am | 3 - include/lv2.h | 321 --------------------------- include/lv2.ttl | 607 ---------------------------------------------------- 3 files changed, 931 deletions(-) delete mode 100644 include/Makefile.am delete mode 100644 include/lv2.h delete mode 100644 include/lv2.ttl (limited to 'include') diff --git a/include/Makefile.am b/include/Makefile.am deleted file mode 100644 index a8d9fe0..0000000 --- a/include/Makefile.am +++ /dev/null @@ -1,3 +0,0 @@ -lv2includedir = $(includedir) - -lv2include_HEADERS = lv2.h diff --git a/include/lv2.h b/include/lv2.h deleted file mode 100644 index e38e2ac..0000000 --- a/include/lv2.h +++ /dev/null @@ -1,321 +0,0 @@ -/* LV2 - LADSPA (Linux Audio Developer's Simple Plugin API) Version 2.0 - * *** PROVISIONAL *** - * - * Copyright (C) 2000-2002 Richard W.E. Furse, Paul Barton-Davis, Stefan - * Westerfeld - * Copyright (C) 2006 Steve Harris, Dave Robillard. - * - * This header is free software; you can redistribute it and/or modify it - * under the terms of the GNU Lesser General Public License as published - * by the Free Software Foundation; either version 2.1 of the License, - * or (at your option) any later version. - * - * This header is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 - * USA. - */ - -#ifndef LV2_H_INCLUDED -#define LV2_H_INCLUDED - -#include - -#ifdef __cplusplus -extern "C" { -#endif - - -/* ************************************************************************* */ - - -/* Overview: - * - * There are a large number of open source and free software synthesis - * packages in use or development at this time. This API ('LV2') - * attempts to give programmers the ability to write simple 'plugin' - * audio processors in C/C++ and link them dynamically ('plug') into - * a range of these packages ('hosts'). It should be possible for any - * host and any plugin to communicate completely through this interface. - * - * This API is deliberately as short and simple as possible. - * The information required to use a plugin is in a companion data - * (RDF) file. The shared library portion of the API (defined in this - * header) does not contain enough information to make use of the plugin - * possible - the data file is mandatory. - * - * Plugins are expected to distinguish between control rate and audio - * rate data. Plugins have 'ports' that are inputs or outputs for audio - * or control data and each plugin is 'run' for a 'block' corresponding - * to a short time interval measured in samples. Audio rate data is - * communicated using arrays with one element per sample processed, - * allowing a block of audio to be processed by the plugin in a single - * pass. Control rate data is communicated using single values. Control - * rate data has a single value at the start of a call to the 'run()' - * function, and may be considered to remain this value for its duration. - * Thus the 'control rate' is determined by the block size, controlled - * by the host. The plugin may assume that all its input and output - * ports have been connected to the relevant data location (see the - * 'connect_port()' function below) before it is asked to run. - * - * Plugins will reside in shared object files suitable for dynamic linking - * by dlopen() and family. The file will provide a number of 'plugin - * types' that can be used to instantiate actual plugins (sometimes known - * as 'plugin instances') that can be connected together to perform tasks. - * - * This API contains very limited error-handling. - */ - - -/* ************************************************************************* */ - - -/** Plugin Handle. - * - * This plugin handle indicates a particular instance of the plugin - * concerned. It is valid to compare this to NULL (0 for C++) but - * otherwise the host MUST not attempt to interpret it. The plugin - * may use it to reference internal instance data. */ -typedef void * LV2_Handle; - - -/* ************************************************************************* */ - - -/** Host feature. - * - * These are passed to a plugin's instantiate method to represent a special - * feature the host has which the plugin may depend on. This is to allow - * extensions to the LV2 specification without causing any breakage. The base - * LV2 specification does not define any host features; hosts are not required - * to use this facility. - */ -typedef struct _LV2_Host_Feature { - /** A globally unique, case-sensitive identifier for this feature. - * - * This MUST be defined in the specification of any LV2 extension which - * defines a host feature. - */ - const char * URI; - - /** Pointer to arbitrary data. - * - * This is to allow hosts to pass data to a plugin (simple values, data - * structures, function pointers, etc) as part of a 'feature'. The LV2 - * specification makes no restrictions on the contents of this data. - * The data here MUST be cleary defined by the LV2 extension which defines - * this feature. - * If no data is required, this may be set to NULL. - */ - void * data; -} LV2_Host_Feature; - - -/* ************************************************************************* */ - - -/** Descriptor for a Type of Plugin. - * - * This structure is used to describe a plugin type. It provides a number - * of functions to instantiate it, link it to buffers and run it. */ -typedef struct _LV2_Descriptor { - - /** A globally unique, case-sensitive identifier for this plugin type. - * - * All plugins with the same URI MUST be compatible in terms of 'port - * signature', meaning they have the same number of ports, same port - * shortnames, and roughly the same functionality. URIs should - * probably contain a version number (or similar) for this reason. - * - * Rationale: When serializing session/patch/etc files, hosts MUST - * refer to a loaded plugin by the plugin URI only. In the future - * loading a plugin with this URI MUST yield a plugin with the - * same ports (etc) which is 100% compatible. */ - const char * URI; - - /** Function pointer that instantiates a plugin. - * - * A handle is returned indicating the new plugin instance. The - * instantiation function accepts a sample rate as a parameter as well - * as the plugin descriptor from which this instantiate function was - * found. This function must return NULL if instantiation fails. - * - * BundlePath is a string of the path to the plugin's .lv2 bundle - * directory, it MUST not include the trailing /. - * - * HostFeatures is a NULL terminated array of the URIs of the LV2 - * features that the host supports. Plugins may refuse to instantiate - * if required features are not found here (however hosts SHOULD NOT use - * this as a discovery mechanism, instead reading the data file before - * attempting to instantiate the plugin). - * - * Note that instance initialisation should generally occur in - * 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, - uint32_t SampleRate, - const char * BundlePath, - const LV2_Host_Feature** HostFeatures); - - /** Function pointer that connects a port on a plugin instance to a memory - * location where the block of data for the port will be read/written. - * - * The data location is expected to be an array of void * (typically - * float *) for audio ports or a single void * value for control - * ports. Memory issues are managed by the host. The plugin must - * read/write the data at these locations every time run() is called - * and the data present at the time of this connection call MUST NOT - * be considered meaningful. - * - * connect_port() may be called more than once for a plugin instance - * to allow the host to change the buffers that the plugin is reading - * or writing. These calls may be made before or after activate() - * or deactivate() calls. - * - * connect_port() must be called at least once for each port before - * run() is called. The plugin must pay careful attention to the block - * size passed to the run function as the block allocated may only just - * be large enough to contain the block of data (typically samples), and - * is not guaranteed to be constant. - * - * Plugin writers should be aware that the host may elect to use the - * same buffer for more than one port and even use the same buffer for - * both input and output (see LV2_PROPERTY_INPLACE_BROKEN (FIXME)). - * 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, - uint32_t Port, - void * DataLocation); - - /** Function pointer that initialises a plugin instance and activates - * it for use. - * - * This is separated from instantiate() to aid real-time support and so - * that hosts can reinitialise a plugin instance by calling deactivate() - * and then activate(). In this case the plugin instance must reset all - * state information dependent on the history of the plugin instance - * except for any data locations provided by connect_port(). If there - * is nothing for activate() to do then the plugin writer may provide - * a NULL rather than an empty function. - * - * When present, hosts MUST call this function once before run() - * is called for the first time. This call SHOULD be made as close - * to the run() call as possible and indicates to real-time plugins - * that they are now live, however plugins MUST NOT rely on a prompt - * call to run() after activate(). activate() may not be called again - * unless deactivate() is called first (after which activate() may be - * called again, followed by deactivate, etc. etc.). If a host calls - * activate, it MUST call deactivate at some point in the future. - * - * Note that connect_port() may be called before or after a call to - * activate(). */ - void (*activate)(LV2_Handle Instance); - - /** Function pointer that runs a plugin instance for a block. - * - * Two parameters are required: the first is a handle to the particular - * instance to be run and the second indicates the block size (in - * samples) for which the plugin instance may run. - * - * Note that if an activate() function exists then it must be called - * before run(). If deactivate() is called for a plugin instance then - * the plugin instance may not be reused until activate() has been - * called again. - * - * If the plugin has the property LV2_PROPERTY_HARD_RT_CAPABLE then - * there are various things that the plugin MUST NOT do within the run() - * function (see above). */ - void (*run)(LV2_Handle Instance, - 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 - * a NULL rather than an empty function. - * - * Hosts must deactivate all activated units after they have been run() - * for the last time. This call SHOULD be made as close to the last - * run() call as possible and indicates to real-time plugins that - * they are no longer live, however plugins MUST NOT rely on prompt - * deactivation. Note that connect_port() may be called before or - * after a call to deactivate(). - * - * Note that deactivation is not similar to pausing as the plugin - * instance will be reinitialised when activate() is called to reuse it. - * Hosts MUST NOT call deactivate() unless activate() was previously - * called. */ - void (*deactivate)(LV2_Handle Instance); - - /** This is the counterpart to instantiate() (see above). Once an instance - * of a plugin has been finished with it can be deleted using this - * function. The instance handle passed ceases to be valid after - * this call. - * - * If activate() was called for a plugin instance then a corresponding - * call to deactivate() MUST be made before cleanup() is called. - * Hosts MUST NOT call cleanup() unless instantiate() was previously - * called. */ - void (*cleanup)(LV2_Handle Instance); - -} LV2_Descriptor; - - -/* ****************************************************************** */ - - -/** Accessing a Plugin: - * - * The exact mechanism by which plugins are loaded is host-dependent, - * however all most hosts will need to know is the URI of the plugin they - * wish to load. The environment variable LV2_PATH, if present, should - * contain a colon-separated path indicating directories (containing - * plugin bundle subdirectories) that should be searched (in order) - * for plugins. It is expected that hosts will use a library to provide - * this functionality. - * - * A plugin programmer must include a function called "lv2_descriptor" - * with the following function prototype within the shared object - * file. This function will have C-style linkage (if you are using - * C++ this is taken care of by the 'extern "C"' clause at the top of - * the file). - * - * A host will find the plugin shared object file by one means or another, - * find the lv2_descriptor() function, call it, and proceed from there. - * - * Plugin types are accessed by index (not ID) using values from 0 - * upwards. Out of range indexes must result in this function returning - * NULL, so the plugin count can be determined by checking for the least - * 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(uint32_t Index); - - -/** Datatype corresponding to the lv2_descriptor() function. */ -typedef const LV2_Descriptor * -(*LV2_Descriptor_Function)(uint32_t Index); - - -/* ******************************************************************** */ - - -/* Put this (LV2_SYMBOL_EXPORT) before any functions that are to be loaded - * by the host as a symbol from the dynamic library. - */ -#ifdef WIN32 -#define LV2_SYMBOL_EXPORT __declspec(dllexport) -#else -#define LV2_SYMBOL_EXPORT -#endif - - -#ifdef __cplusplus -} -#endif - -#endif /* LV2_H_INCLUDED */ - diff --git a/include/lv2.ttl b/include/lv2.ttl deleted file mode 100644 index 75b2aa3..0000000 --- a/include/lv2.ttl +++ /dev/null @@ -1,607 +0,0 @@ -# RDF Schema for LV2 plugins -# *** PROVISIONAL *** -# -# This document describes the classes and properties that are defined by the -# core LV2 specification. See 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 : . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix doap: . -@prefix foaf: . - -<> doap:license . - -<> 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 """ -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 - :port -""" . - - - -################## -## Port Classes ## -################## - -:Port a rdfs:Class ; - 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 - :ControlRateInputPort, :ControlRateOutputPort, - :AudioRateInputPort, :AudioRateOutputPort) - :dataType - :index - :symbol - :name -""" . - -:InputPort a rdfs:Class ; - rdfs:subClassOf :Port . - -:OutputPort a rdfs:Class ; - rdfs:subClassOf :Port . - -:ControlRatePort a rdfs:Class ; - rdfs:subClassOf :Port . - -:AudioRatePort a rdfs:Class ; - rdfs:subClassOf :Port . - -: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. - -Plugins will read values from this pointer during their run method. -""" . - -: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. - -Plugins will write values to this pointer during their run method. -""" . - -: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. -""" . - -: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. -""" . - - - -################################# -# Mandatory Port RDF:Properties # -################################# - -:Datatype a rdfs:Class ; - rdfs:comment "A data type that can be stored in an LV2 port." . - -:dataType a rdf:Property ; - rdfs:domain :Port ; - rdfs:range :DataType ; - rdfs:label "Port Data type" ; - rdfs:comment """ -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 (any extension that defines a new data-type which wishes to allow -this must deal with this issue somehow). -""" . - -:index a rdf:Property ; - 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. -""" . - -:symbol a rdf:Property ; - 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. - -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 """ -A display name for labeling the Port in a user interface. - -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. -""" . - - - -############################################# -# Port Additional RDF:Properties (Optional) # -############################################# - -:Point a rdfs:Class ; - rdfs:label "Port value point" ; - rdfs:comment """ -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: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. -""" . - -: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).". - -: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". -""" . - -: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 -(half the sample rate) could be requested by this hint in conjunction with -:minimum 0.0 and :maximum 0.5. Hosts that support bounds at all must support -this hint to retain meaning. -""" . - -:integer a :PortHint ; - rdfs:label "Integer" ; - rdfs:comment """ -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. -""" . - - - -############################### -# Plugin Categories (Classes) # -############################### - -:UtilityPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Utilities" ; - rdfs:comment """ -Includes things like mathematical functions and non-musical delays. -""" . - -:GeneratorPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Generators" ; - rdfs:comment """ -Any plugin that generates sound internally, rather than processing its input. -""" . - -:OscillatorPlugin a rdfs:Class ; - rdfs:subClassOf :GeneratorPlugin ; - rdfs:label "Oscillators" . - -:SimulatorPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Simulators" ; - rdfs:comment """ -Plugins that aim to duplicate the effect of some environmental effect or -musical equipment. -""" . - -:DelayPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Delays" ; - rdfs:comment """ -Plugins that intentionally delay their input signal as an effect. -""" . - -:PhaserPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Phasers" . - -:FlangerPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Flangers" . - -:ChorusPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Chorus" . - -:ReverbPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:subClassOf :SimulatorPlugin ; - rdfs:subClassOf :DelayPlugin ; - rdfs:label "Reverb" . - -:FilterPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Filters" . - -:LowpassPlugin a rdfs:Class ; - rdfs:subClassOf :FilterPlugin ; - rdfs:label "Lowpass" . - -:BandpassPlugin a rdfs:Class ; - rdfs:subClassOf :FilterPlugin ; - rdfs:label "Bandpass" . - -:HighpassPlugin a rdfs:Class ; - rdfs:subClassOf :FilterPlugin ; - rdfs:label "Highpass" . - -:CombPlugin a rdfs:Class ; - rdfs:subClassOf :FilterPlugin ; - rdfs:label "Combs" . - -:AllpassPlugin a rdfs:Class ; - rdfs:subClassOf :FilterPlugin ; - rdfs:label "Allpass" . - -:EQPlugin a rdfs:Class ; - rdfs:subClassOf :FilterPlugin ; - rdfs:label "Equalisers" . - -:ParaEQPlugin a rdfs:Class ; - rdfs:subClassOf :EQPlugin ; - rdfs:label "Parametrics" . - -:MultiEQPlugin a rdfs:Class ; - rdfs:subClassOf :EQPlugin ; - rdfs:label "Multibands" . - -:PitchPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Pitch Shifters" . - -:AmplifierPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Amplifiers" . - -:WaveshaperPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Waveshapers" . - -:ModulatorPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Modulators" . - -:DistortionPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Distortions" . - -:DynamicsPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Dynamics processors" ; - rdfs:comment """ -Plugins that alter the envelope or dynamic range of the processed audio. -""" . - -:CompressorPlugin a rdfs:Class ; - rdfs:subClassOf :DynamicsPlugin ; - rdfs:label "Compressors" . - -:ExpanderPlugin a rdfs:Class ; - rdfs:subClassOf :DynamicsPlugin ; - rdfs:label "Expanders" . - -:LimiterPlugin a rdfs:Class ; - rdfs:subClassOf :DynamicsPlugin ; - rdfs:label "Limiters" . - -:GatePlugin a rdfs:Class ; - rdfs:subClassOf :DynamicsPlugin ; - rdfs:label "Gates" . -- cgit v1.2.1