aboutsummaryrefslogtreecommitdiffstats
path: root/ext
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2011-11-13 23:54:46 +0000
committerDavid Robillard <d@drobilla.net>2011-11-13 23:54:46 +0000
commit708a01ffb58ed30bb813fbfedca19d16d33ac887 (patch)
tree1796ec9aee3dec3c6a070b20f2c332c9cb973775 /ext
parent50a323df04a85993f0e296e07ce26ed66f883cc4 (diff)
downloadlv2-708a01ffb58ed30bb813fbfedca19d16d33ac887.tar.xz
Remove persist extension
Diffstat (limited to 'ext')
l---------ext/persist.lv2/ext.pc.in1
-rw-r--r--ext/persist.lv2/manifest.ttl9
-rw-r--r--ext/persist.lv2/persist.h229
-rw-r--r--ext/persist.lv2/persist.ttl208
l---------ext/persist.lv2/waf1
l---------ext/persist.lv2/wscript1
6 files changed, 0 insertions, 449 deletions
diff --git a/ext/persist.lv2/ext.pc.in b/ext/persist.lv2/ext.pc.in
deleted file mode 120000
index 950cb3b..0000000
--- a/ext/persist.lv2/ext.pc.in
+++ /dev/null
@@ -1 +0,0 @@
-../../ext.pc.in \ No newline at end of file
diff --git a/ext/persist.lv2/manifest.ttl b/ext/persist.lv2/manifest.ttl
deleted file mode 100644
index da2513c..0000000
--- a/ext/persist.lv2/manifest.ttl
+++ /dev/null
@@ -1,9 +0,0 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/persist>
- a lv2:Specification ;
- lv2:minorVersion 0 ;
- lv2:microVersion 3 ;
- rdfs:seeAlso <persist.ttl> .
-
diff --git a/ext/persist.lv2/persist.h b/ext/persist.lv2/persist.h
deleted file mode 100644
index 5f37765..0000000
--- a/ext/persist.lv2/persist.h
+++ /dev/null
@@ -1,229 +0,0 @@
-/*
- Copyright 2010-2011 David Robillard <http://drobilla.net>
- Copyright 2010 Leonard Ritter <paniq@paniq.org>
-
- 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 API for the LV2 Persist extension <http://lv2plug.in/ns/ext/persist>.
-*/
-
-#ifndef LV2_PERSIST_H
-#define LV2_PERSIST_H
-
-#include <stdbool.h>
-#include <stddef.h>
-#include <stdint.h>
-
-#include "lv2/lv2plug.in/ns/lv2core/lv2.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#define LV2_PERSIST_URI "http://lv2plug.in/ns/ext/persist"
-
-/**
- Flags describing value characteristics.
-
- These flags are used along with the value's type URI to determine how to
- (de-)serialise the value data, or whether it is even possible to do so.
-*/
-typedef enum {
-
- /**
- Plain Old Data.
-
- Values with this flag contain no references to non-persistent or
- non-global resources (e.g. pointers, handles, local paths, etc.). It is
- safe to copy POD values with a simple memcpy and store them for use at
- any time in the future on a machine with a compatible architecture
- (e.g. the same endianness and alignment).
-
- Implementations MUST NOT attempt to copy or serialise a non-POD value if
- they do not understand its type (and thus know how to correctly do so).
- */
- LV2_PERSIST_IS_POD = 1,
-
- /**
- Portable (architecture independent) data.
-
- Values with this flag are in a format that is usable on any
- architecture, i.e. if the value is saved on one machine it can safely be
- restored on another machine regardless of endianness, alignment, etc.
- */
- LV2_PERSIST_IS_PORTABLE = 1 << 1
-
-} LV2_Persist_Flags;
-
-/**
- A host-provided function to store a property.
- @param callback_data Must be the callback_data passed to LV2_Persist.save().
- @param key The key (predicate) to store @a value under (URI mapped integer).
- @param value Pointer to the value (object) to be stored.
- @param size The size of the data at @a value in bytes.
- @param type The type of @a value (URI).
- @param flags LV2_Persist_Flags for @a value.
- @return 0 on success, otherwise a non-zero error code.
-
- The host passes a callback of this type to LV2_Persist.save(). This callback
- is called repeatedly by the plugin within LV2_Persist.save() to store all
- the statements that describe its current state.
-
- The host MAY fail to store a property if the type is not understood and is
- not LV2_PERSIST_IS_POD and/or LV2_PERSIST_IS_PORTABLE. Implementations are
- encouraged to use POD and portable values (e.g. string literals) wherever
- possible, and use common types (e.g. types from
- http://lv2plug.in/ns/ext/atom) regardless, since hosts are likely to already
- contain the necessary implementation.
-
- Note that @a size MUST be > 0, and @a value MUST point to a valid region of
- memory @a size bytes long (this is required to make restore unambiguous).
-
- The plugin MUST NOT attempt to use this function outside of the
- LV2_Persist.restore() context.
-*/
-typedef int (*LV2_Persist_Store_Function)(
- void* callback_data,
- uint32_t key,
- const void* value,
- size_t size,
- uint32_t type,
- uint32_t flags);
-
-/**
- A host-provided function to retrieve a property.
- @param callback_data Must be the callback_data passed to LV2_Persist.restore().
- @param key The key (predicate) of the property to retrieve (URI).
- @param size (Output) If non-NULL, set to the size of the restored value.
- @param type (Output) If non-NULL, set to the type of the restored value.
- @param flags (Output) If non-NULL, set to the LV2_Persist_Flags for
- the returned value.
- @return A pointer to the restored value (object), or NULL if no value
- has been stored under @a key.
-
- A callback of this type is passed by the host to LV2_Persist.restore(). This
- callback is called repeatedly by the plugin within LV2_Persist.restore() to
- retrieve any properties it requires to restore its state.
-
- The returned value MUST remain valid until LV2_Persist.restore() returns.
-
- The plugin MUST NOT attempt to use this function, or any value returned from
- it, outside of the LV2_Persist.restore() context. Returned values MAY be
- copied for later use if necessary, assuming the plugin knows how to do so
- correctly (e.g. the value is POD, or the plugin understands the type).
-*/
-typedef const void* (*LV2_Persist_Retrieve_Function)(
- void* callback_data,
- uint32_t key,
- size_t* size,
- uint32_t* type,
- uint32_t* flags);
-
-/**
- Persist Extension Data.
-
- When the plugin's extension_data is called with argument LV2_PERSIST_URI,
- the plugin MUST return an LV2_Persist structure, which remains valid for the
- lifetime of the plugin.
-
- The host can use the contained function pointers to save and restore the
- state of a plugin instance at any time (provided the threading restrictions
- for the given function are met).
-
- The typical use case is to save the plugin's state when a project is saved,
- and to restore the state when a project has been loaded. Other uses are
- possible (e.g. cloning plugin instances or taking a snapshot of plugin
- state).
-
- Stored data is only guaranteed to be compatible between instances of plugins
- with the same URI (i.e. if a change to a plugin would cause a fatal error
- when restoring state saved by a previous version of that plugin, the plugin
- URI MUST change just as it must when ports change incompatibly). Plugin
- authors should consider this possibility, and always store sensible data
- with meaningful types to avoid such compatibility issues in the future.
-*/
-typedef struct _LV2_Persist {
-
- /**
- Save plugin state using a host-provided @a store callback.
-
- @param instance The instance handle of the plugin.
- @param store The host-provided store callback.
- @param callback_data An opaque pointer to host data, e.g. the map or
- file where the values are to be stored. If @a store is called,
- this MUST be passed as its callback_data parameter.
-
- The plugin is expected to store everything necessary to completely
- restore its state later (possibly much later, in a different process, on
- a completely different machine, etc.)
-
- The @a callback_data pointer and @a store function MUST NOT be used
- beyond the scope of save().
-
- This function has its own special threading class: it may not be called
- concurrently with any "Instantiation" function, but it may be called
- concurrently with functions in any other class, unless the definition of
- that class prohibits it (e.g. it may not be called concurrently with a
- "Discovery" function, but it may be called concurrently with an "Audio"
- function. The plugin is responsible for any locking or lock-free
- techniques necessary to make this possible.
-
- Note that in the simple case where state is only modified by restore(),
- there are no synchronization issues since save() is never called
- concurrently with restore() (though run() may read it during a save).
-
- Plugins that dynamically modify state while running, however, must take
- care to do so in such a way that a concurrent call to save() will save a
- consistent representation of plugin state for a single instant in time.
- */
- void (*save)(LV2_Handle instance,
- LV2_Persist_Store_Function store,
- void* callback_data);
-
- /**
- Restore plugin state using a host-provided @a retrieve callback.
-
- @param instance The instance handle of the plugin.
- @param retrieve The host-provided retrieve callback.
- @param callback_data An opaque pointer to host data, e.g. the map or
- file from which the values are to be restored. If @a retrieve is
- called, this MUST be passed as its callback_data parameter.
-
- The plugin MAY assume a restored value was set by a previous call to
- LV2_Persist.save() by a plugin with the same URI.
-
- The plugin MUST gracefully fall back to a default value when a value can
- not be retrieved. This allows the host to reset the plugin state with an
- empty map.
-
- The @a callback_data pointer and @a store function MUST NOT be used
- beyond the scope of restore().
-
- This function is in the "Instantiation" threading class as defined by
- LV2. This means it MUST NOT be called concurrently with any other
- function on the same plugin instance.
- */
- void (*restore)(LV2_Handle instance,
- LV2_Persist_Retrieve_Function retrieve,
- void* callback_data);
-
-} LV2_Persist;
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif
-
-#endif /* LV2_PERSIST_H */
diff --git a/ext/persist.lv2/persist.ttl b/ext/persist.lv2/persist.ttl
deleted file mode 100644
index 697b931..0000000
--- a/ext/persist.lv2/persist.ttl
+++ /dev/null
@@ -1,208 +0,0 @@
-# LV2 Persist Extension
-# Copyright 2010-2011 David Robillard <d@drobilla.net>
-# Copyright 2010 Leonard Ritter <paniq@paniq.org>
-#
-# 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 persist: <http://lv2plug.in/ns/ext/persist#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
-
-<http://lv2plug.in/ns/ext/persist>
- a lv2:Specification ;
- doap:name "LV2 Persist" ;
- doap:license <http://opensource.org/licenses/isc-license> ;
- doap:release [
- doap:revision "0.3" ;
- doap:created "2011-03-29"
- ] ;
- doap:developer [
- a foaf:Person ;
- foaf:name "Leonard Ritter" ;
- foaf:homepage <http://paniq.org> ;
- ] ;
- doap:maintainer [
- a foaf:Person ;
- foaf:name "David Robillard" ;
- foaf:homepage <http://drobilla.net/> ;
- rdfs:seeAlso <http://drobilla.net/drobilla.rdf>
- ] ;
- lv2:documentation """
-<p>This extension provides a mechanism for plugins to save and restore state
-across instances, allowing hosts to save configuration/state/data with a
-project or fully clone (i.e. make a deep copy of) a plugin instance.</p>
-
-<p>This extension allows plugins to save private state data, i.e. data that is
-not contained in input ports. The motivating ideal is for the state of a plugin
-instance to be <em>entirely</em> described by port values (as with all LV2
-plugins) and a key/value dictionary as defined by this extension. This
-mechanism is simple, yet sufficiently powerful to describe arbitrarily advanced
-state.</p>
-
-<p>The <q>state</q> described by this extension is conceptually a single key/value
-dictionary. Keys are URIs, and values are typed-tagged blobs of any type. The
-plugin provides a save and restore method for saving and restoring state. To
-initiate a save or restore, the host calls these methods, passing a callback to
-be used for saving or restoring a key/value pair. This data is available
-to the host, allowing state to be easily used in many different way. The
-actual mechanism of saving and restoring state is completely abstract from the
-plugin's perspective.</p>
-
-<p>Because the state is a simple dictionary, hosts and plugins can work with
-state easily (virtually all programming languages have an appropriate
-dictionary type available). Additionally, this format is simple and terse to
-serialise in many formats (e.g. any RDF syntax, JSON, XML, key/value databases
-such as BDB, etc.). In particular, state can be elegantly described in a
-plugin's Turtle description, which is useful for e.g. presets or default
-state. Note that these are simply possibilities; this extension defines only a
-few function prototypes and does not require the use of any particular syntax,
-data structure, file system, or other implementation detail. Hosts are free to
-work with plugin state in whatever way is most appropriate for that host.</p>
-
-<p>This extension makes it possible for plugins to save private data, but state
-is not necessarily private, e.g. a plugin could have a public interface for
-inspecting and manipulating internal state, which would be saved using this
-extension. Plugins and extensions SHOULD express state changes as modifications
-to this key/value dictionary, and use meaningful types wherever
-possible. Extensions may define a dynamic mechanism for accessing plugin state,
-or conventional state keys likely to be useful to several implementations.</p>
-
-<p>In pseudo code, a typical use case in a plugin is:</p>
-<pre class="c-code">
-#define NS_EG "http://example.org/"
-#define NS_ATOM "http://lv2plug.in/ns/ext/atom#"
-#define NS_XSD "http://www.w3.org/2001/XMLSchema#"
-
-static const char* const KEY_GREETING = "http://example.org/greeting";
-
-LV2_Handle my_instantiate(...)
-{
- MyPlugin* plugin = ...;
- LV2_URI_Map_Feature* map = ...;
- plugin->uri_greeting_key = map->uri_to_id(..., NULL, NS_EG "greeting-key");
- plugin->uri_xsd_string = map->uri_to_id(..., NULL, NS_XSD "string");
- plugin->state->greeting = strdup("Hello");
- return plugin;
-}
-
-void my_save(LV2_Handle instance,
- LV2_Persist_Store_Function store,
- void* callback_data)
-{
- MyPlugin* plugin = (MyPlugin*)instance;
- const char* greeting = plugin->state->greeting;
-
- store(callback_data,
- plugin->uri_greeting_key,
- greeting,
- strlen(greeting) + 1,
- plugin->uri_xsd_string,
- LV2_PERSIST_IS_POD | LV2_PERSIST_IS_PORTABLE);
-}
-
-void my_restore(LV2_Handle instance,
- LV2_Persist_Retrieve_Function retrieve,
- void* callback_data)
-{
- MyPlugin* plugin = (MyPlugin*)instance;
-
- size_t size;
- uint32_t type;
- uint32_t flags;
- const char* greeting = retrieve(callback_data,
- plugin->uri_greeting_key,
- &amp;size,
- &amp;type,
- &amp;flags);
-
- if (greeting) {
- free(plugin->state->greeting);
- plugin->state->greeting = strdup(greeting);
- } else {
- plugin->state->greeting = strdup("Hello");
- }
-}
-</pre>
-
-<p>Similarly, a typical use case in a host is:</p>
-<pre class="c-code">
-int store_callback(void* callback_data,
- uint32_t key,
- const void* value,
- size_t size,
- uint32_t type,
- uint32_t flags)
-{
- if ((flags &amp; LV2_PERSIST_IS_POD)) {
- /* Keeping state in memory only, if disk was involved then
- LV2_PERSIST_IS_PORTABLE would have to be checked as well.
- */
- Map* state_map = (Map*)callback_data;
- state_map->insert(key, Value(copy(value), size, type, pod));
- return 0;
- } else {
- return 1; /* Non-POD events are unsupported. */
- }
-}
-
-Map get_plugin_state(LV2_Handle instance)
-{
- LV2_Persist* persist = instance.extension_data("http://lv2plug.in/ns/ext/persist");
- Map state_map;
- persist.save(instance, store_callback, &amp;state_map);
- return state_map;
-}
-</pre>
-""" .
-
-persist:InstanceState
- a rdfs:Class ;
- rdfs:label "Plugin Instance State" ;
- rdfs:comment """
-This class is used to express a plugin instance's state in RDF. The key/value
-properties of the instance form the predicate/object (respectively) of triples
-with a persist:InstanceState as the subject (see persist:instanceState for an
-example). This may be used wherever it is useful to express a plugin instance's
-state in RDF (e.g. for serialisation, storing in a model, or transmitting over
-a network). Note that this class is provided because it may be useful for
-hosts, plugins, or extensions that work with instance state, but its use is not
-required to support the LV2 Persist extension.
-""" .
-
-
-persist:instanceState
- a rdf:Property ;
- rdfs:range persist:InstanceState ;
- lv2:documentation """
-Predicate to relate a plugin instance to an InstanceState. This may be used
-wherever the state of a particular plugin instance needs to be represented.
-Note that the domain of this property is unspecified, since LV2 does not define
-any RDF class for plugin instance. This predicate may be used wherever it makes
-sense to do so, e.g.:
-<pre class="turtle-code">
-@prefix eg: &lt;http://example.org/&gt; .
-
-&lt;plugininstance&gt; persist:instanceState [
- eg:somekey "some value" ;
- eg:someotherkey "some other value" ;
- eg:favourite-number 2 .
-]
-</pre>
-Note that this property is provided because it may be useful for hosts,
-plugins, or extensions that work with instance state, but its use is not
-required to support the LV2 Persist extension.
-""" .
diff --git a/ext/persist.lv2/waf b/ext/persist.lv2/waf
deleted file mode 120000
index 59a1ac9..0000000
--- a/ext/persist.lv2/waf
+++ /dev/null
@@ -1 +0,0 @@
-../../waf \ No newline at end of file
diff --git a/ext/persist.lv2/wscript b/ext/persist.lv2/wscript
deleted file mode 120000
index b82a3d0..0000000
--- a/ext/persist.lv2/wscript
+++ /dev/null
@@ -1 +0,0 @@
-../../ext.wscript \ No newline at end of file