From 08d5432a61a7b29f25c12da869d31a46e7d3b860 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Tue, 4 Jun 2019 19:27:20 +0200 Subject: Add state:freePath feature --- lv2/state/lv2-state.doap.ttl | 9 +++++++++ lv2/state/manifest.ttl | 2 +- lv2/state/state.h | 36 +++++++++++++++++++++++++++++++----- lv2/state/state.ttl | 9 +++++++++ 4 files changed, 50 insertions(+), 6 deletions(-) (limited to 'lv2/state') diff --git a/lv2/state/lv2-state.doap.ttl b/lv2/state/lv2-state.doap.ttl index 4ad6089..c2372c9 100644 --- a/lv2/state/lv2-state.doap.ttl +++ b/lv2/state/lv2-state.doap.ttl @@ -13,6 +13,15 @@ ; doap:maintainer ; doap:release [ + doap:revision "2.5" ; + doap:created "2019-06-03" ; + dcs:blame ; + dcs:changeset [ + dcs:item [ + rdfs:label "Add state:freePath feature." + ] + ] + ] , [ doap:revision "2.4" ; doap:created "2019-02-03" ; doap:file-release ; diff --git a/lv2/state/manifest.ttl b/lv2/state/manifest.ttl index e2d4d30..44732b1 100644 --- a/lv2/state/manifest.ttl +++ b/lv2/state/manifest.ttl @@ -4,5 +4,5 @@ a lv2:Specification ; lv2:minorVersion 2 ; - lv2:microVersion 4 ; + lv2:microVersion 5 ; rdfs:seeAlso . diff --git a/lv2/state/state.h b/lv2/state/state.h index 1005d50..45eb7e4 100644 --- a/lv2/state/state.h +++ b/lv2/state/state.h @@ -39,6 +39,7 @@ #define LV2_STATE__State LV2_STATE_PREFIX "State" ///< http://lv2plug.in/ns/ext/state#State #define LV2_STATE__interface LV2_STATE_PREFIX "interface" ///< http://lv2plug.in/ns/ext/state#interface #define LV2_STATE__loadDefaultState LV2_STATE_PREFIX "loadDefaultState" ///< http://lv2plug.in/ns/ext/state#loadDefaultState +#define LV2_STATE__freePath LV2_STATE_PREFIX "freePath" ///< http://lv2plug.in/ns/ext/state#freePath #define LV2_STATE__makePath LV2_STATE_PREFIX "makePath" ///< http://lv2plug.in/ns/ext/state#makePath #define LV2_STATE__mapPath LV2_STATE_PREFIX "mapPath" ///< http://lv2plug.in/ns/ext/state#mapPath #define LV2_STATE__state LV2_STATE_PREFIX "state" ///< http://lv2plug.in/ns/ext/state#state @@ -50,6 +51,7 @@ extern "C" { #endif typedef void* LV2_State_Handle; ///< Opaque handle for state save/restore +typedef void* LV2_State_Free_Path_Handle; ///< Opaque handle for state:freePath feature typedef void* LV2_State_Map_Path_Handle; ///< Opaque handle for state:mapPath feature typedef void* LV2_State_Make_Path_Handle; ///< Opaque handle for state:makePath feature @@ -292,8 +294,8 @@ typedef struct { not necessarily the same original path) using absolute_path(). This function may only be called within the context of - LV2_State_Interface methods. The caller is responsible for freeing the - returned value with free(). + LV2_State_Interface methods. The caller must free the returned value + with LV2_State_Free_Path.free_path(). */ char* (*abstract_path)(LV2_State_Map_Path_Handle handle, const char* absolute_path); @@ -308,8 +310,8 @@ typedef struct { use any paths loaded from plugin state. This function may only be called within the context of - LV2_State_Interface methods. The caller is responsible for freeing the - returned value with free(). + LV2_State_Interface methods. The caller must free the returned value + with LV2_State_Free_Path.free_path(). */ char* (*absolute_path)(LV2_State_Map_Path_Handle handle, const char* abstract_path); @@ -345,12 +347,36 @@ typedef struct { LV2_State_Interface.save(), it may only be called within the dynamic scope of that function call. - The caller is responsible for freeing the returned value with free(). + The caller must free the returned value with + LV2_State_Free_Path.free_path(). */ char* (*path)(LV2_State_Make_Path_Handle handle, const char* path); } LV2_State_Make_Path; +/** + Feature data for state:freePath (@ref LV2_STATE__freePath). +*/ +typedef struct { + /** + Opaque host data. + */ + LV2_State_Free_Path_Handle handle; + + /** + Free a path returned by a state feature. + + @param handle MUST be the `handle` member of this struct. + @param path The path previously returned by a state feature. + + This function can be used by plugins to free paths allocated by the host + and returned by state features (LV2_State_Map_Path.abstract_path(), + LV2_State_Map_Path.absolute_path(), and LV2_State_Make_Path.path()). + */ + void (*free_path)(LV2_State_Free_Path_Handle handle, + char* path); +} LV2_State_Free_Path; + #ifdef __cplusplus } /* extern "C" */ #endif diff --git a/lv2/state/state.ttl b/lv2/state/state.ttl index 9c49195..e5a4ab3 100644 --- a/lv2/state/state.ttl +++ b/lv2/state/state.ttl @@ -364,6 +364,15 @@ which emits a response which is later applied in the audio thread.

state, so this feature allows state to be restored without dropouts.

""" . +state:freePath + a lv2:Feature ; + rdfs:label "free a file path" ; + lv2:documentation """ +

This feature provides a function that can be used by plugins to free paths +that were allocated by the host via other state features (state:mapPath and +state:makePath).

+""" . + state:Changed a rdfs:Class ; rdfs:label "State changed" ; -- cgit v1.2.1