aboutsummaryrefslogtreecommitdiffstats
path: root/ext/polymorphic-port.lv2
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2010-10-04 18:21:08 +0000
committerDavid Robillard <d@drobilla.net>2010-10-04 18:21:08 +0000
commitcef9811dac46a9d54dab0f0d82ce5c3ae032fc7c (patch)
tree632b911da25fc24b6b3d331d7ceffc22606b8e5b /ext/polymorphic-port.lv2
parent61842745ab15454ee66be54a6f3bcc148a75406f (diff)
downloadlv2-cef9811dac46a9d54dab0f0d82ce5c3ae032fc7c.tar.xz
Initial import of lv2plug.in universe.
Diffstat (limited to 'ext/polymorphic-port.lv2')
-rw-r--r--ext/polymorphic-port.lv2/manifest.ttl7
-rw-r--r--ext/polymorphic-port.lv2/polymorphic-port.h63
-rw-r--r--ext/polymorphic-port.lv2/polymorphic-port.ttl71
3 files changed, 141 insertions, 0 deletions
diff --git a/ext/polymorphic-port.lv2/manifest.ttl b/ext/polymorphic-port.lv2/manifest.ttl
new file mode 100644
index 0000000..abe3788
--- /dev/null
+++ b/ext/polymorphic-port.lv2/manifest.ttl
@@ -0,0 +1,7 @@
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/ns/ext/polymorphic-port>
+ a lv2:Specification ;
+ rdfs:seeAlso <polymorphic-port.ttl> .
+
diff --git a/ext/polymorphic-port.lv2/polymorphic-port.h b/ext/polymorphic-port.lv2/polymorphic-port.h
new file mode 100644
index 0000000..98d691e
--- /dev/null
+++ b/ext/polymorphic-port.lv2/polymorphic-port.h
@@ -0,0 +1,63 @@
+/* lv2_data_access.h - C header file for the LV2 Data Access extension.
+ * Copyright (C) 2008-2009 David Robillard <http://drobilla.net>
+ *
+ * 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 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 header; if not, write to the Free Software Foundation,
+ * Inc., 59 Temple Place, Suite 330, Boston, MA 01222-1307 USA
+ */
+
+/** @file
+ * C header for the LV2 Polymorphic Port extension
+ * <http://lv2plug.in/ns/ext/polymorphic-port>.
+ *
+ * This extension defines a buffer format for ports that can take on
+ * various types dynamically at runtime.
+ */
+
+#ifndef LV2_POLYMORPHIC_PORT_H
+#define LV2_POLYMORPHIC_PORT_H
+
+#define LV2_POLYMORPHIC_PORT_URI "http://lv2plug.in/ns/ext/polymorphic-port"
+
+/** The data field of the LV2_Feature for this extension.
+ *
+ * To support this feature the host must pass an LV2_Feature struct to the
+ * instantiate method with URI "http://lv2plug.in/ns/ext/polymorphic-port"
+ * and data pointed to an instance of this struct.
+ */
+typedef struct {
+
+ /** Set the type of a polymorphic port.
+ * If the plugin specifies constraints on port types, the host MUST NOT
+ * call the run method until all port types have been set to a valid
+ * configuration. Whenever the type for a port is changed, the host
+ * MUST call connect_port before the next call to the run method.
+ * The return value of this function SHOULD be ignored by hosts at this
+ * time (future revisions of this extension may specify return values).
+ * Plugins which do not know of any future revision or extension that
+ * dictates otherwise MUST return 0 from this function.
+ * @param port Index of the port to connect (same as LV2 connect_port)
+ * @param type Mapped URI for the type of data being connected
+ * @param type_data Type specific data defined by type URI (may be NULL)
+ * @return Unused at this time
+ */
+ uint32_t (*set_type)(LV2_Handle instance,
+ uint32_t port,
+ uint32_t type,
+ void* type_data);
+
+} LV2_Polymorphic_Feature;
+
+
+#endif /* LV2_POLYMORPHIC_PORT_H */
+
diff --git a/ext/polymorphic-port.lv2/polymorphic-port.ttl b/ext/polymorphic-port.lv2/polymorphic-port.ttl
new file mode 100644
index 0000000..b3d1b37
--- /dev/null
+++ b/ext/polymorphic-port.lv2/polymorphic-port.ttl
@@ -0,0 +1,71 @@
+# LV2 Polymorphic Port Extension
+# Copyright (C) 2008 David Robillard <d@drobilla.net>
+#
+# 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 polym: <http://lv2plug.in/ns/ext/polymorphic-port#> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+
+<http://lv2plug.in/ns/ext/polymorphic-port> a lv2:Specification ;
+ doap:license <http://usefulinc.com/doap/licenses/mit> ;
+ doap:name "LV2 Polymorphic Ports" ;
+ rdfs:comment "Defines LV2 ports which can dynamically change type" ;
+ doap:maintainer [
+ a foaf:Person ;
+ foaf:name "David Robillard" ;
+ foaf:homepage <http://drobilla.net/> ;
+ rdfs:seeAlso <http://drobilla.net/drobilla.rdf>
+ ] .
+
+
+polym:PolymorphicPort a rdfs:Class ;
+ rdfs:label "Polymorphic port" ;
+ rdfs:subClassOf lv2:Port ;
+ rdfs:comment """
+Ports of this type may be connected to buffers of several types. The plugin
+provides a set_type function for the host to specify which type a port is
+currently connected to.
+
+A Port specifies the types it supports using the :supportsType property.
+The type specific in the normal LV2 manner (&lt;port&gt; a &lt;sometype&gt;)
+is the "default type". If the port is connected without set_type being called
+for that port, the type of the buffer is assumed to be the default type.
+In this way polymorphic plugins are backwards compatible and may be used by
+hosts which are not aware of the polymorphic port extension.
+""" .
+
+polym:generic a lv2:PortProperty ;
+ rdfs:label "Generic polymorphic port" ;
+ rdfs:comment """
+Indicates that this port can be connected to a buffer of any type.
+""" .
+
+polym:supportsType a rdf:Property ;
+ rdfs:domain lv2:Port ;
+ rdfs:label "Supports data type" ;
+ rdfs:comment """
+Indicates that this port supports or "understands" a certain data type.
+Hosts MUST NOT connect a port to a buffer unless the port is :generic,
+or is described as supporting the type of that buffer with this property.
+""" .
+