/[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 2703 by schoenebeck, Tue Jan 13 15:28:37 2015 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-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  *
# 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    
45  #ifdef HAVE_CONFIG_H  #ifdef HAVE_CONFIG_H
# Line 169  namespace RIFF { Line 170  namespace RIFF {
170          endian_native = 2          endian_native = 2
171      } endian_t;      } 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      /** @brief Ordinary RIFF Chunk
201       *       *
202       * 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 207  namespace RIFF {
207              Chunk(File* pFile, unsigned long StartPos, List* Parent);              Chunk(File* pFile, unsigned long StartPos, List* Parent);
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                File*          GetFile()    { return pFile;   }             ///< Returns pointer to the chunk's File object.
211              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.
212              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)
213              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().
214              unsigned long  GetPos()     { return ulPos; }               ///< Position within the chunk data body              unsigned long  GetPos()     { return ulPos; }               ///< Position within the chunk data body
215              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 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           ReadString(String& s, int size);
233              unsigned long  Write(void* pData, unsigned long WordCount, unsigned long WordSize);              unsigned long  Write(void* pData, unsigned long WordCount, unsigned long WordSize);
234              unsigned long  WriteInt8(int8_t* pData,     unsigned long WordCount = 1);              unsigned long  WriteInt8(int8_t* pData,     unsigned long WordCount = 1);
235              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 288  namespace RIFF {
288                  }                  }
289                  return result;                  return result;
290              }              }
291              virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);              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.              virtual void __resetPos(); ///< Sets Chunk's read/write position to zero.
293    
294              friend class List;              friend class List;
# Line 287  namespace RIFF { Line 317  namespace RIFF {
317              Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);              Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
318              List*        AddSubList(uint32_t uiListType);              List*        AddSubList(uint32_t uiListType);
319              void         DeleteSubChunk(Chunk* pSubChunk);              void         DeleteSubChunk(Chunk* pSubChunk);
320              void         MoveSubChunk(Chunk* pSrc, Chunk* pDst);              void         MoveSubChunk(Chunk* pSrc, Chunk* pDst); // read API doc comments !!!
321                void         MoveSubChunk(Chunk* pSrc, List* pNewParent);
322              virtual ~List();              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 303  namespace RIFF { Line 335  namespace RIFF {
335              List(File* pFile, List* pParent, uint32_t uiListID);              List(File* pFile, List* pParent, uint32_t uiListID);
336              void ReadHeader(unsigned long fPos);              void ReadHeader(unsigned long fPos);
337              void WriteHeader(unsigned long fPos);              void WriteHeader(unsigned long fPos);
338              void LoadSubChunks();              void LoadSubChunks(progress_t* pProgress = NULL);
339              void LoadSubChunksRecursively();              void LoadSubChunksRecursively(progress_t* pProgress = NULL);
340              virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);              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.              virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.
342              void DeleteChunkList();              void DeleteChunkList();
343      };      };
# Line 320  namespace RIFF { Line 352  namespace RIFF {
352          public:          public:
353              File(uint32_t FileType);              File(uint32_t FileType);
354              File(const String& path);              File(const String& path);
355                File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout);
356              stream_mode_t GetMode();              stream_mode_t GetMode();
357              bool          SetMode(stream_mode_t NewMode);              bool          SetMode(stream_mode_t NewMode);
358              void SetByteOrder(endian_t Endian);              void SetByteOrder(endian_t Endian);
359              String GetFileName();              String GetFileName();
360              virtual void Save();              void SetFileName(const String& path);
361              virtual void Save(const String& path);              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();              virtual ~File();
366          protected:          protected:
367              #if POSIX              #if POSIX
# Line 340  namespace RIFF { Line 376  namespace RIFF {
376              #endif // POSIX              #endif // POSIX
377              String Filename;              String Filename;
378              bool   bEndianNative;              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);              void LogAsResized(Chunk* pResizedChunk);
383              void UnlogResized(Chunk* pResizedChunk);              void UnlogResized(Chunk* pResizedChunk);
# Line 347  namespace RIFF { Line 385  namespace RIFF {
385              friend class List;              friend class List;
386          private:          private:
387              stream_mode_t  Mode;              stream_mode_t  Mode;
388              ChunkList ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).              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);              void ResizeFile(unsigned long ulNewSize);
393              #if POSIX              #if POSIX
Legend:
Removed from v.2155  
changed lines
  Added in v.2703
  ViewVC Help
Powered by ViewVC