/[svn]/libgig/trunk/src/RIFF.h
ViewVC logotype

Contents of /libgig/trunk/src/RIFF.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1953 - (show annotations) (download) (as text)
Thu Jul 30 08:16:02 2009 UTC (9 years, 7 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 14469 byte(s)
* preparations for release 3.3.0

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

  ViewVC Help
Powered by ViewVC