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