--- libgig/trunk/src/RIFF.h 2007/03/18 07:13:06 1102 +++ libgig/trunk/src/RIFF.h 2014/05/31 20:54:39 2584 @@ -2,7 +2,7 @@ * * * libgig - C++ cross-platform Gigasampler format file access library * * * - * Copyright (C) 2003-2007 by Christian Schoenebeck * + * Copyright (C) 2003-2014 by Christian Schoenebeck * * * * * * This library is free software; you can redistribute it and/or modify * @@ -52,17 +52,23 @@ # 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++ # 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,10 +77,34 @@ # 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 + +# 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 + #endif // WORDS_BIGENDIAN #define CHUNK_HEADER_SIZE 8 @@ -82,7 +112,25 @@ #define RIFF_HEADER_SIZE 12 -/** RIFF specific classes and definitions */ +/** + * @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 */ @@ -114,17 +162,35 @@ 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 chunk structure of a 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. + }; + + /** @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. + uint32_t GetChunkID() { return ChunkID; } ///< Chunk ID in unsigned integer representation. + File* GetFile() { return pFile; } ///< Returns pointer to the chunk's File object. + List* GetParent() { return pParent; } ///< Returns pointer to the chunk's parent list chunk. + unsigned long GetSize() const { 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(); @@ -141,6 +207,7 @@ uint16_t ReadUint16(); int32_t ReadInt32(); uint32_t ReadUint32(); + void ReadString(String& s, int size); 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); @@ -205,7 +272,11 @@ 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); @@ -224,7 +295,8 @@ Chunk* AddSubChunk(uint32_t uiChunkID, uint uiBodySize); List* AddSubList(uint32_t uiListType); void DeleteSubChunk(Chunk* pSubChunk); - void MoveSubChunk(Chunk* pSrc, Chunk* pDst); + void MoveSubChunk(Chunk* pSrc, Chunk* pDst); // read API doc comments !!! + void MoveSubChunk(Chunk* pSrc, List* pNewParent); virtual ~List(); protected: typedef std::map ChunkMap; @@ -244,16 +316,27 @@ void LoadSubChunksRecursively(); virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset); 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); + File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout); stream_mode_t GetMode(); bool SetMode(stream_mode_t NewMode); + void SetByteOrder(endian_t Endian); String GetFileName(); + void SetFileName(const String& path); + bool IsNew() const; + layout_t GetLayout() const; virtual void Save(); virtual void Save(const String& path); virtual ~File(); @@ -270,6 +353,8 @@ #endif // POSIX String Filename; bool bEndianNative; + bool bIsNewFile; + layout_t Layout; ///< An ordinary RIFF file is always set to layout_standard. void LogAsResized(Chunk* pResizedChunk); void UnlogResized(Chunk* pResizedChunk); @@ -277,8 +362,9 @@ friend class List; private: stream_mode_t Mode; - ChunkList ResizedChunks; ///< All chunks which have been resized (enlarged / shortened). + ChunkList ResizedChunks; ///< All chunks which have been resized (enlarged / shortened). + void __openExistingFile(const String& path, uint32_t* FileType = NULL); unsigned long GetFileSize(); void ResizeFile(unsigned long ulNewSize); #if POSIX @@ -288,16 +374,19 @@ #else unsigned long __GetFileSize(FILE* hFile); #endif + 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();