/[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 384 by schoenebeck, Thu Feb 17 02:22:26 2005 UTC revision 1713 by persson, Thu Mar 6 20:42:22 2008 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-2007 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>
41    #include <set>
42  #include <map>  #include <map>
43  #include <iostream>  #include <iostream>
44    
# Line 45  Line 55 
55    
56  #include <stdint.h>  #include <stdint.h>
57    
58  //typedef unsigned char  uint8_t;  #ifdef WIN32
59  //typedef unsigned short uint16_t;  # include <windows.h>
60  //typedef unsigned int   uint32_t;    typedef unsigned int   uint;
61    #endif // WIN32
62    
63  #include <stdio.h>  #include <stdio.h>
64    
# Line 66  Line 77 
77  #define RIFF_HEADER_SIZE        12  #define RIFF_HEADER_SIZE        12
78    
79    
80  /** RIFF specific classes and definitions */  /**
81     * @brief RIFF specific classes and definitions
82     *
83     * The Resource Interchange File Format (RIFF) is a generic tree-structured
84     * meta-format which stores data in so called "chunks". It can be compared
85     * to XML, but in contrast to XML, RIFF is entirely binary encoded, that is
86     * not ASCII based. RIFF is used as basis for many file formats like AVI,
87     * WAV, DLS and of course the Gigasampler file format. ;-)
88     *
89     * RIFF chunks can be seen as containers for data. There are two distinct
90     * types of chunks:
91     *
92     * - @e ordinary @e chunks are the leafs of the data tree which encapsulate
93     *   the actual data of the file (i.e. the sample data of a .wav file)
94     *
95     * - @e list @e chunks are the nodes of the data tree which hold an
96     *   arbitrary amount of subchunks (can be both, list chunks and/or ordinary
97     *   chunks)
98     */
99  namespace RIFF {  namespace RIFF {
100    
101      /* just symbol prototyping */      /* just symbol prototyping */
102      class Chunk;      class Chunk;
103      class List;      class List;
104        class File;
105    
106      typedef std::string String;      typedef std::string String;
107    
108        /** Whether file stream is open in read or in read/write mode. */
109        typedef enum {
110            stream_mode_read       = 0,
111            stream_mode_read_write = 1,
112            stream_mode_closed     = 2
113        } stream_mode_t;
114    
115      /** Current state of the file stream. */      /** Current state of the file stream. */
116      typedef enum {      typedef enum {
117          stream_ready       = 0,          stream_ready       = 0,
# Line 90  namespace RIFF { Line 127  namespace RIFF {
127          stream_end      = 3          stream_end      = 3
128      } stream_whence_t;      } stream_whence_t;
129    
130      /** Provides convenient methods to access data of RIFF chunks in general. */      /** Alignment of data bytes in memory (system dependant). */
131        typedef enum {
132            endian_little = 0,
133            endian_big    = 1,
134            endian_native = 2
135        } endian_t;
136    
137        /** @brief Ordinary RIFF Chunk
138         *
139         * Provides convenient methods to access data of ordinary RIFF chunks
140         * in general.
141         */
142      class Chunk {      class Chunk {
143          public:          public:
144              #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  
145              String         GetChunkIDString();              String         GetChunkIDString();
146              uint32_t       GetChunkID() { return ChunkID; };            ///< Chunk ID in unsigned integer representation.              uint32_t       GetChunkID() { return ChunkID; }             ///< Chunk ID in unsigned integer representation.
147              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.
148              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)
149              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().
150              unsigned long  GetFilePos() { return ulStartPos + ulPos; }; ///< Current, actual offset in file.              unsigned long  GetPos()     { return ulPos; }               ///< Position within the chunk data body
151                unsigned long  GetFilePos() { return ulStartPos + ulPos; }  ///< Current, actual offset in file.
152              unsigned long  SetPos(unsigned long Where, stream_whence_t Whence = stream_start);              unsigned long  SetPos(unsigned long Where, stream_whence_t Whence = stream_start);
153              unsigned long  RemainingBytes();              unsigned long  RemainingBytes();
154              stream_state_t GetState();              stream_state_t GetState();
# Line 120  namespace RIFF { Line 165  namespace RIFF {
165              uint16_t       ReadUint16();              uint16_t       ReadUint16();
166              int32_t        ReadInt32();              int32_t        ReadInt32();
167              uint32_t       ReadUint32();              uint32_t       ReadUint32();
168              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);
169              void           ReleaseChunkData();  ///< Free loaded chunk body data from memory (RAM).              unsigned long  WriteInt8(int8_t* pData,     unsigned long WordCount = 1);
170                unsigned long  WriteUint8(uint8_t* pData,   unsigned long WordCount = 1);
171                unsigned long  WriteInt16(int16_t* pData,   unsigned long WordCount = 1);
172                unsigned long  WriteUint16(uint16_t* pData, unsigned long WordCount = 1);
173                unsigned long  WriteInt32(int32_t* pData,   unsigned long WordCount = 1);
174                unsigned long  WriteUint32(uint32_t* pData, unsigned long WordCount = 1);
175                void*          LoadChunkData();
176                void           ReleaseChunkData();
177                void           Resize(int iNewSize);
178              virtual ~Chunk();              virtual ~Chunk();
179          protected:          protected:
180              uint32_t      ChunkID;              uint32_t      ChunkID;
181              uint32_t      ChunkSize;            /* in bytes */              uint32_t      CurrentChunkSize;             /* in bytes */
182                uint32_t      NewChunkSize;                 /* in bytes (if chunk was scheduled to be resized) */
183              List*         pParent;              List*         pParent;
184              #if POSIX              File*         pFile;
             int           hFile;  
             #else  
             FILE*         hFile;  
             #endif // POSIX  
185              unsigned long ulStartPos;           /* actual position in file where chunk (without header) starts */              unsigned long ulStartPos;           /* actual position in file where chunk (without header) starts */
186              unsigned long ulPos;                /* # of bytes from ulStartPos */              unsigned long ulPos;                /* # of bytes from ulStartPos */
             bool          bEndianNative;  
187              uint8_t*      pChunkData;              uint8_t*      pChunkData;
188                unsigned long ulChunkDataSize;
189    
190              Chunk();              Chunk(File* pFile);
191                Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize);
192              void          ReadHeader(unsigned long fPos);              void          ReadHeader(unsigned long fPos);
193                void          WriteHeader(unsigned long fPos);
194              unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);              unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);
195              inline void   swapBytes_16(void* Word) {              inline void   swapBytes_16(void* Word) {
196                  uint8_t byteCache = *((uint8_t*) Word);                  uint8_t byteCache = *((uint8_t*) Word);
# Line 171  namespace RIFF { Line 223  namespace RIFF {
223                  }                  }
224                  return result;                  return result;
225              }              }
226                virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
227                virtual void __resetPos(); ///< Sets Chunk's read/write position to zero.
228    
229                friend class List;
230      };      };
231    
232      /** Provides convenient methods to access data of RIFF list chunks and their subchunks. */      /** @brief RIFF List Chunk
233         *
234         * Provides convenient methods to access data of RIFF list chunks and
235         * their subchunks.
236         */
237      class List : public Chunk {      class List : public Chunk {
238          public:          public:
239              #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  
240              String       GetListTypeString();              String       GetListTypeString();
241              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
242              Chunk*       GetSubChunk(uint32_t ChunkID);              Chunk*       GetSubChunk(uint32_t ChunkID);
# Line 193  namespace RIFF { Line 249  namespace RIFF {
249              unsigned int CountSubChunks(uint32_t ChunkID);              unsigned int CountSubChunks(uint32_t ChunkID);
250              unsigned int CountSubLists();              unsigned int CountSubLists();
251              unsigned int CountSubLists(uint32_t ListType);              unsigned int CountSubLists(uint32_t ListType);
252                Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
253                List*        AddSubList(uint32_t uiListType);
254                void         DeleteSubChunk(Chunk* pSubChunk);
255                void         MoveSubChunk(Chunk* pSrc, Chunk* pDst);
256              virtual ~List();              virtual ~List();
257          protected:          protected:
258              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;
# Line 204  namespace RIFF { Line 264  namespace RIFF {
264              ChunkList::iterator ChunksIterator;              ChunkList::iterator ChunksIterator;
265              ChunkList::iterator ListIterator;              ChunkList::iterator ListIterator;
266    
267              List();              List(File* pFile);
268                List(File* pFile, List* pParent, uint32_t uiListID);
269              void ReadHeader(unsigned long fPos);              void ReadHeader(unsigned long fPos);
270                void WriteHeader(unsigned long fPos);
271              void LoadSubChunks();              void LoadSubChunks();
272                void LoadSubChunksRecursively();
273                virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
274                virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.
275      };      };
276    
277      /** Parses arbitrary RIFF files and provides together with it's base classes convenient methods to walk through the RIFF tree. */      /** @brief RIFF File
278         *
279         * Handles arbitrary RIFF files and provides together with its base
280         * classes convenient methods to walk through, read and modify the
281         * file's RIFF tree.
282         */
283      class File : public List {      class File : public List {
284          public:          public:
285                File(uint32_t FileType);
286              File(const String& path);              File(const String& path);
287                stream_mode_t GetMode();
288                bool          SetMode(stream_mode_t NewMode);
289                void SetByteOrder(endian_t Endian);
290                String GetFileName();
291                virtual void Save();
292                virtual void Save(const String& path);
293              virtual ~File();              virtual ~File();
294            protected:
295                #if POSIX
296                int    hFileRead;  ///< handle / descriptor for reading from file
297                int    hFileWrite; ///< handle / descriptor for writing to (some) file
298                #elif defined(WIN32)
299                HANDLE hFileRead;  ///< handle / descriptor for reading from file
300                HANDLE hFileWrite; ///< handle / descriptor for writing to (some) file
301                #else
302                FILE*  hFileRead;  ///< handle / descriptor for reading from file
303                FILE*  hFileWrite; ///< handle / descriptor for writing to (some) file
304                #endif // POSIX
305                String Filename;
306                bool   bEndianNative;
307    
308                void LogAsResized(Chunk* pResizedChunk);
309                void UnlogResized(Chunk* pResizedChunk);
310                friend class Chunk;
311                friend class List;
312          private:          private:
313                stream_mode_t  Mode;
314                std::set<Chunk*> ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).
315    
316              unsigned long GetFileSize();              unsigned long GetFileSize();
317                void ResizeFile(unsigned long ulNewSize);
318                #if POSIX
319                unsigned long __GetFileSize(int hFile);
320                #elif defined(WIN32)
321                unsigned long __GetFileSize(HANDLE hFile);
322                #else
323                unsigned long __GetFileSize(FILE* hFile);
324                #endif
325      };      };
326    
327      /** Will be thrown whenever an error occurs while parsing a RIFF file. */      /**
328         * Will be thrown whenever an error occurs while handling a RIFF file.
329         */
330      class Exception {      class Exception {
331          public:          public:
332              String Message;              String Message;
333    
334              Exception(String Message) { Exception::Message = Message; };              Exception(String Message) { Exception::Message = Message; }
335              void PrintMessage();              void PrintMessage();
336              virtual ~Exception() {};              virtual ~Exception() {}
337      };      };
338    
339        String libraryName();
340        String libraryVersion();
341    
342  } // namespace RIFF  } // namespace RIFF
343  #endif // __RIFF_H__  #endif // __RIFF_H__
Legend:
Removed from v.384  
changed lines
  Added in v.1713
  ViewVC Help
Powered by ViewVC