aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/lv2plug.in/ns/ext/atom/atom.h
blob: 5583ddb7ac5715f3692454fe49a222f543746175 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
/*
  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.
*/

/**
   @file atom.h C header for the LV2 Atom extension
   <http://lv2plug.in/ns/ext/atom>.

   This header describes the binary layout of various types defined in the
   atom extension.
*/

#ifndef LV2_ATOM_H
#define LV2_ATOM_H

#define LV2_ATOM_URI "http://lv2plug.in/ns/ext/atom"

#define LV2_ATOM__Atom          LV2_ATOM_URI "#Atom"
#define LV2_ATOM__Bang          LV2_ATOM_URI "#Bang"
#define LV2_ATOM__Number        LV2_ATOM_URI "#Number"
#define LV2_ATOM__Int32         LV2_ATOM_URI "#Int32"
#define LV2_ATOM__Int64         LV2_ATOM_URI "#Int64"
#define LV2_ATOM__Float         LV2_ATOM_URI "#Float"
#define LV2_ATOM__Double        LV2_ATOM_URI "#Double"
#define LV2_ATOM__Bool          LV2_ATOM_URI "#Bool"
#define LV2_ATOM__String        LV2_ATOM_URI "#String"
#define LV2_ATOM__Literal       LV2_ATOM_URI "#Literal"
#define LV2_ATOM__Path          LV2_ATOM_URI "#Path"
#define LV2_ATOM__URI           LV2_ATOM_URI "#URI"
#define LV2_ATOM__URID          LV2_ATOM_URI "#URID"
#define LV2_ATOM__Vector        LV2_ATOM_URI "#Vector"
#define LV2_ATOM__Tuple         LV2_ATOM_URI "#Tuple"
#define LV2_ATOM__Property      LV2_ATOM_URI "#Property"
#define LV2_ATOM__Object        LV2_ATOM_URI "#Object"
#define LV2_ATOM__Resource      LV2_ATOM_URI "#Resource"
#define LV2_ATOM__Blank         LV2_ATOM_URI "#Blank"
#define LV2_ATOM__TimeUnit      LV2_ATOM_URI "#TimeUnit"
#define LV2_ATOM__AudioFrames   LV2_ATOM_URI "#AudioFrames"
#define LV2_ATOM__Beats         LV2_ATOM_URI "#Beats"
#define LV2_ATOM__Event         LV2_ATOM_URI "#Event"
#define LV2_ATOM__Sequence      LV2_ATOM_URI "#Sequence"
#define LV2_ATOM__AtomPort      LV2_ATOM_URI "#AtomPort"
#define LV2_ATOM__ValuePort     LV2_ATOM_URI "#ValuePort"
#define LV2_ATOM__MessagePort   LV2_ATOM_URI "#MessagePort"
#define LV2_ATOM__bufferType    LV2_ATOM_URI "#bufferType"
#define LV2_ATOM__supports      LV2_ATOM_URI "#supports"
#define LV2_ATOM__eventTransfer LV2_ATOM_URI "#eventTransfer"

#define LV2_ATOM_REFERENCE_TYPE 0

#include <stdint.h>
#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

/** This expression will fail to compile if double does not fit in 64 bits. */
typedef char lv2_atom_assert_double_fits_in_64_bits[
	((sizeof(double) <= sizeof(uint64_t)) * 2) - 1];

/**
   Return a pointer to the contents of a variable-sized atom.
   @param type The type of the atom, e.g. LV2_Atom_String.
   @param atom A variable-sized atom.
*/
#define LV2_ATOM_CONTENTS(type, atom) \
	((void*)((uint8_t*)(atom) + sizeof(type)))

/** Return a pointer to the body of @p atom (just past the LV2_Atom head). */
#define LV2_ATOM_BODY(atom) LV2_ATOM_CONTENTS(LV2_Atom, atom)

/** The header of an atom:Atom. */
typedef struct {
	uint32_t type;  /**< Type of this atom (mapped URI). */
	uint32_t size;  /**< Size in bytes, not including type and size. */
} LV2_Atom;

/** An atom:Int32 or atom:Bool.  May be cast to LV2_Atom. */
typedef struct {
	LV2_Atom atom;
	int32_t  value;
} LV2_Atom_Int32;

/** An atom:Int64.  May be cast to LV2_Atom. */
typedef struct {
	LV2_Atom atom;
	int64_t  value;
} LV2_Atom_Int64;

/** An atom:Float.  May be cast to LV2_Atom. */
typedef struct {
	LV2_Atom atom;
	float    value;
} LV2_Atom_Float;

/** An atom:Double.  May be cast to LV2_Atom. */
typedef struct {
	LV2_Atom atom;
	double   value;
} LV2_Atom_Double;

/** An atom:Bool.  May be cast to LV2_Atom. */
typedef LV2_Atom_Int32 LV2_Atom_Bool;

/** An atom:URID.  May be cast to LV2_Atom. */
typedef struct {
	LV2_Atom atom;  /**< Atom header. */
	uint32_t id;    /**< URID. */
} LV2_Atom_URID;

