/[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 2450 by persson, Wed May 8 17:53:07 2013 UTC revision 3468 by persson, Tue Feb 12 18:54:40 2019 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file access library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2013 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2019 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 39  Line 39 
39  #include <string>  #include <string>
40  #include <list>  #include <list>
41  #include <map>  #include <map>
42    #include <set>
43  #include <iostream>  #include <iostream>
44    #include <stdarg.h>
45    
46  #ifdef HAVE_CONFIG_H  #ifdef HAVE_CONFIG_H
47  # include <config.h>  # include <config.h>
# Line 67  typedef unsigned __int64 uint64_t; Line 69  typedef unsigned __int64 uint64_t;
69  #endif  #endif
70    
71  #ifdef WIN32  #ifdef WIN32
72    # if (_WIN32 && !_WIN64) || (__GNUC__ && !(__x86_64__ || __ppc64__)) /* if 32 bit windows compilation */
73    #  if _WIN32_WINNT < 0x0501
74    #   undef _WIN32_WINNT
75    #   define _WIN32_WINNT 0x0501 /* Win XP (no service pack): required for 32 bit compilation for GetFileSizeEx() to be declared by windows.h */
76    #  endif
77    # endif
78  # include <windows.h>  # include <windows.h>
79    typedef unsigned int   uint;    typedef unsigned int   uint;
80  #endif // WIN32  #endif // WIN32
# Line 107  typedef unsigned __int64 uint64_t; Line 115  typedef unsigned __int64 uint64_t;
115    
116  #endif // WORDS_BIGENDIAN  #endif // WORDS_BIGENDIAN
117    
118  #define CHUNK_HEADER_SIZE       8  #define CHUNK_HEADER_SIZE(fileOffsetSize)   (4 + fileOffsetSize)
119  #define LIST_HEADER_SIZE        12  #define LIST_HEADER_SIZE(fileOffsetSize)    (8 + fileOffsetSize)
120  #define RIFF_HEADER_SIZE        12  #define RIFF_HEADER_SIZE(fileOffsetSize)    (8 + fileOffsetSize)
   
121    
122  /**  /**
123   * @brief RIFF specific classes and definitions   * @brief RIFF specific classes and definitions
# Line 140  namespace RIFF { Line 147  namespace RIFF {
147    
148      typedef std::string String;      typedef std::string String;
149    
150        /** Type used by libgig for handling file positioning during file I/O tasks. */
151        typedef uint64_t file_offset_t;
152    
153      /** Whether file stream is open in read or in read/write mode. */      /** Whether file stream is open in read or in read/write mode. */
154      typedef enum {      enum stream_mode_t {
155          stream_mode_read       = 0,          stream_mode_read       = 0,
156          stream_mode_read_write = 1,          stream_mode_read_write = 1,
157          stream_mode_closed     = 2          stream_mode_closed     = 2
158      } stream_mode_t;      };
159    
160      /** Current state of the file stream. */      /** Current state of the file stream. */
161      typedef enum {      enum stream_state_t {
162          stream_ready       = 0,          stream_ready       = 0,
163          stream_end_reached = 1,          stream_end_reached = 1,
164          stream_closed      = 2          stream_closed      = 2
165      } stream_state_t;      };
166    
167      /** File stream position dependent to these relations. */      /** File stream position dependent to these relations. */
168      typedef enum {      enum stream_whence_t {
169          stream_start    = 0,          stream_start    = 0,
170          stream_curpos   = 1,          stream_curpos   = 1,
171          stream_backward = 2,          stream_backward = 2,
172          stream_end      = 3          stream_end      = 3
173      } stream_whence_t;      };
174    
175      /** Alignment of data bytes in memory (system dependant). */      /** Alignment of data bytes in memory (system dependant). */
176      typedef enum {      enum endian_t {
177          endian_little = 0,          endian_little = 0,
178          endian_big    = 1,          endian_big    = 1,
179          endian_native = 2          endian_native = 2
180      } endian_t;      };
181    
182        /** General RIFF chunk structure of a RIFF file. */
183        enum layout_t {
184            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.
185            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.
186        };
187    
188        /** Size of RIFF file offsets used in all RIFF chunks' headers. @see File::GetFileOffsetSize() */
189        enum offset_size_t {
190            offset_size_auto  = 0, ///< Use 32 bit offsets for files smaller than 4 GB, use 64 bit offsets for files equal or larger than 4 GB.
191            offset_size_32bit = 4, ///< Always use 32 bit offsets (even for files larger than 4 GB).
192            offset_size_64bit = 8  ///< Always use 64 bit offsets (even for files smaller than 4 GB).
193        };
194    
195        /**
196         * @brief Used for indicating the progress of a certain task.
197         *
198         * The function pointer argument has to be supplied with a valid
199         * function of the given signature which will then be called on
200         * progress changes. An equivalent progress_t structure will be passed
201         * back as argument to the callback function on each progress change.
202         * The factor field of the supplied progress_t structure will then
203         * reflect the current progress as value between 0.0 and 1.0. You might
204         * want to use the custom field for data needed in your callback
205         * function.
206         */
207        struct progress_t {
208            void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification.
209            float factor;                  ///< Reflects current progress as value between 0.0 and 1.0.
210            void* custom;                  ///< This pointer can be used for arbitrary data.
211            float __range_min;             ///< Only for internal usage, do not modify!
212            float __range_max;             ///< Only for internal usage, do not modify!
213            progress_t();
214        };
215    
216      /** @brief Ordinary RIFF Chunk      /** @brief Ordinary RIFF Chunk
217       *       *
# Line 176  namespace RIFF { Line 220  namespace RIFF {
220       */       */
221      class Chunk {      class Chunk {
222          public:          public:
223              Chunk(File* pFile, unsigned long StartPos, List* Parent);              Chunk(File* pFile, file_offset_t StartPos, List* Parent);
224              String         GetChunkIDString();              String         GetChunkIDString() const;
225              uint32_t       GetChunkID() { return ChunkID; }             ///< Chunk ID in unsigned integer representation.              uint32_t       GetChunkID() const { return ChunkID; }       ///< Chunk ID in unsigned integer representation.
226              List*          GetParent()  { return pParent; }             ///< Returns pointer to the chunk's parent list chunk.              File*          GetFile() const    { return pFile;   }       ///< Returns pointer to the chunk's File object.
227              unsigned long  GetSize()    { return CurrentChunkSize; }    ///< Chunk size in bytes (without header, thus the chunk data body)              List*          GetParent() const  { return pParent; }       ///< Returns pointer to the chunk's parent list chunk.
228              unsigned long  GetNewSize() { return NewChunkSize;     }    ///< New chunk size if it was modified with Resize().              file_offset_t  GetSize() const { return ullCurrentChunkSize; } ///< Chunk size in bytes (without header, thus the chunk data body)
229              unsigned long  GetPos()     { return ulPos; }               ///< Position within the chunk data body              file_offset_t  GetNewSize() const { return ullNewChunkSize; } ///< New chunk size if it was modified with Resize(), otherwise value returned will be equal to GetSize().
230              unsigned long  GetFilePos() { return ulStartPos + ulPos; }  ///< Current, actual offset in file.              file_offset_t  GetPos() const { return ullPos; }            ///< Position within the chunk data body (starting with 0).
231              unsigned long  SetPos(unsigned long Where, stream_whence_t Whence = stream_start);              file_offset_t  GetFilePos() const { return ullStartPos + ullPos; } ///< Current, actual offset of chunk data body start in file.
232              unsigned long  RemainingBytes();              file_offset_t  SetPos(file_offset_t Where, stream_whence_t Whence = stream_start);
233              stream_state_t GetState();              file_offset_t  RemainingBytes() const;
234              unsigned long  Read(void* pData, unsigned long WordCount, unsigned long WordSize);              stream_state_t GetState() const;
235              unsigned long  ReadInt8(int8_t* pData,     unsigned long WordCount = 1);              file_offset_t  Read(void* pData, file_offset_t WordCount, file_offset_t WordSize);
236              unsigned long  ReadUint8(uint8_t* pData,   unsigned long WordCount = 1);              file_offset_t  ReadInt8(int8_t* pData,     file_offset_t WordCount = 1);
237              unsigned long  ReadInt16(int16_t* pData,   unsigned long WordCount = 1);              file_offset_t  ReadUint8(uint8_t* pData,   file_offset_t WordCount = 1);
238              unsigned long  ReadUint16(uint16_t* pData, unsigned long WordCount = 1);              file_offset_t  ReadInt16(int16_t* pData,   file_offset_t WordCount = 1);
239              unsigned long  ReadInt32(int32_t* pData,   unsigned long WordCount = 1);              file_offset_t  ReadUint16(uint16_t* pData, file_offset_t WordCount = 1);
240              unsigned long  ReadUint32(uint32_t* pData, unsigned long WordCount = 1);              file_offset_t  ReadInt32(int32_t* pData,   file_offset_t WordCount = 1);
241                file_offset_t  ReadUint32(uint32_t* pData, file_offset_t WordCount = 1);
242              int8_t         ReadInt8();              int8_t         ReadInt8();
243              uint8_t        ReadUint8();              uint8_t        ReadUint8();
244              int16_t        ReadInt16();              int16_t        ReadInt16();
# Line 201  namespace RIFF { Line 246  namespace RIFF {
246              int32_t        ReadInt32();              int32_t        ReadInt32();
247              uint32_t       ReadUint32();              uint32_t       ReadUint32();
248              void           ReadString(String& s, int size);              void           ReadString(String& s, int size);
249              unsigned long  Write(void* pData, unsigned long WordCount, unsigned long WordSize);              file_offset_t  Write(void* pData, file_offset_t WordCount, file_offset_t WordSize);
250              unsigned long  WriteInt8(int8_t* pData,     unsigned long WordCount = 1);              file_offset_t  WriteInt8(int8_t* pData,     file_offset_t WordCount = 1);
251              unsigned long  WriteUint8(uint8_t* pData,   unsigned long WordCount = 1);              file_offset_t  WriteUint8(uint8_t* pData,   file_offset_t WordCount = 1);
252              unsigned long  WriteInt16(int16_t* pData,   unsigned long WordCount = 1);              file_offset_t  WriteInt16(int16_t* pData,   file_offset_t WordCount = 1);
253              unsigned long  WriteUint16(uint16_t* pData, unsigned long WordCount = 1);              file_offset_t  WriteUint16(uint16_t* pData, file_offset_t WordCount = 1);
254              unsigned long  WriteInt32(int32_t* pData,   unsigned long WordCount = 1);              file_offset_t  WriteInt32(int32_t* pData,   file_offset_t WordCount = 1);
255              unsigned long  WriteUint32(uint32_t* pData, unsigned long WordCount = 1);              file_offset_t  WriteUint32(uint32_t* pData, file_offset_t WordCount = 1);
256              void*          LoadChunkData();              void*          LoadChunkData();
257              void           ReleaseChunkData();              void           ReleaseChunkData();
258              void           Resize(int iNewSize);              void           Resize(file_offset_t NewSize);
259              virtual ~Chunk();              virtual ~Chunk();
260          protected:          protected:
261              uint32_t      ChunkID;              uint32_t      ChunkID;
262              uint32_t      CurrentChunkSize;             /* in bytes */              file_offset_t ullCurrentChunkSize;          /* in bytes */
263              uint32_t      NewChunkSize;                 /* in bytes (if chunk was scheduled to be resized) */              file_offset_t ullNewChunkSize;                      /* in bytes (if chunk was scheduled to be resized) */
264              List*         pParent;              List*         pParent;
265              File*         pFile;              File*         pFile;
266              unsigned long ulStartPos;           /* actual position in file where chunk (without header) starts */              file_offset_t ullStartPos;  /* actual position in file where chunk data (without header) starts */
267              unsigned long ulPos;                /* # of bytes from ulStartPos */              file_offset_t ullPos;       /* # of bytes from ulStartPos */
268              uint8_t*      pChunkData;              uint8_t*      pChunkData;
269              unsigned long ulChunkDataSize;              file_offset_t ullChunkDataSize;
270    
271              Chunk(File* pFile);              Chunk(File* pFile);
272              Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize);              Chunk(File* pFile, List* pParent, uint32_t uiChunkID, file_offset_t ullBodySize);
273              void          ReadHeader(unsigned long fPos);              void ReadHeader(file_offset_t filePos);
274              void          WriteHeader(unsigned long fPos);              void WriteHeader(file_offset_t filePos);
275              unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);              file_offset_t ReadSceptical(void* pData, file_offset_t WordCount, file_offset_t WordSize);
276              inline void   swapBytes_16(void* Word) {              inline static String convertToString(uint32_t word) {
                 uint8_t byteCache = *((uint8_t*) Word);  
                 *((uint8_t*) Word)     = *((uint8_t*) Word + 1);  
                 *((uint8_t*) Word + 1) = byteCache;  
             }  
             inline void   swapBytes_32(void* Word) {  
                 uint8_t byteCache = *((uint8_t*) Word);  
                 *((uint8_t*) Word)     = *((uint8_t*) Word + 3);  
                 *((uint8_t*) Word + 3) = byteCache;  
                 byteCache = *((uint8_t*) Word + 1);  
                 *((uint8_t*) Word + 1) = *((uint8_t*) Word + 2);  
                 *((uint8_t*) Word + 2) = byteCache;  
             }  
             inline void   swapBytes(void* Word, unsigned long WordSize) {  
                 uint8_t byteCache;  
                 unsigned long lo = 0, hi = WordSize - 1;  
                 for (; lo < hi; hi--, lo++) {  
                     byteCache = *((uint8_t*) Word + lo);  
                     *((uint8_t*) Word + lo) = *((uint8_t*) Word + hi);  
                     *((uint8_t*) Word + hi) = byteCache;  
                 }  
             }  
             inline String convertToString(uint32_t word) {  
277                  String result;                  String result;
278                  for (int i = 0; i < 4; i++) {                  for (int i = 0; i < 4; i++) {
279                      uint8_t byte = *((uint8_t*)(&word) + i);                      uint8_t byte = *((uint8_t*)(&word) + i);
# Line 259  namespace RIFF { Line 282  namespace RIFF {
282                  }                  }
283                  return result;                  return result;
284              }              }
285              virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);              virtual file_offset_t RequiredPhysicalSize(int fileOffsetSize);
286                virtual file_offset_t WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t* pProgress = NULL);
287              virtual void __resetPos(); ///< Sets Chunk's read/write position to zero.              virtual void __resetPos(); ///< Sets Chunk's read/write position to zero.
288    
289              friend class List;              friend class List;
# Line 272  namespace RIFF { Line 296  namespace RIFF {
296       */       */
297      class List : public Chunk {      class List : public Chunk {
298          public:          public:
299              List(File* pFile, unsigned long StartPos, List* Parent);              List(File* pFile, file_offset_t StartPos, List* Parent);
300              String       GetListTypeString();              String       GetListTypeString() const;
301              uint32_t     GetListType() { return ListType; }   ///< Returns unsigned integer representation of the list's ID              uint32_t     GetListType() const { return ListType; } ///< Returns unsigned integer representation of the list's ID
302              Chunk*       GetSubChunk(uint32_t ChunkID);              Chunk*       GetSubChunk(uint32_t ChunkID);
303              List*        GetSubList(uint32_t ListType);              List*        GetSubList(uint32_t ListType);
304              Chunk*       GetFirstSubChunk();              Chunk*       GetFirstSubChunk();
305              Chunk*       GetNextSubChunk();              Chunk*       GetNextSubChunk();
306              List*        GetFirstSubList();              List*        GetFirstSubList();
307              List*        GetNextSubList();              List*        GetNextSubList();
308              unsigned int CountSubChunks();              size_t       CountSubChunks();
309              unsigned int CountSubChunks(uint32_t ChunkID);              size_t       CountSubChunks(uint32_t ChunkID);
310              unsigned int CountSubLists();              size_t       CountSubLists();
311              unsigned int CountSubLists(uint32_t ListType);              size_t       CountSubLists(uint32_t ListType);
312              Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);              Chunk*       AddSubChunk(uint32_t uiChunkID, file_offset_t ullBodySize);
313              List*        AddSubList(uint32_t uiListType);              List*        AddSubList(uint32_t uiListType);
314              void         DeleteSubChunk(Chunk* pSubChunk);              void         DeleteSubChunk(Chunk* pSubChunk);
315              void         MoveSubChunk(Chunk* pSrc, Chunk* pDst);              void         MoveSubChunk(Chunk* pSrc, Chunk* pDst); // read API doc comments !!!
316                void         MoveSubChunk(Chunk* pSrc, List* pNewParent);
317              virtual ~List();              virtual ~List();
318          protected:          protected:
319              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;
320              typedef std::list<Chunk*>                 ChunkList;              typedef std::list<Chunk*>                 ChunkList;
321                typedef std::set<Chunk*>                  ChunkSet;
322    
323              uint32_t   ListType;              uint32_t   ListType;
324              ChunkList* pSubChunks;              ChunkList* pSubChunks;
# Line 302  namespace RIFF { Line 328  namespace RIFF {
328    
329              List(File* pFile);              List(File* pFile);
330              List(File* pFile, List* pParent, uint32_t uiListID);              List(File* pFile, List* pParent, uint32_t uiListID);
331              void ReadHeader(unsigned long fPos);              void ReadHeader(file_offset_t filePos);
332              void WriteHeader(unsigned long fPos);              void WriteHeader(file_offset_t filePos);
333              void LoadSubChunks();              void LoadSubChunks(progress_t* pProgress = NULL);
334              void LoadSubChunksRecursively();              void LoadSubChunksRecursively(progress_t* pProgress = NULL);
335              virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);              virtual file_offset_t RequiredPhysicalSize(int fileOffsetSize);
336                virtual file_offset_t WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t* pProgress = NULL);
337              virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.              virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.
338              void DeleteChunkList();              void DeleteChunkList();
339      };      };
# Line 321  namespace RIFF { Line 348  namespace RIFF {
348          public:          public:
349              File(uint32_t FileType);              File(uint32_t FileType);
350              File(const String& path);              File(const String& path);
351              stream_mode_t GetMode();              File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout, offset_size_t fileOffsetSize = offset_size_auto);
352                stream_mode_t GetMode() const;
353              bool          SetMode(stream_mode_t NewMode);              bool          SetMode(stream_mode_t NewMode);
354              void SetByteOrder(endian_t Endian);              void SetByteOrder(endian_t Endian);
355              String GetFileName();              String GetFileName() const;
356              virtual void Save();              void SetFileName(const String& path);
357              virtual void Save(const String& path);              bool IsNew() const;
358                layout_t GetLayout() const;
359                file_offset_t GetCurrentFileSize() const;
360                file_offset_t GetRequiredFileSize();
361                file_offset_t GetRequiredFileSize(offset_size_t fileOffsetSize);
362                int GetFileOffsetSize() const;
363                int GetRequiredFileOffsetSize();
364    
365                virtual void Save(progress_t* pProgress = NULL);
366                virtual void Save(const String& path, progress_t* pProgress = NULL);
367              virtual ~File();              virtual ~File();
368          protected:          protected:
369              #if POSIX              #if POSIX
# Line 341  namespace RIFF { Line 378  namespace RIFF {
378              #endif // POSIX              #endif // POSIX
379              String Filename;              String Filename;
380              bool   bEndianNative;              bool   bEndianNative;
381                bool   bIsNewFile;
382                layout_t Layout; ///< An ordinary RIFF file is always set to layout_standard.
383                offset_size_t FileOffsetPreference;
384                int FileOffsetSize; ///< Size of file offsets (in bytes) when this file was opened (or saved the last time).
385    
             void LogAsResized(Chunk* pResizedChunk);  
             void UnlogResized(Chunk* pResizedChunk);  
