/[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 2 by schoenebeck, Sat Oct 25 20:15:04 2003 UTC revision 2682 by schoenebeck, Mon Dec 29 16:25:51 2014 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-2014 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 <iostream>  #include <iostream>
43    
44    #ifdef HAVE_CONFIG_H
45    # include <config.h>
46    #endif
47    
48  #if POSIX  #if POSIX
49  # include <sys/types.h>  # include <sys/types.h>
50  # include <sys/stat.h>  # include <sys/stat.h>
# Line 39  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 51  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 62  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 */
137      class Chunk;      class Chunk;
138      class List;      class List;
139        class File;
140    
141      typedef std::string String;      typedef std::string String;
142    
143        /** Whether file stream is open in read or in read/write mode. */
144        typedef enum {
145            stream_mode_read       = 0,
146            stream_mode_read_write = 1,
147            stream_mode_closed     = 2
148        } stream_mode_t;
149    
150      /** Current state of the file stream. */      /** Current state of the file stream. */
151      typedef enum {      typedef enum {
152          stream_ready       = 0,          stream_ready       = 0,
# Line 86  namespace RIFF { Line 162  namespace RIFF {
162          stream_end      = 3          stream_end      = 3
163      } stream_whence_t;      } stream_whence_t;
164    
165      /** Provides convenient methods to access data of RIFF chunks in general. */      /** Alignment of data bytes in memory (system dependant). */
166        typedef enum {
167            endian_little = 0,
168            endian_big    = 1,
169            endian_native = 2
170        } endian_t;
171    
172        /** General chunk structure of a file. */
173        enum layout_t {
174            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.
175            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.
176        };
177    
178        /**
179         * @brief Used for indicating the progress of a certain task.
180         *
181         * The function pointer argument has to be supplied with a valid
182         * function of the given signature which will then be called on
183         * progress changes. An equivalent progress_t structure will be passed
184         * back as argument to the callback function on each progress change.
185         * The factor field of the supplied progress_t structure will then
186         * reflect the current progress as value between 0.0 and 1.0. You might
187         * want to use the custom field for data needed in your callback
188         * function.
189         */
190        struct progress_t {
191            void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification.
192            float factor;                  ///< Reflects current progress as value between 0.0 and 1.0.
193            void* custom;                  ///< This pointer can be used for arbitrary data.
194            float __range_min;             ///< Only for internal usage, do not modify!
195            float __range_max;             ///< Only for internal usage, do not modify!
196            progress_t();
197        };
198    
199        /** @brief Ordinary RIFF Chunk
200         *
201         * Provides convenient methods to access data of ordinary RIFF chunks
202         * in general.
203         */
204      class Chunk {      class Chunk {
205          public:          public:
206              #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  
207              String         GetChunkIDString();              String         GetChunkIDString();
208              uint32_t       GetChunkID() { return ChunkID; };              uint32_t       GetChunkID() { return ChunkID; }             ///< Chunk ID in unsigned integer representation.
209              List*          GetParent()  { return pParent; };              File*          GetFile()    { return pFile;   }             ///< Returns pointer to the chunk's File object.
210              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.
211              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)
212              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().
213                unsigned long  GetPos()     { return ulPos; }               ///< Position within the chunk data body
214                unsigned long  GetFilePos() { return ulStartPos + ulPos; }  ///< Current, actual offset in file.
215              unsigned long  SetPos(unsigned long Where, stream_whence_t Whence = stream_start);              unsigned long  SetPos(unsigned long Where, stream_whence_t Whence = stream_start);
216              unsigned long  RemainingBytes();              unsigned long  RemainingBytes();
217              stream_state_t GetState();              stream_state_t GetState();
# Line 116  namespace RIFF { Line 228  namespace RIFF {
228              uint16_t       ReadUint16();              uint16_t       ReadUint16();
229              int32_t        ReadInt32();              int32_t        ReadInt32();
230              uint32_t       ReadUint32();              uint32_t       ReadUint32();
231              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);
232              void           ReleaseChunkData();  ///< Free loaded chunk body data from memory (RAM).              unsigned long  Write(void* pData, unsigned long WordCount, unsigned long WordSize);
233             ~Chunk();              unsigned long  WriteInt8(int8_t* pData,     unsigned long WordCount = 1);
234                unsigned long  WriteUint8(uint8_t* pData,   unsigned long WordCount = 1);
235                unsigned long  WriteInt16(int16_t* pData,   unsigned long WordCount = 1);
236                unsigned long  WriteUint16(uint16_t* pData, unsigned long WordCount = 1);
237                unsigned long  WriteInt32(int32_t* pData,   unsigned long WordCount = 1);
238                unsigned long  WriteUint32(uint32_t* pData, unsigned long WordCount = 1);
239                void*          LoadChunkData();
240                void           ReleaseChunkData();
241                void           Resize(int iNewSize);
242                virtual ~Chunk();
243          protected:          protected:
244              uint32_t      ChunkID;              uint32_t      ChunkID;
245              uint32_t      ChunkSize;            /* in bytes */              uint32_t      CurrentChunkSize;             /* in bytes */
246                uint32_t      NewChunkSize;                 /* in bytes (if chunk was scheduled to be resized) */
247              List*         pParent;              List*         pParent;
248              #if POSIX              File*         pFile;
             int           hFile;  
             #else  
             FILE*         hFile;  
             #endif // POSIX  
249              unsigned long ulStartPos;           /* actual position in file where chunk (without header) starts */              unsigned long ulStartPos;           /* actual position in file where chunk (without header) starts */
250              unsigned long ulPos;                /* # of bytes from ulStartPos */              unsigned long ulPos;                /* # of bytes from ulStartPos */
             bool          bEndianNative;  
251              uint8_t*      pChunkData;              uint8_t*      pChunkData;
252                unsigned long ulChunkDataSize;
253    
254              Chunk();              Chunk(File* pFile);
255                Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize);
256              void          ReadHeader(unsigned long fPos);              void          ReadHeader(unsigned long fPos);
257                void          WriteHeader(unsigned long fPos);
258              unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);              unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);
259              inline void   swapBytes_16(void* Word) {              inline void   swapBytes_16(void* Word) {
260                  uint8_t byteCache = *((uint8_t*) Word);                  uint8_t byteCache = *((uint8_t*) Word);
# Line 167  namespace RIFF { Line 287  namespace RIFF {
287                  }                  }
288                  return result;                  return result;
289              }              }
290                virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset, progress_t* pProgress = NULL);
291                virtual void __resetPos(); ///< Sets Chunk's read/write position to zero.
292    
293                friend class List;
294      };      };
295    
296      /** Provides convenient methods to access data of RIFF list chunks and their subchunks. */      /** @brief RIFF List Chunk
297         *
298         * Provides convenient methods to access data of RIFF list chunks and
299         * their subchunks.
300         */
301      class List : public Chunk {      class List : public Chunk {
302          public:          public:
303              #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  
304              String       GetListTypeString();              String       GetListTypeString();
305              uint32_t     GetListType() { return ListType; }              uint32_t     GetListType() { return ListType; }   ///< Returns unsigned integer representation of the list's ID
306              Chunk*       GetSubChunk(uint32_t ChunkID); /* use this if you expect only one subchunk of that type in the list */              Chunk*       GetSubChunk(uint32_t ChunkID);
307              List*        GetSubList(uint32_t ListType); /* use this if you expect only one sublist chunk of that type in the list */              List*        GetSubList(uint32_t ListType);
308              Chunk*       GetFirstSubChunk();              Chunk*       GetFirstSubChunk();
309              Chunk*       GetNextSubChunk();              Chunk*       GetNextSubChunk();
310              List*        GetFirstSubList();              List*        GetFirstSubList();
# Line 189  namespace RIFF { Line 313  namespace RIFF {
313              unsigned int CountSubChunks(uint32_t ChunkID);              unsigned int CountSubChunks(uint32_t ChunkID);
314              unsigned int CountSubLists();              unsigned int CountSubLists();
315              unsigned int CountSubLists(uint32_t ListType);              unsigned int CountSubLists(uint32_t ListType);
316             ~List();              Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
317                List*        AddSubList(uint32_t uiListType);
318                void         DeleteSubChunk(Chunk* pSubChunk);
319                void         MoveSubChunk(Chunk* pSrc, Chunk* pDst); // read API doc comments !!!
320                void         MoveSubChunk(Chunk* pSrc, List* pNewParent);
321                virtual ~List();
322          protected:          protected:
323              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;
324              typedef std::list<Chunk*>                 ChunkList;              typedef std::list<Chunk*>                 ChunkList;
# Line 200  namespace RIFF { Line 329  namespace RIFF {
329              ChunkList::iterator ChunksIterator;              ChunkList::iterator ChunksIterator;
330              ChunkList::iterator ListIterator;              ChunkList::iterator ListIterator;
331    
332              List();              List(File* pFile);
333                List(File* pFile, List* pParent, uint32_t uiListID);
334              void ReadHeader(unsigned long fPos);              void ReadHeader(unsigned long fPos);
335              void LoadSubChunks();              void WriteHeader(unsigned long fPos);
336                void LoadSubChunks(progress_t* pProgress = NULL);
337                void LoadSubChunksRecursively(progress_t* pProgress = NULL);
338                virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset, progress_t* pProgress = NULL);
339                virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.
340                void DeleteChunkList();
341      };      };
342    
343      /** Parses arbitrary RIFF files and provides together with it's base classes convenient methods to walk through the RIFF tree. */      /** @brief RIFF File
344         *
345         * Handles arbitrary RIFF files and provides together with its base
346         * classes convenient methods to walk through, read and modify the
347         * file's RIFF tree.
348         */
349      class File : public List {      class File : public List {
350          public:          public:
351                File(uint32_t FileType);
352              File(const String& path);              File(const String& path);
353             ~File();              File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout);
354                stream_mode_t GetMode();
355                bool          SetMode(stream_mode_t NewMode);
356                void SetByteOrder(endian_t Endian);
357                String GetFileName();
358                void SetFileName(const String& path);
359                bool IsNew() const;
360                layout_t GetLayout() const;
361                virtual void Save(progress_t* pProgress = NULL);
362                virtual void Save(const String& path, progress_t* pProgress = NULL);
363                virtual ~File();
364            protected:
365                #if POSIX
366                int    hFileRead;  ///< handle / descriptor for reading from file
367                int    hFileWrite; ///< handle / descriptor for writing to (some) file
368                #elif defined(WIN32)
369                HANDLE hFileRead;  ///< handle / descriptor for reading from file
370                HANDLE hFileWrite; ///< handle / descriptor for writing to (some) file
371                #else
372                FILE*  hFileRead;  ///< handle / descriptor for reading from file
373                FILE*  hFileWrite; ///< handle / descriptor for writing to (some) file
374                #endif // POSIX
375                String Filename;
376                bool   bEndianNative;
377                bool   bIsNewFile;
378                layout_t Layout; ///< An ordinary RIFF file is always set to layout_standard.
379    
380                void LogAsResized(Chunk* pResizedChunk);
381                void UnlogResized(Chunk* pResizedChunk);
382                friend class Chunk;
383                friend class List;
384          private:          private:
385                stream_mode_t  Mode;
386                ChunkList ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).
387    
388                void __openExistingFile(const String& path, uint32_t* FileType = NULL);
389              unsigned long GetFileSize();              unsigned long GetFileSize();
390                void ResizeFile(unsigned long ulNewSize);
391                #if POSIX
392                unsigned long __GetFileSize(int hFile);
393                #elif defined(WIN32)
394                unsigned long __GetFileSize(HANDLE hFile);
395                #else
396                unsigned long __GetFileSize(FILE* hFile);
397                #endif
398                void Cleanup();
399      };      };
400    
401      /** Will be thrown whenever an error occurs while parsing a RIFF file. */      /**
402         * Will be thrown whenever an error occurs while handling a RIFF file.
403         */
404      class Exception {      class Exception {
405          public:          public:
406              String Message;              String Message;
407    
408              Exception(String Message) { Exception::Message = Message; };              Exception(String Message) { Exception::Message = Message; }
409              void PrintMessage();              void PrintMessage();
410              virtual ~Exception() {};              virtual ~Exception() {}
411      };      };
412    
413        String libraryName();
414        String libraryVersion();
415    
416  } // namespace RIFF  } // namespace RIFF
417  #endif // __RIFF_H__  #endif // __RIFF_H__
Legend:
Removed from v.2  
changed lines
  Added in v.2682
  ViewVC Help
Powered by ViewVC