/[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 1953 by schoenebeck, Thu Jul 30 08:16:02 2009 UTC revision 2584 by schoenebeck, Sat May 31 20:54:39 2014 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-2009 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  *
# Line 77  typedef unsigned __int64 uint64_t; Line 77  typedef unsigned __int64 uint64_t;
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 145  namespace RIFF { Line 169  namespace RIFF {
169          endian_native = 2          endian_native = 2
170      } endian_t;      } 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      /** @brief Ordinary RIFF Chunk      /** @brief Ordinary RIFF Chunk
179       *       *
180       * Provides convenient methods to access data of ordinary RIFF chunks       * Provides convenient methods to access data of ordinary RIFF chunks
# Line 155  namespace RIFF { Line 185  namespace RIFF {
185              Chunk(File* pFile, unsigned long StartPos, List* Parent);              Chunk(File* pFile, unsigned long StartPos, List* Parent);
186              String         GetChunkIDString();              String         GetChunkIDString();
187              uint32_t       GetChunkID() { return ChunkID; }             ///< Chunk ID in unsigned integer representation.              uint32_t       GetChunkID() { return ChunkID; }             ///< Chunk ID in unsigned integer representation.
188                File*          GetFile()    { return pFile;   }             ///< Returns pointer to the chunk's File object.
189              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.
190              unsigned long  GetSize()    { return CurrentChunkSize; }    ///< Chunk size in bytes (without header, thus the chunk data body)              unsigned long  GetSize() const { return CurrentChunkSize; } ///< Chunk size in bytes (without header, thus the chunk data body)
191              unsigned long  GetNewSize() { return NewChunkSize;     }    ///< New chunk size if it was modified with Resize().              unsigned long  GetNewSize() { return NewChunkSize;     }    ///< New chunk size if it was modified with Resize().
192              unsigned long  GetPos()     { return ulPos; }               ///< Position within the chunk data body              unsigned long  GetPos()     { return ulPos; }               ///< Position within the chunk data body
193              unsigned long  GetFilePos() { return ulStartPos + ulPos; }  ///< Current, actual offset in file.              unsigned long  GetFilePos() { return ulStartPos + ulPos; }  ///< Current, actual offset in file.
# Line 176  namespace RIFF { Line 207  namespace RIFF {
207              uint16_t       ReadUint16();              uint16_t       ReadUint16();
208              int32_t        ReadInt32();              int32_t        ReadInt32();
209              uint32_t       ReadUint32();              uint32_t       ReadUint32();
210                void           ReadString(String& s, int size);
211              unsigned long  Write(void* pData, unsigned long WordCount, unsigned long WordSize);              unsigned long  Write(void* pData, unsigned long WordCount, unsigned long WordSize);
212              unsigned long  WriteInt8(int8_t* pData,     unsigned long WordCount = 1);              unsigned long  WriteInt8(int8_t* pData,     unsigned long WordCount = 1);
213              unsigned long  WriteUint8(uint8_t* pData,   unsigned long WordCount = 1);              unsigned long  WriteUint8(uint8_t* pData,   unsigned long WordCount = 1);
# Line 263  namespace RIFF { Line 295  namespace RIFF {
295              Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);              Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
296              List*        AddSubList(uint32_t uiListType);              List*        AddSubList(uint32_t uiListType);
297              void         DeleteSubChunk(Chunk* pSubChunk);              void         DeleteSubChunk(Chunk* pSubChunk);
298              void         MoveSubChunk(Chunk* pSrc, Chunk* pDst);              void         MoveSubChunk(Chunk* pSrc, Chunk* pDst); // read API doc comments !!!
299                void         MoveSubChunk(Chunk* pSrc, List* pNewParent);
300              virtual ~List();              virtual ~List();
301          protected:          protected:
302              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;
# Line 296  namespace RIFF { Line 329  namespace RIFF {
329          public:          public:
330              File(uint32_t FileType);              File(uint32_t FileType);
331              File(const String& path);              File(const String& path);
332                File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout);
333              stream_mode_t GetMode();              stream_mode_t GetMode();
334              bool          SetMode(stream_mode_t NewMode);              bool          SetMode(stream_mode_t NewMode);
335              void SetByteOrder(endian_t Endian);              void SetByteOrder(endian_t Endian);
336              String GetFileName();              String GetFileName();
337                void SetFileName(const String& path);
338                bool IsNew() const;
339                layout_t GetLayout() const;
340              virtual void Save();              virtual void Save();
341              virtual void Save(const String& path);              virtual void Save(const String& path);
342              virtual ~File();              virtual ~File();
# Line 316  namespace RIFF { Line 353  namespace RIFF {
353              #endif // POSIX              #endif // POSIX
354              String Filename;              String Filename;
355              bool   bEndianNative;              bool   bEndianNative;
356                bool   bIsNewFile;
357                layout_t Layout; ///< An ordinary RIFF file is always set to layout_standard.
358    
359              void LogAsResized(Chunk* pResizedChunk);              void LogAsResized(Chunk* pResizedChunk);
360              void UnlogResized(Chunk* pResizedChunk);              void UnlogResized(Chunk* pResizedChunk);
# Line 325  namespace RIFF { Line 364  namespace RIFF {
364              stream_mode_t  Mode;              stream_mode_t  Mode;
365              ChunkList ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).              ChunkList ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).
366    
367                void __openExistingFile(const String& path, uint32_t* FileType = NULL);
368              unsigned long GetFileSize();              unsigned long GetFileSize();
369              void ResizeFile(unsigned long ulNewSize);              void ResizeFile(unsigned long ulNewSize);
370              #if POSIX              #if POSIX
# Line 334  namespace RIFF { Line 374  namespace RIFF {
374              #else              #else
375              unsigned long __GetFileSize(FILE* hFile);              unsigned long __GetFileSize(FILE* hFile);
376              #endif              #endif
377                void Cleanup();
378      };      };
379    
380      /**      /**
Legend:
Removed from v.1953  
changed lines
  Added in v.2584
  ViewVC Help
Powered by ViewVC