trunk/src/RIFF.h

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

#include <stdint.h>

#ifdef WIN32
# include "../win32/libgig_private.h" // like config.h, automatically generated by Dev-C++
# include <windows.h>
  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 <stdio.h>

#if WORDS_BIGENDIAN
# define CHUNK_ID_RIFF  0x52494646
# define CHUNK_ID_RIFX  0x52494658
# define CHUNK_ID_LIST  0x4C495354
#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


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

    /** @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	schoenebeck	1050	* Copyright (C) 2003-2007 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			#include <stdint.h>
56
57	schoenebeck	1050	#ifdef WIN32
58			# include "../win32/libgig_private.h" // like config.h, automatically generated by Dev-C++
59			# include <windows.h>
60			typedef unsigned int uint;
61			typedef unsigned char uint8_t;
62			typedef unsigned short uint16_t;
63			typedef unsigned int uint32_t;
64			# define PACKAGE "libgig"
65			# define VERSION VER_STRING // VER_STRING defined in libgig_private.h
66			#endif // WIN32
67	schoenebeck	2
68			#include <stdio.h>
69
70			#if WORDS_BIGENDIAN
71			# define CHUNK_ID_RIFF 0x52494646
72			# define CHUNK_ID_RIFX 0x52494658
73			# define CHUNK_ID_LIST 0x4C495354
74			#else // little endian
75			# define CHUNK_ID_RIFF 0x46464952
76			# define CHUNK_ID_RIFX 0x58464952
77			# define CHUNK_ID_LIST 0x5453494C
78			#endif // WORDS_BIGENDIAN
79
80			#define CHUNK_HEADER_SIZE 8
81			#define LIST_HEADER_SIZE 12
82			#define RIFF_HEADER_SIZE 12
83
84
85	schoenebeck	1193	/**
86			* @brief RIFF specific classes and definitions
87			*
88			* The Resource Interchange File Format (RIFF) is a generic tree-structured
89			* meta-format which stores data in so called "chunks". It can be compared
90			* to XML, but in contrast to XML, RIFF is entirely binary encoded, that is
91			* not ASCII based. RIFF is used as basis for many file formats like AVI,
92			* WAV, DLS and of course the Gigasampler file format. ;-)
93			*
94			* RIFF chunks can be seen as containers for data. There are two distinct
95			* types of chunks:
96			*
97			* - @e ordinary @e chunks are the leafs of the data tree which encapsulate
98			* the actual data of the file (i.e. the sample data of a .wav file)
99			*
100			* - @e list @e chunks are the nodes of the data tree which hold an
101			* arbitrary amount of subchunks (can be both, list chunks and/or ordinary
102			* chunks)
103			*/
104	schoenebeck	2	namespace RIFF {
105
106			/* just symbol prototyping */
107			class Chunk;
108			class List;
109	schoenebeck	780	class File;
110	schoenebeck	2
111			typedef std::string String;
112
113	schoenebeck	780	/** Whether file stream is open in read or in read/write mode. */
114			typedef enum {
115	schoenebeck	798	stream_mode_read = 0,
116			stream_mode_read_write = 1,
117			stream_mode_closed = 2
118	schoenebeck	780	} stream_mode_t;
119
120	schoenebeck	2	/** Current state of the file stream. */
121			typedef enum {
122			stream_ready = 0,
123			stream_end_reached = 1,
124			stream_closed = 2
125			} stream_state_t;
126
127			/** File stream position dependent to these relations. */
128			typedef enum {
129			stream_start = 0,
130			stream_curpos = 1,
131			stream_backward = 2,
132			stream_end = 3
133			} stream_whence_t;
134
135	schoenebeck	1193	/** Alignment of data bytes in memory (system dependant). */
136	persson	1183	typedef enum {
137			endian_little = 0,
138			endian_big = 1,
139			endian_native = 2
140			} endian_t;
141
142	schoenebeck	1193	/** @brief Ordinary RIFF Chunk
143			*
144			* Provides convenient methods to access data of ordinary RIFF chunks
145			* in general.
146			*/
147	schoenebeck	2	class Chunk {
148			public:
149	schoenebeck	780	Chunk(File* pFile, unsigned long StartPos, List* Parent);
150	schoenebeck	2	String GetChunkIDString();
151	schoenebeck	11	uint32_t GetChunkID() { return ChunkID; }; ///< Chunk ID in unsigned integer representation.
152			List* GetParent() { return pParent; }; ///< Returns pointer to the chunk's parent list chunk.
153	schoenebeck	780	unsigned long GetSize() { return CurrentChunkSize; }; ///< Chunk size in bytes (without header, thus the chunk data body)
154			unsigned long GetNewSize() { return NewChunkSize; }; ///< New chunk size if it was modified with Resize().
155	schoenebeck	11	unsigned long GetPos() { return ulPos; }; ///< Position within the chunk data body
156	schoenebeck	2	unsigned long GetFilePos() { return ulStartPos + ulPos; }; ///< Current, actual offset in file.
157			unsigned long SetPos(unsigned long Where, stream_whence_t Whence = stream_start);
158			unsigned long RemainingBytes();
159			stream_state_t GetState();
160			unsigned long Read(void* pData, unsigned long WordCount, unsigned long WordSize);
161			unsigned long ReadInt8(int8_t* pData, unsigned long WordCount = 1);
162			unsigned long ReadUint8(uint8_t* pData, unsigned long WordCount = 1);
163			unsigned long ReadInt16(int16_t* pData, unsigned long WordCount = 1);
164			unsigned long ReadUint16(uint16_t* pData, unsigned long WordCount = 1);
165			unsigned long ReadInt32(int32_t* pData, unsigned long WordCount = 1);
166			unsigned long ReadUint32(uint32_t* pData, unsigned long WordCount = 1);
167			int8_t ReadInt8();
168			uint8_t ReadUint8();
169			int16_t ReadInt16();
170			uint16_t ReadUint16();
171			int32_t ReadInt32();
172			uint32_t ReadUint32();
173	schoenebeck	780	unsigned long Write(void* pData, unsigned long WordCount, unsigned long WordSize);
174			unsigned long WriteInt8(int8_t* pData, unsigned long WordCount = 1);
175			unsigned long WriteUint8(uint8_t* pData, unsigned long WordCount = 1);
176			unsigned long WriteInt16(int16_t* pData, unsigned long WordCount = 1);
177			unsigned long WriteUint16(uint16_t* pData, unsigned long WordCount = 1);
178			unsigned long WriteInt32(int32_t* pData, unsigned long WordCount = 1);
179			unsigned long WriteUint32(uint32_t* pData, unsigned long WordCount = 1);
180			void* LoadChunkData();
181			void ReleaseChunkData();
182			void Resize(int iNewSize);
183	schoenebeck	384	virtual ~Chunk();
184	schoenebeck	2	protected:
185			uint32_t ChunkID;
186	schoenebeck	780	uint32_t CurrentChunkSize; /* in bytes */
187			uint32_t NewChunkSize; /* in bytes (if chunk was scheduled to be resized) */
188	schoenebeck	2	List* pParent;
189	schoenebeck	780	File* pFile;
190	schoenebeck	2	unsigned long ulStartPos; /* actual position in file where chunk (without header) starts */
191			unsigned long ulPos; /* # of bytes from ulStartPos */
192			uint8_t* pChunkData;
193	schoenebeck	800	unsigned long ulChunkDataSize;
194	schoenebeck	2
195	schoenebeck	780	Chunk(File* pFile);
196			Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize);
197	schoenebeck	2	void ReadHeader(unsigned long fPos);
198	schoenebeck	780	void WriteHeader(unsigned long fPos);
199	schoenebeck	2	unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);
200			inline void swapBytes_16(void* Word) {
201			uint8_t byteCache = ((uint8_t) Word);
202			((uint8_t) Word) = ((uint8_t) Word + 1);
203			((uint8_t) Word + 1) = byteCache;
204			}
205			inline void swapBytes_32(void* Word) {
206			uint8_t byteCache = ((uint8_t) Word);
207			((uint8_t) Word) = ((uint8_t) Word + 3);
208			((uint8_t) Word + 3) = byteCache;
209			byteCache = ((uint8_t) Word + 1);
210			((uint8_t) Word + 1) = ((uint8_t) Word + 2);
211			((uint8_t) Word + 2) = byteCache;
212			}
213			inline void swapBytes(void* Word, unsigned long WordSize) {
214			uint8_t byteCache;
215			unsigned long lo = 0, hi = WordSize - 1;
216			for (; lo < hi; hi--, lo++) {
217			byteCache = ((uint8_t) Word + lo);
218			((uint8_t) Word + lo) = ((uint8_t) Word + hi);
219			((uint8_t) Word + hi) = byteCache;
220			}
221			}
222			inline String convertToString(uint32_t word) {
223			String result;
224			for (int i = 0; i < 4; i++) {
225			uint8_t byte = ((uint8_t)(&word) + i);
226			char c = byte;
227			result += c;
228			}
229			return result;
230			}
231	schoenebeck	780	virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
232			virtual void __resetPos(); ///< Sets Chunk's read/write position to zero.
233
234			friend class List;
235	schoenebeck	2	};
236
237	schoenebeck	1193	/** @brief RIFF List Chunk
238			*
239			* Provides convenient methods to access data of RIFF list chunks and
240			* their subchunks.
241			*/
242	schoenebeck	2	class List : public Chunk {
243			public:
244	schoenebeck	780	List(File* pFile, unsigned long StartPos, List* Parent);
245	schoenebeck	2	String GetListTypeString();
246	schoenebeck	11	uint32_t GetListType() { return ListType; } ///< Returns unsigned integer representation of the list's ID
247			Chunk* GetSubChunk(uint32_t ChunkID);
248			List* GetSubList(uint32_t ListType);
249	schoenebeck	2	Chunk* GetFirstSubChunk();
250			Chunk* GetNextSubChunk();
251			List* GetFirstSubList();
252			List* GetNextSubList();
253			unsigned int CountSubChunks();
254			unsigned int CountSubChunks(uint32_t ChunkID);
255			unsigned int CountSubLists();
256			unsigned int CountSubLists(uint32_t ListType);
257	schoenebeck	780	Chunk* AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
258			List* AddSubList(uint32_t uiListType);
259			void DeleteSubChunk(Chunk* pSubChunk);
260	persson	1102	void MoveSubChunk(Chunk* pSrc, Chunk* pDst);
261	schoenebeck	384	virtual ~List();
262	schoenebeck	2	protected:
263			typedef std::map<uint32_t, RIFF::Chunk*> ChunkMap;
264			typedef std::list<Chunk*> ChunkList;
265
266			uint32_t ListType;
267			ChunkList* pSubChunks;
268			ChunkMap* pSubChunksMap;
269			ChunkList::iterator ChunksIterator;
270			ChunkList::iterator ListIterator;
271
272	schoenebeck	780	List(File* pFile);
273			List(File* pFile, List* pParent, uint32_t uiListID);
274	schoenebeck	2	void ReadHeader(unsigned long fPos);
275	schoenebeck	780	void WriteHeader(unsigned long fPos);
276	schoenebeck	2	void LoadSubChunks();
277	schoenebeck	833	void LoadSubChunksRecursively();
278	schoenebeck	780	virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
279			virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.
280	schoenebeck	2	};
281
282	schoenebeck	1193	/** @brief RIFF File
283			*
284			* Handles arbitrary RIFF files and provides together with its base
285			* classes convenient methods to walk through, read and modify the
286			* file's RIFF tree.
287			*/
288	schoenebeck	2	class File : public List {
289			public:
290	schoenebeck	798	File(uint32_t FileType);
291	schoenebeck	2	File(const String& path);
292	schoenebeck	780	stream_mode_t GetMode();
293			bool SetMode(stream_mode_t NewMode);
294	persson	1184	void SetByteOrder(endian_t Endian);
295	schoenebeck	780	String GetFileName();
296			virtual void Save();
297			virtual void Save(const String& path);
298	schoenebeck	384	virtual ~File();
299	schoenebeck	780	protected:
300			#if POSIX
301			int hFileRead; ///< handle / descriptor for reading from file
302			int hFileWrite; ///< handle / descriptor for writing to (some) file
303	schoenebeck	1050	#elif defined(WIN32)
304			HANDLE hFileRead; ///< handle / descriptor for reading from file
305			HANDLE hFileWrite; ///< handle / descriptor for writing to (some) file
306	schoenebeck	780	#else
307			FILE* hFileRead; ///< handle / descriptor for reading from file
308			FILE* hFileWrite; ///< handle / descriptor for writing to (some) file
309			#endif // POSIX
310			String Filename;
311			bool bEndianNative;
312
313			void LogAsResized(Chunk* pResizedChunk);
314	schoenebeck	1095	void UnlogResized(Chunk* pResizedChunk);
315	schoenebeck	780	friend class Chunk;
316			friend class List;
317	schoenebeck	2	private:
318	schoenebeck	780	stream_mode_t Mode;
319			ChunkList ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).
320
321	schoenebeck	2	unsigned long GetFileSize();
322	schoenebeck	780	void ResizeFile(unsigned long ulNewSize);
323	schoenebeck	798	#if POSIX
324			unsigned long __GetFileSize(int hFile);
325	schoenebeck	1050	#elif defined(WIN32)
326			unsigned long __GetFileSize(HANDLE hFile);
327	schoenebeck	798	#else
328			unsigned long __GetFileSize(FILE* hFile);
329			#endif
330	schoenebeck	2	};
331
332	schoenebeck	1193	/**
333			* Will be thrown whenever an error occurs while handling a RIFF file.
334			*/
335	schoenebeck	2	class Exception {
336			public:
337			String Message;
338
339			Exception(String Message) { Exception::Message = Message; };
340			void PrintMessage();
341			virtual ~Exception() {};
342			};
343
344	schoenebeck	518	String libraryName();
345			String libraryVersion();
346
347	schoenebeck	2	} // namespace RIFF
348			#endif // __RIFF_H__