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> |
54 |
|
|
55 |
#include <stdint.h> |
#include <stdint.h> |
56 |
|
|
57 |
//typedef unsigned char uint8_t; |
#ifdef WIN32 |
58 |
//typedef unsigned short uint16_t; |
# include "../win32/libgig_private.h" // like config.h, automatically generated by Dev-C++ |
59 |
//typedef unsigned int uint32_t; |
# 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 |
|
|
68 |
#include <stdio.h> |
#include <stdio.h> |
69 |
|
|
82 |
#define RIFF_HEADER_SIZE 12 |
#define RIFF_HEADER_SIZE 12 |
83 |
|
|
84 |
|
|
85 |
/** RIFF specific classes and definitions */ |
/** |
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 |
namespace RIFF { |
namespace RIFF { |
105 |
|
|
106 |
/* just symbol prototyping */ |
/* just symbol prototyping */ |
112 |
|
|
113 |
/** Whether file stream is open in read or in read/write mode. */ |
/** Whether file stream is open in read or in read/write mode. */ |
114 |
typedef enum { |
typedef enum { |
115 |
stream_mode_read, |
stream_mode_read = 0, |
116 |
stream_mode_read_write |
stream_mode_read_write = 1, |
117 |
|
stream_mode_closed = 2 |
118 |
} stream_mode_t; |
} stream_mode_t; |
119 |
|
|
120 |
/** Current state of the file stream. */ |
/** Current state of the file stream. */ |
132 |
stream_end = 3 |
stream_end = 3 |
133 |
} stream_whence_t; |
} stream_whence_t; |
134 |
|
|
135 |
/** Provides convenient methods to access data of RIFF chunks in general. */ |
/** Alignment of data bytes in memory (system dependant). */ |
136 |
|
typedef enum { |
137 |
|
endian_little = 0, |
138 |
|
endian_big = 1, |
139 |
|
endian_native = 2 |
140 |
|
} endian_t; |
141 |
|
|
142 |
|
/** @brief Ordinary RIFF Chunk |
143 |
|
* |
144 |
|
* Provides convenient methods to access data of ordinary RIFF chunks |
145 |
|
* in general. |
146 |
|
*/ |
147 |
class Chunk { |
class Chunk { |
148 |
public: |
public: |
149 |
Chunk(File* pFile, unsigned long StartPos, List* Parent); |
Chunk(File* pFile, unsigned long StartPos, List* Parent); |
190 |
unsigned long ulStartPos; /* actual position in file where chunk (without header) starts */ |
unsigned long ulStartPos; /* actual position in file where chunk (without header) starts */ |
191 |
unsigned long ulPos; /* # of bytes from ulStartPos */ |
unsigned long ulPos; /* # of bytes from ulStartPos */ |
192 |
uint8_t* pChunkData; |
uint8_t* pChunkData; |
193 |
|
unsigned long ulChunkDataSize; |
194 |
|
|
195 |
Chunk(File* pFile); |
Chunk(File* pFile); |
196 |
Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize); |
Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize); |
234 |
friend class List; |
friend class List; |
235 |
}; |
}; |
236 |
|
|
237 |
/** Provides convenient methods to access data of RIFF list chunks and their subchunks. */ |
/** @brief RIFF List Chunk |
238 |
|
* |
239 |
|
* Provides convenient methods to access data of RIFF list chunks and |
240 |
|
* their subchunks. |
241 |
|
*/ |
242 |
class List : public Chunk { |
class List : public Chunk { |
243 |
public: |
public: |
244 |
List(File* pFile, unsigned long StartPos, List* Parent); |
List(File* pFile, unsigned long StartPos, List* Parent); |
257 |
Chunk* AddSubChunk(uint32_t uiChunkID, uint uiBodySize); |
Chunk* AddSubChunk(uint32_t uiChunkID, uint uiBodySize); |
258 |
List* AddSubList(uint32_t uiListType); |
List* AddSubList(uint32_t uiListType); |
259 |
void DeleteSubChunk(Chunk* pSubChunk); |
void DeleteSubChunk(Chunk* pSubChunk); |
260 |
|
void MoveSubChunk(Chunk* pSrc, Chunk* pDst); |
261 |
virtual ~List(); |
virtual ~List(); |
262 |
protected: |
protected: |
263 |
typedef std::map<uint32_t, RIFF::Chunk*> ChunkMap; |
typedef std::map<uint32_t, RIFF::Chunk*> ChunkMap; |
274 |
void ReadHeader(unsigned long fPos); |
void ReadHeader(unsigned long fPos); |
275 |
void WriteHeader(unsigned long fPos); |
void WriteHeader(unsigned long fPos); |
276 |
void LoadSubChunks(); |
void LoadSubChunks(); |
277 |
|
void LoadSubChunksRecursively(); |
278 |
virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset); |
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. |
virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same. |
280 |
}; |
}; |
281 |
|
|
282 |
/** Parses arbitrary RIFF files and provides together with it's base classes convenient methods to walk through the RIFF tree. */ |
/** @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 |
class File : public List { |
class File : public List { |
289 |
public: |
public: |
290 |
File(); |
File(uint32_t FileType); |
291 |
File(const String& path); |
File(const String& path); |
292 |
stream_mode_t GetMode(); |
stream_mode_t GetMode(); |
293 |
bool SetMode(stream_mode_t NewMode); |
bool SetMode(stream_mode_t NewMode); |
294 |
|
void SetByteOrder(endian_t Endian); |
295 |
String GetFileName(); |
String GetFileName(); |
296 |
virtual void Save(); |
virtual void Save(); |
297 |
virtual void Save(const String& path); |
virtual void Save(const String& path); |
300 |
#if POSIX |
#if POSIX |
301 |
int hFileRead; ///< handle / descriptor for reading from file |
int hFileRead; ///< handle / descriptor for reading from file |
302 |
int hFileWrite; ///< handle / descriptor for writing to (some) file |
int hFileWrite; ///< handle / descriptor for writing to (some) file |
303 |
|
#elif defined(WIN32) |
304 |
|
HANDLE hFileRead; ///< handle / descriptor for reading from file |
305 |
|
HANDLE hFileWrite; ///< handle / descriptor for writing to (some) file |
306 |
#else |
#else |
307 |
FILE* hFileRead; ///< handle / descriptor for reading from file |
FILE* hFileRead; ///< handle / descriptor for reading from file |
308 |
FILE* hFileWrite; ///< handle / descriptor for writing to (some) file |
FILE* hFileWrite; ///< handle / descriptor for writing to (some) file |
311 |
bool bEndianNative; |
bool bEndianNative; |
312 |
|
|
313 |
void LogAsResized(Chunk* pResizedChunk); |
void LogAsResized(Chunk* pResizedChunk); |
314 |
|
void UnlogResized(Chunk* pResizedChunk); |
315 |
friend class Chunk; |
friend class Chunk; |
316 |
friend class List; |
friend class List; |
317 |
private: |
private: |
320 |
|
|
321 |
unsigned long GetFileSize(); |
unsigned long GetFileSize(); |
322 |
void ResizeFile(unsigned long ulNewSize); |
void ResizeFile(unsigned long ulNewSize); |
323 |
|
#if POSIX |
324 |
|
unsigned long __GetFileSize(int hFile); |
325 |
|
#elif defined(WIN32) |
326 |
|
unsigned long __GetFileSize(HANDLE hFile); |
327 |
|
#else |
328 |
|
unsigned long __GetFileSize(FILE* hFile); |
329 |
|
#endif |
330 |
}; |
}; |
331 |
|
|
332 |
/** Will be thrown whenever an error occurs while parsing a RIFF file. */ |
/** |
333 |
|
* Will be thrown whenever an error occurs while handling a RIFF file. |
334 |
|
*/ |
335 |
class Exception { |
class Exception { |
336 |
public: |
public: |
337 |
String Message; |
String Message; |