aboutsummaryrefslogtreecommitdiffstats
path: root/ns/ext/urid
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2011-11-20 23:08:57 +0000
committerDavid Robillard <d@drobilla.net>2011-11-20 23:08:57 +0000
commit725d4a404b838da6b67d9da66228a1125bddef57 (patch)
treea1daab3d767c85b1b67ff3a9eb60d54721b2e5fc /ns/ext/urid
parent5ae0165d6d0420e95e22c1451e319b9e83398c28 (diff)
downloadlv2-725d4a404b838da6b67d9da66228a1125bddef57.tar.xz
Lay out repository structure to match include and URI structure.
Treat lv2core like all the other specifications in gendoc.py.
Diffstat (limited to 'ns/ext/urid')
l---------ns/ext/urid/ext.pc.in1
-rw-r--r--ns/ext/urid/manifest.ttl9
-rw-r--r--ns/ext/urid/urid.h113
-rw-r--r--ns/ext/urid/urid.ttl67
l---------ns/ext/urid/waf1
l---------ns/ext/urid/wscript1
6 files changed, 192 insertions, 0 deletions
diff --git a/ns/ext/urid/ext.pc.in b/ns/ext/urid/ext.pc.in
new file mode 120000
index 0000000..1cdad2a
--- /dev/null
+++ b/ns/ext/urid/ext.pc.in
@@ -0,0 +1 @@
+../../../ext.pc.in \ No newline at end of file
diff --git a/ns/ext/urid/manifest.ttl b/ns/ext/urid/manifest.ttl
new file mode 100644
index 0000000..c77aff6
--- /dev/null
+++ b/ns/ext/urid/manifest.ttl
@@ -0,0 +1,9 @@
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix urid: <http://lv2plug.in/ns/ext/urid#> .
+
+<http://lv2plug.in/ns/ext/urid>
+ a lv2:Specification ;
+ lv2:minorVersion 0 ;
+ lv2:microVersion 2 ;
+ rdfs:seeAlso <urid.ttl> .
diff --git a/ns/ext/urid/urid.h b/ns/ext/urid/urid.h
new file mode 100644
index 0000000..d36d0dd
--- /dev/null
+++ b/ns/ext/urid/urid.h
@@ -0,0 +1,113 @@
+/*
+ Copyright 2011 Gabriel M. Beddingfield <gabrbedd@gmail.com>
+ Copyright 2008-2011 David Robillard <http://drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+/**
+ @file
+ C header for the LV2 URID extension <http://lv2plug.in/ns/ext/urid>
+*/
+
+#ifndef LV2_URID_H
+#define LV2_URID_H
+
+#define LV2_URID_URI "http://lv2plug.in/ns/ext/urid"
+
+#include <stdint.h>
+
+/**
+ Opaque pointer to host data for LV2_URID_Map.
+*/
+typedef void* LV2_URID_Map_Handle;
+
+/**
+ Opaque pointer to host data for LV2_URID_Unmap.
+*/
+typedef void* LV2_URID_Unmap_Handle;
+
+/**
+ URI mapped to an integer.
+*/
+typedef uint32_t LV2_URID;
+
+/**
+ URI Map (http://lv2plug.in/ns/ext/urid#map).
+*/
+typedef struct {
+ /**
+ Opaque pointer to host data.
+
+ This MUST be passed to map_uri() whenever it is called.
+ Otherwise, it must not be interpreted in any way.
+ */
+ LV2_URID_Map_Handle handle;
+
+ /**
+ Get the numeric ID of a URI.
+
+ If the ID does not already exist, it will be created.
+
+ This function is referentially transparent; any number of calls with the
+ same arguments is guaranteed to return the same value over the life of a
+ plugin instance. Note, however, that several URIs MAY resolve to the
+ same ID if the host considers those URIs equivalent.
+
+ This function is not necessarily very fast or RT-safe: plugins SHOULD
+ cache any IDs they might need in performance critical situations.
+
+ The return value 0 is reserved and indicates that an ID for that URI
+ could not be created for whatever reason. However, hosts SHOULD NOT
+ return 0 from this function in non-exceptional circumstances (i.e. the
+ URI map SHOULD be dynamic).
+
+ @param handle Must be the callback_data member of this struct.
+ @param uri The URI to be mapped to an integer ID.
+ */
+ LV2_URID (*map)(LV2_URID_Map_Handle handle,
+ const char* uri);
+} LV2_URID_Map;
+
+/**
+ URI Unmap (http://lv2plug.in/ns/ext/urid#unmap).
+*/
+typedef struct {
+ /**
+ Opaque pointer to host data.
+
+ This MUST be passed to unmap() whenever it is called.
+ Otherwise, it must not be interpreted in any way.
+ */
+ LV2_URID_Unmap_Handle handle;
+
+ /**
+ Get the URI for a previously mapped numeric ID.
+
+ Returns NULL if @c urid is not yet mapped. Otherwise, the corresponding
+ URI is returned in a canonical form. This MAY not be the exact same
+ string that was originally passed to LV2_URID_Map::map(), but it MUST be
+ an identical URI according to the URI syntax specification (RFC3986). A
+ non-NULL return for a given @c urid will always be the same for the life
+ of the plugin. Plugins that intend to perform string comparison on
+ unmapped URIs SHOULD first canonicalise URI strings with a call to
+ map_uri() followed by a call to unmap_uri().
+
+ @param handle Must be the callback_data member of this struct.
+ @param urid The ID to be mapped back to the URI string.
+ */
+ const char* (*unmap)(LV2_URID_Unmap_Handle handle,
+ LV2_URID urid);
+} LV2_URID_Unmap;
+
+#endif /* LV2_URID_H */
diff --git a/ns/ext/urid/urid.ttl b/ns/ext/urid/urid.ttl
new file mode 100644
index 0000000..a87b368
--- /dev/null
+++ b/ns/ext/urid/urid.ttl
@@ -0,0 +1,67 @@
+# LV2 URID Extension
+# Copyright 2011 Gabriel M. Beddingfield <gabrbedd@gmail.com>
+# Copyright 2008-2011 David Robillard <http://drobilla.net>
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+@prefix doap: <http://usefulinc.com/ns/doap#> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix urid: <http://lv2plug.in/ns/ext/urid#> .
+
+<http://lv2plug.in/ns/ext/urid>
+ a lv2:Specification ;
+ doap:license <http://opensource.org/licenses/isc-license> ;
+ doap:name "LV2 URID" ;
+ doap:shortdesc "Features for mapping URIs to and from integers." ;
+ doap:release [
+ doap:revision "0.2" ;
+ doap:created "2011-01-04"
+ ] ;
+ doap:developer [
+ a foaf:Person ;
+ foaf:name "Gabriel M. Beddingfield" ;
+ foaf:homepage <http://gabe.is-a-geek.org/>
+ ] ;
+ lv2:documentation """
+<p>This extension defines a simple mechanism for plugins to map URIs to and
+from integers, usually for performance reasons (e.g. processing events typed by
+URIs in real time). Typically, plugins map URIs to integers for things they
+"understand" at instantiation time, and store those values for use in the audio
+thread without doing any string comparison. This allows for the extensibility
+of RDF but with the performance of integers.</p>
+
+<p>This extension is intended as an improved and simpler replacement for the <a
+href="http://lv2plug.in/ns/ext/uri-map">uri-map</a> extension, since the
+<q>map</q> context parameter has been found problematic.</p>
+""" .
+
+urid:map
+ a lv2:Feature ;
+ lv2:documentation """
+<p>A feature which is used to map URIs to integers. To support this feature,
+the host must pass an LV2_Feature to LV2_Descriptor::instantiate() with
+<em>URI</em> <q>http://lv2plug.in/ns/ext/urid#map</q> and <em>data</em> pointed
+to an instance of LV2_URID_Map.</p>
+""" .
+
+urid:unmap
+ a lv2:Feature ;
+ lv2:documentation """
+<p>A feature which is used to unmap URIs previously mapped to integers by
+urid:map. To support this feature, the host must pass an LV2_Feature to
+LV2_Descriptor::instantiate() with <em>URI</em>
+<q>http://lv2plug.in/ns/ext/urid#unmap</q> and <em>data</em> pointed to an
+instance of LV2_URID_Unmap.</p>
+""" .
diff --git a/ns/ext/urid/waf b/ns/ext/urid/waf
new file mode 120000
index 0000000..917d5c5
--- /dev/null
+++ b/ns/ext/urid/waf
@@ -0,0 +1 @@
+../../../waf \ No newline at end of file
diff --git a/ns/ext/urid/wscript b/ns/ext/urid/wscript
new file mode 120000
index 0000000..cf8cbae
--- /dev/null
+++ b/ns/ext/urid/wscript
@@ -0,0 +1 @@
+../../../ext.wscript \ No newline at end of file