/[svn]/libgig/trunk/src/RIFF.h
ViewVC logotype

Diff of /libgig/trunk/src/RIFF.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1095 by schoenebeck, Mon Mar 12 18:16:55 2007 UTC revision 1193 by schoenebeck, Thu May 17 17:08:29 2007 UTC
# Line 82  Line 82 
82  #define RIFF_HEADER_SIZE        12  #define RIFF_HEADER_SIZE        12
83    
84    
85  /** RIFF specific classes and definitions */  /**
86     * @brief RIFF specific classes and definitions
87     *
88     * The Resource Interchange File Format (RIFF) is a generic tree-structured
89     * meta-format which stores data in so called "chunks". It can be compared
90     * to XML, but in contrast to XML, RIFF is entirely binary encoded, that is
91     * not ASCII based. RIFF is used as basis for many file formats like AVI,
92     * WAV, DLS and of course the Gigasampler file format. ;-)
93     *
94     * RIFF chunks can be seen as containers for data. There are two distinct
95     * types of chunks:
96     *
97     * - @e ordinary @e chunks are the leafs of the data tree which encapsulate
98     *   the actual data of the file (i.e. the sample data of a .wav file)
99     *
100     * - @e list @e chunks are the nodes of the data tree which hold an
101     *   arbitrary amount of subchunks (can be both, list chunks and/or ordinary
102     *   chunks)
103     */
104  namespace RIFF {  namespace RIFF {
105    
106      /* just symbol prototyping */      /* just symbol prototyping */
# Line 114  namespace RIFF { Line 132  namespace RIFF {
132          stream_end      = 3          stream_end      = 3
133      } stream_whence_t;      } stream_whence_t;
134    
135      /** Provides convenient methods to access data of RIFF chunks in general. */      /** Alignment of data bytes in memory (system dependant). */
136        typedef enum {
137            endian_little = 0,
138            endian_big    = 1,
139            endian_native = 2
140        } endian_t;
141    
142        /** @brief Ordinary RIFF Chunk
143         *
144         * Provides convenient methods to access data of ordinary RIFF chunks
145         * in general.
146         */
147      class Chunk {      class Chunk {
148          public:          public:
149              Chunk(File* pFile, unsigned long StartPos, List* Parent);              Chunk(File* pFile, unsigned long StartPos, List* Parent);
# Line 205  namespace RIFF { Line 234  namespace RIFF {
234              friend class List;              friend class List;
235      };      };
236    
237      /** Provides convenient methods to access data of RIFF list chunks and their subchunks. */      /** @brief RIFF List Chunk
238         *
239         * Provides convenient methods to access data of RIFF list chunks and
240         * their subchunks.
241         */
242      class List : public Chunk {      class List : public Chunk {
243          public:          public:
244              List(File* pFile, unsigned long StartPos, List* Parent);              List(File* pFile, unsigned long StartPos, List* Parent);
# Line 224  namespace RIFF { Line 257  namespace RIFF {
257              Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);              Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
258              List*        AddSubList(uint32_t uiListType);              List*        AddSubList(uint32_t uiListType);
259              void         DeleteSubChunk(Chunk* pSubChunk);              void         DeleteSubChunk(Chunk* pSubChunk);
260                void         MoveSubChunk(Chunk* pSrc, Chunk* pDst);
261              virtual ~List();              virtual ~List();
262          protected:          protected:
263              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;
# Line 245  namespace RIFF { Line 279  namespace RIFF {
279              virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.              virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.
280      };      };
281    
282      /** Parses arbitrary RIFF files and provides together with it's base classes convenient methods to walk through the RIFF tree. */      /** @brief RIFF File
283         *
284         * Handles arbitrary RIFF files and provides together with its base
285         * classes convenient methods to walk through, read and modify the
286         * file's RIFF tree.
287         */
288      class File : public List {      class File : public List {
289          public:          public:
290              File(uint32_t FileType);              File(uint32_t FileType);
291              File(const String& path);              File(const String& path);
292              stream_mode_t GetMode();              stream_mode_t GetMode();
293              bool          SetMode(stream_mode_t NewMode);              bool          SetMode(stream_mode_t NewMode);
294                void SetByteOrder(endian_t Endian);
295              String GetFileName();              String GetFileName();
296              virtual void Save();              virtual void Save();
297              virtual void Save(const String& path);              virtual void Save(const String& path);
# Line 289  namespace RIFF { Line 329  namespace RIFF {
329              #endif              #endif
330      };      };
331    
332      /** Will be thrown whenever an error occurs while parsing a RIFF file. */      /**
333         * Will be thrown whenever an error occurs while handling a RIFF file.
334         */
335      class Exception {      class Exception {
336          public:          public:
337              String Message;              String Message;
Legend:
Removed from v.1095  
changed lines
  Added in v.1193
  ViewVC Help
Powered by ViewVC