ardour/livetrax
13
0
Fork 0
Code

Flesh out RDFF documentation.

Browse Source 
git-svn-id: svn://localhost/ardour2/branches/3.0@9223 d708f5d6-7413-0410-9779-e7cbd77b26cf
This commit is contained in:
David Robillard 2011-03-29 02:37:48 +00:00
parent c9d0c2beae
commit b502bbc618
1 changed files with 19 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
libs/ardour/rdff.h
View File

@ -40,40 +40,46 @@
extern "C" { extern "C" {
#endif #endif
/**
RDFF file or stream.
*/
typedef struct _RDFF* RDFF; typedef struct _RDFF* RDFF;
/**
Status codes for function returns.
*/
typedef enum { typedef enum {
RDFF_STATUS_OK = 0, RDFF_STATUS_OK = 0, /**< Success. */
RDFF_STATUS_UNKNOWN_ERROR = 1, RDFF_STATUS_UNKNOWN_ERROR = 1, /**< Unknown error. */
RDFF_STATUS_EOF = 2, RDFF_STATUS_EOF = 2, /**< End of file. */
RDFF_STATUS_CORRUPT = 3 RDFF_STATUS_CORRUPT = 3 /**< Corrupt data. */
} RDFFStatus; } RDFFStatus;
/** /**
Generic RIFF chunk header. Generic RIFF chunk header.
*/ */
typedef struct { typedef struct {
char type[4]; char type[4]; /**< Chunk type ID. */
uint32_t size; uint32_t size; /**< Size of chunk body (not including header). */
char data[]; char data[]; /**< Chunk body. */
} PACKED RDFFChunk; } PACKED RDFFChunk;
/** /**
Body of a URID chunk. Body of a URID chunk.
*/ */
typedef struct { typedef struct {
uint32_t id; uint32_t id; /**< Numeric ID of URI in this RDFF. */
char uri[]; char uri[]; /**< URI string. */
} PACKED RDFFURIChunk; } PACKED RDFFURIChunk;
/** /**
Body of a KVAL chunk. Body of a KVAL chunk.
*/ */
typedef struct { typedef struct {
uint32_t key; uint32_t key; /**< Predicate URI ID. */
uint32_t type; uint32_t type; /**< Type URI ID. */
uint32_t size; uint32_t size; /**< Size of object data. */
char value[]; char value[]; /**< Object data. */
} PACKED RDFFValueChunk; } PACKED RDFFValueChunk;
/** /**