386              friend class Chunk;              friend class Chunk;
387              friend class List;              friend class List;
388          private:          private:
389              stream_mode_t  Mode;              stream_mode_t  Mode;
             ChunkList ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).  
390    
391              unsigned long GetFileSize();              void __openExistingFile(const String& path, uint32_t* FileType = NULL);
392              void ResizeFile(unsigned long ulNewSize);              void ResizeFile(file_offset_t ullNewSize);
393              #if POSIX              #if POSIX
394              unsigned long __GetFileSize(int hFile);              file_offset_t __GetFileSize(int hFile) const;
395              #elif defined(WIN32)              #elif defined(WIN32)
396              unsigned long __GetFileSize(HANDLE hFile);              file_offset_t __GetFileSize(HANDLE hFile) const;
397              #else              #else
398              unsigned long __GetFileSize(FILE* hFile);              file_offset_t __GetFileSize(FILE* hFile) const;
399              #endif              #endif
400                int FileOffsetSizeFor(file_offset_t fileSize) const;
401              void Cleanup();              void Cleanup();
402      };      };
403    
# Line 369  namespace RIFF { Line 408  namespace RIFF {
408          public:          public:
409              String Message;              String Message;
410    
411              Exception(String Message) { Exception::Message = Message; }              Exception(String format, ...);
412                Exception(String format, va_list arg);
413              void PrintMessage();              void PrintMessage();
414              virtual ~Exception() {}              virtual ~Exception() {}
415    
416            protected:
417                Exception();
418                static String assemble(String format, va_list arg);
419      };      };
420    
421      String libraryName();      String libraryName();
Legend:
Removed from v.2450  
changed lines
  Added in v.3468
  ViewVC Help
Powered by ViewVC