aboutsummaryrefslogtreecommitdiffstats
path: root/ext/string-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/string-port.lv2
parent61842745ab15454ee66be54a6f3bcc148a75406f (diff)
downloadlv2-cef9811dac46a9d54dab0f0d82ce5c3ae032fc7c.tar.xz
Initial import of lv2plug.in universe.
Diffstat (limited to 'ext/string-port.lv2')
-rw-r--r--ext/string-port.lv2/manifest.ttl6
-rw-r--r--ext/string-port.lv2/string-port.h58
-rw-r--r--ext/string-port.lv2/string-port.ttl105
3 files changed, 169 insertions, 0 deletions
diff --git a/ext/string-port.lv2/manifest.ttl b/ext/string-port.lv2/manifest.ttl
new file mode 100644
index 0000000..c7ba4e1
--- /dev/null
+++ b/ext/string-port.lv2/manifest.ttl
@@ -0,0 +1,6 @@
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/ns/ext/string-port>
+ a lv2:Specification ;
+ rdfs:seeAlso <string-port.ttl> .
diff --git a/ext/string-port.lv2/string-port.h b/ext/string-port.lv2/string-port.h
new file mode 100644
index 0000000..e7fc8c7
--- /dev/null
+++ b/ext/string-port.lv2/string-port.h
@@ -0,0 +1,58 @@
+/* lv2_string_port.h - C header file for LV2 string port extension.
+ * Draft Revision 3
+ * Copyright (C) 2008 Krzysztof Foltman <wdev@foltman.com>
+ *
+ * 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 String Port extension
+ * <http://lv2plug.in/ns/ext/string-port#StringTransfer>.
+ */
+
+#ifndef LV2_STRING_PORT_H
+#define LV2_STRING_PORT_H
+
+#include <stdint.h>
+
+/** URI for the string port transfer mechanism feature */
+#define LV2_STRING_PORT_URI "http://lv2plug.in/ns/ext/string-port#StringTransfer"
+
+/** Flag: port data has been updated; for input ports, this flag is set by
+the host. For output ports, this flag is set by the plugin. */
+#define LV2_STRING_DATA_CHANGED_FLAG 1
+
+/** structure for string port data */
+typedef struct
+{
+ /** Buffer for UTF-8 encoded zero-terminated string value; host-allocated */
+ char *data;
+
+ /** Length in bytes (not characters), not including zero byte */
+ size_t len;
+
+ /** Output ports: storage space in bytes; must be >= RDF-specified requirements */
+ size_t storage;
+
+ /** Flags defined above */
+ uint32_t flags;
+
+ /** Undefined (pad to 8 bytes) */
+ uint32_t pad;
+
+} LV2_String_Data;
+
+#endif
+
diff --git a/ext/string-port.lv2/string-port.ttl b/ext/string-port.lv2/string-port.ttl
new file mode 100644
index 0000000..e6adfc2
--- /dev/null
+++ b/ext/string-port.lv2/string-port.ttl
@@ -0,0 +1,105 @@
+# LV2 String Port Extension.
+# Draft Revision 3
+# Copyright (C) 2008 Krzysztof Foltman
+#
+# 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 sp: <http://lv2plug.in/ns/ext/string-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 xsd: <http://www.w3.org/2001/XMLSchema> .
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+
+<http://lv2plug.in/ns/ext/string-port> a lv2:Specification ;
+ doap:license <http://usefulinc.com/doap/licenses/mit> ;
+ doap:name "LV2 String Ports" ;
+ doap:maintainer [
+ a foaf:Person ;
+ foaf:name "Krzysztof Foltman" ;
+ ] ;
+ rdfs:comment """
+Defines ports which contain string data.
+
+<h4>UI issues</h4>
+When using port_event / write_port (and possible other communication
+mechanisms), the format parameter should contain the numeric value of URI
+LV2_STRING_PORT_URI (mapped with http://lv2plug.in/ns/extensions/ui specified
+as map URI).
+
+It's probably possible to use ports belonging to message context
+&lt;http://lv2plug.in/ns/ext/contexts#MessageContext&gt; for transfer. However,
+contexts mechanism does not offer any way to notify the message recipient
+about which ports have been changed. To remedy that, this extension defines
+a flag LV2_STRING_DATA_CHANGED_FLAG that carries that information inside a
+port value structure.
+
+<h4>Storage</h4>
+The value of string port are assumed to be "persistent": if a host saves
+and restores a state of a plugin (e.g. control port values), the values
+of input string ports should also be assumed to belong to that state. This
+also applies to message context: if a session is being restored, the host
+MUST resend the last value that was sent to the port before session has been
+saved. In other words, string port values "stick" to message ports.
+""" .
+
+sp:StringTransfer a lv2:Feature ;
+ rdfs:label "String data transfer via LV2_String_Data" .
+
+sp:StringPort a lv2:Port ;
+ rdfs:label "String port" ;
+ rdfs:comment """
+Indicates that the port data points to a LV2_String_Data structure
+as defined in accompanying header file.
+
+<h4>Input Port Semantics</h4>
+If the port does not have a context specified (it runs in the default,
+realtime audio processing context), the values in the structure and the actual
+string data MUST remain unchanged for the time a run() function of a plugin
+is executed. However, if the port belongs to a different context, the same
+data MUST remain unchanged only for the time a run() or message_process()
+function of a given context is executed.
+
+<h4>Output Port Semantics</h4>
+The plugin may only change the string or length in a run() function (if
+the port belongs to default context) or in context-defined counterparts
+(if the port belongs to another context). Because of that, using default
+context output string ports is contraindicated for longer strings.
+""" .
+
+sp:default a rdf:Property ;
+ rdfs:label "Default value" ;
+ rdfs:domain sp:StringPort ;
+ rdfs:range xsd:string ;
+ rdfs:comment """
+Gives a default value for a string port.
+""" .
+
+sp:requiredSpace a rdf:Property ;
+ rdfs:label "Required storage space in bytes" ;
+ rdfs:domain sp:StringPort ;
+ rdfs:range xsd:nonNegativeInteger ;
+ rdfs:comment """
+Specifies required buffer space for output string ports and those of
+input string ports that are meant to be GUI-controlled. The host MUST
+allocate a buffer of at least required size to accommodate for all values
+that can be produced by the plugin.
+""" .
+