ardour/ardour
ardour/ardour
13
1
Fork 0
Code Pull Requests Releases Activity

Update to latest LV2 state extension.

Browse Source 
git-svn-id: svn://localhost/ardour2/branches/3.0@11769 d708f5d6-7413-0410-9779-e7cbd77b26cf
This commit is contained in:
David Robillard 2012-03-30 23:32:48 +00:00
parent 7c2b3171c2
commit c886f761eb
3 changed files with 134 additions and 128 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
libs/ardour/ardour/lv2_plugin.h
View File

@ -136,7 +136,7 @@ class LV2Plugin : public ARDOUR::Plugin
static uint32_t _chunk_type; static uint32_t _chunk_type;
static uint32_t _sequence_type; static uint32_t _sequence_type;
static uint32_t _event_transfer_type; static uint32_t _event_transfer_type;
static uint32_t _state_path_type; static uint32_t _path_type;
private: private:
struct Impl; struct Impl;

252
libs/ardour/lv2/lv2plug.in/ns/ext/state/state.h
View File

@ -1,5 +1,5 @@
/* /*
Copyright 2010-2011 David Robillard <http://drobilla.net> Copyright 2010-2012 David Robillard <http://drobilla.net>
Copyright 2010 Leonard Ritter <paniq@paniq.org> Copyright 2010 Leonard Ritter <paniq@paniq.org>
Permission to use, copy, modify, and/or distribute this software for any Permission to use, copy, modify, and/or distribute this software for any
@ -16,30 +16,33 @@
*/ */
/** /**
@file @file state.h
C API for the LV2 State extension <http://lv2plug.in/ns/ext/state>. C API for the LV2 State extension <http://lv2plug.in/ns/ext/state>.
*/ */
#ifndef LV2_STATE_H #ifndef LV2_STATE_H
#define LV2_STATE_H #define LV2_STATE_H
#include <stdbool.h>
#include <stddef.h> #include <stddef.h>
#include <stdint.h> #include <stdint.h>
#include "lv2/lv2plug.in/ns/lv2core/lv2.h" #include "lv2/lv2plug.in/ns/lv2core/lv2.h"
#define LV2_STATE_URI "http://lv2plug.in/ns/ext/state"
#define LV2_STATE_PREFIX LV2_STATE_URI "#"
#define LV2_STATE__State LV2_STATE_PREFIX "State"
#define LV2_STATE__interface LV2_STATE_PREFIX "interface"
#define LV2_STATE__makePath LV2_STATE_PREFIX "makePath"
#define LV2_STATE__mapPath LV2_STATE_PREFIX "mapPath"
#define LV2_STATE__state LV2_STATE_PREFIX "state"
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#else
# include <stdbool.h>
#endif #endif
#define LV2_STATE_URI "http://lv2plug.in/ns/ext/state"
#define LV2_STATE_INTERFACE_URI LV2_STATE_URI "#Interface"
#define LV2_STATE_PATH_URI LV2_STATE_URI "#Path"
#define LV2_STATE_MAP_PATH_URI LV2_STATE_URI "#mapPath"
#define LV2_STATE_MAKE_PATH_URI LV2_STATE_URI "#makePath"
typedef void* LV2_State_Handle; typedef void* LV2_State_Handle;
typedef void* LV2_State_Map_Path_Handle; typedef void* LV2_State_Map_Path_Handle;
typedef void* LV2_State_Make_Path_Handle; typedef void* LV2_State_Make_Path_Handle;
@ -55,11 +58,11 @@ typedef enum {
/** /**
Plain Old Data. Plain Old Data.
Values with this flag contain no references to non-persistent or Values with this flag contain no pointers or references to other areas
non-global resources (e.g. pointers, handles, local paths, etc.). It is of memory. It is safe to copy POD values with a simple memcpy and store
safe to copy POD values with a simple memcpy and store them for use at them for the duration of the process. A POD value is not necessarily
any time in the future on a machine with a compatible architecture safe to trasmit between processes or machines (e.g. filenames are POD),
(e.g. the same endianness and alignment). see LV2_STATE_IS_PORTABLE for details.
Implementations MUST NOT attempt to copy or serialise a non-POD value if 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). they do not understand its type (and thus know how to correctly do so).
@ -70,8 +73,10 @@ typedef enum {
Portable (architecture independent) data. Portable (architecture independent) data.
Values with this flag are in a format that is usable on any 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 architecture. A portable value saved on one machine can be restored on
restored on another machine regardless of endianness, alignment, etc. another machine regardless of architecture. The format of portable
values MUST NOT depend on architecture-specific properties like
endianness or alignment. Portable values MUST NOT contain filenames.
*/ */
LV2_STATE_IS_PORTABLE = 1 << 1, LV2_STATE_IS_PORTABLE = 1 << 1,
@ -88,115 +93,120 @@ typedef enum {
} LV2_State_Flags; } LV2_State_Flags;
/** A status code for state functions. */
typedef enum {
LV2_STATE_SUCCESS = 0, /**< Completed successfully. */
LV2_STATE_ERR_UNKNOWN = 1, /**< Unknown error. */
LV2_STATE_ERR_BAD_TYPE = 2, /**< Failed due to unsupported type. */
LV2_STATE_ERR_BAD_FLAGS = 3, /**< Failed due to unsupported flags. */
LV2_STATE_ERR_NO_FEATURE = 4, /**< Failed due to missing features. */
LV2_STATE_ERR_NO_PROPERTY = 5 /**< Failed due to missing property. */
} LV2_State_Status;
/** /**
A host-provided function to store a property. A host-provided function to store a property.
@param handle Must be the handle passed to LV2_State_Interface.save(). @param handle Must be the handle passed to LV2_State_Interface.save().
@param key The key (predicate) to store @c value under (URI mapped integer). @param key The key to store @p value under (URID).
@param value Pointer to the value (object) to be stored. @param value Pointer to the value to be stored.
@param size The size of the data at @c value in bytes. @param size The size of @p value in bytes.
@param type The type of @c value (URI). @param type The type of @p value (URID).
@param flags LV2_State_Flags for @c value. @param flags LV2_State_Flags for @p value.
@return 0 on success, otherwise a non-zero error code. @return 0 on success, otherwise a non-zero error code.
The host passes a callback of this type to LV2_State_Interface.save(). This callback The host passes a callback of this type to LV2_State_Interface.save(). This
is called repeatedly by the plugin within LV2_State_Interface.save() to store all callback is called repeatedly by the plugin to store all the properties that
the statements that describe its current state. describe its current state.
The host MAY fail to store a property if the type is not understood and is DO NOT INVENT NONSENSE URI SCHEMES FOR THE KEY. Best is to use keys from
not LV2_STATE_IS_POD and/or LV2_STATE_IS_PORTABLE. Implementations are existing vocabularies. If nothing appropriate is available, use http URIs
encouraged to use POD and portable values (e.g. string literals) wherever that point to somewhere you can host documents so documentation can be made
possible, and use common types (e.g. types from resolvable (e.g. a child of the plugin or project URI). If this is not
http://lv2plug.in/ns/ext/atom) regardless, since hosts are likely to already possible, invent a URN scheme, e.g. urn:myproj:whatever. The plugin MUST
contain the necessary implementation. NOT pass an invalid URI key.
Note that @c size MUST be > 0, and @c value MUST point to a valid region of The host MAY fail to store a property for whatever reason, but SHOULD
memory @c size bytes long (this is required to make restore unambiguous). store any property that is LV2_STATE_IS_POD and LV2_STATE_IS_PORTABLE.
Implementations SHOULD use the types from the LV2 Atom extension
(http://lv2plug.in/ns/ext/atom) wherever possible. The plugin SHOULD
attempt to fall-back and avoid the error if possible.
Note that @p size MUST be > 0, and @p value MUST point to a valid region of
memory @p size bytes long (this is required to make restore unambiguous).
The plugin MUST NOT attempt to use this function outside of the The plugin MUST NOT attempt to use this function outside of the
LV2_State_Interface.restore() context. LV2_State_Interface.restore() context.
*/ */
typedef int (*LV2_State_Store_Function)(LV2_State_Handle handle, typedef LV2_State_Status (*LV2_State_Store_Function)(
uint32_t key, LV2_State_Handle handle,
const void* value, uint32_t key,
size_t size, const void* value,
uint32_t type, size_t size,
uint32_t flags); uint32_t type,
uint32_t flags);
/** /**
A host-provided function to retrieve a property. A host-provided function to retrieve a property.
@param handle Must be the handle passed to @param handle Must be the handle passed to LV2_State_Interface.restore().
LV2_State_Interface.restore(). @param key The key of the property to retrieve (URID).
@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 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 type (Output) If non-NULL, set to the type of the restored value.
@param flags (Output) If non-NULL, set to the LV2_State_Flags for @param flags (Output) If non-NULL, set to the flags for the restored value.
the returned value.
@return A pointer to the restored value (object), or NULL if no value @return A pointer to the restored value (object), or NULL if no value
has been stored under @c key. has been stored under @p key.
A callback of this type is passed by the host to A callback of this type is passed by the host to
LV2_State_Interface.restore(). This callback is called repeatedly by the LV2_State_Interface.restore(). This callback is called repeatedly by the
plugin within LV2_State_Interface.restore() to retrieve any properties it plugin to retrieve any properties it requires to restore its state.
requires to restore its state.
The returned value MUST remain valid until LV2_State_Interface.restore() The returned value MUST remain valid until LV2_State_Interface.restore()
returns. returns. The plugin MUST NOT attempt to use this function, or any value
returned from it, outside of the LV2_State_Interface.restore() context.
The plugin MUST NOT attempt to use this function, or any value returned from
it, outside of the LV2_State_Interface.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_State_Retrieve_Function)(LV2_State_Handle handle, typedef const void* (*LV2_State_Retrieve_Function)(
uint32_t key, LV2_State_Handle handle,
size_t* size, uint32_t key,
uint32_t* type, size_t* size,
uint32_t* flags); uint32_t* type,
uint32_t* flags);
/** /**
State Extension Data. LV2 Plugin State Interface.
When the plugin's extension_data is called with argument LV2_STATE_URI, When the plugin's extension_data is called with argument
the plugin MUST return an LV2_State structure, which remains valid for the LV2_STATE__interface, the plugin MUST return an LV2_State_Interface
lifetime of the plugin. structure, which remains valid for the lifetime of the plugin.
The host can use the contained function pointers to save and restore the 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 state of a plugin instance at any time, provided the threading restrictions
for the given function are met). of the functions 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 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 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 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 URI MUST change just as it must when ports change incompatibly). Plugin
authors should consider this possibility, and always store sensible data authors should consider this possibility, and always store sensible data
with meaningful types to avoid such compatibility issues in the future. with meaningful types to avoid such problems in the future.
*/ */
typedef struct _LV2_State_Interface { typedef struct _LV2_State_Interface {
/** /**
Save plugin state using a host-provided @c store callback. Save plugin state using a host-provided @p store callback.
@param instance The instance handle of the plugin. @param instance The instance handle of the plugin.
@param store The host-provided store callback. @param store The host-provided store callback.
@param handle An opaque pointer to host data, e.g. the map or @param handle An opaque pointer to host data which MUST be passed as the
file where the values are to be stored. If @c store is called, this MUST handle parameter to @p store if it is called.
be passed as its handle parameter. @param flags Flags describing desired properties of this save. These
@param flags Flags describing desires properties of this save. The flags may be used to determine the most appropriate values to store.
plugin SHOULD use these values to determine the most appropriate and/or
efficient serialisation, but is not required to do so.
@param features Extensible parameter for passing any additional @param features Extensible parameter for passing any additional
features to be used for this save. features to be used for this save.
The plugin is expected to store everything necessary to completely The plugin is expected to store everything necessary to completely
restore its state later (possibly much later, in a different process, on restore its state later. Plugins SHOULD store simple POD data whenever
a completely different machine, etc.) possible, and consider the possibility of state being restored much
later on a different machine.
The @c handle pointer and @c store function MUST NOT be used The @p handle pointer and @p store function MUST NOT be used
beyond the scope of save(). beyond the scope of save().
This function has its own special threading class: it may not be called This function has its own special threading class: it may not be called
@ -204,7 +214,7 @@ typedef struct _LV2_State_Interface {
concurrently with functions in any other class, unless the definition of 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 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" "Discovery" function, but it may be called concurrently with an "Audio"
function. The plugin is responsible for any locking or lock-free function. The plugin is responsible for any locking or lock-free
techniques necessary to make this possible. techniques necessary to make this possible.
Note that in the simple case where state is only modified by restore(), Note that in the simple case where state is only modified by restore(),
@ -215,20 +225,19 @@ typedef struct _LV2_State_Interface {
care to do so in such a way that a concurrent call to save() will save a 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. consistent representation of plugin state for a single instant in time.
*/ */
void (*save)(LV2_Handle instance, LV2_State_Status (*save)(LV2_Handle instance,
LV2_State_Store_Function store, LV2_State_Store_Function store,
LV2_State_Handle handle, LV2_State_Handle handle,
uint32_t flags, uint32_t flags,
const LV2_Feature *const * features); const LV2_Feature *const * features);
/** /**
Restore plugin state using a host-provided @c retrieve callback. Restore plugin state using a host-provided @p retrieve callback.
@param instance The instance handle of the plugin. @param instance The instance handle of the plugin.
@param retrieve The host-provided retrieve callback. @param retrieve The host-provided retrieve callback.
@param handle An opaque pointer to host data, e.g. the map or @param handle An opaque pointer to host data which MUST be passed as the
file from which the values are to be restored. If @c retrieve is handle parameter to @p retrieve if it is called.
called, this MUST be passed as its handle parameter.
@param flags Currently unused. @param flags Currently unused.
@param features Extensible parameter for passing any additional @param features Extensible parameter for passing any additional
features to be used for this restore. features to be used for this restore.
@ -237,26 +246,26 @@ typedef struct _LV2_State_Interface {
LV2_State_Interface.save() by a plugin with the same URI. LV2_State_Interface.save() by a plugin with the same URI.
The plugin MUST gracefully fall back to a default value when a value can 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 not be retrieved. This allows the host to reset the plugin state with
empty map. an empty map.
The @c handle pointer and @c store function MUST NOT be used The @p handle pointer and @p store function MUST NOT be used
beyond the scope of restore(). beyond the scope of restore().
This function is in the "Instantiation" threading class as defined by This function is in the "Instantiation" threading class as defined by
LV2. This means it MUST NOT be called concurrently with any other LV2. This means it MUST NOT be called concurrently with any other
function on the same plugin instance. function on the same plugin instance.
*/ */
void (*restore)(LV2_Handle instance, LV2_State_Status (*restore)(LV2_Handle instance,
LV2_State_Retrieve_Function retrieve, LV2_State_Retrieve_Function retrieve,
LV2_State_Handle handle, LV2_State_Handle handle,
uint32_t flags, uint32_t flags,
const LV2_Feature *const * features); const LV2_Feature *const * features);
} LV2_State_Interface; } LV2_State_Interface;
/** /**
Feature data for state:mapPath (LV2_STATE_MAP_PATH_URI). Feature data for state:mapPath (LV2_STATE__mapPath).
*/ */
typedef struct { typedef struct {
@ -267,41 +276,38 @@ typedef struct {
/** /**
Map an absolute path to an abstract path for use in plugin state. Map an absolute path to an abstract path for use in plugin state.
@param handle MUST be the @a handle member of this struct. @param handle MUST be the @p handle member of this struct.
@param absolute_path The absolute path of a file. @param absolute_path The absolute path of a file.
@return An abstract path suitable for use in plugin state. @return An abstract path suitable for use in plugin state.
The plugin MUST use this function to map any paths that will be stored The plugin MUST use this function to map any paths that will be stored
in files in plugin state. The returned value is an abstract path which in plugin state. The returned value is an abstract path which MAY not
MAY not be an actual file system path; @ref absolute_path MUST be used be an actual file system path; @ref absolute_path() MUST be used to map
to map it to an actual path in order to use the file. it to an actual path in order to use the file.
Hosts MAY map paths in any way (e.g. by creating symbolic links within Plugins MUST NOT make any assumptions about abstract paths except that
the plugin's state directory or storing a list of referenced files they can be mapped back to the absolute path of the "same" file (though
elsewhere). Plugins MUST NOT make any assumptions about abstract paths not necessarily the same original path) using @ref absolute_path().
except that they can be mapped back to an absolute path using @ref
absolute_path.
This function may only be called within the context of This function may only be called within the context of
LV2_State_Interface.save() or LV2_State_Interface.restore(). The caller LV2_State_Interface methods. The caller is responsible for freeing the
is responsible for freeing the returned value. returned value with free().
*/ */
char* (*abstract_path)(LV2_State_Map_Path_Handle handle, char* (*abstract_path)(LV2_State_Map_Path_Handle handle,
const char* absolute_path); const char* absolute_path);
/** /**
Map an abstract path from plugin state to an absolute path. Map an abstract path from plugin state to an absolute path.
@param handle MUST be the @a handle member of this struct. @param handle MUST be the @p handle member of this struct.
@param abstract_path An abstract path (e.g. a path from plugin state). @param abstract_path An abstract path (e.g. a path from plugin state).
@return An absolute file system path. @return An absolute file system path.
Since abstract paths are not necessarily actual file paths (or at least The plugin MUST use this function in order to actually open or otherwise
not necessarily absolute paths), this function MUST be used in order to use any paths loaded from plugin state.
actually open or otherwise use the file referred to by an abstract path.
This function may only be called within the context of This function may only be called within the context of
LV2_State_Interface.save() or LV2_State_Interface.restore(). The caller LV2_State_Interface methods. The caller is responsible for freeing the
is responsible for freeing the returned value. returned value with free().
*/ */
char* (*absolute_path)(LV2_State_Map_Path_Handle handle, char* (*absolute_path)(LV2_State_Map_Path_Handle handle,
const char* abstract_path); const char* abstract_path);
@ -309,7 +315,7 @@ typedef struct {
} LV2_State_Map_Path; } LV2_State_Map_Path;
/** /**
Feature data for state:makePath (@ref LV2_STATE_MAKE_PATH_URI). Feature data for state:makePath (@ref LV2_STATE__makePath).
*/ */
typedef struct { typedef struct {
@ -320,9 +326,9 @@ typedef struct {
/** /**
Return a path the plugin may use to create a new file. Return a path the plugin may use to create a new file.
@param handle MUST be the @a handle member of this struct. @param handle MUST be the @p handle member of this struct.
@param path The path of the new file relative to a namespace unique @param path The path of the new file within a namespace unique to this
to this plugin instance. plugin instance.
@return The absolute path to use for the new file. @return The absolute path to use for the new file.
This function can be used by plugins to create files and directories, This function can be used by plugins to create files and directories,
@ -330,7 +336,7 @@ typedef struct {
LV2_State_Interface.save()) or any time (if this feature is passed to LV2_State_Interface.save()) or any time (if this feature is passed to
LV2_Descriptor.instantiate()). LV2_Descriptor.instantiate()).
The host must do whatever is necessary for the plugin to be able to The host MUST do whatever is necessary for the plugin to be able to
create a file at the returned path (e.g. using fopen), including create a file at the returned path (e.g. using fopen), including
creating any leading directories. creating any leading directories.

8
libs/ardour/lv2_plugin.cc
View File

@ -80,8 +80,8 @@ uint32_t LV2Plugin::_sequence_type = _uri_map.uri_to_id(
NULL, LV2_ATOM__Sequence); NULL, LV2_ATOM__Sequence);
uint32_t LV2Plugin::_event_transfer_type = _uri_map.uri_to_id( uint32_t LV2Plugin::_event_transfer_type = _uri_map.uri_to_id(
NULL, LV2_ATOM__eventTransfer); NULL, LV2_ATOM__eventTransfer);
uint32_t LV2Plugin::_state_path_type = _uri_map.uri_to_id( uint32_t LV2Plugin::_path_type = _uri_map.uri_to_id(
NULL, LV2_STATE_PATH_URI); NULL, LV2_ATOM__Path);
class LV2World : boost::noncopyable { class LV2World : boost::noncopyable {
public: public:
@ -176,12 +176,12 @@ LV2Plugin::init(void* c_plugin, framecnt_t rate)
_instance_access_feature.URI = "http://lv2plug.in/ns/ext/instance-access"; _instance_access_feature.URI = "http://lv2plug.in/ns/ext/instance-access";
_data_access_feature.URI = "http://lv2plug.in/ns/ext/data-access"; _data_access_feature.URI = "http://lv2plug.in/ns/ext/data-access";
_make_path_feature.URI = LV2_STATE_MAKE_PATH_URI; _make_path_feature.URI = LV2_STATE__makePath;
LilvPlugin* plugin = _impl->plugin; LilvPlugin* plugin = _impl->plugin;
#ifdef HAVE_NEW_LILV #ifdef HAVE_NEW_LILV
LilvNode* state_iface_uri = lilv_new_uri(_world.world, LV2_STATE_INTERFACE_URI); LilvNode* state_iface_uri = lilv_new_uri(_world.world, LV2_STATE__interface);
LilvNode* state_uri = lilv_new_uri(_world.world, LV2_STATE_URI); LilvNode* state_uri = lilv_new_uri(_world.world, LV2_STATE_URI);
_has_state_interface = _has_state_interface =
// What plugins should have (lv2:extensionData state:Interface) // What plugins should have (lv2:extensionData state:Interface)