aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/lv2plug.in/ns/ext/data-access/data-access.h
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2012-02-08 04:56:24 +0000
committerDavid Robillard <d@drobilla.net>2012-02-08 04:56:24 +0000
commited78bbe5ba12be1f9bcc736f14c51da6b4f639f3 (patch)
tree653a2dfe33f3923da45a38fc04ed2106f93528f3 /lv2/lv2plug.in/ns/ext/data-access/data-access.h
parentb617875c6f3ad439d25ae166da79df839ebfdc71 (diff)
downloadlv2-ed78bbe5ba12be1f9bcc736f14c51da6b4f639f3.tar.xz
Rearrange tree so top level can be used as an include path for standard style LV2 includes.
Diffstat (limited to 'lv2/lv2plug.in/ns/ext/data-access/data-access.h')
-rw-r--r--lv2/lv2plug.in/ns/ext/data-access/data-access.h56
1 files changed, 56 insertions, 0 deletions
diff --git a/lv2/lv2plug.in/ns/ext/data-access/data-access.h b/lv2/lv2plug.in/ns/ext/data-access/data-access.h
new file mode 100644
index 0000000..fac6974
--- /dev/null
+++ b/lv2/lv2plug.in/ns/ext/data-access/data-access.h
@@ -0,0 +1,56 @@
+/*
+ LV2 Data Access Extension
+ 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 data-access.h
+ C header for the LV2 Extension Data extension
+ <http://lv2plug.in/ns/ext/data-access>.
+
+ This extension defines a method for (e.g.) plugin UIs to have (possibly
+ marshalled) access to the extension_data function on a plugin instance.
+*/
+
+#ifndef LV2_DATA_ACCESS_H
+#define LV2_DATA_ACCESS_H
+
+#define LV2_DATA_ACCESS_URI "http://lv2plug.in/ns/ext/data-access"
+
+/**
+ 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/data-access"
+ and data pointed to an instance of this struct.
+*/
+typedef struct {
+ /**
+ A pointer to a method the UI can call to get data (of a type specified
+ by some other extension) from the plugin.
+
+ This call never is never guaranteed to return anything, UIs should
+ degrade gracefully if direct access to the plugin data is not possible
+ (in which case this function will return NULL).
+
+ This is for access to large data that can only possibly work if the UI
+ and plugin are running in the same process. For all other things, use
+ the normal LV2 UI communication system.
+ */
+ const void* (*data_access)(const char* uri);
+
+} LV2_Extension_Data_Feature;
+
+#endif /* LV2_DATA_ACCESS_H */