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
|
/*
RDFF - RDF in RIFF
Copyright 2011 David Robillard <http://drobilla.net>
This is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This software is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this sofware; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
02110-1301 USA.
*/
#ifndef RDFF_RDFF_H
#define RDFF_RDFF_H
#include <stdbool.h>
#include <stdint.h>
#ifdef __GNUC__
# define PACKED __attribute__((__packed__))
#else
# define PACKED
#endif
#ifdef __cplusplus
extern "C" {
#endif
typedef struct _RDFF* RDFF;
typedef enum {
RDFF_STATUS_OK = 0,
RDFF_STATUS_UNKNOWN_ERROR = 1,
RDFF_STATUS_EOF = 2,
RDFF_STATUS_CORRUPT = 3
} RDFFStatus;
/**
Generic RIFF chunk header.
*/
typedef struct {
char type[4];
uint32_t size;
char data[];
} PACKED RDFFChunk;
/**
Body of a URID chunk.
*/
typedef struct {
uint32_t id;
char uri[];
} PACKED RDFFURIChunk;
/**
Body of a KVAL chunk.
*/
typedef struct {
uint32_t key;
uint32_t type;
uint32_t size;
char value[];
} PACKED RDFFValueChunk;
/**
Open/Create a new RDFF file.
*/
RDFF
rdff_open(const char* path, bool write);
/**
Write a URI ID to @a file.
*/
RDFFStatus
rdff_write_uri(RDFF file,
uint32_t id,
const char* uri,
uint32_t len);
/**
Write a key/value record to @a file.
*/
RDFFStatus
rdff_write_value(RDFF file,
uint32_t key,
const void* value,
uint32_t size,
uint32_t type);
/**
Read a chunk from @a file.
@param buf MUST point to an RDFFChunk dynamically allocated with malloc.
The @a size field (i.e. (*buf)->size) MUST be set to the amount of available
memory in the chunk (not including the header). If this is insufficient,
*buf will be resized using realloc.
*/
RDFFStatus
rdff_read_chunk(RDFF file,
RDFFChunk** buf);
/**
Close @a file.
After this call, @a file is invalid.
*/
void
rdff_close(RDFF file);
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* RDFF_RDFF_H */
|
