trunk/src/RIFF.h

/***************************************************************************
 *                                                                         *
 *   libgig - C++ cross-platform Gigasampler format file access library    *
 *                                                                         *
 *   Copyright (C) 2003-2014 by Christian Schoenebeck                      *
 *                              <cuse@users.sourceforge.net>               *
 *                                                                         *
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this library; if not, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#ifndef __RIFF_H__
#define __RIFF_H__

#ifdef WIN32
# define POSIX 0
#endif

#ifndef POSIX
# define POSIX 1
#endif

#ifndef DEBUG
# define DEBUG 0
#endif

#include <string>
#include <list>
#include <map>
#include <iostream>

#ifdef HAVE_CONFIG_H
# include <config.h>
#endif

#if POSIX
# include <sys/types.h>
# include <sys/stat.h>
# include <fcntl.h>
# include <unistd.h>
#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 <stdint.h>
#endif

#ifdef WIN32
# include <windows.h>
  typedef unsigned int   uint;
#endif // WIN32

#include <stdio.h>

#if WORDS_BIGENDIAN
# 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
#define LIST_HEADER_SIZE        12
#define RIFF_HEADER_SIZE        12


/**
 * @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 */
    class Chunk;
    class List;
    class File;

    typedef std::string String;

    /** Whether file stream is open in read or in read/write mode. */
    typedef enum {
        stream_mode_read       = 0,
        stream_mode_read_write = 1,
        stream_mode_closed     = 2
    } stream_mode_t;

    /** Current state of the file stream. */
    typedef enum {
        stream_ready       = 0,
        stream_end_reached = 1,
        stream_closed      = 2
    } stream_state_t;

    /** File stream position dependent to these relations. */
    typedef enum {
        stream_start    = 0,
        stream_curpos   = 1,
        stream_backward = 2,
        stream_end      = 3
    } stream_whence_t;

    /** 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 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.
            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();
            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);
            int8_t         ReadInt8();
            uint8_t        ReadUint8();
            int16_t        ReadInt16();
            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);
            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*          LoadChunkData();
            void           ReleaseChunkData();
            void           Resize(int iNewSize);
            virtual ~Chunk();
        protected:
            uint32_t      ChunkID;
            uint32_t      CurrentChunkSize;             /* in bytes */
            uint32_t      NewChunkSize;                 /* 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 */
            uint8_t*      pChunkData;
            unsigned long ulChunkDataSize;

            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) {
                String result;
                for (int i = 0; i < 4; i++) {
                    uint8_t byte = *((uint8_t*)(&word) + i);
                    char c = byte;
                    result += c;
                }
                return result;
            }
            virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset, progress_t* pProgress = NULL);
            virtual void __resetPos(); ///< Sets Chunk's read/write position to zero.

            friend class List;
    };

    /** @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
            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);
            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<uint32_t, RIFF::Chunk*>  ChunkMap;
            typedef std::list<Chunk*>                 ChunkList;

            uint32_t   ListType;
            ChunkList* pSubChunks;
            ChunkMap*  pSubChunksMap;
            ChunkList::iterator ChunksIterator;
            ChunkList::iterator ListIterator;

            List(File* pFile);
            List(File* pFile, List* pParent, uint32_t uiListID);
            void ReadHeader(unsigned long fPos);
            void WriteHeader(unsigned long fPos);
            void LoadSubChunks(progress_t* pProgress = NULL);
            void LoadSubChunksRecursively(progress_t* pProgress = NULL);
            virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset, 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();
    };

    /** @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(progress_t* pProgress = NULL);
            virtual void Save(const String& path, progress_t* pProgress = NULL);
            virtual ~File();
        protected:
            #if POSIX
            int    hFileRead;  ///< handle / descriptor for reading from file
            int    hFileWrite; ///< handle / descriptor for writing to (some) file
            #elif defined(WIN32)
            HANDLE hFileRead;  ///< handle / descriptor for reading from file
            HANDLE hFileWrite; ///< handle / descriptor for writing to (some) file
            #else
            FILE*  hFileRead;  ///< handle / descriptor for reading from file
            FILE*  hFileWrite; ///< handle / descriptor for writing to (some) file
            #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);
            friend class Chunk;
            friend class List;
        private:
            stream_mode_t  Mode;
            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
            unsigned long __GetFileSize(int hFile);
            #elif defined(WIN32)
            unsigned long __GetFileSize(HANDLE hFile);
            #else
            unsigned long __GetFileSize(FILE* hFile);
            #endif
            void Cleanup();
    };

    /**
     * Will be thrown whenever an error occurs while handling a RIFF file.
     */
    class Exception {
        public:
            String Message;

            Exception(String Message) { Exception::Message = Message; }
            void PrintMessage();
            virtual ~Exception() {}
    };

    String libraryName();
    String libraryVersion();

} // namespace RIFF
#endif // __RIFF_H__
1	schoenebeck	2	/***************************************************************************
2			* *
3	schoenebeck	933	* libgig - C++ cross-platform Gigasampler format file access library *
4	schoenebeck	2	* *
5	schoenebeck	2543	* Copyright (C) 2003-2014 by Christian Schoenebeck *
6	schoenebeck	384	* <cuse@users.sourceforge.net> *
7	schoenebeck	2	* *
8			* This library is free software; you can redistribute it and/or modify *
9			* it under the terms of the GNU General Public License as published by *
10			* the Free Software Foundation; either version 2 of the License, or *
11			* (at your option) any later version. *
12			* *
13			* This library is distributed in the hope that it will be useful, *
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of *
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16			* GNU General Public License for more details. *
17			* *
18			* You should have received a copy of the GNU General Public License *
19			* along with this library; if not, write to the Free Software *
20			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21			* MA 02111-1307 USA *
22			***************************************************************************/
23
24			#ifndef __RIFF_H__
25			#define __RIFF_H__
26
27	schoenebeck	1050	#ifdef WIN32
28			# define POSIX 0
29			#endif
30	schoenebeck	2
31	schoenebeck	1050	#ifndef POSIX
32			# define POSIX 1
33			#endif
34
35			#ifndef DEBUG
36			# define DEBUG 0
37			#endif
38
39	schoenebeck	2	#include <string>
40			#include <list>
41			#include <map>
42			#include <iostream>
43
44	schoenebeck	11	#ifdef HAVE_CONFIG_H
45			# include <config.h>
46			#endif
47
48	schoenebeck	2	#if POSIX
49			# include <sys/types.h>
50			# include <sys/stat.h>
51			# include <fcntl.h>
52			# include <unistd.h>
53			#endif // POSIX
54
55	persson	1869	#ifdef _MSC_VER
56			// Visual C++ 2008 doesn't have stdint.h
57			typedef __int8 int8_t;
58			typedef __int16 int16_t;
59			typedef __int32 int32_t;
60			typedef __int64 int64_t;
61			typedef unsigned __int8 uint8_t;
62			typedef unsigned __int16 uint16_t;
63			typedef unsigned __int32 uint32_t;
64			typedef unsigned __int64 uint64_t;
65			#else
66	schoenebeck	2	#include <stdint.h>
67	persson	1869	#endif
68	schoenebeck	2
69	schoenebeck	1050	#ifdef WIN32
70			# include <windows.h>
71			typedef unsigned int uint;
72			#endif // WIN32
73	schoenebeck	2
74			#include <stdio.h>
75
76			#if WORDS_BIGENDIAN
77			# define CHUNK_ID_RIFF 0x52494646
78			# define CHUNK_ID_RIFX 0x52494658
79			# define CHUNK_ID_LIST 0x4C495354
80	persson	2044
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	schoenebeck	2	#else // little endian
93			# define CHUNK_ID_RIFF 0x46464952
94			# define CHUNK_ID_RIFX 0x58464952
95			# define CHUNK_ID_LIST 0x5453494C
96	persson	2044
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	schoenebeck	2	#endif // WORDS_BIGENDIAN
109
110			#define CHUNK_HEADER_SIZE 8
111			#define LIST_HEADER_SIZE 12
112			#define RIFF_HEADER_SIZE 12
113
114
115	schoenebeck	1193	/**
116			* @brief RIFF specific classes and definitions
117			*
118			* The Resource Interchange File Format (RIFF) is a generic tree-structured
119			* meta-format which stores data in so called "chunks". It can be compared
120			* to XML, but in contrast to XML, RIFF is entirely binary encoded, that is
121			* not ASCII based. RIFF is used as basis for many file formats like AVI,
122			* WAV, DLS and of course the Gigasampler file format. ;-)
123			*
124			* RIFF chunks can be seen as containers for data. There are two distinct
125			* types of chunks:
126			*
127			* - @e ordinary @e chunks are the leafs of the data tree which encapsulate
128			* the actual data of the file (i.e. the sample data of a .wav file)
129			*
130			* - @e list @e chunks are the nodes of the data tree which hold an
131			* arbitrary amount of subchunks (can be both, list chunks and/or ordinary
132			* chunks)
133			*/
134	schoenebeck	2	namespace RIFF {
135
136			/* just symbol prototyping */
137			class Chunk;
138			class List;
139	schoenebeck	780	class File;
140	schoenebeck	2
141			typedef std::string String;
142
143	schoenebeck	780	/** Whether file stream is open in read or in read/write mode. */
144			typedef enum {
145	schoenebeck	798	stream_mode_read = 0,
146			stream_mode_read_write = 1,
147			stream_mode_closed = 2
148	schoenebeck	780	} stream_mode_t;
149
150	schoenebeck	2	/** Current state of the file stream. */
151			typedef enum {
152			stream_ready = 0,
153			stream_end_reached = 1,
154			stream_closed = 2
155			} stream_state_t;
156
157			/** File stream position dependent to these relations. */
158			typedef enum {
159			stream_start = 0,
160			stream_curpos = 1,
161			stream_backward = 2,
162			stream_end = 3
163			} stream_whence_t;
164
165	schoenebeck	1193	/** Alignment of data bytes in memory (system dependant). */
166	persson	1183	typedef enum {
167			endian_little = 0,
168			endian_big = 1,
169			endian_native = 2
170			} endian_t;
171
172	schoenebeck	2543	/** 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	schoenebeck	2682	/**
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	schoenebeck	1193	/** @brief Ordinary RIFF Chunk
200			*
201			* Provides convenient methods to access data of ordinary RIFF chunks
202			* in general.
203			*/
204	schoenebeck	2	class Chunk {
205			public:
206	schoenebeck	780	Chunk(File* pFile, unsigned long StartPos, List* Parent);
207	schoenebeck	2	String GetChunkIDString();
208	persson	1713	uint32_t GetChunkID() { return ChunkID; } ///< Chunk ID in unsigned integer representation.
209	schoenebeck	2543	File* GetFile() { return pFile; } ///< Returns pointer to the chunk's File object.
210	persson	1713	List* GetParent() { return pParent; } ///< Returns pointer to the chunk's parent list chunk.
211	schoenebeck	2482	unsigned long GetSize() const { return CurrentChunkSize; } ///< Chunk size in bytes (without header, thus the chunk data body)
212	persson	1713	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
214			unsigned long GetFilePos() { return ulStartPos + ulPos; } ///< Current, actual offset in file.
215	schoenebeck	2	unsigned long SetPos(unsigned long Where, stream_whence_t Whence = stream_start);
216			unsigned long RemainingBytes();
217			stream_state_t GetState();
218			unsigned long Read(void* pData, unsigned long WordCount, unsigned long WordSize);
219			unsigned long ReadInt8(int8_t* pData, unsigned long WordCount = 1);
220			unsigned long ReadUint8(uint8_t* pData, unsigned long WordCount = 1);
221			unsigned long ReadInt16(int16_t* pData, unsigned long WordCount = 1);
222			unsigned long ReadUint16(uint16_t* pData, unsigned long WordCount = 1);
223			unsigned long ReadInt32(int32_t* pData, unsigned long WordCount = 1);
224			unsigned long ReadUint32(uint32_t* pData, unsigned long WordCount = 1);
225			int8_t ReadInt8();
226			uint8_t ReadUint8();
227			int16_t ReadInt16();
228			uint16_t ReadUint16();
229			int32_t ReadInt32();
230			uint32_t ReadUint32();
231	persson	2450	void ReadString(String& s, int size);
232	schoenebeck	780	unsigned long Write(void* pData, unsigned long WordCount, unsigned long WordSize);
233			unsigned long WriteInt8(int8_t* pData, unsigned long WordCount = 1);
234			unsigned long WriteUint8(uint8_t* pData, unsigned long WordCount = 1);
235			unsigned long WriteInt16(int16_t* pData, unsigned long WordCount = 1);
236			unsigned long WriteUint16(uint16_t* pData, unsigned long WordCount = 1);
237			unsigned long WriteInt32(int32_t* pData, unsigned long WordCount = 1);
238			unsigned long WriteUint32(uint32_t* pData, unsigned long WordCount = 1);
239			void* LoadChunkData();
240			void ReleaseChunkData();
241			void Resize(int iNewSize);
242	schoenebeck	384	virtual ~Chunk();
243	schoenebeck	2	protected:
244			uint32_t ChunkID;
245	schoenebeck	780	uint32_t CurrentChunkSize; /* in bytes */
246			uint32_t NewChunkSize; /* in bytes (if chunk was scheduled to be resized) */
247	schoenebeck	2	List* pParent;
248	schoenebeck	780	File* pFile;
249	schoenebeck	2	unsigned long ulStartPos; /* actual position in file where chunk (without header) starts */
250			unsigned long ulPos; /* # of bytes from ulStartPos */
251			uint8_t* pChunkData;
252	schoenebeck	800	unsigned long ulChunkDataSize;
253	schoenebeck	2
254	schoenebeck	780	Chunk(File* pFile);
255			Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize);
256	schoenebeck	2	void ReadHeader(unsigned long fPos);
257	schoenebeck	780	void WriteHeader(unsigned long fPos);
258	schoenebeck	2	unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);
259			inline void swapBytes_16(void* Word) {
260			uint8_t byteCache = ((uint8_t) Word);
261			((uint8_t) Word) = ((uint8_t) Word + 1);
262			((uint8_t) Word + 1) = byteCache;
263			}
264			inline void swapBytes_32(void* Word) {
265			uint8_t byteCache = ((uint8_t) Word);
266			((uint8_t) Word) = ((uint8_t) Word + 3);
267			((uint8_t) Word + 3) = byteCache;
268			byteCache = ((uint8_t) Word + 1);
269			((uint8_t) Word + 1) = ((uint8_t) Word + 2);
270			((uint8_t) Word + 2) = byteCache;
271			}
272			inline void swapBytes(void* Word, unsigned long WordSize) {
273			uint8_t byteCache;
274			unsigned long lo = 0, hi = WordSize - 1;
275			for (; lo < hi; hi--, lo++) {
276			byteCache = ((uint8_t) Word + lo);
277			((uint8_t) Word + lo) = ((uint8_t) Word + hi);
278			((uint8_t) Word + hi) = byteCache;
279			}
280			}
281			inline String convertToString(uint32_t word) {
282			String result;
283			for (int i = 0; i < 4; i++) {
284			uint8_t byte = ((uint8_t)(&word) + i);
285			char c = byte;
286			result += c;
287			}
288			return result;
289			}
290	schoenebeck	2682	virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset, progress_t* pProgress = NULL);
291	schoenebeck	780	virtual void __resetPos(); ///< Sets Chunk's read/write position to zero.
292
293			friend class List;
294	schoenebeck	2	};
295
296	schoenebeck	1193	/** @brief RIFF List Chunk
297			*
298			* Provides convenient methods to access data of RIFF list chunks and
299			* their subchunks.
300			*/
301	schoenebeck	2	class List : public Chunk {
302			public:
303	schoenebeck	780	List(File* pFile, unsigned long StartPos, List* Parent);
304	schoenebeck	2	String GetListTypeString();
305	schoenebeck	11	uint32_t GetListType() { return ListType; } ///< Returns unsigned integer representation of the list's ID
306			Chunk* GetSubChunk(uint32_t ChunkID);
307			List* GetSubList(uint32_t ListType);
308	schoenebeck	2	Chunk* GetFirstSubChunk();
309			Chunk* GetNextSubChunk();
310			List* GetFirstSubList();
311			List* GetNextSubList();
312			unsigned int CountSubChunks();
313			unsigned int CountSubChunks(uint32_t ChunkID);
314			unsigned int CountSubLists();
315			unsigned int CountSubLists(uint32_t ListType);
316	schoenebeck	780	Chunk* AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
317			List* AddSubList(uint32_t uiListType);
318			void DeleteSubChunk(Chunk* pSubChunk);
319	schoenebeck	2584	void MoveSubChunk(Chunk* pSrc, Chunk* pDst); // read API doc comments !!!
320			void MoveSubChunk(Chunk* pSrc, List* pNewParent);
321	schoenebeck	384	virtual ~List();
322	schoenebeck	2	protected:
323			typedef std::map<uint32_t, RIFF::Chunk*> ChunkMap;
324			typedef std::list<Chunk*> ChunkList;
325
326			uint32_t ListType;
327			ChunkList* pSubChunks;
328			ChunkMap* pSubChunksMap;
329			ChunkList::iterator ChunksIterator;
330			ChunkList::iterator ListIterator;
331
332	schoenebeck	780	List(File* pFile);
333			List(File* pFile, List* pParent, uint32_t uiListID);
334	schoenebeck	2	void ReadHeader(unsigned long fPos);
335	schoenebeck	780	void WriteHeader(unsigned long fPos);
336	schoenebeck	2682	void LoadSubChunks(progress_t* pProgress = NULL);
337			void LoadSubChunksRecursively(progress_t* pProgress = NULL);
338			virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset, progress_t* pProgress = NULL);
339	schoenebeck	780	virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.
340	persson	1869	void DeleteChunkList();
341	schoenebeck	2	};
342
343	schoenebeck	1193	/** @brief RIFF File
344			*
345			* Handles arbitrary RIFF files and provides together with its base
346			* classes convenient methods to walk through, read and modify the
347			* file's RIFF tree.
348			*/
349	schoenebeck	2	class File : public List {
350			public:
351	schoenebeck	798	File(uint32_t FileType);
352	schoenebeck	2	File(const String& path);
353	schoenebeck	2543	File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout);
354	schoenebeck	780	stream_mode_t GetMode();
355			bool SetMode(stream_mode_t NewMode);
356	persson	1184	void SetByteOrder(endian_t Endian);
357	schoenebeck	780	String GetFileName();
358	schoenebeck	2482	void SetFileName(const String& path);
359			bool IsNew() const;
360	schoenebeck	2543	layout_t GetLayout() const;
361	schoenebeck	2682	virtual void Save(progress_t* pProgress = NULL);
362			virtual void Save(const String& path, progress_t* pProgress = NULL);
363	schoenebeck	384	virtual ~File();
364	schoenebeck	780	protected:
365			#if POSIX
366			int hFileRead; ///< handle / descriptor for reading from file
367			int hFileWrite; ///< handle / descriptor for writing to (some) file
368	schoenebeck	1050	#elif defined(WIN32)
369			HANDLE hFileRead; ///< handle / descriptor for reading from file
370			HANDLE hFileWrite; ///< handle / descriptor for writing to (some) file
371	schoenebeck	780	#else
372			FILE* hFileRead; ///< handle / descriptor for reading from file
373			FILE* hFileWrite; ///< handle / descriptor for writing to (some) file
374			#endif // POSIX
375			String Filename;
376			bool bEndianNative;
377	schoenebeck	2482	bool bIsNewFile;
378	schoenebeck	2543	layout_t Layout; ///< An ordinary RIFF file is always set to layout_standard.
379	schoenebeck	780
380			void LogAsResized(Chunk* pResizedChunk);
381	schoenebeck	1095	void UnlogResized(Chunk* pResizedChunk);
382	schoenebeck	780	friend class Chunk;
383			friend class List;
384	schoenebeck	2	private:
385	schoenebeck	780	stream_mode_t Mode;
386	schoenebeck	1953	ChunkList ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).
387	schoenebeck	780
388	schoenebeck	2543	void __openExistingFile(const String& path, uint32_t* FileType = NULL);
389	schoenebeck	2	unsigned long GetFileSize();
390	schoenebeck	780	void ResizeFile(unsigned long ulNewSize);
391	schoenebeck	798	#if POSIX
392			unsigned long __GetFileSize(int hFile);
393	schoenebeck	1050	#elif defined(WIN32)
394			unsigned long __GetFileSize(HANDLE hFile);
395	schoenebeck	798	#else
396			unsigned long __GetFileSize(FILE* hFile);
397			#endif
398	persson	2155	void Cleanup();
399	schoenebeck	2	};
400
401	schoenebeck	1193	/**
402			* Will be thrown whenever an error occurs while handling a RIFF file.
403			*/
404	schoenebeck	2	class Exception {
405			public:
406			String Message;
407
408	persson	1713	Exception(String Message) { Exception::Message = Message; }
409	schoenebeck	2	void PrintMessage();
410	persson	1713	virtual ~Exception() {}
411	schoenebeck	2	};
412
413	schoenebeck	518	String libraryName();
414			String libraryVersion();
415
416	schoenebeck	2	} // namespace RIFF
417			#endif // __RIFF_H__