--- libgig/trunk/src/RIFF.h 2007/03/12 18:16:55 1095 +++ libgig/trunk/src/RIFF.h 2016/05/18 18:04:49 2922 @@ -2,7 +2,7 @@ * * * libgig - C++ cross-platform Gigasampler format file access library * * * - * Copyright (C) 2003-2007 by Christian Schoenebeck * + * Copyright (C) 2003-2016 by Christian Schoenebeck * * * * * * This library is free software; you can redistribute it and/or modify * @@ -39,6 +39,7 @@ #include #include #include +#include #include #ifdef HAVE_CONFIG_H @@ -52,17 +53,26 @@ # include #endif // POSIX +#ifdef _MSC_VER +// Visual C++ 2008 doesn't have stdint.h +typedef __int8 int8_t; +typedef __int16 int16_t; +typedef __int32 int32_t; +typedef __int64 int64_t; +typedef unsigned __int8 uint8_t; +typedef unsigned __int16 uint16_t; +typedef unsigned __int32 uint32_t; +typedef unsigned __int64 uint64_t; +#else #include +#endif #ifdef WIN32 -# include "../win32/libgig_private.h" // like config.h, automatically generated by Dev-C++ +# if (_WIN32 && !_WIN64) || (__GNUC__ && !(__x86_64__ || __ppc64__)) /* if 32 bit windows compilation */ +# define _WIN32_WINNT 0x0501 /* Win XP (no service pack): required for 32 bit compilation for GetFileSizeEx() to be declared by windows.h */ +# endif # include typedef unsigned int uint; - typedef unsigned char uint8_t; - typedef unsigned short uint16_t; - typedef unsigned int uint32_t; -# define PACKAGE "libgig" -# define VERSION VER_STRING // VER_STRING defined in libgig_private.h #endif // WIN32 #include @@ -71,18 +81,59 @@ # define CHUNK_ID_RIFF 0x52494646 # define CHUNK_ID_RIFX 0x52494658 # define CHUNK_ID_LIST 0x4C495354 + +# define LIST_TYPE_INFO 0x494E464F +# define CHUNK_ID_ICMT 0x49434D54 +# define CHUNK_ID_ICOP 0x49434F50 +# define CHUNK_ID_ICRD 0x49435244 +# define CHUNK_ID_IENG 0x49454E47 +# define CHUNK_ID_INAM 0x494E414D +# define CHUNK_ID_IPRD 0x49505244 +# define CHUNK_ID_ISFT 0x49534654 + +# define CHUNK_ID_SMPL 0x736D706C + #else // little endian # define CHUNK_ID_RIFF 0x46464952 # define CHUNK_ID_RIFX 0x58464952 # define CHUNK_ID_LIST 0x5453494C -#endif // WORDS_BIGENDIAN -#define CHUNK_HEADER_SIZE 8 -#define LIST_HEADER_SIZE 12 -#define RIFF_HEADER_SIZE 12 +# define LIST_TYPE_INFO 0x4F464E49 +# define CHUNK_ID_ICMT 0x544D4349 +# define CHUNK_ID_ICOP 0x504F4349 +# define CHUNK_ID_ICRD 0x44524349 +# define CHUNK_ID_IENG 0x474E4549 +# define CHUNK_ID_INAM 0x4D414E49 +# define CHUNK_ID_IPRD 0x44525049 +# define CHUNK_ID_ISFT 0x54465349 +# define CHUNK_ID_SMPL 0x6C706D73 -/** RIFF specific classes and definitions */ +#endif // WORDS_BIGENDIAN + +#define CHUNK_HEADER_SIZE(fileOffsetSize) (4 + fileOffsetSize) +#define LIST_HEADER_SIZE(fileOffsetSize) (8 + fileOffsetSize) +#define RIFF_HEADER_SIZE(fileOffsetSize) (8 + fileOffsetSize) + +/** + * @brief RIFF specific classes and definitions + * + * The Resource Interchange File Format (RIFF) is a generic tree-structured + * meta-format which stores data in so called "chunks". It can be compared + * to XML, but in contrast to XML, RIFF is entirely binary encoded, that is + * not ASCII based. RIFF is used as basis for many file formats like AVI, + * WAV, DLS and of course the Gigasampler file format. ;-) + * + * RIFF chunks can be seen as containers for data. There are two distinct + * types of chunks: + * + * - @e ordinary @e chunks are the leafs of the data tree which encapsulate + * the actual data of the file (i.e. the sample data of a .wav file) + * + * - @e list @e chunks are the nodes of the data tree which hold an + * arbitrary amount of subchunks (can be both, list chunks and/or ordinary + * chunks) + */ namespace RIFF { /* just symbol prototyping */ @@ -92,6 +143,9 @@ typedef std::string String; + /** Type used by libgig for handling file positioning during file I/O tasks. */ + typedef uint64_t file_offset_t; + /** Whether file stream is open in read or in read/write mode. */ typedef enum { stream_mode_read = 0, @@ -114,83 +168,108 @@ stream_end = 3 } stream_whence_t; - /** Provides convenient methods to access data of RIFF chunks in general. */ + /** Alignment of data bytes in memory (system dependant). */ + typedef enum { + endian_little = 0, + endian_big = 1, + endian_native = 2 + } endian_t; + + /** General RIFF chunk structure of a RIFF file. */ + enum layout_t { + 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. + 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. + }; + + /** Size of RIFF file offsets used in all RIFF chunks' headers. @see File::GetFileOffsetSize() */ + enum offset_size_t { + 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. + offset_size_32bit = 4, ///< Always use 32 bit offsets (even for files larger than 4 GB). + offset_size_64bit = 8 ///< Always use 64 bit offsets (even for files smaller than 4 GB). + }; + + /** + * @brief Used for indicating the progress of a certain task. + * + * The function pointer argument has to be supplied with a valid + * function of the given signature which will then be called on + * progress changes. An equivalent progress_t structure will be passed + * back as argument to the callback function on each progress change. + * The factor field of the supplied progress_t structure will then + * reflect the current progress as value between 0.0 and 1.0. You might + * want to use the custom field for data needed in your callback + * function. + */ + struct progress_t { + void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification. + float factor; ///< Reflects current progress as value between 0.0 and 1.0. + void* custom; ///< This pointer can be used for arbitrary data. + float __range_min; ///< Only for internal usage, do not modify! + float __range_max; ///< Only for internal usage, do not modify! + progress_t(); + }; + + /** @brief Ordinary RIFF Chunk + * + * Provides convenient methods to access data of ordinary RIFF chunks + * in general. + */ class Chunk { public: - Chunk(File* pFile, unsigned long StartPos, List* Parent); - String GetChunkIDString(); - uint32_t GetChunkID() { return ChunkID; }; ///< Chunk ID in unsigned integer representation. - List* GetParent() { return pParent; }; ///< Returns pointer to the chunk's parent list chunk. - unsigned long GetSize() { return CurrentChunkSize; }; ///< Chunk size in bytes (without header, thus the chunk data body) - unsigned long GetNewSize() { return NewChunkSize; }; ///< New chunk size if it was modified with Resize(). - unsigned long GetPos() { return ulPos; }; ///< Position within the chunk data body - unsigned long GetFilePos() { return ulStartPos + ulPos; }; ///< Current, actual offset in file. - unsigned long SetPos(unsigned long Where, stream_whence_t Whence = stream_start); - unsigned long RemainingBytes(); - stream_state_t GetState(); - unsigned long Read(void* pData, unsigned long WordCount, unsigned long WordSize); - unsigned long ReadInt8(int8_t* pData, unsigned long WordCount = 1); - unsigned long ReadUint8(uint8_t* pData, unsigned long WordCount = 1); - unsigned long ReadInt16(int16_t* pData, unsigned long WordCount = 1); - unsigned long ReadUint16(uint16_t* pData, unsigned long WordCount = 1); - unsigned long ReadInt32(int32_t* pData, unsigned long WordCount = 1); - unsigned long ReadUint32(uint32_t* pData, unsigned long WordCount = 1); + Chunk(File* pFile, file_offset_t StartPos, List* Parent); + String GetChunkIDString() const; + uint32_t GetChunkID() const { return ChunkID; } ///< Chunk ID in unsigned integer representation. + File* GetFile() const { return pFile; } ///< Returns pointer to the chunk's File object. + List* GetParent() const { return pParent; } ///< Returns pointer to the chunk's parent list chunk. + file_offset_t GetSize() const { return ullCurrentChunkSize; } ///< Chunk size in bytes (without header, thus 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(). + file_offset_t GetPos() const { return ullPos; } ///< Position within the chunk data body (starting with 0). + file_offset_t GetFilePos() const { return ullStartPos + ullPos; } ///< Current, actual offset of chunk data body start in file. + file_offset_t SetPos(file_offset_t Where, stream_whence_t Whence = stream_start); + file_offset_t RemainingBytes() const; + stream_state_t GetState() const; + file_offset_t Read(void* pData, file_offset_t WordCount, file_offset_t WordSize); + file_offset_t ReadInt8(int8_t* pData, file_offset_t WordCount = 1); + file_offset_t ReadUint8(uint8_t* pData, file_offset_t WordCount = 1); + file_offset_t ReadInt16(int16_t* pData, file_offset_t WordCount = 1); + file_offset_t ReadUint16(uint16_t* pData, file_offset_t WordCount = 1); + file_offset_t ReadInt32(int32_t* pData, file_offset_t WordCount = 1); + file_offset_t ReadUint32(uint32_t* pData, file_offset_t WordCount = 1); int8_t ReadInt8(); uint8_t ReadUint8(); int16_t ReadInt16(); uint16_t ReadUint16(); int32_t ReadInt32(); uint32_t ReadUint32(); - unsigned long Write(void* pData, unsigned long WordCount, unsigned long WordSize); - unsigned long WriteInt8(int8_t* pData, unsigned long WordCount = 1); - unsigned long WriteUint8(uint8_t* pData, unsigned long WordCount = 1); - unsigned long WriteInt16(int16_t* pData, unsigned long WordCount = 1); - unsigned long WriteUint16(uint16_t* pData, unsigned long WordCount = 1); - unsigned long WriteInt32(int32_t* pData, unsigned long WordCount = 1); - unsigned long WriteUint32(uint32_t* pData, unsigned long WordCount = 1); + void ReadString(String& s, int size); + file_offset_t Write(void* pData, file_offset_t WordCount, file_offset_t WordSize); + file_offset_t WriteInt8(int8_t* pData, file_offset_t WordCount = 1); + file_offset_t WriteUint8(uint8_t* pData, file_offset_t WordCount = 1); + file_offset_t WriteInt16(int16_t* pData, file_offset_t WordCount = 1); + file_offset_t WriteUint16(uint16_t* pData, file_offset_t WordCount = 1); + file_offset_t WriteInt32(int32_t* pData, file_offset_t WordCount = 1); + file_offset_t WriteUint32(uint32_t* pData, file_offset_t WordCount = 1); void* LoadChunkData(); void ReleaseChunkData(); - void Resize(int iNewSize); + void Resize(file_offset_t NewSize); virtual ~Chunk(); protected: uint32_t ChunkID; - uint32_t CurrentChunkSize; /* in bytes */ - uint32_t NewChunkSize; /* in bytes (if chunk was scheduled to be resized) */ + file_offset_t ullCurrentChunkSize; /* in bytes */ + file_offset_t ullNewChunkSize; /* in bytes (if chunk was scheduled to be resized) */ List* pParent; File* pFile; - unsigned long ulStartPos; /* actual position in file where chunk (without header) starts */ - unsigned long ulPos; /* # of bytes from ulStartPos */ + file_offset_t ullStartPos; /* actual position in file where chunk data (without header) starts */ + file_offset_t ullPos; /* # of bytes from ulStartPos */ uint8_t* pChunkData; - unsigned long ulChunkDataSize; + file_offset_t ullChunkDataSize; Chunk(File* pFile); - Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize); - void ReadHeader(unsigned long fPos); - void WriteHeader(unsigned long fPos); - unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize); - inline void swapBytes_16(void* 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) { + Chunk(File* pFile, List* pParent, uint32_t uiChunkID, file_offset_t ullBodySize); + void ReadHeader(file_offset_t filePos); + void WriteHeader(file_offset_t filePos); + file_offset_t ReadSceptical(void* pData, file_offset_t WordCount, file_offset_t WordSize); + inline static String convertToString(uint32_t word) { String result; for (int i = 0; i < 4; i++) { uint8_t byte = *((uint8_t*)(&word) + i); @@ -199,35 +278,43 @@ } return result; } - virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset); + virtual file_offset_t RequiredPhysicalSize(int fileOffsetSize); + virtual file_offset_t WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t* pProgress = NULL); virtual void __resetPos(); ///< Sets Chunk's read/write position to zero. friend class List; }; - /** Provides convenient methods to access data of RIFF list chunks and their subchunks. */ + /** @brief RIFF List Chunk + * + * Provides convenient methods to access data of RIFF list chunks and + * their subchunks. + */ class List : public Chunk { public: - List(File* pFile, unsigned long StartPos, List* Parent); - String GetListTypeString(); - uint32_t GetListType() { return ListType; } ///< Returns unsigned integer representation of the list's ID + List(File* pFile, file_offset_t StartPos, List* Parent); + String GetListTypeString() const; + uint32_t GetListType() const { return ListType; } ///< Returns unsigned integer representation of the list's ID Chunk* GetSubChunk(uint32_t ChunkID); List* GetSubList(uint32_t ListType); Chunk* GetFirstSubChunk(); Chunk* GetNextSubChunk(); List* GetFirstSubList(); List* GetNextSubList(); - unsigned int CountSubChunks(); - unsigned int CountSubChunks(uint32_t ChunkID); - unsigned int CountSubLists(); - unsigned int CountSubLists(uint32_t ListType); - Chunk* AddSubChunk(uint32_t uiChunkID, uint uiBodySize); + size_t CountSubChunks(); + size_t CountSubChunks(uint32_t ChunkID); + size_t CountSubLists(); + size_t CountSubLists(uint32_t ListType); + Chunk* AddSubChunk(uint32_t uiChunkID, file_offset_t ullBodySize); List* AddSubList(uint32_t uiListType); void DeleteSubChunk(Chunk* pSubChunk); + void MoveSubChunk(Chunk* pSrc, Chunk* pDst); // read API doc comments !!! + void MoveSubChunk(Chunk* pSrc, List* pNewParent); virtual ~List(); protected: typedef std::map ChunkMap; typedef std::list ChunkList; + typedef std::set ChunkSet; uint32_t ListType; ChunkList* pSubChunks; @@ -237,24 +324,42 @@ List(File* pFile); List(File* pFile, List* pParent, uint32_t uiListID); - void ReadHeader(unsigned long fPos); - void WriteHeader(unsigned long fPos); - void LoadSubChunks(); - void LoadSubChunksRecursively(); - virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset); + void ReadHeader(file_offset_t filePos); + void WriteHeader(file_offset_t filePos); + void LoadSubChunks(progress_t* pProgress = NULL); + void LoadSubChunksRecursively(progress_t* pProgress = NULL); + virtual file_offset_t RequiredPhysicalSize(int fileOffsetSize); + virtual file_offset_t WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t* pProgress = NULL); virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same. + void DeleteChunkList(); }; - /** Parses arbitrary RIFF files and provides together with it's base classes convenient methods to walk through the RIFF tree. */ + /** @brief RIFF File + * + * Handles arbitrary RIFF files and provides together with its base + * classes convenient methods to walk through, read and modify the + * file's RIFF tree. + */ class File : public List { public: File(uint32_t FileType); File(const String& path); - stream_mode_t GetMode(); + File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout, offset_size_t fileOffsetSize = offset_size_auto); + stream_mode_t GetMode() const; bool SetMode(stream_mode_t NewMode); - String GetFileName(); - virtual void Save(); - virtual void Save(const String& path); + void SetByteOrder(endian_t Endian); + String GetFileName() const; + void SetFileName(const String& path); + bool IsNew() const; + layout_t GetLayout() const; + file_offset_t GetCurrentFileSize() const; + file_offset_t GetRequiredFileSize(); + file_offset_t GetRequiredFileSize(offset_size_t fileOffsetSize); + int GetFileOffsetSize() const; + int GetRequiredFileOffsetSize(); + + virtual void Save(progress_t* pProgress = NULL); + virtual void Save(const String& path, progress_t* pProgress = NULL); virtual ~File(); protected: #if POSIX @@ -269,34 +374,39 @@ #endif // POSIX String Filename; bool bEndianNative; + bool bIsNewFile; + layout_t Layout; ///< An ordinary RIFF file is always set to layout_standard. + offset_size_t FileOffsetPreference; + int FileOffsetSize; ///< Size of file offsets (in bytes) when this file was opened (or saved the last time). - void LogAsResized(Chunk* pResizedChunk); - void UnlogResized(Chunk* pResizedChunk); friend class Chunk; friend class List; private: stream_mode_t Mode; - ChunkList ResizedChunks; ///< All chunks which have been resized (enlarged / shortened). - unsigned long GetFileSize(); - void ResizeFile(unsigned long ulNewSize); + void __openExistingFile(const String& path, uint32_t* FileType = NULL); + void ResizeFile(file_offset_t ullNewSize); #if POSIX - unsigned long __GetFileSize(int hFile); + file_offset_t __GetFileSize(int hFile) const; #elif defined(WIN32) - unsigned long __GetFileSize(HANDLE hFile); + file_offset_t __GetFileSize(HANDLE hFile) const; #else - unsigned long __GetFileSize(FILE* hFile); + file_offset_t __GetFileSize(FILE* hFile) const; #endif + int FileOffsetSizeFor(file_offset_t fileSize) const; + void Cleanup(); }; - /** Will be thrown whenever an error occurs while parsing a RIFF file. */ + /** + * Will be thrown whenever an error occurs while handling a RIFF file. + */ class Exception { public: String Message; - Exception(String Message) { Exception::Message = Message; }; + Exception(String Message) { Exception::Message = Message; } void PrintMessage(); - virtual ~Exception() {}; + virtual ~Exception() {} }; String libraryName();