/[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 518 by schoenebeck, Sun May 8 16:19:34 2005 UTC revision 1953 by schoenebeck, Thu Jul 30 08:16:02 2009 UTC
# Line 1  Line 1 
1  /***************************************************************************  /***************************************************************************
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file loader library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2005 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2009 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 24  Line 24 
24  #ifndef __RIFF_H__  #ifndef __RIFF_H__
25  #define __RIFF_H__  #define __RIFF_H__
26    
27  #define POSIX 1  #ifdef WIN32
28  #define DEBUG 0  # define POSIX 0
29    #endif
30    
31    #ifndef POSIX
32    # define POSIX 1
33    #endif
34    
35    #ifndef DEBUG
36    # define DEBUG 0
37    #endif
38    
39  #include <string>  #include <string>
40  #include <list>  #include <list>
# Line 43  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  //typedef unsigned char  uint8_t;  #ifdef WIN32
70  //typedef unsigned short uint16_t;  # include <windows.h>
71  //typedef unsigned int   uint32_t;    typedef unsigned int   uint;
72    #endif // WIN32
73    
74  #include <stdio.h>  #include <stdio.h>
75    
# Line 66  Line 88 
88  #define RIFF_HEADER_SIZE        12  #define RIFF_HEADER_SIZE        12
89    
90    
91  /** RIFF specific classes and definitions */  /**
92     * @brief RIFF specific classes and definitions
93     *
94     * The Resource Interchange File Format (RIFF) is a generic tree-structured
95     * meta-format which stores data in so called "chunks". It can be compared
96     * to XML, but in contrast to XML, RIFF is entirely binary encoded, that is
97     * not ASCII based. RIFF is used as basis for many file formats like AVI,
98     * WAV, DLS and of course the Gigasampler file format. ;-)
99     *
100     * RIFF chunks can be seen as containers for data. There are two distinct
101     * types of chunks:
102     *
103     * - @e ordinary @e chunks are the leafs of the data tree which encapsulate
104     *   the actual data of the file (i.e. the sample data of a .wav file)
105     *
106     * - @e list @e chunks are the nodes of the data tree which hold an
107     *   arbitrary amount of subchunks (can be both, list chunks and/or ordinary
108     *   chunks)
109     */
110  namespace RIFF {  namespace RIFF {
111    
112      /* just symbol prototyping */      /* just symbol prototyping */
113      class Chunk;      class Chunk;
114      class List;      class List;
115        class File;
116    
117      typedef std::string String;      typedef std::string String;
118    
119        /** Whether file stream is open in read or in read/write mode. */
120        typedef enum {
121            stream_mode_read       = 0,
122            stream_mode_read_write = 1,
123            stream_mode_closed     = 2
124        } stream_mode_t;
125    
126      /** Current state of the file stream. */      /** Current state of the file stream. */
127      typedef enum {      typedef enum {
128          stream_ready       = 0,          stream_ready       = 0,
# Line 90  namespace RIFF { Line 138  namespace RIFF {
138          stream_end      = 3          stream_end      = 3
139      } stream_whence_t;      } stream_whence_t;
140    
141      /** Provides convenient methods to access data of RIFF chunks in general. */      /** Alignment of data bytes in memory (system dependant). */
142        typedef enum {
143            endian_little = 0,
144            endian_big    = 1,
145            endian_native = 2
146        } endian_t;
147    
148        /** @brief Ordinary RIFF Chunk
149         *
150         * Provides convenient methods to access data of ordinary RIFF chunks
151         * in general.
152         */
153      class Chunk {      class Chunk {
154          public:          public:
155              #if POSIX              Chunk(File* pFile, unsigned long StartPos, List* Parent);
             Chunk(int hFile, unsigned long StartPos, bool EndianNative, List* Parent);  
             #else  
             Chunk(FILE* hFile, unsigned long StartPos, bool EndianNative, List* Parent);  
             #endif // POSIX  
156              String         GetChunkIDString();              String         GetChunkIDString();
157              uint32_t       GetChunkID() { return ChunkID; };            ///< Chunk ID in unsigned integer representation.              uint32_t       GetChunkID() { return ChunkID; }             ///< Chunk ID in unsigned integer representation.
158              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.
159              unsigned long  GetSize()    { return ChunkSize; };          ///< 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)
160              unsigned long  GetPos()     { return ulPos; };              ///< Position within the chunk data body              unsigned long  GetNewSize() { return NewChunkSize;     }    ///< New chunk size if it was modified with Resize().
161              unsigned long  GetFilePos() { return ulStartPos + ulPos; }; ///< Current, actual offset in file.              unsigned long  GetPos()     { return ulPos; }               ///< Position within the chunk data body
162                unsigned long  GetFilePos() { return ulStartPos + ulPos; }  ///< Current, actual offset in file.
163              unsigned long  SetPos(unsigned long Where, stream_whence_t Whence = stream_start);              unsigned long  SetPos(unsigned long Where, stream_whence_t Whence = stream_start);
164              unsigned long  RemainingBytes();              unsigned long  RemainingBytes();
165              stream_state_t GetState();              stream_state_t GetState();
# Line 120  namespace RIFF { Line 176  namespace RIFF {
176              uint16_t       ReadUint16();              uint16_t       ReadUint16();
177              int32_t        ReadInt32();              int32_t        ReadInt32();
178              uint32_t       ReadUint32();              uint32_t       ReadUint32();
179              void*          LoadChunkData();     ///< Load the whole chunk body in memory (on success returns a pointer to the data in RAM, else NULL).              unsigned long  Write(void* pData, unsigned long WordCount, unsigned long WordSize);
180              void           ReleaseChunkData();  ///< Free loaded chunk body data from memory (RAM).              unsigned long  WriteInt8(int8_t* pData,     unsigned long WordCount = 1);
181                unsigned long  WriteUint8(uint8_t* pData,   unsigned long WordCount = 1);
182                unsigned long  WriteInt16(int16_t* pData,   unsigned long WordCount = 1);
183                unsigned long  WriteUint16(uint16_t* pData, unsigned long WordCount = 1);
184                unsigned long  WriteInt32(int32_t* pData,   unsigned long WordCount = 1);
185                unsigned long  WriteUint32(uint32_t* pData, unsigned long WordCount = 1);
186                void*          LoadChunkData();
187                void           ReleaseChunkData();
188                void           Resize(int iNewSize);
189              virtual ~Chunk();              virtual ~Chunk();
190          protected:          protected:
191              uint32_t      ChunkID;              uint32_t      ChunkID;
192              uint32_t      ChunkSize;            /* in bytes */              uint32_t      CurrentChunkSize;             /* in bytes */
193                uint32_t      NewChunkSize;                 /* in bytes (if chunk was scheduled to be resized) */
194              List*         pParent;              List*         pParent;
195              #if POSIX              File*         pFile;
             int           hFile;  
             #else  
             FILE*         hFile;  
             #endif // POSIX  
196              unsigned long ulStartPos;           /* actual position in file where chunk (without header) starts */              unsigned long ulStartPos;           /* actual position in file where chunk (without header) starts */
197              unsigned long ulPos;                /* # of bytes from ulStartPos */              unsigned long ulPos;                /* # of bytes from ulStartPos */
             bool          bEndianNative;  
198              uint8_t*      pChunkData;              uint8_t*      pChunkData;
199                unsigned long ulChunkDataSize;
200    
201              Chunk();              Chunk(File* pFile);
202                Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize);
203              void          ReadHeader(unsigned long fPos);              void          ReadHeader(unsigned long fPos);
204                void          WriteHeader(unsigned long fPos);
205              unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);              unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);
206              inline void   swapBytes_16(void* Word) {              inline void   swapBytes_16(void* Word) {
207                  uint8_t byteCache = *((uint8_t*) Word);                  uint8_t byteCache = *((uint8_t*) Word);
# Line 171  namespace RIFF { Line 234  namespace RIFF {
234                  }                  }
235                  return result;                  return result;
236              }              }
237                virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
238                virtual void __resetPos(); ///< Sets Chunk's read/write position to zero.
239    
240                friend class List;
241      };      };
242    
243      /** Provides convenient methods to access data of RIFF list chunks and their subchunks. */      /** @brief RIFF List Chunk
244         *
245         * Provides convenient methods to access data of RIFF list chunks and
246         * their subchunks.
247         */
248      class List : public Chunk {      class List : public Chunk {
249          public:          public:
250              #if POSIX              List(File* pFile, unsigned long StartPos, List* Parent);
             List(int hFile, unsigned long StartPos, bool EndianNative, List* Parent);  
             #else  
             List(FILE* hFile, unsigned long StartPos, bool EndianNative, List* Parent);  
             #endif // POSIX  
251              String       GetListTypeString();              String       GetListTypeString();
252              uint32_t     GetListType() { return ListType; }   ///< Returns unsigned integer representation of the list's ID              uint32_t     GetListType() { return ListType; }   ///< Returns unsigned integer representation of the list's ID
253              Chunk*       GetSubChunk(uint32_t ChunkID);              Chunk*       GetSubChunk(uint32_t ChunkID);
# Line 193  namespace RIFF { Line 260  namespace RIFF {
260              unsigned int CountSubChunks(uint32_t ChunkID);              unsigned int CountSubChunks(uint32_t ChunkID);
261              unsigned int CountSubLists();              unsigned int CountSubLists();
262              unsigned int CountSubLists(uint32_t ListType);              unsigned int CountSubLists(uint32_t ListType);
263                Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
264                List*        AddSubList(uint32_t uiListType);
265                void         DeleteSubChunk(Chunk* pSubChunk);
266                void         MoveSubChunk(Chunk* pSrc, Chunk* pDst);
267              virtual ~List();              virtual ~List();
268          protected:          protected:
269              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;
# Line 204  namespace RIFF { Line 275  namespace RIFF {
275              ChunkList::iterator ChunksIterator;              ChunkList::iterator ChunksIterator;
276              ChunkList::iterator ListIterator;              ChunkList::iterator ListIterator;
277    
278              List();              List(File* pFile);
279                List(File* pFile, List* pParent, uint32_t uiListID);
280              void ReadHeader(unsigned long fPos);              void ReadHeader(unsigned long fPos);
281                void WriteHeader(unsigned long fPos);
282              void LoadSubChunks();              void LoadSubChunks();
283                void LoadSubChunksRecursively();
284                virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
285                virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.
286                void DeleteChunkList();
287      };      };
288    
289      /** Parses arbitrary RIFF files and provides together with it's base classes convenient methods to walk through the RIFF tree. */      /** @brief RIFF File
290         *
291         * Handles arbitrary RIFF files and provides together with its base
292         * classes convenient methods to walk through, read and modify the
293         * file's RIFF tree.
294         */
295      class File : public List {      class File : public List {
296          public:          public:
297                File(uint32_t FileType);
298              File(const String& path);              File(const String& path);
299                stream_mode_t GetMode();
300                bool          SetMode(stream_mode_t NewMode);
301                void SetByteOrder(endian_t Endian);
302                String GetFileName();
303                virtual void Save();
304                virtual void Save(const String& path);
305              virtual ~File();              virtual ~File();
306            protected:
307                #if POSIX
308                int    hFileRead;  ///< handle / descriptor for reading from file
309                int    hFileWrite; ///< handle / descriptor for writing to (some) file
310                #elif defined(WIN32)
311                HANDLE hFileRead;  ///< handle / descriptor for reading from file
312                HANDLE hFileWrite; ///< handle / descriptor for writing to (some) file
313                #else
314                FILE*  hFileRead;  ///< handle / descriptor for reading from file
315                FILE*  hFileWrite; ///< handle / descriptor for writing to (some) file
316                #endif // POSIX
317                String Filename;
318                bool   bEndianNative;
319    
320                void LogAsResized(Chunk* pResizedChunk);
321                void UnlogResized(Chunk* pResizedChunk);
322                friend class Chunk;
323                friend class List;
324          private:          private:
325                stream_mode_t  Mode;
326                ChunkList ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).
327    
328              unsigned long GetFileSize();              unsigned long GetFileSize();
329                void ResizeFile(unsigned long ulNewSize);
330                #if POSIX
331                unsigned long __GetFileSize(int hFile);
332                #elif defined(WIN32)
333                unsigned long __GetFileSize(HANDLE hFile);
334                #else
335                unsigned long __GetFileSize(FILE* hFile);
336                #endif
337      };      };
338    
339      /** Will be thrown whenever an error occurs while parsing a RIFF file. */      /**
340         * Will be thrown whenever an error occurs while handling a RIFF file.
341         */
342      class Exception {      class Exception {
343          public:          public:
344              String Message;              String Message;
345    
346              Exception(String Message) { Exception::Message = Message; };              Exception(String Message) { Exception::Message = Message; }
347              void PrintMessage();              void PrintMessage();
348              virtual ~Exception() {};              virtual ~Exception() {}
349      };      };
350    
351      String libraryName();      String libraryName();
Legend:
Removed from v.518  
changed lines
  Added in v.1953
  ViewVC Help
Powered by ViewVC