trunk/src/RIFF.h

/***************************************************************************
 *                                                                         *
 *   libgig - C++ cross-platform Gigasampler format file access library    *
 *                                                                         *
 *   Copyright (C) 2003-2010 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;

    /** @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);
            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*          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);
            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);
            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();
            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();
    };

    /** @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();
            bool          SetMode(stream_mode_t NewMode);
            void SetByteOrder(endian_t Endian);
            String GetFileName();
            virtual void Save();
            virtual void Save(const String& path);
            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;

            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);
            #if POSIX
            unsigned long __GetFileSize(int hFile);
            #elif defined(WIN32)
            unsigned long __GetFileSize(HANDLE hFile);
            #else
            unsigned long __GetFileSize(FILE* hFile);
            #endif
    };

    /**
     * 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	persson	2044	* Copyright (C) 2003-2010 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	1193	/** @brief Ordinary RIFF Chunk
173			*
174			* Provides convenient methods to access data of ordinary RIFF chunks
175			* in general.
176			*/
177	schoenebeck	2	class Chunk {
178			public:
179	schoenebeck	780	Chunk(File* pFile, unsigned long StartPos, List* Parent);
180	schoenebeck	2	String GetChunkIDString();
181	persson	1713	uint32_t GetChunkID() { return ChunkID; } ///< Chunk ID in unsigned integer representation.
182			List* GetParent() { return pParent; } ///< Returns pointer to the chunk's parent list chunk.
183			unsigned long GetSize() { return CurrentChunkSize; } ///< Chunk size in bytes (without header, thus the chunk data body)
184			unsigned long GetNewSize() { return NewChunkSize; } ///< New chunk size if it was modified with Resize().
185			unsigned long GetPos() { return ulPos; } ///< Position within the chunk data body
186			unsigned long GetFilePos() { return ulStartPos + ulPos; } ///< Current, actual offset in file.
187	schoenebeck	2	unsigned long SetPos(unsigned long Where, stream_whence_t Whence = stream_start);
188			unsigned long RemainingBytes();
189			stream_state_t GetState();
190			unsigned long Read(void* pData, unsigned long WordCount, unsigned long WordSize);
191			unsigned long ReadInt8(int8_t* pData, unsigned long WordCount = 1);
192			unsigned long ReadUint8(uint8_t* pData, unsigned long WordCount = 1);
193			unsigned long ReadInt16(int16_t* pData, unsigned long WordCount = 1);
194			unsigned long ReadUint16(uint16_t* pData, unsigned long WordCount = 1);
195			unsigned long ReadInt32(int32_t* pData, unsigned long WordCount = 1);
196			unsigned long ReadUint32(uint32_t* pData, unsigned long WordCount = 1);
197			int8_t ReadInt8();
198			uint8_t ReadUint8();
199			int16_t ReadInt16();
200			uint16_t ReadUint16();
201			int32_t ReadInt32();
202			uint32_t ReadUint32();
203	schoenebeck	780	unsigned long Write(void* pData, unsigned long WordCount, unsigned long WordSize);
204			unsigned long WriteInt8(int8_t* pData, unsigned long WordCount = 1);
205			unsigned long WriteUint8(uint8_t* pData, unsigned long WordCount = 1);
206			unsigned long WriteInt16(int16_t* pData, unsigned long WordCount = 1);
207			unsigned long WriteUint16(uint16_t* pData, unsigned long WordCount = 1);
208			unsigned long WriteInt32(int32_t* pData, unsigned long WordCount = 1);
209			unsigned long WriteUint32(uint32_t* pData, unsigned long WordCount = 1);
210			void* LoadChunkData();
211			void ReleaseChunkData();
212			void Resize(int iNewSize);
213	schoenebeck	384	virtual ~Chunk();
214	schoenebeck	2	protected:
215			uint32_t ChunkID;
216	schoenebeck	780	uint32_t CurrentChunkSize; /* in bytes */
217			uint32_t NewChunkSize; /* in bytes (if chunk was scheduled to be resized) */
218	schoenebeck	2	List* pParent;
219	schoenebeck	780	File* pFile;
220	schoenebeck	2	unsigned long ulStartPos; /* actual position in file where chunk (without header) starts */
221			unsigned long ulPos; /* # of bytes from ulStartPos */
222			uint8_t* pChunkData;
223	schoenebeck	800	unsigned long ulChunkDataSize;
224	schoenebeck	2
225	schoenebeck	780	Chunk(File* pFile);
226			Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize);
227	schoenebeck	2	void ReadHeader(unsigned long fPos);
228	schoenebeck	780	void WriteHeader(unsigned long fPos);
229	schoenebeck	2	unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);
230			inline void swapBytes_16(void* Word) {
231			uint8_t byteCache = ((uint8_t) Word);
232			((uint8_t) Word) = ((uint8_t) Word + 1);
233			((uint8_t) Word + 1) = byteCache;
234			}
235			inline void swapBytes_32(void* Word) {
236			uint8_t byteCache = ((uint8_t) Word);
237			((uint8_t) Word) = ((uint8_t) Word + 3);
238			((uint8_t) Word + 3) = byteCache;
239			byteCache = ((uint8_t) Word + 1);
240			((uint8_t) Word + 1) = ((uint8_t) Word + 2);
241			((uint8_t) Word + 2) = byteCache;
242			}
243			inline void swapBytes(void* Word, unsigned long WordSize) {
244			uint8_t byteCache;
245			unsigned long lo = 0, hi = WordSize - 1;
246			for (; lo < hi; hi--, lo++) {
247			byteCache = ((uint8_t) Word + lo);
248			((uint8_t) Word + lo) = ((uint8_t) Word + hi);
249			((uint8_t) Word + hi) = byteCache;
250			}
251			}
252			inline String convertToString(uint32_t word) {
253			String result;
254			for (int i = 0; i < 4; i++) {
255			uint8_t byte = ((uint8_t)(&word) + i);
256			char c = byte;
257			result += c;
258			}
259			return result;
260			}
261	schoenebeck	780	virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
262			virtual void __resetPos(); ///< Sets Chunk's read/write position to zero.
263
264			friend class List;
265	schoenebeck	2	};
266
267	schoenebeck	1193	/** @brief RIFF List Chunk
268			*
269			* Provides convenient methods to access data of RIFF list chunks and
270			* their subchunks.
271			*/
272	schoenebeck	2	class List : public Chunk {
273			public:
274	schoenebeck	780	List(File* pFile, unsigned long StartPos, List* Parent);
275	schoenebeck	2	String GetListTypeString();
276	schoenebeck	11	uint32_t GetListType() { return ListType; } ///< Returns unsigned integer representation of the list's ID
277			Chunk* GetSubChunk(uint32_t ChunkID);
278			List* GetSubList(uint32_t ListType);
279	schoenebeck	2	Chunk* GetFirstSubChunk();
280			Chunk* GetNextSubChunk();
281			List* GetFirstSubList();
282			List* GetNextSubList();
283			unsigned int CountSubChunks();
284			unsigned int CountSubChunks(uint32_t ChunkID);
285			unsigned int CountSubLists();
286			unsigned int CountSubLists(uint32_t ListType);
287	schoenebeck	780	Chunk* AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
288			List* AddSubList(uint32_t uiListType);
289			void DeleteSubChunk(Chunk* pSubChunk);
290	persson	1102	void MoveSubChunk(Chunk* pSrc, Chunk* pDst);
291	schoenebeck	384	virtual ~List();
292	schoenebeck	2	protected:
293			typedef std::map<uint32_t, RIFF::Chunk*> ChunkMap;
294			typedef std::list<Chunk*> ChunkList;
295
296			uint32_t ListType;
297			ChunkList* pSubChunks;
298			ChunkMap* pSubChunksMap;
299			ChunkList::iterator ChunksIterator;
300			ChunkList::iterator ListIterator;
301
302	schoenebeck	780	List(File* pFile);
303			List(File* pFile, List* pParent, uint32_t uiListID);
304	schoenebeck	2	void ReadHeader(unsigned long fPos);
305	schoenebeck	780	void WriteHeader(unsigned long fPos);
306	schoenebeck	2	void LoadSubChunks();
307	schoenebeck	833	void LoadSubChunksRecursively();
308	schoenebeck	780	virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
309			virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.
310	persson	1869	void DeleteChunkList();
311	schoenebeck	2	};
312
313	schoenebeck	1193	/** @brief RIFF File
314			*
315			* Handles arbitrary RIFF files and provides together with its base
316			* classes convenient methods to walk through, read and modify the
317			* file's RIFF tree.
318			*/
319	schoenebeck	2	class File : public List {
320			public:
321	schoenebeck	798	File(uint32_t FileType);
322	schoenebeck	2	File(const String& path);
323	schoenebeck	780	stream_mode_t GetMode();
324			bool SetMode(stream_mode_t NewMode);
325	persson	1184	void SetByteOrder(endian_t Endian);
326	schoenebeck	780	String GetFileName();
327			virtual void Save();
328			virtual void Save(const String& path);
329	schoenebeck	384	virtual ~File();
330	schoenebeck	780	protected:
331			#if POSIX
332			int hFileRead; ///< handle / descriptor for reading from file
333			int hFileWrite; ///< handle / descriptor for writing to (some) file
334	schoenebeck	1050	#elif defined(WIN32)
335			HANDLE hFileRead; ///< handle / descriptor for reading from file
336			HANDLE hFileWrite; ///< handle / descriptor for writing to (some) file
337	schoenebeck	780	#else
338			FILE* hFileRead; ///< handle / descriptor for reading from file
339			FILE* hFileWrite; ///< handle / descriptor for writing to (some) file
340			#endif // POSIX
341			String Filename;
342			bool bEndianNative;
343
344			void LogAsResized(Chunk* pResizedChunk);
345	schoenebeck	1095	void UnlogResized(Chunk* pResizedChunk);
346	schoenebeck	780	friend class Chunk;
347			friend class List;
348	schoenebeck	2	private:
349	schoenebeck	780	stream_mode_t Mode;
350	schoenebeck	1953	ChunkList ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).
351	schoenebeck	780
352	schoenebeck	2	unsigned long GetFileSize();
353	schoenebeck	780	void ResizeFile(unsigned long ulNewSize);
354	schoenebeck	798	#if POSIX
355			unsigned long __GetFileSize(int hFile);
356	schoenebeck	1050	#elif defined(WIN32)
357			unsigned long __GetFileSize(HANDLE hFile);
358	schoenebeck	798	#else
359			unsigned long __GetFileSize(FILE* hFile);
360			#endif
361	schoenebeck	2	};
362
363	schoenebeck	1193	/**
364			* Will be thrown whenever an error occurs while handling a RIFF file.
365			*/
366	schoenebeck	2	class Exception {
367			public:
368			String Message;
369
370	persson	1713	Exception(String Message) { Exception::Message = Message; }
371	schoenebeck	2	void PrintMessage();
372	persson	1713	virtual ~Exception() {}
373	schoenebeck	2	};
374
375	schoenebeck	518	String libraryName();
376			String libraryVersion();
377
378	schoenebeck	2	} // namespace RIFF
379			#endif // __RIFF_H__