lv2_atom.h

Go to the documentation of this file.

/*
  Copyright 2008-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_ATOM_H
#define LV2_ATOM_H
 
#include <stdint.h>
#include <stddef.h>
 
#define LV2_ATOM_URI    "http://lv2plug.in/ns/ext/atom"
#define LV2_ATOM_PREFIX LV2_ATOM_URI "#"
 
#define LV2_ATOM__Atom          LV2_ATOM_PREFIX "Atom"
#define LV2_ATOM__AtomPort      LV2_ATOM_PREFIX "AtomPort"
#define LV2_ATOM__Blank         LV2_ATOM_PREFIX "Blank"
#define LV2_ATOM__Bool          LV2_ATOM_PREFIX "Bool"
#define LV2_ATOM__Chunk         LV2_ATOM_PREFIX "Chunk"
#define LV2_ATOM__Double        LV2_ATOM_PREFIX "Double"
#define LV2_ATOM__Event         LV2_ATOM_PREFIX "Event"
#define LV2_ATOM__Float         LV2_ATOM_PREFIX "Float"
#define LV2_ATOM__Int           LV2_ATOM_PREFIX "Int"
#define LV2_ATOM__Literal       LV2_ATOM_PREFIX "Literal"
#define LV2_ATOM__Long          LV2_ATOM_PREFIX "Long"
#define LV2_ATOM__Number        LV2_ATOM_PREFIX "Number"
#define LV2_ATOM__Object        LV2_ATOM_PREFIX "Object"
#define LV2_ATOM__Path          LV2_ATOM_PREFIX "Path"
#define LV2_ATOM__Property      LV2_ATOM_PREFIX "Property"
#define LV2_ATOM__Resource      LV2_ATOM_PREFIX "Resource"
#define LV2_ATOM__Sequence      LV2_ATOM_PREFIX "Sequence"
#define LV2_ATOM__Sound         LV2_ATOM_PREFIX "Sound"
#define LV2_ATOM__String        LV2_ATOM_PREFIX "String"
#define LV2_ATOM__Tuple         LV2_ATOM_PREFIX "Tuple"
#define LV2_ATOM__URI           LV2_ATOM_PREFIX "URI"
#define LV2_ATOM__URID          LV2_ATOM_PREFIX "URID"
#define LV2_ATOM__Vector        LV2_ATOM_PREFIX "Vector"
#define LV2_ATOM__atomTransfer  LV2_ATOM_PREFIX "atomTransfer"
#define LV2_ATOM__beatTime      LV2_ATOM_PREFIX "beatTime"
#define LV2_ATOM__bufferType    LV2_ATOM_PREFIX "bufferType"
#define LV2_ATOM__childType     LV2_ATOM_PREFIX "childType"
#define LV2_ATOM__eventTransfer LV2_ATOM_PREFIX "eventTransfer"
#define LV2_ATOM__frameTime     LV2_ATOM_PREFIX "frameTime"
#define LV2_ATOM__supports      LV2_ATOM_PREFIX "supports"
#define LV2_ATOM__timeUnit      LV2_ATOM_PREFIX "timeUnit"
 
#define LV2_ATOM_REFERENCE_TYPE 0
 
#ifdef __cplusplus
extern "C" {
#endif

typedef char lv2_atom_assert_double_fits_in_64_bits[
        ((sizeof(double) <= sizeof(uint64_t)) * 2) - 1];

#define LV2_ATOM_CONTENTS(type, atom) \
        ((void*)((uint8_t*)(atom) + sizeof(type)))

#define LV2_ATOM_CONTENTS_CONST(type, atom) \
        ((const void*)((const uint8_t*)(atom) + sizeof(type)))

#define LV2_ATOM_BODY(atom) LV2_ATOM_CONTENTS(LV2_Atom, atom)

#define LV2_ATOM_BODY_CONST(atom) LV2_ATOM_CONTENTS_CONST(LV2_Atom, atom)

typedef struct {
        uint32_t size;  
        uint32_t type;  
} LV2_Atom;

typedef struct {
        LV2_Atom atom;  
        int32_t  body;  
} LV2_Atom_Int;

typedef struct {
        LV2_Atom atom;  
        int64_t  body;  
} LV2_Atom_Long;

typedef struct {
        LV2_Atom atom;  
        float    body;  
} LV2_Atom_Float;

typedef struct {
        LV2_Atom atom;  
        double   body;  
} LV2_Atom_Double;

typedef LV2_Atom_Int LV2_Atom_Bool;

typedef struct {
        LV2_Atom atom;  
        uint32_t body;  
} LV2_Atom_URID;

typedef struct {
        LV2_Atom atom;  
        /* Contents (a null-terminated UTF-8 string) follow here. */
} LV2_Atom_String;

typedef struct {
        uint32_t datatype;  
        uint32_t lang;      
        /* Contents (a null-terminated UTF-8 string) follow here. */
} LV2_Atom_Literal_Body;

typedef struct {
        LV2_Atom              atom;  
        LV2_Atom_Literal_Body body;  
} LV2_Atom_Literal;

typedef struct {
        LV2_Atom atom;  
        /* Contents (a series of complete atoms) follow here. */
} LV2_Atom_Tuple;

typedef struct {
        uint32_t child_size;  
        uint32_t child_type;  
        /* Contents (a series of packed atom bodies) follow here. */
} LV2_Atom_Vector_Body;

typedef struct {
        LV2_Atom             atom;  
        LV2_Atom_Vector_Body body;  
} LV2_Atom_Vector;

typedef struct {
        uint32_t key;      
        uint32_t context;  
        LV2_Atom value;    
        /* Value atom body follows here. */
} LV2_Atom_Property_Body;

typedef struct {
        LV2_Atom               atom;  
        LV2_Atom_Property_Body body;  
} LV2_Atom_Property;

typedef struct {
        uint32_t id;     
        uint32_t otype;  
        /* Contents (a series of property bodies) follow here. */
} LV2_Atom_Object_Body;

typedef struct {
        LV2_Atom             atom;  
        LV2_Atom_Object_Body body;  
} LV2_Atom_Object;

typedef struct {
        union {
                int64_t frames;  
                double  beats;   
        } time;
        LV2_Atom body;  
        /* Body atom contents follow here. */
} LV2_Atom_Event;

typedef struct {
        uint32_t unit;  
        uint32_t pad;   
        /* Contents (a series of events) follow here. */
} LV2_Atom_Sequence_Body;

typedef struct {
        LV2_Atom               atom;  
        LV2_Atom_Sequence_Body body;  
} LV2_Atom_Sequence;
 
#ifdef __cplusplus
}  /* extern "C" */
#endif
 
#endif  /* LV2_ATOM_H */