1 |
/*************************************************************************** |
2 |
* * |
3 |
* libgig - C++ cross-platform Gigasampler format file access library * |
4 |
* * |
5 |
* Copyright (C) 2003-2015 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 <set> |
43 |
#include <iostream> |
44 |
|
45 |
#ifdef HAVE_CONFIG_H |
46 |
# include <config.h> |
47 |
#endif |
48 |
|
49 |
#if POSIX |
50 |
# include <sys/types.h> |
51 |
# include <sys/stat.h> |
52 |
# include <fcntl.h> |
53 |
# include <unistd.h> |
54 |
#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> |
68 |
#endif |
69 |
|
70 |
#ifdef WIN32 |
71 |
# include <windows.h> |
72 |
typedef unsigned int uint; |
73 |
#endif // WIN32 |
74 |
|
75 |
#include <stdio.h> |
76 |
|
77 |
#if WORDS_BIGENDIAN |
78 |
# define CHUNK_ID_RIFF 0x52494646 |
79 |
# define CHUNK_ID_RIFX 0x52494658 |
80 |
# define CHUNK_ID_LIST 0x4C495354 |
81 |
|
82 |
# define LIST_TYPE_INFO 0x494E464F |
83 |
# define CHUNK_ID_ICMT 0x49434D54 |
84 |
# define CHUNK_ID_ICOP 0x49434F50 |
85 |
# define CHUNK_ID_ICRD 0x49435244 |
86 |
# define CHUNK_ID_IENG 0x49454E47 |
87 |
# define CHUNK_ID_INAM 0x494E414D |
88 |
# define CHUNK_ID_IPRD 0x49505244 |
89 |
# define CHUNK_ID_ISFT 0x49534654 |
90 |
|
91 |
# define CHUNK_ID_SMPL 0x736D706C |
92 |
|
93 |
#else // little endian |
94 |
# define CHUNK_ID_RIFF 0x46464952 |
95 |
# define CHUNK_ID_RIFX 0x58464952 |
96 |
# define CHUNK_ID_LIST 0x5453494C |
97 |
|
98 |
# define LIST_TYPE_INFO 0x4F464E49 |
99 |
# define CHUNK_ID_ICMT 0x544D4349 |
100 |
# define CHUNK_ID_ICOP 0x504F4349 |
101 |
# define CHUNK_ID_ICRD 0x44524349 |
102 |
# define CHUNK_ID_IENG 0x474E4549 |
103 |
# define CHUNK_ID_INAM 0x4D414E49 |
104 |
# define CHUNK_ID_IPRD 0x44525049 |
105 |
# define CHUNK_ID_ISFT 0x54465349 |
106 |
|
107 |
# define CHUNK_ID_SMPL 0x6C706D73 |
108 |
|
109 |
#endif // WORDS_BIGENDIAN |
110 |
|
111 |
#define CHUNK_HEADER_SIZE 8 |
112 |
#define LIST_HEADER_SIZE 12 |
113 |
#define RIFF_HEADER_SIZE 12 |
114 |
|
115 |
|
116 |
/** |
117 |
* @brief RIFF specific classes and definitions |
118 |
* |
119 |
* The Resource Interchange File Format (RIFF) is a generic tree-structured |
120 |
* meta-format which stores data in so called "chunks". It can be compared |
121 |
* to XML, but in contrast to XML, RIFF is entirely binary encoded, that is |
122 |
* not ASCII based. RIFF is used as basis for many file formats like AVI, |
123 |
* WAV, DLS and of course the Gigasampler file format. ;-) |
124 |
* |
125 |
* RIFF chunks can be seen as containers for data. There are two distinct |
126 |
* types of chunks: |
127 |
* |
128 |
* - @e ordinary @e chunks are the leafs of the data tree which encapsulate |
129 |
* the actual data of the file (i.e. the sample data of a .wav file) |
130 |
* |
131 |
* - @e list @e chunks are the nodes of the data tree which hold an |
132 |
* arbitrary amount of subchunks (can be both, list chunks and/or ordinary |
133 |
* chunks) |
134 |
*/ |
135 |
namespace RIFF { |
136 |
|
137 |
/* just symbol prototyping */ |
138 |
class Chunk; |
139 |
class List; |
140 |
class File; |
141 |
|
142 |
typedef std::string String; |
143 |
|
144 |
/** Whether file stream is open in read or in read/write mode. */ |
145 |
typedef enum { |
146 |
stream_mode_read = 0, |
147 |
stream_mode_read_write = 1, |
148 |
stream_mode_closed = 2 |
149 |
} stream_mode_t; |
150 |
|
151 |
/** Current state of the file stream. */ |
152 |
typedef enum { |
153 |
stream_ready = 0, |
154 |
stream_end_reached = 1, |
155 |
stream_closed = 2 |
156 |
} stream_state_t; |
157 |
|
158 |
/** File stream position dependent to these relations. */ |
159 |
typedef enum { |
160 |
stream_start = 0, |
161 |
stream_curpos = 1, |
162 |
stream_backward = 2, |
163 |
stream_end = 3 |
164 |
} stream_whence_t; |
165 |
|
166 |
/** Alignment of data bytes in memory (system dependant). */ |
167 |
typedef enum { |
168 |
endian_little = 0, |
169 |
endian_big = 1, |
170 |
endian_native = 2 |
171 |
} endian_t; |
172 |
|
173 |
/** General chunk structure of a file. */ |
174 |
enum layout_t { |
175 |
layout_standard = 0, ///< Standard RIFF file layout: First chunk in file is a List chunk which contains all other chunks and there are no chunks outside the scope of that very first (List) chunk. |
176 |
layout_flat = 1 ///< Not a "real" RIFF file: First chunk in file is an ordinary data chunk, not a List chunk, and there might be other chunks after that first chunk. |
177 |
}; |
178 |
|
179 |
/** |
180 |
* @brief Used for indicating the progress of a certain task. |
181 |
* |
182 |
* The function pointer argument has to be supplied with a valid |
183 |
* function of the given signature which will then be called on |
184 |
* progress changes. An equivalent progress_t structure will be passed |
185 |
* back as argument to the callback function on each progress change. |
186 |
* The factor field of the supplied progress_t structure will then |
187 |
* reflect the current progress as value between 0.0 and 1.0. You might |
188 |
* want to use the custom field for data needed in your callback |
189 |
* function. |
190 |
*/ |
191 |
struct progress_t { |
192 |
void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification. |
193 |
float factor; ///< Reflects current progress as value between 0.0 and 1.0. |
194 |
void* custom; ///< This pointer can be used for arbitrary data. |
195 |
float __range_min; ///< Only for internal usage, do not modify! |
196 |
float __range_max; ///< Only for internal usage, do not modify! |
197 |
progress_t(); |
198 |
}; |
199 |
|
200 |
/** @brief Ordinary RIFF Chunk |
201 |
* |
202 |
* Provides convenient methods to access data of ordinary RIFF chunks |
203 |
* in general. |
204 |
*/ |
205 |
class Chunk { |
206 |
public: |
207 |
Chunk(File* pFile, unsigned long StartPos, List* Parent); |
208 |
String GetChunkIDString(); |
209 |
uint32_t GetChunkID() { return ChunkID; } ///< Chunk ID in unsigned integer representation. |
210 |
File* GetFile() { return pFile; } ///< Returns pointer to the chunk's File object. |
211 |
List* GetParent() { return pParent; } ///< Returns pointer to the chunk's parent list chunk. |
212 |
unsigned long GetSize() const { return CurrentChunkSize; } ///< Chunk size in bytes (without header, thus the chunk data body) |
213 |
unsigned long GetNewSize() { return NewChunkSize; } ///< New chunk size if it was modified with Resize(). |
214 |
unsigned long GetPos() { return ulPos; } ///< Position within the chunk data body |
215 |
unsigned long GetFilePos() { return ulStartPos + ulPos; } ///< Current, actual offset in file. |
216 |
unsigned long SetPos(unsigned long Where, stream_whence_t Whence = stream_start); |
217 |
unsigned long RemainingBytes(); |
218 |
stream_state_t GetState(); |
219 |
unsigned long Read(void* pData, unsigned long WordCount, unsigned long WordSize); |
220 |
unsigned long ReadInt8(int8_t* pData, unsigned long WordCount = 1); |
221 |
unsigned long ReadUint8(uint8_t* pData, unsigned long WordCount = 1); |
222 |
unsigned long ReadInt16(int16_t* pData, unsigned long WordCount = 1); |
223 |
unsigned long ReadUint16(uint16_t* pData, unsigned long WordCount = 1); |
224 |
unsigned long ReadInt32(int32_t* pData, unsigned long WordCount = 1); |
225 |
unsigned long ReadUint32(uint32_t* pData, unsigned long WordCount = 1); |
226 |
int8_t ReadInt8(); |
227 |
uint8_t ReadUint8(); |
228 |
int16_t ReadInt16(); |
229 |
uint16_t ReadUint16(); |
230 |
int32_t ReadInt32(); |
231 |
uint32_t ReadUint32(); |
232 |
void ReadString(String& s, int size); |
233 |
unsigned long Write(void* pData, unsigned long WordCount, unsigned long WordSize); |
234 |
unsigned long WriteInt8(int8_t* pData, unsigned long WordCount = 1); |
235 |
unsigned long WriteUint8(uint8_t* pData, unsigned long WordCount = 1); |
236 |
unsigned long WriteInt16(int16_t* pData, unsigned long WordCount = 1); |
237 |
unsigned long WriteUint16(uint16_t* pData, unsigned long WordCount = 1); |
238 |
unsigned long WriteInt32(int32_t* pData, unsigned long WordCount = 1); |
239 |
unsigned long WriteUint32(uint32_t* pData, unsigned long WordCount = 1); |
240 |
void* LoadChunkData(); |
241 |
void ReleaseChunkData(); |
242 |
void Resize(int iNewSize); |
243 |
virtual ~Chunk(); |
244 |
protected: |
245 |
uint32_t ChunkID; |
246 |
uint32_t CurrentChunkSize; /* in bytes */ |
247 |
uint32_t NewChunkSize; /* in bytes (if chunk was scheduled to be resized) */ |
248 |
List* pParent; |
249 |
File* pFile; |
250 |
unsigned long ulStartPos; /* actual position in file where chunk (without header) starts */ |
251 |
unsigned long ulPos; /* # of bytes from ulStartPos */ |
252 |
uint8_t* pChunkData; |
253 |
unsigned long ulChunkDataSize; |
254 |
|
255 |
Chunk(File* pFile); |
256 |
Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize); |
257 |
void ReadHeader(unsigned long fPos); |
258 |
void WriteHeader(unsigned long fPos); |
259 |
unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize); |
260 |
inline void swapBytes_16(void* Word) { |
261 |
uint8_t byteCache = *((uint8_t*) Word); |
262 |
*((uint8_t*) Word) = *((uint8_t*) Word + 1); |
263 |
*((uint8_t*) Word + 1) = byteCache; |
264 |
} |
265 |
inline void swapBytes_32(void* Word) { |
266 |
uint8_t byteCache = *((uint8_t*) Word); |
267 |
*((uint8_t*) Word) = *((uint8_t*) Word + 3); |
268 |
*((uint8_t*) Word + 3) = byteCache; |
269 |
byteCache = *((uint8_t*) Word + 1); |
270 |
*((uint8_t*) Word + 1) = *((uint8_t*) Word + 2); |
271 |
*((uint8_t*) Word + 2) = byteCache; |
272 |
} |
273 |
inline void swapBytes(void* Word, unsigned long WordSize) { |
274 |
uint8_t byteCache; |
275 |
unsigned long lo = 0, hi = WordSize - 1; |
276 |
for (; lo < hi; hi--, lo++) { |
277 |
byteCache = *((uint8_t*) Word + lo); |
278 |
*((uint8_t*) Word + lo) = *((uint8_t*) Word + hi); |
279 |
*((uint8_t*) Word + hi) = byteCache; |
280 |
} |
281 |
} |
282 |
inline String convertToString(uint32_t word) { |
283 |
String result; |
284 |
for (int i = 0; i < 4; i++) { |
285 |
uint8_t byte = *((uint8_t*)(&word) + i); |
286 |
char c = byte; |
287 |
result += c; |
288 |
} |
289 |
return result; |
290 |
} |
291 |
virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset, progress_t* pProgress = NULL); |
292 |
virtual void __resetPos(); ///< Sets Chunk's read/write position to zero. |
293 |
|
294 |
friend class List; |
295 |
}; |
296 |
|
297 |
/** @brief RIFF List Chunk |
298 |
* |
299 |
* Provides convenient methods to access data of RIFF list chunks and |
300 |
* their subchunks. |
301 |
*/ |
302 |
class List : public Chunk { |
303 |
public: |
304 |
List(File* pFile, unsigned long StartPos, List* Parent); |
305 |
String GetListTypeString(); |
306 |
uint32_t GetListType() { return ListType; } ///< Returns unsigned integer representation of the list's ID |
307 |
Chunk* GetSubChunk(uint32_t ChunkID); |
308 |
List* GetSubList(uint32_t ListType); |
309 |
Chunk* GetFirstSubChunk(); |
310 |
Chunk* GetNextSubChunk(); |
311 |
List* GetFirstSubList(); |
312 |
List* GetNextSubList(); |
313 |
unsigned int CountSubChunks(); |
314 |
unsigned int CountSubChunks(uint32_t ChunkID); |
315 |
unsigned int CountSubLists(); |
316 |
unsigned int CountSubLists(uint32_t ListType); |
317 |
Chunk* AddSubChunk(uint32_t uiChunkID, uint uiBodySize); |
318 |
List* AddSubList(uint32_t uiListType); |
319 |
void DeleteSubChunk(Chunk* pSubChunk); |
320 |
void MoveSubChunk(Chunk* pSrc, Chunk* pDst); // read API doc comments !!! |
321 |
void MoveSubChunk(Chunk* pSrc, List* pNewParent); |
322 |
virtual ~List(); |
323 |
protected: |
324 |
typedef std::map<uint32_t, RIFF::Chunk*> ChunkMap; |
325 |
typedef std::list<Chunk*> ChunkList; |
326 |
typedef std::set<Chunk*> ChunkSet; |
327 |
|
328 |
uint32_t ListType; |
329 |
ChunkList* pSubChunks; |
330 |
ChunkMap* pSubChunksMap; |
331 |
ChunkList::iterator ChunksIterator; |
332 |
ChunkList::iterator ListIterator; |
333 |
|
334 |
List(File* pFile); |
335 |
List(File* pFile, List* pParent, uint32_t uiListID); |
336 |
void ReadHeader(unsigned long fPos); |
337 |
void WriteHeader(unsigned long fPos); |
338 |
void LoadSubChunks(progress_t* pProgress = NULL); |
339 |
void LoadSubChunksRecursively(progress_t* pProgress = NULL); |
340 |
virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset, progress_t* pProgress = NULL); |
341 |
virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same. |
342 |
void DeleteChunkList(); |
343 |
}; |
344 |
|
345 |
/** @brief RIFF File |
346 |
* |
347 |
* Handles arbitrary RIFF files and provides together with its base |
348 |
* classes convenient methods to walk through, read and modify the |
349 |
* file's RIFF tree. |
350 |
*/ |
351 |
class File : public List { |
352 |
public: |
353 |
File(uint32_t FileType); |
354 |
File(const String& path); |
355 |
File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout); |
356 |
stream_mode_t GetMode(); |
357 |
bool SetMode(stream_mode_t NewMode); |
358 |
void SetByteOrder(endian_t Endian); |
359 |
String GetFileName(); |
360 |
void SetFileName(const String& path); |
361 |
bool IsNew() const; |
362 |
layout_t GetLayout() const; |
363 |
virtual void Save(progress_t* pProgress = NULL); |
364 |
virtual void Save(const String& path, progress_t* pProgress = NULL); |
365 |
virtual ~File(); |
366 |
protected: |
367 |
#if POSIX |
368 |
int hFileRead; ///< handle / descriptor for reading from file |
369 |
int hFileWrite; ///< handle / descriptor for writing to (some) file |
370 |
#elif defined(WIN32) |
371 |
HANDLE hFileRead; ///< handle / descriptor for reading from file |
372 |
HANDLE hFileWrite; ///< handle / descriptor for writing to (some) file |
373 |
#else |
374 |
FILE* hFileRead; ///< handle / descriptor for reading from file |
375 |
FILE* hFileWrite; ///< handle / descriptor for writing to (some) file |
376 |
#endif // POSIX |
377 |
String Filename; |
378 |
bool bEndianNative; |
379 |
bool bIsNewFile; |
380 |
layout_t Layout; ///< An ordinary RIFF file is always set to layout_standard. |
381 |
|
382 |
void LogAsResized(Chunk* pResizedChunk); |
383 |
void UnlogResized(Chunk* pResizedChunk); |
384 |
friend class Chunk; |
385 |
friend class List; |
386 |
private: |
387 |
stream_mode_t Mode; |
388 |
ChunkSet ResizedChunks; ///< All chunks which have been resized (enlarged / shortened). |
389 |
|
390 |
void __openExistingFile(const String& path, uint32_t* FileType = NULL); |
391 |
unsigned long GetFileSize(); |
392 |
void ResizeFile(unsigned long ulNewSize); |
393 |
#if POSIX |
394 |
unsigned long __GetFileSize(int hFile); |
395 |
#elif defined(WIN32) |
396 |
unsigned long __GetFileSize(HANDLE hFile); |
397 |
#else |
398 |
unsigned long __GetFileSize(FILE* hFile); |
399 |
#endif |
400 |
void Cleanup(); |
401 |
}; |
402 |
|
403 |
/** |
404 |
* Will be thrown whenever an error occurs while handling a RIFF file. |
405 |
*/ |
406 |
class Exception { |
407 |
public: |
408 |
String Message; |
409 |
|
410 |
Exception(String Message) { Exception::Message = Message; } |
411 |
void PrintMessage(); |
412 |
virtual ~Exception() {} |
413 |
}; |
414 |
|
415 |
String libraryName(); |
416 |
String libraryVersion(); |
417 |
|
418 |
} // namespace RIFF |
419 |
#endif // __RIFF_H__ |