aboutsummaryrefslogtreecommitdiffstats
path: root/ext/data-access.lv2/data-access.h
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/data-access.lv2/data-access.h
parent61842745ab15454ee66be54a6f3bcc148a75406f (diff)
downloadlv2-cef9811dac46a9d54dab0f0d82ce5c3ae032fc7c.tar.xz
Initial import of lv2plug.in universe.
Diffstat (limited to 'ext/data-access.lv2/data-access.h')
-rw-r--r--ext/data-access.lv2/data-access.h57
1 files changed, 57 insertions, 0 deletions
diff --git a/ext/data-access.lv2/data-access.h b/ext/data-access.lv2/data-access.h
new file mode 100644
index 0000000..aa87723
--- /dev/null
+++ b/ext/data-access.lv2/data-access.h
@@ -0,0 +1,57 @@
+/* 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 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 */
+