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
|
/*
RDFF - RDF in RIFF
Copyright 2011 David Robillard <http://drobilla.net>
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
THE POSSIBILITY OF SUCH DAMAGE.
*/
#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
/**
RDFF file or stream.
*/
typedef struct _RDFF* RDFF;
/**
Status codes for function returns.
*/
typedef enum {
RDFF_STATUS_OK = 0, /**< Success. */
RDFF_STATUS_UNKNOWN_ERROR = 1, /**< Unknown error. */
RDFF_STATUS_EOF = 2, /**< End of file. */
RDFF_STATUS_CORRUPT = 3 /**< Corrupt data. */
} RDFFStatus;
/**
Generic RIFF chunk header.
*/
typedef struct {
char type[4]; /**< Chunk type ID. */
uint32_t size; /**< Size of chunk body (not including header). */
char data[]; /**< Chunk body. */
} PACKED RDFFChunk;
/**
Body of a URID chunk.
*/
typedef struct {
uint32_t id; /**< Numeric ID of URI in this RDFF. */
char uri[]; /**< URI string. */
} PACKED RDFFURIChunk;
/**
Body of a KVAL chunk.
*/
typedef struct {
uint32_t key; /**< Predicate URI ID. */
uint32_t type; /**< Type URI ID. */
uint32_t size; /**< Size of object data. */
char value[]; /**< Object data. */
} 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 */
|
