/[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 1330 by persson, Sun Sep 9 10:36:23 2007 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>
# Line 45  Line 54 
54    
55  #include <stdint.h>  #include <stdint.h>
56    
57  //typedef unsigned char  uint8_t;  #ifdef WIN32
58  //typedef unsigned short uint16_t;  # include <windows.h>
59  //typedef unsigned int   uint32_t;    typedef unsigned int   uint;
60    #endif // WIN32
61    
62  #include <stdio.h>  #include <stdio.h>
63    
# Line 66  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 */
101      class Chunk;      class Chunk;
102      class List;      class List;
103        class File;
104    
105      typedef std::string String;      typedef std::string String;
106    
107        /** Whether file stream is open in read or in read/write mode. */
108        typedef enum {
109            stream_mode_read       = 0,
110            stream_mode_read_write = 1,
111            stream_mode_closed     = 2
112        } stream_mode_t;
113    
114      /** Current state of the file stream. */      /** Current state of the file stream. */
115      typedef enum {      typedef enum {
116          stream_ready       = 0,          stream_ready       = 0,
# Line 90  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              #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  
144              String         GetChunkIDString();              String         GetChunkIDString();
145              uint32_t       GetChunkID() { return ChunkID; };            ///< Chunk ID in unsigned integer representation.              uint32_t       GetChunkID() { return ChunkID; };            ///< Chunk ID in unsigned integer representation.
146              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.
147              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)
148                unsigned long  GetNewSize() { return NewChunkSize;     };   ///< New chunk size if it was modified with Resize().
149              unsigned long  GetPos()     { return ulPos; };              ///< Position within the chunk data body              unsigned long  GetPos()     { return ulPos; };              ///< Position within the chunk data body
150              unsigned long  GetFilePos() { return ulStartPos + ulPos; }; ///< Current, actual offset in file.              unsigned long  GetFilePos() { return ulStartPos + ulPos; }; ///< Current, actual offset in file.
151              unsigned long  SetPos(unsigned long Where, stream_whence_t Whence = stream_start);              unsigned long  SetPos(unsigned long Where, stream_whence_t Whence = stream_start);
# Line 120  namespace RIFF { Line 164  namespace RIFF {
164              uint16_t       ReadUint16();              uint16_t       ReadUint16();
165              int32_t        ReadInt32();              int32_t        ReadInt32();
166              uint32_t       ReadUint32();              uint32_t       ReadUint32();
167              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);
168              void           ReleaseChunkData();  ///< Free loaded chunk body data from memory (RAM).              unsigned long  WriteInt8(int8_t* pData,     unsigned long WordCount = 1);
169                unsigned long  WriteUint8(uint8_t* pData,   unsigned long WordCount = 1);
170                unsigned long  WriteInt16(int16_t* pData,   unsigned long WordCount = 1);
171                unsigned long  WriteUint16(uint16_t* pData, unsigned long WordCount = 1);
172                unsigned long  WriteInt32(int32_t* pData,   unsigned long WordCount = 1);
173                unsigned long  WriteUint32(uint32_t* pData, unsigned long WordCount = 1);
174                void*          LoadChunkData();
175                void           ReleaseChunkData();
176                void           Resize(int iNewSize);
177              virtual ~Chunk();              virtual ~Chunk();
178          protected:          protected:
179              uint32_t      ChunkID;              uint32_t      ChunkID;
180              uint32_t      ChunkSize;            /* in bytes */              uint32_t      CurrentChunkSize;             /* in bytes */
181                uint32_t      NewChunkSize;                 /* in bytes (if chunk was scheduled to be resized) */
182              List*         pParent;              List*         pParent;
183              #if POSIX              File*         pFile;
             int           hFile;  
             #else  
             FILE*         hFile;  
             #endif // POSIX  
184              unsigned long ulStartPos;           /* actual position in file where chunk (without header) starts */              unsigned long ulStartPos;           /* actual position in file where chunk (without header) starts */
185              unsigned long ulPos;                /* # of bytes from ulStartPos */              unsigned long ulPos;                /* # of bytes from ulStartPos */
             bool          bEndianNative;  
186              uint8_t*      pChunkData;              uint8_t*      pChunkData;
187                unsigned long ulChunkDataSize;
188    
189              Chunk();              Chunk(File* pFile);
190                Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize);
191              void          ReadHeader(unsigned long fPos);              void          ReadHeader(unsigned long fPos);
192                void          WriteHeader(unsigned long fPos);
193              unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);              unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);
194              inline void   swapBytes_16(void* Word) {              inline void   swapBytes_16(void* Word) {
195                  uint8_t byteCache = *((uint8_t*) Word);                  uint8_t byteCache = *((uint8_t*) Word);
# Line 171  namespace RIFF { Line 222  namespace RIFF {
222                  }                  }
223                  return result;                  return result;
224              }              }
225                virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
226                virtual void __resetPos(); ///< Sets Chunk's read/write position to zero.
227    
228                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              #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  
239              String       GetListTypeString();              String       GetListTypeString();
240              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
241              Chunk*       GetSubChunk(uint32_t ChunkID);              Chunk*       GetSubChunk(uint32_t ChunkID);
# Line 193  namespace RIFF { Line 248  namespace RIFF {
248              unsigned int CountSubChunks(uint32_t ChunkID);              unsigned int CountSubChunks(uint32_t ChunkID);
249              unsigned int CountSubLists();              unsigned int CountSubLists();
250              unsigned int CountSubLists(uint32_t ListType);              unsigned int CountSubLists(uint32_t ListType);
251                Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
252                List*        AddSubList(uint32_t uiListType);
253                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 204  namespace RIFF { Line 263  namespace RIFF {
263              ChunkList::iterator ChunksIterator;              ChunkList::iterator ChunksIterator;
264              ChunkList::iterator ListIterator;              ChunkList::iterator ListIterator;
265    
266              List();              List(File* pFile);
267                List(File* pFile, List* pParent, uint32_t uiListID);
268              void ReadHeader(unsigned long fPos);              void ReadHeader(unsigned long fPos);
269                void WriteHeader(unsigned long fPos);
270              void LoadSubChunks();              void LoadSubChunks();
271                void LoadSubChunksRecursively();
272                virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
273                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);
285              File(const String& path);              File(const String& path);
286                stream_mode_t GetMode();
287                bool          SetMode(stream_mode_t NewMode);
288                void SetByteOrder(endian_t Endian);
289                String GetFileName();
290                virtual void Save();
291                virtual void Save(const String& path);
292              virtual ~File();              virtual ~File();
293            protected:
294                #if POSIX
295                int    hFileRead;  ///< handle / descriptor for reading from file
296                int    hFileWrite; ///< handle / descriptor for writing to (some) file
297                #elif defined(WIN32)
298                HANDLE hFileRead;  ///< handle / descriptor for reading from file
299                HANDLE hFileWrite; ///< handle / descriptor for writing to (some) file
300                #else
301                FILE*  hFileRead;  ///< handle / descriptor for reading from file
302                FILE*  hFileWrite; ///< handle / descriptor for writing to (some) file
303                #endif // POSIX
304                String Filename;
305                bool   bEndianNative;
306    
307                void LogAsResized(Chunk* pResizedChunk);
308                void UnlogResized(Chunk* pResizedChunk);
309                friend class Chunk;
310                friend class List;
311          private:          private:
312                stream_mode_t  Mode;
313                ChunkList      ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).
314    
315              unsigned long GetFileSize();              unsigned long GetFileSize();
316                void ResizeFile(unsigned long ulNewSize);
317                #if POSIX
318                unsigned long __GetFileSize(int hFile);
319                #elif defined(WIN32)
320                unsigned long __GetFileSize(HANDLE hFile);
321                #else
322                unsigned long __GetFileSize(FILE* hFile);
323                #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;
# Line 228  namespace RIFF { Line 335  namespace RIFF {
335              virtual ~Exception() {};              virtual ~Exception() {};
336      };      };
337    
338        String libraryName();
339        String libraryVersion();
340    
341  } // namespace RIFF  } // namespace RIFF
342  #endif // __RIFF_H__  #endif // __RIFF_H__
Legend:
Removed from v.384  
changed lines
  Added in v.1330
  ViewVC Help
Powered by ViewVC