/[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 1183 by persson, Sun May 13 10:34:29 2007 UTC revision 2155 by persson, Thu Jan 6 11:33:40 2011 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file access library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2007 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2011 by Christian Schoenebeck                      *
6   *                              <cuse@users.sourceforge.net>               *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   This library is free software; you can redistribute it and/or modify  *
# Line 52  Line 52 
52  # include <unistd.h>  # include <unistd.h>
53  #endif // POSIX  #endif // POSIX
54    
55    #ifdef _MSC_VER
56    // Visual C++ 2008 doesn't have stdint.h
57    typedef __int8 int8_t;
58    typedef __int16 int16_t;
59    typedef __int32 int32_t;
60    typedef __int64 int64_t;
61    typedef unsigned __int8 uint8_t;
62    typedef unsigned __int16 uint16_t;
63    typedef unsigned __int32 uint32_t;
64    typedef unsigned __int64 uint64_t;
65    #else
66  #include <stdint.h>  #include <stdint.h>
67    #endif
68    
69  #ifdef WIN32  #ifdef WIN32
 # include "../win32/libgig_private.h" // like config.h, automatically generated by Dev-C++  
70  # include <windows.h>  # include <windows.h>
71    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  
72  #endif // WIN32  #endif // WIN32
73    
74  #include <stdio.h>  #include <stdio.h>
# Line 71  Line 77 
77  # define CHUNK_ID_RIFF  0x52494646  # define CHUNK_ID_RIFF  0x52494646
78  # define CHUNK_ID_RIFX  0x52494658  # define CHUNK_ID_RIFX  0x52494658
79  # define CHUNK_ID_LIST  0x4C495354  # define CHUNK_ID_LIST  0x4C495354
80    
81    # define LIST_TYPE_INFO 0x494E464F
82    # define CHUNK_ID_ICMT  0x49434D54
83    # define CHUNK_ID_ICOP  0x49434F50
84    # define CHUNK_ID_ICRD  0x49435244
85    # define CHUNK_ID_IENG  0x49454E47
86    # define CHUNK_ID_INAM  0x494E414D
87    # define CHUNK_ID_IPRD  0x49505244
88    # define CHUNK_ID_ISFT  0x49534654
89    
90    # define CHUNK_ID_SMPL  0x736D706C
91    
92  #else  // little endian  #else  // little endian
93  # define CHUNK_ID_RIFF  0x46464952  # define CHUNK_ID_RIFF  0x46464952
94  # define CHUNK_ID_RIFX  0x58464952  # define CHUNK_ID_RIFX  0x58464952
95  # define CHUNK_ID_LIST  0x5453494C  # define CHUNK_ID_LIST  0x5453494C
96    
97    # define LIST_TYPE_INFO 0x4F464E49
98    # define CHUNK_ID_ICMT  0x544D4349
99    # define CHUNK_ID_ICOP  0x504F4349
100    # define CHUNK_ID_ICRD  0x44524349
101    # define CHUNK_ID_IENG  0x474E4549
102    # define CHUNK_ID_INAM  0x4D414E49
103    # define CHUNK_ID_IPRD  0x44525049
104    # define CHUNK_ID_ISFT  0x54465349
105    
106    # define CHUNK_ID_SMPL  0x6C706D73
107    
108  #endif // WORDS_BIGENDIAN  #endif // WORDS_BIGENDIAN
109    
110  #define CHUNK_HEADER_SIZE       8  #define CHUNK_HEADER_SIZE       8
# Line 82  Line 112 
112  #define RIFF_HEADER_SIZE        12  #define RIFF_HEADER_SIZE        12
113    
114    
115  /** RIFF specific classes and definitions */  /**
116     * @brief RIFF specific classes and definitions
117     *
118     * The Resource Interchange File Format (RIFF) is a generic tree-structured
119     * meta-format which stores data in so called "chunks". It can be compared
120     * to XML, but in contrast to XML, RIFF is entirely binary encoded, that is
121     * not ASCII based. RIFF is used as basis for many file formats like AVI,
122     * WAV, DLS and of course the Gigasampler file format. ;-)
123     *
124     * RIFF chunks can be seen as containers for data. There are two distinct
125     * types of chunks:
126     *
127     * - @e ordinary @e chunks are the leafs of the data tree which encapsulate
128     *   the actual data of the file (i.e. the sample data of a .wav file)
129     *
130     * - @e list @e chunks are the nodes of the data tree which hold an
131     *   arbitrary amount of subchunks (can be both, list chunks and/or ordinary
132     *   chunks)
133     */
134  namespace RIFF {  namespace RIFF {
135    
136      /* just symbol prototyping */      /* just symbol prototyping */
# Line 114  namespace RIFF { Line 162  namespace RIFF {
162          stream_end      = 3          stream_end      = 3
163      } stream_whence_t;      } stream_whence_t;
164    
165        /** Alignment of data bytes in memory (system dependant). */
166      typedef enum {      typedef enum {
167          endian_little = 0,          endian_little = 0,
168          endian_big    = 1,          endian_big    = 1,
169          endian_native = 2          endian_native = 2
170      } endian_t;      } endian_t;
171    
172      /** Provides convenient methods to access data of RIFF chunks in general. */      /** @brief Ordinary RIFF Chunk
173         *
174         * Provides convenient methods to access data of ordinary RIFF chunks
175         * in general.
176         */
177      class Chunk {      class Chunk {
178          public:          public:
179              Chunk(File* pFile, unsigned long StartPos, List* Parent);              Chunk(File* pFile, unsigned long StartPos, List* Parent);
180              String         GetChunkIDString();              String         GetChunkIDString();
181              uint32_t       GetChunkID() { return ChunkID; };            ///< Chunk ID in unsigned integer representation.              uint32_t       GetChunkID() { return ChunkID; }             ///< Chunk ID in unsigned integer representation.
182              List*          GetParent()  { return pParent; };            ///< Returns pointer to the chunk's parent list chunk.              List*          GetParent()  { return pParent; }             ///< Returns pointer to the chunk's parent list chunk.
183              unsigned long  GetSize()    { return CurrentChunkSize; };   ///< Chunk size in bytes (without header, thus the chunk data body)              unsigned long  GetSize()    { return CurrentChunkSize; }    ///< Chunk size in bytes (without header, thus the chunk data body)
184              unsigned long  GetNewSize() { return NewChunkSize;     };   ///< New chunk size if it was modified with Resize().              unsigned long  GetNewSize() { return NewChunkSize;     }    ///< New chunk size if it was modified with Resize().
185              unsigned long  GetPos()     { return ulPos; };              ///< Position within the chunk data body              unsigned long  GetPos()     { return ulPos; }               ///< Position within the chunk data body
186              unsigned long  GetFilePos() { return ulStartPos + ulPos; }; ///< Current, actual offset in file.              unsigned long  GetFilePos() { return ulStartPos + ulPos; }  ///< Current, actual offset in file.
187              unsigned long  SetPos(unsigned long Where, stream_whence_t Whence = stream_start);              unsigned long  SetPos(unsigned long Where, stream_whence_t Whence = stream_start);
188              unsigned long  RemainingBytes();              unsigned long  RemainingBytes();
189              stream_state_t GetState();              stream_state_t GetState();
# Line 211  namespace RIFF { Line 264  namespace RIFF {
264              friend class List;              friend class List;
265      };      };
266    
267      /** Provides convenient methods to access data of RIFF list chunks and their subchunks. */      /** @brief RIFF List Chunk
268         *
269         * Provides convenient methods to access data of RIFF list chunks and
270         * their subchunks.
271         */
272      class List : public Chunk {      class List : public Chunk {
273          public:          public:
274              List(File* pFile, unsigned long StartPos, List* Parent);              List(File* pFile, unsigned long StartPos, List* Parent);
# Line 250  namespace RIFF { Line 307  namespace RIFF {
307              void LoadSubChunksRecursively();              void LoadSubChunksRecursively();
308              virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);              virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
309              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.
310                void DeleteChunkList();
311      };      };
312    
313      /** Parses arbitrary RIFF files and provides together with it's base classes convenient methods to walk through the RIFF tree. */      /** @brief RIFF File
314         *
315         * Handles arbitrary RIFF files and provides together with its base
316         * classes convenient methods to walk through, read and modify the
317         * file's RIFF tree.
318         */
319      class File : public List {      class File : public List {
320          public:          public:
321              File(uint32_t FileType);              File(uint32_t FileType);
             File(uint32_t FileType, endian_t Endian);  
322              File(const String& path);              File(const String& path);
323              stream_mode_t GetMode();              stream_mode_t GetMode();
324              bool          SetMode(stream_mode_t NewMode);              bool          SetMode(stream_mode_t NewMode);
325                void SetByteOrder(endian_t Endian);
326              String GetFileName();              String GetFileName();
327              virtual void Save();              virtual void Save();
328              virtual void Save(const String& path);              virtual void Save(const String& path);
# Line 284  namespace RIFF { Line 347  namespace RIFF {
347              friend class List;              friend class List;
348          private:          private:
349              stream_mode_t  Mode;              stream_mode_t  Mode;
350              ChunkList      ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).              ChunkList ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).
351    
352              unsigned long GetFileSize();              unsigned long GetFileSize();
353              void ResizeFile(unsigned long ulNewSize);              void ResizeFile(unsigned long ulNewSize);
# Line 295  namespace RIFF { Line 358  namespace RIFF {
358              #else              #else
359              unsigned long __GetFileSize(FILE* hFile);              unsigned long __GetFileSize(FILE* hFile);
360              #endif              #endif
361                void Cleanup();
362      };      };
363    
364      /** Will be thrown whenever an error occurs while parsing a RIFF file. */      /**
365         * Will be thrown whenever an error occurs while handling a RIFF file.
366         */
367      class Exception {      class Exception {
368          public:          public:
369              String Message;              String Message;
370    
371              Exception(String Message) { Exception::Message = Message; };              Exception(String Message) { Exception::Message = Message; }
372              void PrintMessage();              void PrintMessage();
373              virtual ~Exception() {};              virtual ~Exception() {}
374      };      };
375    
376      String libraryName();      String libraryName();
Legend:
Removed from v.1183  
changed lines
  Added in v.2155
  ViewVC Help
Powered by ViewVC