aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/urid
diff options
context:
space:
mode:
Diffstat (limited to 'lv2/urid')
-rw-r--r--lv2/urid/manifest.ttl9
-rw-r--r--lv2/urid/urid.h137
-rw-r--r--lv2/urid/urid.meta.ttl84
-rw-r--r--lv2/urid/urid.ttl22
4 files changed, 252 insertions, 0 deletions
diff --git a/lv2/urid/manifest.ttl b/lv2/urid/manifest.ttl
new file mode 100644
index 0000000..772e2b6
--- /dev/null
+++ b/lv2/urid/manifest.ttl
@@ -0,0 +1,9 @@
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://lv2plug.in/ns/ext/urid>
+ a lv2:Specification ;
+ lv2:minorVersion 1 ;
+ lv2:microVersion 4 ;
+ rdfs:seeAlso <urid.ttl> .
+
diff --git a/lv2/urid/urid.h b/lv2/urid/urid.h
new file mode 100644
index 0000000..a68bc12
--- /dev/null
+++ b/lv2/urid/urid.h
@@ -0,0 +1,137 @@
+/*
+ Copyright 2008-2016 David Robillard <http://drobilla.net>
+ Copyright 2011 Gabriel M. Beddingfield <gabrbedd@gmail.com>
+
+ 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.
+*/
+
+/**
+ @defgroup urid URID
+ @ingroup lv2
+
+ Features for mapping URIs to and from integers, see
+ <http://lv2plug.in/ns/ext/urid> for details.
+
+ @{
+*/
+
+#ifndef LV2_URID_H
+#define LV2_URID_H
+
+#define LV2_URID_URI "http://lv2plug.in/ns/ext/urid" ///< http://lv2plug.in/ns/ext/urid
+#define LV2_URID_PREFIX LV2_URID_URI "#" ///< http://lv2plug.in/ns/ext/urid#
+
+#define LV2_URID__map LV2_URID_PREFIX "map" ///< http://lv2plug.in/ns/ext/urid#map
+#define LV2_URID__unmap LV2_URID_PREFIX "unmap" ///< http://lv2plug.in/ns/ext/urid#unmap
+
+#define LV2_URID_MAP_URI LV2_URID__map ///< Legacy
+#define LV2_URID_UNMAP_URI LV2_URID__unmap ///< Legacy
+
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ 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;
+
+/**
+ URID Map Feature (LV2_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 Feature (LV2_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 `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 `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;
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
+#endif /* LV2_URID_H */
+
+/**
+ @}
+*/
diff --git a/lv2/urid/urid.meta.ttl b/lv2/urid/urid.meta.ttl
new file mode 100644
index 0000000..b2a74fa
--- /dev/null
+++ b/lv2/urid/urid.meta.ttl
@@ -0,0 +1,84 @@
+@prefix dcs: <http://ontologi.es/doap-changeset#> .
+@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 doap:Project ;
+ doap:license <http://opensource.org/licenses/isc> ;
+ doap:name "LV2 URID" ;
+ doap:shortdesc "Features for mapping URIs to and from integers." ;
+ doap:created "2011-07-22" ;
+ doap:developer <http://lv2plug.in/ns/meta#gabrbedd> ;
+ doap:maintainer <http://drobilla.net/drobilla#me> ;
+ doap:release [
+ doap:revision "1.4" ;
+ doap:created "2012-10-14" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Fix typo in urid:unmap documentation."
+ ]
+ ]
+ ] , [
+ doap:revision "1.2" ;
+ doap:created "2012-04-17" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-1.0.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Add feature struct names."
+ ] , [
+ rdfs:label "Merge with unified LV2 package."
+ ]
+ ]
+ ] , [
+ doap:revision "1.0" ;
+ doap:created "2011-11-21" ;
+ doap:file-release <http://lv2plug.in/spec/lv2-urid-1.0.tar.bz2> ;
+ dcs:blame <http://drobilla.net/drobilla#me> ;
+ dcs:changeset [
+ dcs:item [
+ rdfs:label "Initial release."
+ ]
+ ]
+ ] ;
+ lv2:documentation """
+
+This extension defines a simple mechanism for plugins to map URIs to and from
+integers. This is usually used for performance reasons, for example for
+processing events with URI types in real-time audio code). 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.
+
+This extension is intended as an improved and simplified replacement for the
+[uri-map](uri-map.html) extension, since the `map` context parameter there has
+proven problematic. This extension is functionally equivalent to the uri-map
+extension with a NULL context. New implementations are encouraged to use this
+extension for URI mapping.
+
+"""^^lv2:Markdown .
+
+urid:map
+ lv2:documentation """
+
+To support this feature, the host must pass an LV2_Feature to
+LV2_Descriptor::instantiate() with URI LV2_URID__map and data pointed to an
+instance of LV2_URID_Map.
+
+"""^^lv2:Markdown .
+
+urid:unmap
+ lv2:documentation """
+
+To support this feature, the host must pass an LV2_Feature to
+LV2_Descriptor::instantiate() with URI LV2_URID__unmap and data pointed to an
+instance of LV2_URID_Unmap.
+
+"""^^lv2:Markdown .
+
diff --git a/lv2/urid/urid.ttl b/lv2/urid/urid.ttl
new file mode 100644
index 0000000..2c44b56
--- /dev/null
+++ b/lv2/urid/urid.ttl
@@ -0,0 +1,22 @@
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix owl: <http://www.w3.org/2002/07/owl#> .
+@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 owl:Ontology ;
+ rdfs:label "LV2 URID" ;
+ rdfs:comment "Features for mapping URIs to and from integers." ;
+ rdfs:seeAlso <urid.h> ,
+ <urid.meta.ttl> .
+
+urid:map
+ a lv2:Feature ;
+ rdfs:label "map" ;
+ rdfs:comment "A feature to map URI strings to integer URIDs." .
+
+urid:unmap
+ a lv2:Feature ;
+ rdfs:label "unmap" ;
+ rdfs:comment "A feature to unmap URIDs back to strings." .
+
generated by cgit v1.2.1 (git 2.18.0) at 2026-03-15 07:22:19 +0000