/[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 1050 by schoenebeck, Fri Mar 2 01:04:45 2007 UTC revision 1330 by persson, Sun Sep 9 10:36:23 2007 UTC
# Line 55  Line 55 
55  #include <stdint.h>  #include <stdint.h>
56    
57  #ifdef WIN32  #ifdef WIN32
 # include "../win32/libgig_private.h" // like config.h, automatically generated by Dev-C++  
58  # include <windows.h>  # include <windows.h>
59    typedef unsigned int   uint;    typedef unsigned int   uint;
   typedef unsigned char  uint8_t;  
   typedef unsigned short uint16_t;  
   typedef unsigned int   uint32_t;  
 # define PACKAGE "libgig"  
 # define VERSION VER_STRING // VER_STRING defined in libgig_private.h  
60  #endif // WIN32  #endif // WIN32
61    
62  #include <stdio.h>  #include <stdio.h>
# Line 82  Line 76 
76  #define RIFF_HEADER_SIZE        12  #define RIFF_HEADER_SIZE        12
77    
78    
79  /** RIFF specific classes and definitions */  /**
80     * @brief RIFF specific classes and definitions
81     *
82     * The Resource Interchange File Format (RIFF) is a generic tree-structured
83     * meta-format which stores data in so called "chunks". It can be compared
84     * to XML, but in contrast to XML, RIFF is entirely binary encoded, that is
85     * not ASCII based. RIFF is used as basis for many file formats like AVI,
86     * WAV, DLS and of course the Gigasampler file format. ;-)
87     *
88     * RIFF chunks can be seen as containers for data. There are two distinct
89     * types of chunks:
90     *
91     * - @e ordinary @e chunks are the leafs of the data tree which encapsulate
92     *   the actual data of the file (i.e. the sample data of a .wav file)
93     *
94     * - @e list @e chunks are the nodes of the data tree which hold an
95     *   arbitrary amount of subchunks (can be both, list chunks and/or ordinary
96     *   chunks)
97     */
98  namespace RIFF {  namespace RIFF {
99    
100      /* just symbol prototyping */      /* just symbol prototyping */
# Line 114  namespace RIFF { Line 126  namespace RIFF {
126          stream_end      = 3          stream_end      = 3
127      } stream_whence_t;      } stream_whence_t;
128    
129      /** Provides convenient methods to access data of RIFF chunks in general. */      /** Alignment of data bytes in memory (system dependant). */
130        typedef enum {
131            endian_little = 0,
132            endian_big    = 1,
133            endian_native = 2
134        } endian_t;
135    
136        /** @brief Ordinary RIFF Chunk
137         *
138         * Provides convenient methods to access data of ordinary RIFF chunks
139         * in general.
140         */
141      class Chunk {      class Chunk {
142          public:          public:
143              Chunk(File* pFile, unsigned long StartPos, List* Parent);              Chunk(File* pFile, unsigned long StartPos, List* Parent);
# Line 205  namespace RIFF { Line 228  namespace RIFF {
228              friend class List;              friend class List;
229      };      };
230    
231      /** Provides convenient methods to access data of RIFF list chunks and their subchunks. */      /** @brief RIFF List Chunk
232         *
233         * Provides convenient methods to access data of RIFF list chunks and
234         * their subchunks.
235         */
236      class List : public Chunk {      class List : public Chunk {
237          public:          public:
238              List(File* pFile, unsigned long StartPos, List* Parent);              List(File* pFile, unsigned long StartPos, List* Parent);
# Line 224  namespace RIFF { Line 251  namespace RIFF {
251              Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);              Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
252              List*        AddSubList(uint32_t uiListType);              List*        AddSubList(uint32_t uiListType);
253              void         DeleteSubChunk(Chunk* pSubChunk);              void         DeleteSubChunk(Chunk* pSubChunk);
254                void         MoveSubChunk(Chunk* pSrc, Chunk* pDst);
255              virtual ~List();              virtual ~List();
256          protected:          protected:
257              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;
# Line 245  namespace RIFF { Line 273  namespace RIFF {
273              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.
274      };      };
275    
276      /** Parses arbitrary RIFF files and provides together with it's base classes convenient methods to walk through the RIFF tree. */      /** @brief RIFF File
277         *
278         * Handles arbitrary RIFF files and provides together with its base
279         * classes convenient methods to walk through, read and modify the
280         * file's RIFF tree.
281         */
282      class File : public List {      class File : public List {
283          public:          public:
284              File(uint32_t FileType);              File(uint32_t FileType);
285              File(const String& path);              File(const String& path);
286              stream_mode_t GetMode();              stream_mode_t GetMode();
287              bool          SetMode(stream_mode_t NewMode);              bool          SetMode(stream_mode_t NewMode);
288                void SetByteOrder(endian_t Endian);
289              String GetFileName();              String GetFileName();
290              virtual void Save();              virtual void Save();
291              virtual void Save(const String& path);              virtual void Save(const String& path);
# Line 271  namespace RIFF { Line 305  namespace RIFF {
305              bool   bEndianNative;              bool   bEndianNative;
306    
307              void LogAsResized(Chunk* pResizedChunk);              void LogAsResized(Chunk* pResizedChunk);
308                void UnlogResized(Chunk* pResizedChunk);
309              friend class Chunk;              friend class Chunk;
310              friend class List;              friend class List;
311          private:          private:
# Line 288  namespace RIFF { Line 323  namespace RIFF {
323              #endif              #endif
324      };      };
325    
326      /** Will be thrown whenever an error occurs while parsing a RIFF file. */      /**
327         * Will be thrown whenever an error occurs while handling a RIFF file.
328         */
329      class Exception {      class Exception {
330          public:          public:
331              String Message;              String Message;
Legend:
Removed from v.1050  
changed lines
  Added in v.1330
  ViewVC Help
Powered by ViewVC