/** The complete header of an atom:String. */
typedef struct {
	LV2_Atom atom;  /**< Atom header. */
	/* Contents (a null-terminated UTF-8 string) follow here. */
} LV2_Atom_String;

/** The complete header of an atom:Literal. */
typedef struct {
	LV2_Atom atom;      /**< Atom header. */
	uint32_t datatype;  /**< The ID of the datatype of this literal. */
	uint32_t lang;      /**< The ID of the language of this literal. */
	/* Contents (a null-terminated UTF-8 string) follow here. */
} LV2_Atom_Literal;

/** The complete header of an atom:Tuple. */
typedef struct {
	LV2_Atom atom;  /**< Atom header. */
	/* Contents (a series of complete atoms) follow here. */
} LV2_Atom_Tuple;

/** The complete header of an atom:Vector. */
typedef struct {
	LV2_Atom atom;        /**< Atom header. */
	uint32_t elem_count;  /**< The number of elements in the vector */
	uint32_t elem_type;   /**< The type of each element in the vector */
	/* Contents (a series of packed atom bodies) follow here. */
} LV2_Atom_Vector;

/** The header of an atom:Property body (e.g. in an atom:Object). */
typedef struct {
	uint32_t key;      /**< Key (predicate) (mapped URI). */
	uint32_t context;  /**< Context URID (may be, and generally is, 0). */
	LV2_Atom value;    /**< Value atom header. */
} LV2_Atom_Property_Body;

/** The complete header of an atom:Property. */
typedef struct {
	LV2_Atom atom;     /**< Atom header. */
	uint32_t key;      /**< Key (predicate) (mapped URI). */
	uint32_t context;  /**< Context URID (may be, and generally is, 0). */
	LV2_Atom value;    /**< Value atom header. */
	/* Value atom body follows here. */
} LV2_Atom_Property;

/** The complete header of an atom:Object. */
typedef struct {
	LV2_Atom atom;  /**< Atom header. */
	uint32_t id;    /**< URID for atom:Resource, or blank ID for atom:Blank. */
	uint32_t type;  /**< Type URID (same as rdf:type, for fast dispatch). */
	/* Contents (a series of property bodies) follow here. */
} LV2_Atom_Object;

/** A time stamp in frames.  Note this type is NOT an LV2_Atom. */
typedef struct {
	uint32_t frames;     /**< Time in frames relative to this block. */
	uint32_t subframes;  /**< Fractional time in 1/(2^32)ths of a frame. */
} LV2_Atom_Audio_Time;

/** The header of an atom:Event.  Note this type is NOT an LV2_Atom. */
typedef struct {
	/** Time stamp.  Which type is valid is determined by context. */
	union {
		LV2_Atom_Audio_Time audio;  /**< Time in audio frames. */
		double              beats;  /**< Time in beats. */
	} time;
	LV2_Atom body;  /**< Event body atom header. */
	/* Body atom contents follow here. */
} LV2_Atom_Event;

/**
   A sequence of events (time-stamped atoms).

   This is used as the contents of an atom:EventPort, but is a generic Atom
   type which can be used anywhere.

   The unit field is either a URID that described an appropriate time stamp
   type, or may be 0 where a default stamp type is known.  For
   LV2_Descriptor::run(), the default stamp type is atom:AudioFrames, i.e.
   LV2_Atom_Audio_Time.

   The contents of a sequence is a series of LV2_Atom_Event, each aligned
   to 64-bits, e.g.:
   <pre>
   | Event 1 (size 6)                              | Event 2
   |       |       |       |       |       |       |       |       |
   | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
   |FRAMES |SUBFRMS|TYPE   |SIZE   |DATADATADATAPAD|FRAMES |SUBFRMS|...
   </pre>
*/
typedef struct {
	LV2_Atom atom;  /**< Atom header. */
	uint32_t unit;  /**< URID of unit of event time stamps. */
	uint32_t pad;   /**< Currently unused. */
	/* Contents (a series of events) follow here. */
} LV2_Atom_Sequence;

/**
   The contents of an atom:AtomPort buffer.

   This contains a pointer to an Atom, which is the data to be
   processed/written, as well as additional metadata.  This struct may be
   augmented in the future to add more metadata fields as they become
   necessary.  The initial version of this struct contains data, size, and
   capacity.  Implementations MUST check that any other fields they wish to use
   are actually present by comparing the size with the offset of that field,
   e.g.:

   @code
   if (offsetof(LV2_Atom_Port_Buffer, field) < buf->size) {
       do_stuff_with(buf->field);
   }
   @endcode
*/
typedef struct {
	LV2_Atom* data;      /** Pointer to data. */
	uint32_t  size;      /** Total size of this struct. */
	uint32_t  capacity;  /** Available space for data body. */
} LV2_Atom_Port_Buffer;

#ifdef __cplusplus
}  /* extern "C" */
#endif

#endif  /* LV2_ATOM_H */