lv2_state.h

Go to the documentation of this file.

/*
  Copyright 2010-2012 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.
*/

 
#ifndef LV2_STATE_H
#define LV2_STATE_H
 
#include <stddef.h>
#include <stdint.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__loadDefaultState LV2_STATE_PREFIX "loadDefaultState"
#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
extern "C" {
#else
#    include <stdbool.h>
#endif
 
typedef void* LV2_State_Handle;
typedef void* LV2_State_Map_Path_Handle;
typedef void* LV2_State_Make_Path_Handle;

typedef enum {
        LV2_STATE_IS_POD = 1,

        LV2_STATE_IS_PORTABLE = 1 << 1,

        LV2_STATE_IS_NATIVE = 1 << 2
} LV2_State_Flags;

typedef enum {
        LV2_STATE_SUCCESS         = 0,  
        LV2_STATE_ERR_UNKNOWN     = 1,  
        LV2_STATE_ERR_BAD_TYPE    = 2,  
        LV2_STATE_ERR_BAD_FLAGS   = 3,  
        LV2_STATE_ERR_NO_FEATURE  = 4,  
        LV2_STATE_ERR_NO_PROPERTY = 5   
} LV2_State_Status;

typedef LV2_State_Status (*LV2_State_Store_Function)(
        LV2_State_Handle handle,
        uint32_t         key,
        const void*      value,
        size_t           size,
        uint32_t         type,
        uint32_t         flags);

typedef const void* (*LV2_State_Retrieve_Function)(
        LV2_State_Handle handle,
        uint32_t         key,
        size_t*          size,
        uint32_t*        type,
        uint32_t*        flags);

typedef struct _LV2_State_Interface {
        LV2_State_Status (*save)(LV2_Handle                 instance,
                                 LV2_State_Store_Function   store,
                                 LV2_State_Handle           handle,
                                 uint32_t                   flags,
                                 const LV2_Feature *const * features);

        LV2_State_Status (*restore)(LV2_Handle                  instance,
                                    LV2_State_Retrieve_Function retrieve,
                                    LV2_State_Handle            handle,
                                    uint32_t                    flags,
                                    const LV2_Feature *const *  features);
} LV2_State_Interface;

typedef struct {
        LV2_State_Map_Path_Handle handle;

        char* (*abstract_path)(LV2_State_Map_Path_Handle handle,
                               const char*               absolute_path);

        char* (*absolute_path)(LV2_State_Map_Path_Handle handle,
                               const char*               abstract_path);
} LV2_State_Map_Path;

typedef struct {
        LV2_State_Make_Path_Handle handle;

        char* (*path)(LV2_State_Make_Path_Handle handle,
                      const char*                path);
} LV2_State_Make_Path;
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* LV2_STATE_H */