lv2_options.h

Go to the documentation of this file.

/*
  Copyright 2012 David Robillard <http://drobilla.net>
 
  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_OPTIONS_H
#define LV2_OPTIONS_H
 
#include <stdint.h>
 
#include "lv2_urid.h"
#include "lv2/lv2plug.in/ns/lv2core/lv2.h"
 
#define LV2_OPTIONS_URI    "http://lv2plug.in/ns/ext/options"
#define LV2_OPTIONS_PREFIX LV2_OPTIONS_URI "#"
 
#define LV2_OPTIONS__Option          LV2_OPTIONS_PREFIX "Option"
#define LV2_OPTIONS__interface       LV2_OPTIONS_PREFIX "interface"
#define LV2_OPTIONS__options         LV2_OPTIONS_PREFIX "options"
#define LV2_OPTIONS__requiredOption  LV2_OPTIONS_PREFIX "requiredOption"
#define LV2_OPTIONS__supportedOption LV2_OPTIONS_PREFIX "supportedOption"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
        LV2_OPTIONS_INSTANCE,

        LV2_OPTIONS_RESOURCE,

        LV2_OPTIONS_BLANK,

        LV2_OPTIONS_PORT
} LV2_Options_Context;

typedef struct _LV2_Options_Option {
        LV2_Options_Context context;  
        uint32_t            subject;  
        LV2_URID            key;      
        uint32_t            size;     
        LV2_URID            type;     
        const void*         value;    
} LV2_Options_Option;

typedef enum {
        LV2_OPTIONS_SUCCESS         = 0,       
        LV2_OPTIONS_ERR_UNKNOWN     = 1,       
        LV2_OPTIONS_ERR_BAD_SUBJECT = 1 << 1,  
        LV2_OPTIONS_ERR_BAD_KEY     = 1 << 2,  
        LV2_OPTIONS_ERR_BAD_VALUE   = 1 << 3   
} LV2_Options_Status;

typedef struct _LV2_Options_Interface {
        uint32_t (*get)(LV2_Handle          instance,
                        LV2_Options_Option* options);

        uint32_t (*set)(LV2_Handle                instance,
                        const LV2_Options_Option* options);
} LV2_Options_Interface;
 
#ifdef __cplusplus
}  /* extern "C" */
#endif
 
#endif  /* LV2_OPTIONS_H */