1 |
/*************************************************************************** |
2 |
* * |
3 |
* libgig - C++ cross-platform Gigasampler format file access library * |
4 |
* * |
5 |
* Copyright (C) 2003-2021 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 |
#ifndef OVERRIDE |
40 |
# if defined(__cplusplus) && __cplusplus >= 201103L |
41 |
# define OVERRIDE override |
42 |
# else |
43 |
# define OVERRIDE |
44 |
# endif |
45 |
#endif |
46 |
|
47 |
#ifdef __GNUC__ |
48 |
# define LIBGIG_DEPRECATED_API(msg) __attribute__ ((deprecated(msg))) |
49 |
#else |
50 |
# define LIBGIG_DEPRECATED_API(msg) |
51 |
#endif |
52 |
|
53 |
#include <string> |
54 |
#include <list> |
55 |
#include <map> |
56 |
#include <set> |
57 |
#include <vector> |
58 |
#include <iostream> |
59 |
#include <stdarg.h> |
60 |
#include <thread> |
61 |
#include <mutex> |
62 |
|
63 |
#ifdef HAVE_CONFIG_H |
64 |
# include <config.h> |
65 |
#endif |
66 |
|
67 |
#if POSIX |
68 |
# include <sys/types.h> |
69 |
# include <sys/stat.h> |
70 |
# include <fcntl.h> |
71 |
# include <unistd.h> |
72 |
#endif // POSIX |
73 |
|
74 |
#if defined _MSC_VER && _MSC_VER < 1600 |
75 |
// Visual C++ 2008 doesn't have stdint.h |
76 |
typedef __int8 int8_t; |
77 |
typedef __int16 int16_t; |
78 |
typedef __int32 int32_t; |
79 |
typedef __int64 int64_t; |
80 |
typedef unsigned __int8 uint8_t; |
81 |
typedef unsigned __int16 uint16_t; |
82 |
typedef unsigned __int32 uint32_t; |
83 |
typedef unsigned __int64 uint64_t; |
84 |
#else |
85 |
#include <stdint.h> |
86 |
#endif |
87 |
|
88 |
#ifdef WIN32 |
89 |
# if (_WIN32 && !_WIN64) || (__GNUC__ && !(__x86_64__ || __ppc64__)) /* if 32 bit windows compilation */ |
90 |
# if _WIN32_WINNT < 0x0501 |
91 |
# undef _WIN32_WINNT |
92 |
# define _WIN32_WINNT 0x0501 /* Win XP (no service pack): required for 32 bit compilation for GetFileSizeEx() to be declared by windows.h */ |
93 |
# endif |
94 |
# endif |
95 |
# include <windows.h> |
96 |
typedef unsigned int uint; |
97 |
#endif // WIN32 |
98 |
|
99 |
#include <stdio.h> |
100 |
|
101 |
#if WORDS_BIGENDIAN |
102 |
# define CHUNK_ID_RIFF 0x52494646 |
103 |
# define CHUNK_ID_RIFX 0x52494658 |
104 |
# define CHUNK_ID_LIST 0x4C495354 |
105 |
|
106 |
# define LIST_TYPE_INFO 0x494E464F |
107 |
# define CHUNK_ID_ICMT 0x49434D54 |
108 |
# define CHUNK_ID_ICOP 0x49434F50 |
109 |
# define CHUNK_ID_ICRD 0x49435244 |
110 |
# define CHUNK_ID_IENG 0x49454E47 |
111 |
# define CHUNK_ID_INAM 0x494E414D |
112 |
# define CHUNK_ID_IPRD 0x49505244 |
113 |
# define CHUNK_ID_ISFT 0x49534654 |
114 |
|
115 |
# define CHUNK_ID_SMPL 0x736D706C |
116 |
|
117 |
#else // little endian |
118 |
# define CHUNK_ID_RIFF 0x46464952 |
119 |
# define CHUNK_ID_RIFX 0x58464952 |
120 |
# define CHUNK_ID_LIST 0x5453494C |
121 |
|
122 |
# define LIST_TYPE_INFO 0x4F464E49 |
123 |
# define CHUNK_ID_ICMT 0x544D4349 |
124 |
# define CHUNK_ID_ICOP 0x504F4349 |
125 |
# define CHUNK_ID_ICRD 0x44524349 |
126 |
# define CHUNK_ID_IENG 0x474E4549 |
127 |
# define CHUNK_ID_INAM 0x4D414E49 |
128 |
# define CHUNK_ID_IPRD 0x44525049 |
129 |
# define CHUNK_ID_ISFT 0x54465349 |
130 |
|
131 |
# define CHUNK_ID_SMPL 0x6C706D73 |
132 |
|
133 |
#endif // WORDS_BIGENDIAN |
134 |
|
135 |
#define CHUNK_HEADER_SIZE(fileOffsetSize) (4 + fileOffsetSize) |
136 |
#define LIST_HEADER_SIZE(fileOffsetSize) (8 + fileOffsetSize) |
137 |
#define RIFF_HEADER_SIZE(fileOffsetSize) (8 + fileOffsetSize) |
138 |
|
139 |
/** |
140 |
* @brief RIFF specific classes and definitions |
141 |
* |
142 |
* The Resource Interchange File Format (RIFF) is a generic tree-structured |
143 |
* meta-format which stores data in so called "chunks". It can be compared |
144 |
* to XML, but in contrast to XML, RIFF is entirely binary encoded, that is |
145 |
* not ASCII based. RIFF is used as basis for many file formats like AVI, |
146 |
* WAV, DLS and of course the Gigasampler file format. ;-) |
147 |
* |
148 |
* RIFF chunks can be seen as containers for data. There are two distinct |
149 |
* types of chunks: |
150 |
* |
151 |
* - @e ordinary @e chunks are the leafs of the data tree which encapsulate |
152 |
* the actual data of the file (i.e. the sample data of a .wav file) |
153 |
* |
154 |
* - @e list @e chunks are the nodes of the data tree which hold an |
155 |
* arbitrary amount of subchunks (can be both, list chunks and/or ordinary |
156 |
* chunks) |
157 |
*/ |
158 |
namespace RIFF { |
159 |
|
160 |
/* just symbol prototyping */ |
161 |
class Chunk; |
162 |
class List; |
163 |
class File; |
164 |
|
165 |
typedef std::string String; |
166 |
|
167 |
/** Type used by libgig for handling file positioning during file I/O tasks. */ |
168 |
typedef uint64_t file_offset_t; |
169 |
|
170 |
/** Whether file stream is open in read or in read/write mode. */ |
171 |
enum stream_mode_t { |
172 |
stream_mode_read = 0, |
173 |
stream_mode_read_write = 1, |
174 |
stream_mode_closed = 2 |
175 |
}; |
176 |
|
177 |
/** Current state of the file stream. */ |
178 |
enum stream_state_t { |
179 |
stream_ready = 0, |
180 |
stream_end_reached = 1, |
181 |
stream_closed = 2 |
182 |
}; |
183 |
|
184 |
/** File stream position dependent to these relations. */ |
185 |
enum stream_whence_t { |
186 |
stream_start = 0, |
187 |
stream_curpos = 1, |
188 |
stream_backward = 2, |
189 |
stream_end = 3 |
190 |
}; |
191 |
|
192 |
/** Alignment of data bytes in memory (system dependant). */ |
193 |
enum endian_t { |
194 |
endian_little = 0, |
195 |
endian_big = 1, |
196 |
endian_native = 2 |
197 |
}; |
198 |
|
199 |
/** General RIFF chunk structure of a RIFF file. */ |
200 |
enum layout_t { |
201 |
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. |
202 |
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. |
203 |
}; |
204 |
|
205 |
/** Size of RIFF file offsets used in all RIFF chunks' headers. @see File::GetFileOffsetSize() */ |
206 |
enum offset_size_t { |
207 |
offset_size_auto = 0, ///< Use 32 bit offsets for files smaller than 4 GB, use 64 bit offsets for files equal or larger than 4 GB. |
208 |
offset_size_32bit = 4, ///< Always use 32 bit offsets (even for files larger than 4 GB). |
209 |
offset_size_64bit = 8 ///< Always use 64 bit offsets (even for files smaller than 4 GB). |
210 |
}; |
211 |
|
212 |
/** |
213 |
* @brief Used for indicating the progress of a certain task. |
214 |
* |
215 |
* The function pointer argument has to be supplied with a valid |
216 |
* function of the given signature which will then be called on |
217 |
* progress changes. An equivalent progress_t structure will be passed |
218 |
* back as argument to the callback function on each progress change. |
219 |
* The factor field of the supplied progress_t structure will then |
220 |
* reflect the current progress as value between 0.0 and 1.0. You might |
221 |
* want to use the custom field for data needed in your callback |
222 |
* function. |
223 |
*/ |
224 |
struct progress_t { |
225 |
void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification. |
226 |
float factor; ///< Reflects current progress as value between 0.0 and 1.0. |
227 |
void* custom; ///< This pointer can be used for arbitrary data. |
228 |
float __range_min; ///< Only for internal usage, do not modify! |
229 |
float __range_max; ///< Only for internal usage, do not modify! |
230 |
progress_t(); |
231 |
std::vector<progress_t> subdivide(int iSubtasks); |
232 |
std::vector<progress_t> subdivide(std::vector<float> vSubTaskPortions); |
233 |
}; |
234 |
|
235 |
/** @brief Ordinary RIFF Chunk |
236 |
* |
237 |
* Provides convenient methods to access data of ordinary RIFF chunks |
238 |
* in general. |
239 |
*/ |
240 |
class Chunk { |
241 |
public: |
242 |
Chunk(File* pFile, file_offset_t StartPos, List* Parent); |
243 |
String GetChunkIDString() const; |
244 |
uint32_t GetChunkID() const { return ChunkID; } ///< Chunk ID in unsigned integer representation. |
245 |
File* GetFile() const { return pFile; } ///< Returns pointer to the chunk's File object. |
246 |
List* GetParent() const { return pParent; } ///< Returns pointer to the chunk's parent list chunk. |
247 |
file_offset_t GetSize() const { return ullCurrentChunkSize; } ///< Chunk size in bytes (without header, thus the chunk data body) |
248 |
file_offset_t GetNewSize() const { return ullNewChunkSize; } ///< New chunk size if it was modified with Resize(), otherwise value returned will be equal to GetSize(). |
249 |
file_offset_t GetPos() const; |
250 |
file_offset_t GetFilePos() const; |
251 |
file_offset_t SetPos(file_offset_t Where, stream_whence_t Whence = stream_start); |
252 |
file_offset_t RemainingBytes() const; |
253 |
stream_state_t GetState() const; |
254 |
file_offset_t Read(void* pData, file_offset_t WordCount, file_offset_t WordSize); |
255 |
file_offset_t ReadInt8(int8_t* pData, file_offset_t WordCount = 1); |
256 |
file_offset_t ReadUint8(uint8_t* pData, file_offset_t WordCount = 1); |
257 |
file_offset_t ReadInt16(int16_t* pData, file_offset_t WordCount = 1); |
258 |
file_offset_t ReadUint16(uint16_t* pData, file_offset_t WordCount = 1); |
259 |
file_offset_t ReadInt32(int32_t* pData, file_offset_t WordCount = 1); |
260 |
file_offset_t ReadUint32(uint32_t* pData, file_offset_t WordCount = 1); |
261 |
int8_t ReadInt8(); |
262 |
uint8_t ReadUint8(); |
263 |
int16_t ReadInt16(); |
264 |
uint16_t ReadUint16(); |
265 |
int32_t ReadInt32(); |
266 |
uint32_t ReadUint32(); |
267 |
void ReadString(String& s, int size); |
268 |
file_offset_t Write(void* pData, file_offset_t WordCount, file_offset_t WordSize); |
269 |
file_offset_t WriteInt8(int8_t* pData, file_offset_t WordCount = 1); |
270 |
file_offset_t WriteUint8(uint8_t* pData, file_offset_t WordCount = 1); |
271 |
file_offset_t WriteInt16(int16_t* pData, file_offset_t WordCount = 1); |
272 |
file_offset_t WriteUint16(uint16_t* pData, file_offset_t WordCount = 1); |
273 |
file_offset_t WriteInt32(int32_t* pData, file_offset_t WordCount = 1); |
274 |
file_offset_t WriteUint32(uint32_t* pData, file_offset_t WordCount = 1); |
275 |
void* LoadChunkData(); |
276 |
void ReleaseChunkData(); |
277 |
void Resize(file_offset_t NewSize); |
278 |
virtual ~Chunk(); |
279 |
protected: |
280 |
uint32_t ChunkID; |
281 |
file_offset_t ullCurrentChunkSize; /* in bytes */ |
282 |
file_offset_t ullNewChunkSize; /* in bytes (if chunk was scheduled to be resized) */ |
283 |
List* pParent; |
284 |
File* pFile; |
285 |
file_offset_t ullStartPos; /* actual position in file where chunk data (without header) starts */ |
286 |
uint8_t* pChunkData; |
287 |
file_offset_t ullChunkDataSize; |
288 |
struct ChunkPos { /* current read/write position as # of bytes from ulStartPos */ |
289 |
file_offset_t ullPos; /* used if File::IsIOPerThread() is false (default) */ |
290 |
mutable std::map<std::thread::id,file_offset_t> byThread; /* used if File::IsIOPerThread() is true */ |
291 |
mutable std::mutex mutex; /* for protecting concurrent changes on byThread map itself */ |
292 |
} chunkPos; |
293 |
|
294 |
Chunk(File* pFile); |
295 |
Chunk(File* pFile, List* pParent, uint32_t uiChunkID, file_offset_t ullBodySize); |
296 |
void ReadHeader(file_offset_t filePos); |
297 |
void WriteHeader(file_offset_t filePos); |
298 |
file_offset_t ReadSceptical(void* pData, file_offset_t WordCount, file_offset_t WordSize); |
299 |
inline static String convertToString(uint32_t word) { |
300 |
String result; |
301 |
for (int i = 0; i < 4; i++) { |
302 |
uint8_t byte = *((uint8_t*)(&word) + i); |
303 |
char c = byte; |
304 |
result += c; |
305 |
} |
306 |
return result; |
307 |
} |
308 |
virtual file_offset_t RequiredPhysicalSize(int fileOffsetSize); |
309 |
virtual file_offset_t WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t* pProgress = NULL); |
310 |
virtual void __resetPos(); ///< Sets Chunk's read/write position to zero. |
311 |
|
312 |
friend class List; |
313 |
private: |
314 |
file_offset_t& GetPosUnsafeRef(); |
315 |
}; |
316 |
|
317 |
/** @brief RIFF List Chunk |
318 |
* |
319 |
* Provides convenient methods to access data of RIFF list chunks and |
320 |
* their subchunks. |
321 |
*/ |
322 |
class List : public Chunk { |
323 |
public: |
324 |
List(File* pFile, file_offset_t StartPos, List* Parent); |
325 |
String GetListTypeString() const; |
326 |
uint32_t GetListType() const { return ListType; } ///< Returns unsigned integer representation of the list's ID |
327 |
Chunk* GetSubChunkAt(size_t pos); |
328 |
Chunk* GetSubChunk(uint32_t ChunkID); |
329 |
List* GetSubListAt(size_t pos); |
330 |
List* GetSubList(uint32_t ListType); |
331 |
Chunk* GetFirstSubChunk() LIBGIG_DEPRECATED_API("Use GetSubChunkAt() instead."); |
332 |
Chunk* GetNextSubChunk() LIBGIG_DEPRECATED_API("Use GetSubChunkAt() instead."); |
333 |
List* GetFirstSubList() LIBGIG_DEPRECATED_API("Use GetSubListAt() instead."); |
334 |
List* GetNextSubList() LIBGIG_DEPRECATED_API("Use GetSubListAt() instead."); |
335 |
size_t CountSubChunks(); |
336 |
size_t CountSubChunks(uint32_t ChunkID); |
337 |
size_t CountSubLists(); |
338 |
size_t CountSubLists(uint32_t ListType); |
339 |
Chunk* AddSubChunk(uint32_t uiChunkID, file_offset_t ullBodySize); |
340 |
List* AddSubList(uint32_t uiListType); |
341 |
void DeleteSubChunk(Chunk* pSubChunk); |
342 |
void MoveSubChunk(Chunk* pSrc, Chunk* pDst); // read API doc comments !!! |
343 |
void MoveSubChunk(Chunk* pSrc, List* pNewParent); |
344 |
virtual ~List(); |
345 |
protected: |
346 |
typedef std::map<uint32_t, RIFF::Chunk*> ChunkMap; |
347 |
typedef std::vector<Chunk*> ChunkList; |
348 |
typedef std::set<Chunk*> ChunkSet; |
349 |
|
350 |
uint32_t ListType; |
351 |
ChunkList* pSubChunks; |
352 |
ChunkMap* pSubChunksMap; |
353 |
ChunkList::iterator ChunksIterator; |
354 |
ChunkList::iterator ListIterator; |
355 |
|
356 |
List(File* pFile); |
357 |
List(File* pFile, List* pParent, uint32_t uiListID); |
358 |
void ReadHeader(file_offset_t filePos); |
359 |
void WriteHeader(file_offset_t filePos); |
360 |
void LoadSubChunks(progress_t* pProgress = NULL); |
361 |
void LoadSubChunksRecursively(progress_t* pProgress = NULL); |
362 |
virtual file_offset_t RequiredPhysicalSize(int fileOffsetSize); |
363 |
virtual file_offset_t WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t* pProgress = NULL); |
364 |
virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same. |
365 |
void DeleteChunkList(); |
366 |
}; |
367 |
|
368 |
/** @brief RIFF File |
369 |
* |
370 |
* Handles arbitrary RIFF files and provides together with its base |
371 |
* classes convenient methods to walk through, read and modify the |
372 |
* file's RIFF tree. |
373 |
*/ |
374 |
class File : public List { |
375 |
public: |
376 |
/** |
377 |
* OS dependent type serving as file handle / descriptor for OS |
378 |
* dependent file I/O operations. |
379 |
*/ |
380 |
#if POSIX |
381 |
typedef int Handle; |
382 |
#elif defined(WIN32) |
383 |
typedef HANDLE Handle; |
384 |
#else |
385 |
typedef FILE* Handle; |
386 |
#endif |
387 |
|
388 |
File(uint32_t FileType); |
389 |
File(const String& path); |
390 |
File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout, offset_size_t fileOffsetSize = offset_size_auto); |
391 |
stream_mode_t GetMode() const; |
392 |
bool SetMode(stream_mode_t NewMode); |
393 |
void SetByteOrder(endian_t Endian); |
394 |
String GetFileName() const; |
395 |
void SetFileName(const String& path); |
396 |
Handle FileHandle() const; |
397 |
bool IsNew() const; |
398 |
layout_t GetLayout() const; |
399 |
file_offset_t GetCurrentFileSize() const; |
400 |
file_offset_t GetRequiredFileSize(); |
401 |
file_offset_t GetRequiredFileSize(offset_size_t fileOffsetSize); |
402 |
int GetFileOffsetSize() const; |
403 |
int GetRequiredFileOffsetSize(); |
404 |
bool IsIOPerThread() const; |
405 |
void SetIOPerThread(bool enable); |
406 |
|
407 |
virtual void Save(progress_t* pProgress = NULL); |
408 |
virtual void Save(const String& path, progress_t* pProgress = NULL); |
409 |
virtual ~File(); |
410 |
protected: |
411 |
struct HandlePair { |
412 |
Handle hRead; ///< handle / descriptor for reading from file |
413 |
Handle hWrite; ///< handle / descriptor for writing to (some) file |
414 |
stream_mode_t Mode; ///< State of handles (ro, rw, closed). |
415 |
}; |
416 |
struct IO : HandlePair { |
417 |
bool isPerThread; ///< Whether SetIOPerThread(true) was called. |
418 |
mutable std::map<std::thread::id,HandlePair> byThread; ///< Optional: Individual file handle pair for each thread separately. |
419 |
mutable std::mutex mutex; ///< For protecting concurrent changes on the @c byThread map itself and replacing handles. |
420 |
} io; |
421 |
String Filename; |
422 |
bool bEndianNative; |
423 |
bool bIsNewFile; |
424 |
layout_t Layout; ///< An ordinary RIFF file is always set to layout_standard. |
425 |
offset_size_t FileOffsetPreference; |
426 |
int FileOffsetSize; ///< Size of file offsets (in bytes) when this file was opened (or saved the last time). |
427 |
|
428 |
Handle FileWriteHandle() const; |
429 |
HandlePair FileHandlePair() const; |
430 |
|
431 |
friend class Chunk; |
432 |
friend class List; |
433 |
private: |
434 |
void __openExistingFile(const String& path, uint32_t* FileType = NULL); |
435 |
void ResizeFile(file_offset_t ullNewSize); |
436 |
#if POSIX |
437 |
file_offset_t __GetFileSize(int hFile) const; |
438 |
#elif defined(WIN32) |
439 |
file_offset_t __GetFileSize(HANDLE hFile) const; |
440 |
#else |
441 |
file_offset_t __GetFileSize(FILE* hFile) const; |
442 |
#endif |
443 |
int FileOffsetSizeFor(file_offset_t fileSize) const; |
444 |
void Cleanup(); |
445 |
HandlePair& FileHandlePairUnsafeRef(); |
446 |
bool SetModeInternal(stream_mode_t NewMode, bool* pResetPos); |
447 |
}; |
448 |
|
449 |
/** |
450 |
* Will be thrown whenever an error occurs while handling a RIFF file. |
451 |
*/ |
452 |
class Exception { |
453 |
public: |
454 |
String Message; |
455 |
|
456 |
Exception(String format, ...); |
457 |
Exception(String format, va_list arg); |
458 |
void PrintMessage(); |
459 |
virtual ~Exception() {} |
460 |
|
461 |
protected: |
462 |
Exception(); |
463 |
static String assemble(String format, va_list arg); |
464 |
}; |
465 |
|
466 |
String libraryName(); |
467 |
String libraryVersion(); |
468 |
|
469 |
} // namespace RIFF |
470 |
#endif // __RIFF_H__ |