1 |
/*************************************************************************** |
/*************************************************************************** |
2 |
* * |
* * |
3 |
* libgig - C++ cross-platform Gigasampler format file loader library * |
* libgig - C++ cross-platform Gigasampler format file access library * |
4 |
* * |
* * |
5 |
* Copyright (C) 2003-2005 by Christian Schoenebeck * |
* Copyright (C) 2003-2007 by Christian Schoenebeck * |
6 |
* <cuse@users.sourceforge.net> * |
* <cuse@users.sourceforge.net> * |
7 |
* * |
* * |
8 |
* This library is free software; you can redistribute it and/or modify * |
* This library is free software; you can redistribute it and/or modify * |
24 |
#ifndef __RIFF_H__ |
#ifndef __RIFF_H__ |
25 |
#define __RIFF_H__ |
#define __RIFF_H__ |
26 |
|
|
27 |
#define POSIX 1 |
#ifdef WIN32 |
28 |
#define DEBUG 0 |
# 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> |
#include <string> |
40 |
#include <list> |
#include <list> |
41 |
|
#include <set> |
42 |
#include <map> |
#include <map> |
43 |
#include <iostream> |
#include <iostream> |
44 |
|
|
53 |
# include <unistd.h> |
# include <unistd.h> |
54 |
#endif // POSIX |
#endif // POSIX |
55 |
|
|
56 |
|
#ifdef _MSC_VER |
57 |
|
// Visual C++ 2008 doesn't have stdint.h |
58 |
|
typedef __int8 int8_t; |
59 |
|
typedef __int16 int16_t; |
60 |
|
typedef __int32 int32_t; |
61 |
|
typedef __int64 int64_t; |
62 |
|
typedef unsigned __int8 uint8_t; |
63 |
|
typedef unsigned __int16 uint16_t; |
64 |
|
typedef unsigned __int32 uint32_t; |
65 |
|
typedef unsigned __int64 uint64_t; |
66 |
|
#else |
67 |
#include <stdint.h> |
#include <stdint.h> |
68 |
|
#endif |
69 |
|
|
70 |
//typedef unsigned char uint8_t; |
#ifdef WIN32 |
71 |
//typedef unsigned short uint16_t; |
# include <windows.h> |
72 |
//typedef unsigned int uint32_t; |
typedef unsigned int uint; |
73 |
|
#endif // WIN32 |
74 |
|
|
75 |
#include <stdio.h> |
#include <stdio.h> |
76 |
|
|
89 |
#define RIFF_HEADER_SIZE 12 |
#define RIFF_HEADER_SIZE 12 |
90 |
|
|
91 |
|
|
92 |
/** RIFF specific classes and definitions */ |
/** |
93 |
|
* @brief RIFF specific classes and definitions |
94 |
|
* |
95 |
|
* The Resource Interchange File Format (RIFF) is a generic tree-structured |
96 |
|
* meta-format which stores data in so called "chunks". It can be compared |
97 |
|
* to XML, but in contrast to XML, RIFF is entirely binary encoded, that is |
98 |
|
* not ASCII based. RIFF is used as basis for many file formats like AVI, |
99 |
|
* WAV, DLS and of course the Gigasampler file format. ;-) |
100 |
|
* |
101 |
|
* RIFF chunks can be seen as containers for data. There are two distinct |
102 |
|
* types of chunks: |
103 |
|
* |
104 |
|
* - @e ordinary @e chunks are the leafs of the data tree which encapsulate |
105 |
|
* the actual data of the file (i.e. the sample data of a .wav file) |
106 |
|
* |
107 |
|
* - @e list @e chunks are the nodes of the data tree which hold an |
108 |
|
* arbitrary amount of subchunks (can be both, list chunks and/or ordinary |
109 |
|
* chunks) |
110 |
|
*/ |
111 |
namespace RIFF { |
namespace RIFF { |
112 |
|
|
113 |
/* just symbol prototyping */ |
/* just symbol prototyping */ |
119 |
|
|
120 |
/** Whether file stream is open in read or in read/write mode. */ |
/** Whether file stream is open in read or in read/write mode. */ |
121 |
typedef enum { |
typedef enum { |
122 |
stream_mode_read, |
stream_mode_read = 0, |
123 |
stream_mode_read_write |
stream_mode_read_write = 1, |
124 |
|
stream_mode_closed = 2 |
125 |
} stream_mode_t; |
} stream_mode_t; |
126 |
|
|
127 |
/** Current state of the file stream. */ |
/** Current state of the file stream. */ |
139 |
stream_end = 3 |
stream_end = 3 |
140 |
} stream_whence_t; |
} stream_whence_t; |
141 |
|
|
142 |
/** Provides convenient methods to access data of RIFF chunks in general. */ |
/** Alignment of data bytes in memory (system dependant). */ |
143 |
|
typedef enum { |
144 |
|
endian_little = 0, |
145 |
|
endian_big = 1, |
146 |
|
endian_native = 2 |
147 |
|
} endian_t; |
148 |
|
|
149 |
|
/** @brief Ordinary RIFF Chunk |
150 |
|
* |
151 |
|
* Provides convenient methods to access data of ordinary RIFF chunks |
152 |
|
* in general. |
153 |
|
*/ |
154 |
class Chunk { |
class Chunk { |
155 |
public: |
public: |
156 |
Chunk(File* pFile, unsigned long StartPos, List* Parent); |
Chunk(File* pFile, unsigned long StartPos, List* Parent); |
157 |
String GetChunkIDString(); |
String GetChunkIDString(); |
158 |
uint32_t GetChunkID() { return ChunkID; }; ///< Chunk ID in unsigned integer representation. |
uint32_t GetChunkID() { return ChunkID; } ///< Chunk ID in unsigned integer representation. |
159 |
List* GetParent() { return pParent; }; ///< Returns pointer to the chunk's parent list chunk. |
List* GetParent() { return pParent; } ///< Returns pointer to the chunk's parent list chunk. |
160 |
unsigned long GetSize() { return CurrentChunkSize; }; ///< Chunk size in bytes (without header, thus the chunk data body) |
unsigned long GetSize() { return CurrentChunkSize; } ///< Chunk size in bytes (without header, thus the chunk data body) |
161 |
unsigned long GetNewSize() { return NewChunkSize; }; ///< New chunk size if it was modified with Resize(). |
unsigned long GetNewSize() { return NewChunkSize; } ///< New chunk size if it was modified with Resize(). |
162 |
unsigned long GetPos() { return ulPos; }; ///< Position within the chunk data body |
unsigned long GetPos() { return ulPos; } ///< Position within the chunk data body |
163 |
unsigned long GetFilePos() { return ulStartPos + ulPos; }; ///< Current, actual offset in file. |
unsigned long GetFilePos() { return ulStartPos + ulPos; } ///< Current, actual offset in file. |
164 |
unsigned long SetPos(unsigned long Where, stream_whence_t Whence = stream_start); |
unsigned long SetPos(unsigned long Where, stream_whence_t Whence = stream_start); |
165 |
unsigned long RemainingBytes(); |
unsigned long RemainingBytes(); |
166 |
stream_state_t GetState(); |
stream_state_t GetState(); |
197 |
unsigned long ulStartPos; /* actual position in file where chunk (without header) starts */ |
unsigned long ulStartPos; /* actual position in file where chunk (without header) starts */ |
198 |
unsigned long ulPos; /* # of bytes from ulStartPos */ |
unsigned long ulPos; /* # of bytes from ulStartPos */ |
199 |
uint8_t* pChunkData; |
uint8_t* pChunkData; |
200 |
|
unsigned long ulChunkDataSize; |
201 |
|
|
202 |
Chunk(File* pFile); |
Chunk(File* pFile); |
203 |
Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize); |
Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize); |
241 |
friend class List; |
friend class List; |
242 |
}; |
}; |
243 |
|
|
244 |
/** Provides convenient methods to access data of RIFF list chunks and their subchunks. */ |
/** @brief RIFF List Chunk |
245 |
|
* |
246 |
|
* Provides convenient methods to access data of RIFF list chunks and |
247 |
|
* their subchunks. |
248 |
|
*/ |
249 |
class List : public Chunk { |
class List : public Chunk { |
250 |
public: |
public: |
251 |
List(File* pFile, unsigned long StartPos, List* Parent); |
List(File* pFile, unsigned long StartPos, List* Parent); |
264 |
Chunk* AddSubChunk(uint32_t uiChunkID, uint uiBodySize); |
Chunk* AddSubChunk(uint32_t uiChunkID, uint uiBodySize); |
265 |
List* AddSubList(uint32_t uiListType); |
List* AddSubList(uint32_t uiListType); |
266 |
void DeleteSubChunk(Chunk* pSubChunk); |
void DeleteSubChunk(Chunk* pSubChunk); |
267 |
|
void MoveSubChunk(Chunk* pSrc, Chunk* pDst); |
268 |
virtual ~List(); |
virtual ~List(); |
269 |
protected: |
protected: |
270 |
typedef std::map<uint32_t, RIFF::Chunk*> ChunkMap; |
typedef std::map<uint32_t, RIFF::Chunk*> ChunkMap; |
281 |
void ReadHeader(unsigned long fPos); |
void ReadHeader(unsigned long fPos); |
282 |
void WriteHeader(unsigned long fPos); |
void WriteHeader(unsigned long fPos); |
283 |
void LoadSubChunks(); |
void LoadSubChunks(); |
284 |
|
void LoadSubChunksRecursively(); |
285 |
virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset); |
virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset); |
286 |
virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same. |
virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same. |
287 |
|
void DeleteChunkList(); |
288 |
}; |
}; |
289 |
|
|
290 |
/** Parses arbitrary RIFF files and provides together with it's base classes convenient methods to walk through the RIFF tree. */ |
/** @brief RIFF File |
291 |
|
* |
292 |
|
* Handles arbitrary RIFF files and provides together with its base |
293 |
|
* classes convenient methods to walk through, read and modify the |
294 |
|
* file's RIFF tree. |
295 |
|
*/ |
296 |
class File : public List { |
class File : public List { |
297 |
public: |
public: |
298 |
File(); |
File(uint32_t FileType); |
299 |
File(const String& path); |
File(const String& path); |
300 |
stream_mode_t GetMode(); |
stream_mode_t GetMode(); |
301 |
bool SetMode(stream_mode_t NewMode); |
bool SetMode(stream_mode_t NewMode); |
302 |
|
void SetByteOrder(endian_t Endian); |
303 |
String GetFileName(); |
String GetFileName(); |
304 |
virtual void Save(); |
virtual void Save(); |
305 |
virtual void Save(const String& path); |
virtual void Save(const String& path); |
308 |
#if POSIX |
#if POSIX |
309 |
int hFileRead; ///< handle / descriptor for reading from file |
int hFileRead; ///< handle / descriptor for reading from file |
310 |
int hFileWrite; ///< handle / descriptor for writing to (some) file |
int hFileWrite; ///< handle / descriptor for writing to (some) file |
311 |
|
#elif defined(WIN32) |
312 |
|
HANDLE hFileRead; ///< handle / descriptor for reading from file |
313 |
|
HANDLE hFileWrite; ///< handle / descriptor for writing to (some) file |
314 |
#else |
#else |
315 |
FILE* hFileRead; ///< handle / descriptor for reading from file |
FILE* hFileRead; ///< handle / descriptor for reading from file |
316 |
FILE* hFileWrite; ///< handle / descriptor for writing to (some) file |
FILE* hFileWrite; ///< handle / descriptor for writing to (some) file |
319 |
bool bEndianNative; |
bool bEndianNative; |
320 |
|
|
321 |
void LogAsResized(Chunk* pResizedChunk); |
void LogAsResized(Chunk* pResizedChunk); |
322 |
|
void UnlogResized(Chunk* pResizedChunk); |
323 |
friend class Chunk; |
friend class Chunk; |
324 |
friend class List; |
friend class List; |
325 |
private: |
private: |
326 |
stream_mode_t Mode; |
stream_mode_t Mode; |
327 |
ChunkList ResizedChunks; ///< All chunks which have been resized (enlarged / shortened). |
std::set<Chunk*> ResizedChunks; ///< All chunks which have been resized (enlarged / shortened). |
328 |
|
|
329 |
unsigned long GetFileSize(); |
unsigned long GetFileSize(); |
330 |
void ResizeFile(unsigned long ulNewSize); |
void ResizeFile(unsigned long ulNewSize); |
331 |
|
#if POSIX |
332 |
|
unsigned long __GetFileSize(int hFile); |
333 |
|
#elif defined(WIN32) |
334 |
|
unsigned long __GetFileSize(HANDLE hFile); |
335 |
|
#else |
336 |
|
unsigned long __GetFileSize(FILE* hFile); |
337 |
|
#endif |
338 |
}; |
}; |
339 |
|
|
340 |
/** Will be thrown whenever an error occurs while parsing a RIFF file. */ |
/** |
341 |
|
* Will be thrown whenever an error occurs while handling a RIFF file. |
342 |
|
*/ |
343 |
class Exception { |
class Exception { |
344 |
public: |
public: |
345 |
String Message; |
String Message; |
346 |
|
|
347 |
Exception(String Message) { Exception::Message = Message; }; |
Exception(String Message) { Exception::Message = Message; } |
348 |
void PrintMessage(); |
void PrintMessage(); |
349 |
virtual ~Exception() {}; |
virtual ~Exception() {} |
350 |
}; |
}; |
351 |
|
|
352 |
String libraryName(); |
String libraryName(); |