aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/ns/ext/dynmanifest/dynmanifest.h
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2011-11-21 01:36:00 +0000
committerDavid Robillard <d@drobilla.net>2011-11-21 01:36:00 +0000
commiteb43c8896480114b224755e824fae2e2f7485256 (patch)
tree26e91bd8dc6421d2296a33991e90f7dcb546b079 /lv2/ns/ext/dynmanifest/dynmanifest.h
parentdf79255ccef7fb5d091e9d4e52f3c46545b53282 (diff)
downloadlv2-eb43c8896480114b224755e824fae2e2f7485256.tar.xz
Move ns to lv2/ns so repository top level can be used as an include dir directly.
Diffstat (limited to 'lv2/ns/ext/dynmanifest/dynmanifest.h')
-rw-r--r--lv2/ns/ext/dynmanifest/dynmanifest.h144
1 files changed, 144 insertions, 0 deletions
diff --git a/lv2/ns/ext/dynmanifest/dynmanifest.h b/lv2/ns/ext/dynmanifest/dynmanifest.h
new file mode 100644
index 0000000..56d829e
--- /dev/null
+++ b/lv2/ns/ext/dynmanifest/dynmanifest.h
@@ -0,0 +1,144 @@
+/*
+ Dynamic manifest specification for LV2
+ Copyright 2008-2011 Stefano D'Angelo <zanga.mail@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.
+*/
+
+/**
+ @file dynmanifest.h
+ C header for the LV2 Dynamic Manifest extension
+ <http://lv2plug.in/ns/ext/dynmanifest>.
+ Revision: 1.1
+*/
+
+#ifndef LV2_DYN_MANIFEST_H_INCLUDED
+#define LV2_DYN_MANIFEST_H_INCLUDED
+
+#include <stdio.h>
+
+#include "lv2/lv2plug.in/ns/lv2core/lv2.h"
+
+#define LV2_DYN_MANIFEST_URI "http://lv2plug.in/ns/ext/dynmanifest"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ Dynamic manifest generator handle.
+
+ This handle indicates a particular status of a dynamic manifest generator.
+ The host MUST NOT attempt to interpret it and, unlikely LV2_Handle, it is
+ NOT even valid to compare this to NULL. The dynamic manifest generator MAY
+ use it to reference internal data.
+*/
+typedef void * LV2_Dyn_Manifest_Handle;
+
+/**
+ Generate the dynamic manifest.
+
+ @param handle Pointer to an uninitialized dynamic manifest generator handle.
+
+ @param features NULL terminated array of LV2_Feature structs which represent
+ the features the host supports. The dynamic manifest generator may refuse to
+ (re)generate the dynamic manifest if required features are not found here
+ (however hosts SHOULD NOT use this as a discovery mechanism, instead of
+ reading the static manifest file). This array must always exist; if a host
+ has no features, it MUST pass a single element array containing NULL.
+
+ @return 0 on success, otherwise a non-zero error code. The host SHOULD
+ evaluate the result of the operation by examining the returned value and
+ MUST NOT try to interpret the value of handle.
+*/
+int lv2_dyn_manifest_open(LV2_Dyn_Manifest_Handle * handle,
+ const LV2_Feature *const * features);
+
+/**
+ Fetch a "list" of subject URIs described in the dynamic manifest.
+
+ The dynamic manifest generator has to fill the resource only with the needed
+ triples to make the host aware of the "objects" it wants to expose. For
+ example, if the plugin library exposes a regular LV2 plugin, it should
+ output only a triple like the following:
+
+ <http://www.example.com/plugin/uri> a lv2:Plugin .
+
+ The objects that are elegible for exposure are those that would need to be
+ represented by a subject node in a static manifest.
+
+ @param handle Dynamic manifest generator handle.
+
+ @param fp FILE * identifying the resource the host has to set up for the
+ dynamic manifest generator. The host MUST pass a writable, empty resource to
+ this function, and the dynamic manifest generator MUST ONLY perform write
+ operations on it at the end of the stream (e.g., using only fprintf(),
+ fwrite() and similar).
+
+ @return 0 on success, otherwise a non-zero error code.
+*/
+int lv2_dyn_manifest_get_subjects(LV2_Dyn_Manifest_Handle handle,
+ FILE * fp);
+
+/**
+ Function that fetches data related to a specific URI.
+
+ The dynamic manifest generator has to fill the resource with data related to
+ object represented by the given URI. For example, if the library exposes a
+ regular LV2 plugin whose URI, as retrieved by the host using
+ lv2_dyn_manifest_get_subjects() is http://www.example.com/plugin/uri, it
+ should output something like:
+
+ <pre>
+ <http://www.example.com/plugin/uri>
+ a lv2:Plugin ;
+ doap:name "My Plugin" ;
+ lv2:binary <mylib.so> ;
+ etc:etc "..." .
+ </pre>
+
+ @param handle Dynamic manifest generator handle.
+
+ @param fp FILE * identifying the resource the host has to set up for the
+ dynamic manifest generator. The host MUST pass a writable resource to this
+ function, and the dynamic manifest generator MUST ONLY perform write
+ operations on it at the current position of the stream (e.g. using only
+ fprintf(), fwrite() and similar).
+
+ @param uri URI to get data about (in the "plain" form, i.e., absolute URI
+ without Turtle prefixes).
+
+ @return 0 on success, otherwise a non-zero error code.
+*/
+int lv2_dyn_manifest_get_data(LV2_Dyn_Manifest_Handle handle,
+ FILE * fp,
+ const char * uri);
+
+/**
+ Function that ends the operations on the dynamic manifest generator.
+
+ This function SHOULD be used by the dynamic manifest generator to perform
+ cleanup operations, etc.
+
+ Once this function is called, referring to handle will cause undefined
+ behavior.
+
+ @param handle Dynamic manifest generator handle.
+*/
+void lv2_dyn_manifest_close(LV2_Dyn_Manifest_Handle handle);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* LV2_DYN_MANIFEST_H_INCLUDED */