/[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 2155 by persson, Thu Jan 6 11:33:40 2011 UTC revision 2682 by schoenebeck, Mon Dec 29 16:25:51 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-2011 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 169  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        /**
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      /** @brief Ordinary RIFF Chunk
200       *       *
201       * Provides convenient methods to access data of ordinary RIFF chunks       * Provides convenient methods to access data of ordinary RIFF chunks
# Line 179  namespace RIFF { Line 206  namespace RIFF {
206              Chunk(File* pFile, unsigned long StartPos, List* Parent);              Chunk(File* pFile, unsigned long StartPos, List* Parent);
207              String         GetChunkIDString();              String         GetChunkIDString();
208              uint32_t       GetChunkID() { return ChunkID; }             ///< Chunk ID in unsigned integer representation.              uint32_t       GetChunkID() { return ChunkID; }             ///< Chunk ID in unsigned integer representation.
209                File*          GetFile()    { return pFile;   }             ///< Returns pointer to the chunk's File object.
210              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.
211              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)
212              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().
213              unsigned long  GetPos()     { return ulPos; }               ///< Position within the chunk data body              unsigned long  GetPos()     { return ulPos; }               ///< Position within the chunk data body
214              unsigned long  GetFilePos() { return ulStartPos + ulPos; }  ///< Current, actual offset in file.              unsigned long  GetFilePos() { return ulStartPos + ulPos; }  ///< Current, actual offset in file.
# Line 200  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           ReadString(String& s, int size);
232              unsigned long  Write(void* pData, unsigned long WordCount, unsigned long WordSize);              unsigned long  Write(void* pData, unsigned long WordCount, unsigned long WordSize);
233              unsigned long  WriteInt8(int8_t* pData,     unsigned long WordCount = 1);              unsigned long  WriteInt8(int8_t* pData,     unsigned long WordCount = 1);
234              unsigned long  WriteUint8(uint8_t* pData,   unsigned long WordCount = 1);              unsigned long  WriteUint8(uint8_t* pData,   unsigned long WordCount = 1);
# Line 258  namespace RIFF { Line 287  namespace RIFF {
287                  }                  }
288                  return result;                  return result;
289              }              }
290              virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);              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.              virtual void __resetPos(); ///< Sets Chunk's read/write position to zero.
292    
293              friend class List;              friend class List;
# Line 287  namespace RIFF { Line 316  namespace RIFF {
316              Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);              Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
317              List*        AddSubList(uint32_t uiListType);              List*        AddSubList(uint32_t uiListType);
318              void         DeleteSubChunk(Chunk* pSubChunk);              void         DeleteSubChunk(Chunk* pSubChunk);
319              void         MoveSubChunk(Chunk* pSrc, Chunk* pDst);              void         MoveSubChunk(Chunk* pSrc, Chunk* pDst); // read API doc comments !!!
320                void         MoveSubChunk(Chunk* pSrc, List* pNewParent);
321              virtual ~List();              virtual ~List();
322          protected:          protected:
323              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;
# Line 303  namespace RIFF { Line 333  namespace RIFF {
333              List(File* pFile, List* pParent, uint32_t uiListID);              List(File* pFile, List* pParent, uint32_t uiListID);
334              void ReadHeader(unsigned long fPos);              void ReadHeader(unsigned long fPos);
335              void WriteHeader(unsigned long fPos);              void WriteHeader(unsigned long fPos);
336              void LoadSubChunks();              void LoadSubChunks(progress_t* pProgress = NULL);
337              void LoadSubChunksRecursively();              void LoadSubChunksRecursively(progress_t* pProgress = NULL);
338              virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);              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.              virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.
340              void DeleteChunkList();              void DeleteChunkList();
341      };      };
# Line 320  namespace RIFF { Line 350  namespace RIFF {
350          public:          public:
351              File(uint32_t FileType);              File(uint32_t FileType);
352              File(const String& path);              File(const String& path);
353                File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout);
354              stream_mode_t GetMode();              stream_mode_t GetMode();
355              bool          SetMode(stream_mode_t NewMode);              bool          SetMode(stream_mode_t NewMode);
356              void SetByteOrder(endian_t Endian);              void SetByteOrder(endian_t Endian);
357              String GetFileName();              String GetFileName();
358              virtual void Save();              void SetFileName(const String& path);
359              virtual void Save(const String& path);              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();              virtual ~File();
364          protected:          protected:
365              #if POSIX              #if POSIX
# Line 340  namespace RIFF { Line 374  namespace RIFF {
374              #endif // POSIX              #endif // POSIX
375              String Filename;              String Filename;
376              bool   bEndianNative;              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);              void LogAsResized(Chunk* pResizedChunk);
381              void UnlogResized(Chunk* pResizedChunk);              void UnlogResized(Chunk* pResizedChunk);
# Line 349  namespace RIFF { Line 385  namespace RIFF {
385              stream_mode_t  Mode;              stream_mode_t  Mode;
386              ChunkList ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).              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);              void ResizeFile(unsigned long ulNewSize);
391              #if POSIX              #if POSIX
Legend:
Removed from v.2155  
changed lines
  Added in v.2682
  ViewVC Help
Powered by ViewVC