/[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 11 by schoenebeck, Sun Nov 16 17:47:00 2003 UTC revision 2703 by schoenebeck, Tue Jan 13 15:28:37 2015 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 by Christian Schoenebeck                           *   *   Copyright (C) 2003-2015 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  *
9   *   it under the terms of the GNU General Public License as published by  *   *   it under the terms of the GNU General Public License as published by  *
# 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 <map>  #include <map>
42    #include <set>
43  #include <iostream>  #include <iostream>
44    
45  #ifdef HAVE_CONFIG_H  #ifdef HAVE_CONFIG_H
# Line 43  Line 53 
53  # include <unistd.h>  # include <unistd.h>
54  #endif // POSIX  #endif // POSIX
55    
56    #ifdef _MSC_VER
57    // Visual C++ 2008 doesn't have stdint.h
58    typedef __int8 int8_t;
59    typedef __int16 int16_t;
60    typedef __int32 int32_t;
61    typedef __int64 int64_t;
62    typedef unsigned __int8 uint8_t;
63    typedef unsigned __int16 uint16_t;
64    typedef unsigned __int32 uint32_t;
65    typedef unsigned __int64 uint64_t;
66    #else
67  #include <stdint.h>  #include <stdint.h>
68    #endif
69    
70  //typedef unsigned char  uint8_t;  #ifdef WIN32
71  //typedef unsigned short uint16_t;  # include <windows.h>
72  //typedef unsigned int   uint32_t;    typedef unsigned int   uint;
73    #endif // WIN32
74    
75  #include <stdio.h>  #include <stdio.h>
76    
# Line 55  Line 78 
78  # define CHUNK_ID_RIFF  0x52494646  # define CHUNK_ID_RIFF  0x52494646
79  # define CHUNK_ID_RIFX  0x52494658  # define CHUNK_ID_RIFX  0x52494658
80  # define CHUNK_ID_LIST  0x4C495354  # define CHUNK_ID_LIST  0x4C495354
81    
82    # define LIST_TYPE_INFO 0x494E464F
83    # define CHUNK_ID_ICMT  0x49434D54
84    # define CHUNK_ID_ICOP  0x49434F50
85    # define CHUNK_ID_ICRD  0x49435244
86    # define CHUNK_ID_IENG  0x49454E47
87    # define CHUNK_ID_INAM  0x494E414D
88    # define CHUNK_ID_IPRD  0x49505244
89    # define CHUNK_ID_ISFT  0x49534654
90    
91    # define CHUNK_ID_SMPL  0x736D706C
92    
93  #else  // little endian  #else  // little endian
94  # define CHUNK_ID_RIFF  0x46464952  # define CHUNK_ID_RIFF  0x46464952
95  # define CHUNK_ID_RIFX  0x58464952  # define CHUNK_ID_RIFX  0x58464952
96  # define CHUNK_ID_LIST  0x5453494C  # define CHUNK_ID_LIST  0x5453494C
97    
98    # define LIST_TYPE_INFO 0x4F464E49
99    # define CHUNK_ID_ICMT  0x544D4349
100    # define CHUNK_ID_ICOP  0x504F4349
101    # define CHUNK_ID_ICRD  0x44524349
102    # define CHUNK_ID_IENG  0x474E4549
103    # define CHUNK_ID_INAM  0x4D414E49
104    # define CHUNK_ID_IPRD  0x44525049
105    # define CHUNK_ID_ISFT  0x54465349
106    
107    # define CHUNK_ID_SMPL  0x6C706D73
108    
109  #endif // WORDS_BIGENDIAN  #endif // WORDS_BIGENDIAN
110    
111  #define CHUNK_HEADER_SIZE       8  #define CHUNK_HEADER_SIZE       8
# Line 66  Line 113 
113  #define RIFF_HEADER_SIZE        12  #define RIFF_HEADER_SIZE        12
114    
115    
116  /** RIFF specific classes and definitions */  /**
117     * @brief RIFF specific classes and definitions
118     *
119     * The Resource Interchange File Format (RIFF) is a generic tree-structured
120     * meta-format which stores data in so called "chunks". It can be compared
121     * to XML, but in contrast to XML, RIFF is entirely binary encoded, that is
122     * not ASCII based. RIFF is used as basis for many file formats like AVI,
123     * WAV, DLS and of course the Gigasampler file format. ;-)
124     *
125     * RIFF chunks can be seen as containers for data. There are two distinct
126     * types of chunks:
127     *
128     * - @e ordinary @e chunks are the leafs of the data tree which encapsulate
129     *   the actual data of the file (i.e. the sample data of a .wav file)
130     *
131     * - @e list @e chunks are the nodes of the data tree which hold an
132     *   arbitrary amount of subchunks (can be both, list chunks and/or ordinary
133     *   chunks)
134     */
135  namespace RIFF {  namespace RIFF {
136    
137      /* just symbol prototyping */      /* just symbol prototyping */
138      class Chunk;      class Chunk;
139      class List;      class List;
140        class File;
141    
142      typedef std::string String;      typedef std::string String;
143    
144        /** Whether file stream is open in read or in read/write mode. */
145        typedef enum {
146            stream_mode_read       = 0,
147            stream_mode_read_write = 1,
148            stream_mode_closed     = 2
149        } stream_mode_t;
150    
151      /** Current state of the file stream. */      /** Current state of the file stream. */
152      typedef enum {      typedef enum {
153          stream_ready       = 0,          stream_ready       = 0,
# Line 90  namespace RIFF { Line 163  namespace RIFF {
163          stream_end      = 3          stream_end      = 3
164      } stream_whence_t;      } stream_whence_t;
165    
166      /** Provides convenient methods to access data of RIFF chunks in general. */      /** Alignment of data bytes in memory (system dependant). */
167        typedef enum {
168            endian_little = 0,
169            endian_big    = 1,
170            endian_native = 2
171        } endian_t;
172    
173        /** General chunk structure of a file. */
174        enum layout_t {
175            layout_standard = 0, ///< Standard RIFF file layout: First chunk in file is a List chunk which contains all other chunks and there are no chunks outside the scope of that very first (List) chunk.
176            layout_flat     = 1  ///< Not a "real" RIFF file: First chunk in file is an ordinary data chunk, not a List chunk, and there might be other chunks after that first chunk.
177        };
178    
179        /**
180         * @brief Used for indicating the progress of a certain task.
181         *
182         * The function pointer argument has to be supplied with a valid
183         * function of the given signature which will then be called on
184         * progress changes. An equivalent progress_t structure will be passed
185         * back as argument to the callback function on each progress change.
186         * The factor field of the supplied progress_t structure will then
187         * reflect the current progress as value between 0.0 and 1.0. You might
188         * want to use the custom field for data needed in your callback
189         * function.
190         */
191        struct progress_t {
192            void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification.
193            float factor;                  ///< Reflects current progress as value between 0.0 and 1.0.
194            void* custom;                  ///< This pointer can be used for arbitrary data.
195            float __range_min;             ///< Only for internal usage, do not modify!
196            float __range_max;             ///< Only for internal usage, do not modify!
197            progress_t();
198        };
199    
200        /** @brief Ordinary RIFF Chunk
201         *
202         * Provides convenient methods to access data of ordinary RIFF chunks
203         * in general.
204         */
205      class Chunk {      class Chunk {
206          public:          public:
207              #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  
208              String         GetChunkIDString();              String         GetChunkIDString();
209              uint32_t       GetChunkID() { return ChunkID; };            ///< Chunk ID in unsigned integer representation.              uint32_t       GetChunkID() { return ChunkID; }             ///< Chunk ID in unsigned integer representation.
210              List*          GetParent()  { return pParent; };            ///< Returns pointer to the chunk's parent list chunk.              File*          GetFile()    { return pFile;   }             ///< Returns pointer to the chunk's File object.
211              unsigned long  GetSize()    { return ChunkSize; };          ///< Chunk size in bytes (without header, thus the chunk data body)              List*          GetParent()  { return pParent; }             ///< Returns pointer to the chunk's parent list chunk.
212              unsigned long  GetPos()     { return ulPos; };              ///< Position within the chunk data body              unsigned long  GetSize() const { return CurrentChunkSize; } ///< Chunk size in bytes (without header, thus the chunk data body)
213              unsigned long  GetFilePos() { return ulStartPos + ulPos; }; ///< Current, actual offset in file.              unsigned long  GetNewSize() { return NewChunkSize;     }    ///< New chunk size if it was modified with Resize().
214                unsigned long  GetPos()     { return ulPos; }               ///< Position within the chunk data body
215                unsigned long  GetFilePos() { return ulStartPos + ulPos; }  ///< Current, actual offset in file.
216              unsigned long  SetPos(unsigned long Where, stream_whence_t Whence = stream_start);              unsigned long  SetPos(unsigned long Where, stream_whence_t Whence = stream_start);
217              unsigned long  RemainingBytes();              unsigned long  RemainingBytes();
218              stream_state_t GetState();              stream_state_t GetState();
# Line 120  namespace RIFF { Line 229  namespace RIFF {
229              uint16_t       ReadUint16();              uint16_t       ReadUint16();
230              int32_t        ReadInt32();              int32_t        ReadInt32();
231              uint32_t       ReadUint32();              uint32_t       ReadUint32();
232              void*          LoadChunkData();     ///< Load the whole chunk body in memory (on success returns a pointer to the data in RAM, else NULL).              void           ReadString(String& s, int size);
233              void           ReleaseChunkData();  ///< Free loaded chunk body data from memory (RAM).              unsigned long  Write(void* pData, unsigned long WordCount, unsigned long WordSize);
234             ~Chunk();              unsigned long  WriteInt8(int8_t* pData,     unsigned long WordCount = 1);
235                unsigned long  WriteUint8(uint8_t* pData,   unsigned long WordCount = 1);
236                unsigned long  WriteInt16(int16_t* pData,   unsigned long WordCount = 1);
237                unsigned long  WriteUint16(uint16_t* pData, unsigned long WordCount = 1);
238                unsigned long  WriteInt32(int32_t* pData,   unsigned long WordCount = 1);
239                unsigned long  WriteUint32(uint32_t* pData, unsigned long WordCount = 1);
240                void*          LoadChunkData();
241                void           ReleaseChunkData();
242                void           Resize(int iNewSize);
243                virtual ~Chunk();
244          protected:          protected:
245              uint32_t      ChunkID;              uint32_t      ChunkID;
246              uint32_t      ChunkSize;            /* in bytes */              uint32_t      CurrentChunkSize;             /* in bytes */
247                uint32_t      NewChunkSize;                 /* in bytes (if chunk was scheduled to be resized) */
248              List*         pParent;              List*         pParent;
249              #if POSIX              File*         pFile;
             int           hFile;  
             #else  
             FILE*         hFile;  
             #endif // POSIX  
250              unsigned long ulStartPos;           /* actual position in file where chunk (without header) starts */              unsigned long ulStartPos;           /* actual position in file where chunk (without header) starts */
251              unsigned long ulPos;                /* # of bytes from ulStartPos */              unsigned long ulPos;                /* # of bytes from ulStartPos */
             bool          bEndianNative;  
252              uint8_t*      pChunkData;              uint8_t*      pChunkData;
253                unsigned long ulChunkDataSize;
254    
255              Chunk();              Chunk(File* pFile);
256                Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize);
257              void          ReadHeader(unsigned long fPos);              void          ReadHeader(unsigned long fPos);
258                void          WriteHeader(unsigned long fPos);
259              unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);              unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);
260              inline void   swapBytes_16(void* Word) {              inline void   swapBytes_16(void* Word) {
261                  uint8_t byteCache = *((uint8_t*) Word);                  uint8_t byteCache = *((uint8_t*) Word);
# Line 171  namespace RIFF { Line 288  namespace RIFF {
288                  }                  }
289                  return result;                  return result;
290              }              }
291                virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset, progress_t* pProgress = NULL);
292                virtual void __resetPos(); ///< Sets Chunk's read/write position to zero.
293    
294                friend class List;
295      };      };
296    
297      /** Provides convenient methods to access data of RIFF list chunks and their subchunks. */      /** @brief RIFF List Chunk
298         *
299         * Provides convenient methods to access data of RIFF list chunks and
300         * their subchunks.
301         */
302      class List : public Chunk {      class List : public Chunk {
303          public:          public:
304              #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  
305              String       GetListTypeString();              String       GetListTypeString();
306              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
307              Chunk*       GetSubChunk(uint32_t ChunkID);              Chunk*       GetSubChunk(uint32_t ChunkID);
# Line 193  namespace RIFF { Line 314  namespace RIFF {
314              unsigned int CountSubChunks(uint32_t ChunkID);              unsigned int CountSubChunks(uint32_t ChunkID);
315              unsigned int CountSubLists();              unsigned int CountSubLists();
316              unsigned int CountSubLists(uint32_t ListType);              unsigned int CountSubLists(uint32_t ListType);
317             ~List();              Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
318                List*        AddSubList(uint32_t uiListType);
319                void         DeleteSubChunk(Chunk* pSubChunk);
320                void         MoveSubChunk(Chunk* pSrc, Chunk* pDst); // read API doc comments !!!
321                void         MoveSubChunk(Chunk* pSrc, List* pNewParent);
322                virtual ~List();
323          protected:          protected:
324              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;
325              typedef std::list<Chunk*>                 ChunkList;              typedef std::list<Chunk*>                 ChunkList;
326                typedef std::set<Chunk*>                  ChunkSet;
327    
328              uint32_t   ListType;              uint32_t   ListType;
329              ChunkList* pSubChunks;              ChunkList* pSubChunks;
# Line 204  namespace RIFF { Line 331  namespace RIFF {
331              ChunkList::iterator ChunksIterator;              ChunkList::iterator ChunksIterator;
332              ChunkList::iterator ListIterator;              ChunkList::iterator ListIterator;
333    
334              List();              List(File* pFile);
335                List(File* pFile, List* pParent, uint32_t uiListID);
336              void ReadHeader(unsigned long fPos);              void ReadHeader(unsigned long fPos);
337              void LoadSubChunks();              void WriteHeader(unsigned long fPos);
338                void LoadSubChunks(progress_t* pProgress = NULL);
339                void LoadSubChunksRecursively(progress_t* pProgress = NULL);
340                virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset, progress_t* pProgress = NULL);
341                virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.
342                void DeleteChunkList();
343      };      };
344    
345      /** Parses arbitrary RIFF files and provides together with it's base classes convenient methods to walk through the RIFF tree. */      /** @brief RIFF File
346         *
347         * Handles arbitrary RIFF files and provides together with its base
348         * classes convenient methods to walk through, read and modify the
349         * file's RIFF tree.
350         */
351      class File : public List {      class File : public List {
352          public:          public:
353                File(uint32_t FileType);
354              File(const String& path);              File(const String& path);
355             ~File();              File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout);
356                stream_mode_t GetMode();
357                bool          SetMode(stream_mode_t NewMode);
358                void SetByteOrder(endian_t Endian);
359                String GetFileName();
360                void SetFileName(const String& path);
361                bool IsNew() const;
362                layout_t GetLayout() const;
363                virtual void Save(progress_t* pProgress = NULL);
364                virtual void Save(const String& path, progress_t* pProgress = NULL);
365                virtual ~File();
366            protected:
367                #if POSIX
368                int    hFileRead;  ///< handle / descriptor for reading from file
369                int    hFileWrite; ///< handle / descriptor for writing to (some) file
370                #elif defined(WIN32)
371                HANDLE hFileRead;  ///< handle / descriptor for reading from file
372                HANDLE hFileWrite; ///< handle / descriptor for writing to (some) file
373                #else
374                FILE*  hFileRead;  ///< handle / descriptor for reading from file
375                FILE*  hFileWrite; ///< handle / descriptor for writing to (some) file
376                #endif // POSIX
377                String Filename;
378                bool   bEndianNative;
379                bool   bIsNewFile;
380                layout_t Layout; ///< An ordinary RIFF file is always set to layout_standard.
381    
382                void LogAsResized(Chunk* pResizedChunk);
383                void UnlogResized(Chunk* pResizedChunk);
384                friend class Chunk;
385                friend class List;
386          private:          private:
387                stream_mode_t  Mode;
388                ChunkSet ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).
389    
390                void __openExistingFile(const String& path, uint32_t* FileType = NULL);
391              unsigned long GetFileSize();              unsigned long GetFileSize();
392                void ResizeFile(unsigned long ulNewSize);
393                #if POSIX
394                unsigned long __GetFileSize(int hFile);
395                #elif defined(WIN32)
396                unsigned long __GetFileSize(HANDLE hFile);
397                #else
398                unsigned long __GetFileSize(FILE* hFile);
399                #endif
400                void Cleanup();
401      };      };
402    
403      /** Will be thrown whenever an error occurs while parsing a RIFF file. */      /**
404         * Will be thrown whenever an error occurs while handling a RIFF file.
405         */
406      class Exception {      class Exception {
407          public:          public:
408              String Message;              String Message;
409    
410              Exception(String Message) { Exception::Message = Message; };              Exception(String Message) { Exception::Message = Message; }
411              void PrintMessage();              void PrintMessage();
412              virtual ~Exception() {};              virtual ~Exception() {}
413      };      };
414    
415        String libraryName();
416        String libraryVersion();
417    
418  } // namespace RIFF  } // namespace RIFF
419  #endif // __RIFF_H__  #endif // __RIFF_H__
Legend:
Removed from v.11  
changed lines
  Added in v.2703
  ViewVC Help
Powered by ViewVC