RIFF Namespace Reference

RIFF specific classes and definitions. More...


Classes

class  Chunk
 Ordinary RIFF Chunk. More...
class  List
 RIFF List Chunk. More...
class  File
 RIFF File. More...
class  Exception
 Will be thrown whenever an error occurs while handling a RIFF file. More...

Typedefs

typedef std::string String

Enumerations

enum  stream_mode_t { stream_mode_read = 0, stream_mode_read_write = 1, stream_mode_closed = 2 }
 Whether file stream is open in read or in read/write mode. More...
enum  stream_state_t { stream_ready = 0, stream_end_reached = 1, stream_closed = 2 }
 Current state of the file stream. More...
enum  stream_whence_t { stream_start = 0, stream_curpos = 1, stream_backward = 2, stream_end = 3 }
 File stream position dependent to these relations. More...
enum  endian_t { endian_little = 0, endian_big = 1, endian_native = 2 }
 Alignment of data bytes in memory (system dependant). More...

Functions

String libraryName ()
 Returns the name of this C++ library.
String libraryVersion ()
 Returns version of this C++ library.


Detailed Description

RIFF specific classes and definitions.

The Resource Interchange File Format (RIFF) is a generic tree-structured meta-format which stores data in so called "chunks". It can be compared to XML, but in contrast to XML, RIFF is entirely binary encoded, that is not ASCII based. RIFF is used as basis for many file formats like AVI, WAV, DLS and of course the Gigasampler file format. ;-)

RIFF chunks can be seen as containers for data. There are two distinct types of chunks:


Typedef Documentation

typedef std::string RIFF::String

Definition at line 139 of file RIFF.h.


Enumeration Type Documentation

enum RIFF::endian_t

Alignment of data bytes in memory (system dependant).

Enumerator:
endian_little 
endian_big 
endian_native 

Definition at line 166 of file RIFF.h.

enum RIFF::stream_mode_t

Whether file stream is open in read or in read/write mode.

Enumerator:
stream_mode_read 
stream_mode_read_write 
stream_mode_closed 

Definition at line 144 of file RIFF.h.

enum RIFF::stream_state_t

Current state of the file stream.

Enumerator:
stream_ready 
stream_end_reached 
stream_closed 

Definition at line 151 of file RIFF.h.

enum RIFF::stream_whence_t

File stream position dependent to these relations.

Enumerator:
stream_start 
stream_curpos 
stream_backward 
stream_end 

Definition at line 158 of file RIFF.h.


Function Documentation

String RIFF::libraryName (  ) 

Returns the name of this C++ library.

This is usually "libgig" of course. This call is equivalent to DLS::libraryName() and gig::libraryName().

Definition at line 1845 of file RIFF.cpp.

String RIFF::libraryVersion (  ) 

Returns version of this C++ library.

This call is equivalent to DLS::libraryVersion() and gig::libraryVersion().

Definition at line 1853 of file RIFF.cpp.


Generated on Sun May 1 03:22:47 2011 for libgig by  doxygen 1.5.2