libgig 4.4.1
RIFF.h
1/***************************************************************************
2 * *
3 * libgig - C++ cross-platform Gigasampler format file access library *
4 * *
5 * Copyright (C) 2003-2024 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#include <string>
28#include <list>
29#include <map>
30#include <set>
31#include <vector>
32#include <iostream>
33#include <stdarg.h>
34#include <thread>
35#include <mutex>
36#include <stdio.h>
37
38#include "sysdef.h"
39
40#if WORDS_BIGENDIAN
41# define CHUNK_ID_RIFF 0x52494646
42# define CHUNK_ID_RIFX 0x52494658
43# define CHUNK_ID_LIST 0x4C495354
44
45# define LIST_TYPE_INFO 0x494E464F
46# define CHUNK_ID_ICMT 0x49434D54
47# define CHUNK_ID_ICOP 0x49434F50
48# define CHUNK_ID_ICRD 0x49435244
49# define CHUNK_ID_IENG 0x49454E47
50# define CHUNK_ID_INAM 0x494E414D
51# define CHUNK_ID_IPRD 0x49505244
52# define CHUNK_ID_ISFT 0x49534654
53
54# define CHUNK_ID_SMPL 0x736D706C
55
56#else // little endian
57# define CHUNK_ID_RIFF 0x46464952
58# define CHUNK_ID_RIFX 0x58464952
59# define CHUNK_ID_LIST 0x5453494C
60
61# define LIST_TYPE_INFO 0x4F464E49
62# define CHUNK_ID_ICMT 0x544D4349
63# define CHUNK_ID_ICOP 0x504F4349
64# define CHUNK_ID_ICRD 0x44524349
65# define CHUNK_ID_IENG 0x474E4549
66# define CHUNK_ID_INAM 0x4D414E49
67# define CHUNK_ID_IPRD 0x44525049
68# define CHUNK_ID_ISFT 0x54465349
69
70# define CHUNK_ID_SMPL 0x6C706D73
71
72#endif // WORDS_BIGENDIAN
73
74#define CHUNK_HEADER_SIZE(fileOffsetSize) (4 + fileOffsetSize)
75#define LIST_HEADER_SIZE(fileOffsetSize) (8 + fileOffsetSize)
76#define RIFF_HEADER_SIZE(fileOffsetSize) (8 + fileOffsetSize)
77
97namespace RIFF {
98
99 /* just symbol prototyping */
100 class Chunk;
101 class List;
102 class File;
103
104 typedef std::string String;
105
107 typedef uint64_t file_offset_t;
108
111 stream_mode_read = 0,
112 stream_mode_read_write = 1,
113 stream_mode_closed = 2
114 };
115
118 stream_ready = 0,
119 stream_end_reached = 1,
120 stream_closed = 2
121 };
122
125 stream_start = 0,
126 stream_curpos = 1,
127 stream_backward = 2,
128 stream_end = 3
129 };
130
132 enum endian_t {
133 endian_little = 0,
134 endian_big = 1,
135 endian_native = 2
136 };
137
143
150
163 struct progress_t {
165 float factor;
166 void* custom;
169 progress_t();
170 std::vector<progress_t> subdivide(int iSubtasks);
171 std::vector<progress_t> subdivide(std::vector<float> vSubTaskPortions);
172 };
173
179 class Chunk {
180 public:
181 Chunk(File* pFile, file_offset_t StartPos, List* Parent);
182 String GetChunkIDString() const;
183 uint32_t GetChunkID() const { return ChunkID; }
184 File* GetFile() const { return pFile; }
185 List* GetParent() const { return pParent; }
186 file_offset_t GetSize() const { return ullCurrentChunkSize; }
187 file_offset_t GetNewSize() const { return ullNewChunkSize; }
188 file_offset_t GetPos() const;
190 file_offset_t SetPos(file_offset_t Where, stream_whence_t Whence = stream_start);
192 stream_state_t GetState() const;
193 file_offset_t Read(void* pData, file_offset_t WordCount, file_offset_t WordSize);
194 file_offset_t ReadInt8(int8_t* pData, file_offset_t WordCount = 1);
195 file_offset_t ReadUint8(uint8_t* pData, file_offset_t WordCount = 1);
196 file_offset_t ReadInt16(int16_t* pData, file_offset_t WordCount = 1);
197 file_offset_t ReadUint16(uint16_t* pData, file_offset_t WordCount = 1);
198 file_offset_t ReadInt32(int32_t* pData, file_offset_t WordCount = 1);
199 file_offset_t ReadUint32(uint32_t* pData, file_offset_t WordCount = 1);
200 int8_t ReadInt8();
201 uint8_t ReadUint8();
202 int16_t ReadInt16();
203 uint16_t ReadUint16();
204 int32_t ReadInt32();
205 uint32_t ReadUint32();
206 void ReadString(String& s, int size);
207 file_offset_t Write(void* pData, file_offset_t WordCount, file_offset_t WordSize);
208 file_offset_t WriteInt8(int8_t* pData, file_offset_t WordCount = 1);
209 file_offset_t WriteUint8(uint8_t* pData, file_offset_t WordCount = 1);
210 file_offset_t WriteInt16(int16_t* pData, file_offset_t WordCount = 1);
211 file_offset_t WriteUint16(uint16_t* pData, file_offset_t WordCount = 1);
212 file_offset_t WriteInt32(int32_t* pData, file_offset_t WordCount = 1);
213 file_offset_t WriteUint32(uint32_t* pData, file_offset_t WordCount = 1);
214 void* LoadChunkData();
215 void ReleaseChunkData();
216 void Resize(file_offset_t NewSize);
217 virtual ~Chunk();
218 protected:
219 uint32_t ChunkID;
220 file_offset_t ullCurrentChunkSize; /* in bytes */
221 file_offset_t ullNewChunkSize; /* in bytes (if chunk was scheduled to be resized) */
222 List* pParent;
223 File* pFile;
224 file_offset_t ullStartPos; /* actual position in file where chunk data (without header) starts */
225 uint8_t* pChunkData;
226 file_offset_t ullChunkDataSize;
227 struct ChunkPos { /* current read/write position as # of bytes from ulStartPos */
228 file_offset_t ullPos; /* used if File::IsIOPerThread() is false (default) */
229 mutable std::map<std::thread::id,file_offset_t> byThread; /* used if File::IsIOPerThread() is true */
230 mutable std::mutex mutex; /* for protecting concurrent changes on byThread map itself */
231 } chunkPos;
232
233 Chunk(File* pFile);
234 Chunk(File* pFile, List* pParent, uint32_t uiChunkID, file_offset_t ullBodySize);
235 void ReadHeader(file_offset_t filePos);
236 void WriteHeader(file_offset_t filePos);
237 file_offset_t ReadSceptical(void* pData, file_offset_t WordCount, file_offset_t WordSize);
238 inline static String convertToString(uint32_t word) {
239 String result;
240 for (int i = 0; i < 4; i++) {
241 uint8_t byte = *((uint8_t*)(&word) + i);
242 char c = byte;
243 result += c;
244 }
245 return result;
246 }
247 virtual file_offset_t RequiredPhysicalSize(int fileOffsetSize);
248 virtual file_offset_t WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t* pProgress = NULL);
249 virtual void __resetPos();
250
251 friend class List;
252 private:
253 file_offset_t& GetPosUnsafeRef();
254 };
255
261 class List : public Chunk {
262 public:
263 List(File* pFile, file_offset_t StartPos, List* Parent);
264 String GetListTypeString() const;
265 uint32_t GetListType() const { return ListType; }
266 Chunk* GetSubChunkAt(size_t pos);
267 Chunk* GetSubChunk(uint32_t ChunkID);
268 List* GetSubListAt(size_t pos);
269 List* GetSubList(uint32_t ListType);
270 Chunk* GetFirstSubChunk() LIBGIG_DEPRECATED_API("Use GetSubChunkAt() instead.");
271 Chunk* GetNextSubChunk() LIBGIG_DEPRECATED_API("Use GetSubChunkAt() instead.");
272 List* GetFirstSubList() LIBGIG_DEPRECATED_API("Use GetSubListAt() instead.");
273 List* GetNextSubList() LIBGIG_DEPRECATED_API("Use GetSubListAt() instead.");
274 size_t CountSubChunks();
275 size_t CountSubChunks(uint32_t ChunkID);
276 size_t CountSubLists();
277 size_t CountSubLists(uint32_t ListType);
278 Chunk* AddSubChunk(uint32_t uiChunkID, file_offset_t ullBodySize);
279 List* AddSubList(uint32_t uiListType);
280 void DeleteSubChunk(Chunk* pSubChunk);
281 void MoveSubChunk(Chunk* pSrc, Chunk* pDst); // read API doc comments !!!
282 void MoveSubChunk(Chunk* pSrc, List* pNewParent);
283 virtual ~List();
284 protected:
285 typedef std::map<uint32_t, RIFF::Chunk*> ChunkMap;
286 typedef std::vector<Chunk*> ChunkList;
287 typedef std::set<Chunk*> ChunkSet;
288
289 uint32_t ListType;
290 ChunkList* pSubChunks;
291 ChunkMap* pSubChunksMap;
292 ChunkList::iterator ChunksIterator;
293 ChunkList::iterator ListIterator;
294
295 List(File* pFile);
296 List(File* pFile, List* pParent, uint32_t uiListID);
297 void ReadHeader(file_offset_t filePos);
298 void WriteHeader(file_offset_t filePos);
299 void LoadSubChunks(progress_t* pProgress = NULL);
300 void LoadSubChunksRecursively(progress_t* pProgress = NULL);
301 virtual file_offset_t RequiredPhysicalSize(int fileOffsetSize);
302 virtual file_offset_t WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t* pProgress = NULL);
303 virtual void __resetPos();
304 void DeleteChunkList();
305 };
306
313 class File : public List {
314 public:
319 #if POSIX
320 typedef int Handle;
321 #elif defined(WIN32)
322 typedef HANDLE Handle;
323 #else
324 typedef FILE* Handle;
325 #endif
326
327 File(uint32_t FileType);
328 File(const String& path);
329 File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout, offset_size_t fileOffsetSize = offset_size_auto);
330 stream_mode_t GetMode() const;
331 bool SetMode(stream_mode_t NewMode);
332 void SetByteOrder(endian_t Endian);
333 String GetFileName() const;
334 void SetFileName(const String& path);
335 Handle FileHandle() const;
336 bool IsNew() const;
337 layout_t GetLayout() const;
338 file_offset_t GetCurrentFileSize() const;
339 file_offset_t GetRequiredFileSize();
340 file_offset_t GetRequiredFileSize(offset_size_t fileOffsetSize);
341 int GetFileOffsetSize() const;
342 int GetRequiredFileOffsetSize();
343 bool IsIOPerThread() const;
344 void SetIOPerThread(bool enable);
345
346 virtual void Save(progress_t* pProgress = NULL);
347 virtual void Save(const String& path, progress_t* pProgress = NULL);
348 virtual ~File();
349 protected:
350 struct HandlePair {
351 Handle hRead;
352 Handle hWrite;
353 stream_mode_t Mode;
354 };
355 struct IO : HandlePair {
356 bool isPerThread;
357 mutable std::map<std::thread::id,HandlePair> byThread;
358 mutable std::mutex mutex;
359 } io;
360 String Filename;
361 bool bEndianNative;
362 bool bIsNewFile;
364 offset_size_t FileOffsetPreference;
366
367 Handle FileWriteHandle() const;
368 HandlePair FileHandlePair() const;
369
370 friend class Chunk;
371 friend class List;
372 private:
373 void __openExistingFile(const String& path, uint32_t* FileType = NULL);
374 void ResizeFile(file_offset_t ullNewSize);
375 #if POSIX
376 file_offset_t __GetFileSize(int hFile) const;
377 #elif defined(WIN32)
378 file_offset_t __GetFileSize(HANDLE hFile) const;
379 #else
380 file_offset_t __GetFileSize(FILE* hFile) const;
381 #endif
382 int FileOffsetSizeFor(file_offset_t fileSize) const;
383 void Cleanup();
384 HandlePair& FileHandlePairUnsafeRef();
385 bool SetModeInternal(stream_mode_t NewMode, bool* pResetPos);
386 };
387
391 class Exception {
392 public:
393 String Message;
394
395 Exception(String format, ...);
396 Exception(String format, va_list arg);
397 void PrintMessage();
398 virtual ~Exception() {}
399
400 protected:
401 Exception();
402 static String assemble(String format, va_list arg);
403 };
404
405 String libraryName();
406 String libraryVersion();
407
408} // namespace RIFF
409#endif // __RIFF_H__
Ordinary RIFF Chunk.
Definition RIFF.h:179
File * GetFile() const
Returns pointer to the chunk's File object.
Definition RIFF.h:184
List * GetParent() const
Returns pointer to the chunk's parent list chunk.
Definition RIFF.h:185
file_offset_t WriteInt16(int16_t *pData, file_offset_t WordCount=1)
Writes WordCount number of 16 Bit signed integer words from the buffer pointed by pData to the chunk'...
Definition RIFF.cpp:693
virtual void __resetPos()
Sets Chunk's read/write position to zero.
Definition RIFF.cpp:1159
void Resize(file_offset_t NewSize)
Resize chunk.
Definition RIFF.cpp:1034
int8_t ReadInt8()
Reads one 8 Bit signed integer word and increments the position within the chunk.
Definition RIFF.cpp:840
uint32_t ReadUint32()
Reads one 32 Bit unsigned integer word and increments the position within the chunk.
Definition RIFF.cpp:929
stream_state_t GetState() const
Returns the current state of the chunk object.
Definition RIFF.cpp:410
file_offset_t SetPos(file_offset_t Where, stream_whence_t Whence=stream_start)
Sets the position within the chunk body, thus within the data portion of the chunk (in bytes).
Definition RIFF.cpp:341
file_offset_t GetFilePos() const
Current, actual offset in file of current chunk data body read/write position.
Definition RIFF.cpp:324
void ReleaseChunkData()
Free loaded chunk body from RAM.
Definition RIFF.cpp:1009
file_offset_t Write(void *pData, file_offset_t WordCount, file_offset_t WordSize)
Writes WordCount number of data words with given WordSize from the buffer pointed by pData.
Definition RIFF.cpp:517
file_offset_t RemainingBytes() const
Returns the number of bytes left to read in the chunk body.
Definition RIFF.cpp:376
int16_t ReadInt16()
Reads one 16 Bit signed integer word and increments the position within the chunk.
Definition RIFF.cpp:875
virtual file_offset_t WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t *pProgress=NULL)
Write chunk persistently e.g.
Definition RIFF.cpp:1057
file_offset_t GetPos() const
Current read/write position within the chunk data body (starting with 0).
Definition RIFF.cpp:311
file_offset_t WriteInt32(int32_t *pData, file_offset_t WordCount=1)
Writes WordCount number of 32 Bit signed integer words from the buffer pointed by pData to the chunk'...
Definition RIFF.cpp:771
file_offset_t ReadSceptical(void *pData, file_offset_t WordCount, file_offset_t WordSize)
Just an internal wrapper for the main Read() method with additional Exception throwing on errors.
Definition RIFF.cpp:575
virtual file_offset_t RequiredPhysicalSize(int fileOffsetSize)
Returns the actual total size in bytes (including header) of this Chunk if being stored to a file.
Definition RIFF.cpp:391
file_offset_t Read(void *pData, file_offset_t WordCount, file_offset_t WordSize)
Reads WordCount number of data words with given WordSize and copies it into a buffer pointed by pData...
Definition RIFF.cpp:441
uint32_t GetChunkID() const
Chunk ID in unsigned integer representation.
Definition RIFF.h:183
void * LoadChunkData()
Load chunk body into RAM.
Definition RIFF.cpp:960
String GetChunkIDString() const
Returns the String representation of the chunk's ID (e.g.
Definition RIFF.cpp:288
uint8_t ReadUint8()
Reads one 8 Bit unsigned integer word and increments the position within the chunk.
Definition RIFF.cpp:857
file_offset_t WriteInt8(int8_t *pData, file_offset_t WordCount=1)
Writes WordCount number of 8 Bit signed integer words from the buffer pointed by pData to the chunk's...
Definition RIFF.cpp:615
file_offset_t WriteUint16(uint16_t *pData, file_offset_t WordCount=1)
Writes WordCount number of 16 Bit unsigned integer words from the buffer pointed by pData to the chun...
Definition RIFF.cpp:732
file_offset_t WriteUint32(uint32_t *pData, file_offset_t WordCount=1)
Writes WordCount number of 32 Bit unsigned integer words from the buffer pointed by pData to the chun...
Definition RIFF.cpp:828
void ReadString(String &s, int size)
Reads a null-padded string of size characters and copies it into the string s.
Definition RIFF.cpp:806
uint16_t ReadUint16()
Reads one 16 Bit unsigned integer word and increments the position within the chunk.
Definition RIFF.cpp:893
file_offset_t GetSize() const
Chunk size in bytes (without header, thus the chunk data body)
Definition RIFF.h:186
int32_t ReadInt32()
Reads one 32 Bit signed integer word and increments the position within the chunk.
Definition RIFF.cpp:911
file_offset_t WriteUint8(uint8_t *pData, file_offset_t WordCount=1)
Writes WordCount number of 8 Bit unsigned integer words from the buffer pointed by pData to the chunk...
Definition RIFF.cpp:654
file_offset_t GetNewSize() const
New chunk size if it was modified with Resize(), otherwise value returned will be equal to GetSize().
Definition RIFF.h:187
Will be thrown whenever an error occurs while handling a RIFF file.
Definition RIFF.h:391
RIFF File.
Definition RIFF.h:313
layout_t Layout
An ordinary RIFF file is always set to layout_standard.
Definition RIFF.h:363
int Handle
OS dependent type serving as file handle / descriptor for OS dependent file I/O operations.
Definition RIFF.h:320
int FileOffsetSize
Size of file offsets (in bytes) when this file was opened (or saved the last time).
Definition RIFF.h:365
RIFF List Chunk.
Definition RIFF.h:261
size_t CountSubLists()
Returns number of sublists within the list.
Definition RIFF.cpp:1422
Chunk * GetSubChunk(uint32_t ChunkID)
Returns subchunk with chunk ID ChunkID within this chunk list.
Definition RIFF.cpp:1246
virtual file_offset_t RequiredPhysicalSize(int fileOffsetSize)
Returns the actual total size in bytes (including List chunk header and all subchunks) of this List C...
Definition RIFF.cpp:1584
void MoveSubChunk(Chunk *pSrc, Chunk *pDst)
Moves a sub chunk witin this list.
Definition RIFF.cpp:1480
List * GetFirstSubList()
Returns the first sublist within the list (that is a subchunk with chunk ID "LIST").
Definition RIFF.cpp:1354
List * AddSubList(uint32_t uiListType)
Creates a new list sub chunk.
Definition RIFF.cpp:1537
Chunk * GetFirstSubChunk()
Returns the first subchunk within the list (which may be an ordinary chunk as well as a list chunk).
Definition RIFF.cpp:1315
virtual file_offset_t WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t *pProgress=NULL)
Write list chunk persistently e.g.
Definition RIFF.cpp:1722
void DeleteSubChunk(Chunk *pSubChunk)
Removes a sub chunk.
Definition RIFF.cpp:1556
List * GetSubListAt(size_t pos)
Returns sublist chunk with list type ListType at supplied pos position among all subchunks of type Li...
Definition RIFF.cpp:1264
size_t CountSubChunks()
Returns number of subchunks within the list (including list chunks).
Definition RIFF.cpp:1396
List * GetSubList(uint32_t ListType)
Returns sublist chunk with list type ListType within this chunk list.
Definition RIFF.cpp:1287
Chunk * GetNextSubChunk()
Returns the next subchunk within the list (which may be an ordinary chunk as well as a list chunk).
Definition RIFF.cpp:1334
uint32_t GetListType() const
Returns unsigned integer representation of the list's ID.
Definition RIFF.h:265
String GetListTypeString() const
Returns string representation of the lists's id.
Definition RIFF.cpp:1770
List * GetNextSubList()
Returns the next sublist (that is a subchunk with chunk ID "LIST") within the list.
Definition RIFF.cpp:1378
Chunk * AddSubChunk(uint32_t uiChunkID, file_offset_t ullBodySize)
Creates a new sub chunk.
Definition RIFF.cpp:1458
virtual void __resetPos()
Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.
Definition RIFF.cpp:1758
Chunk * GetSubChunkAt(size_t pos)
Returns subchunk at supplied pos position within this chunk list.
Definition RIFF.cpp:1229
RIFF specific classes and definitions.
Definition RIFF.h:97
String libraryVersion()
Returns version of this C++ library.
Definition RIFF.cpp:2722
stream_whence_t
File stream position dependent to these relations.
Definition RIFF.h:124
stream_state_t
Current state of the file stream.
Definition RIFF.h:117
String libraryName()
Returns the name of this C++ library.
Definition RIFF.cpp:2714
offset_size_t
Size of RIFF file offsets used in all RIFF chunks' headers.
Definition RIFF.h:145
@ offset_size_64bit
Always use 64 bit offsets (even for files smaller than 4 GB).
Definition RIFF.h:148
@ offset_size_auto
Use 32 bit offsets for files smaller than 4 GB, use 64 bit offsets for files equal or larger than 4 G...
Definition RIFF.h:146
@ offset_size_32bit
Always use 32 bit offsets (even for files larger than 4 GB).
Definition RIFF.h:147
stream_mode_t
Whether file stream is open in read or in read/write mode.
Definition RIFF.h:110
layout_t
General RIFF chunk structure of a RIFF file.
Definition RIFF.h:139
@ layout_standard
Standard RIFF file layout: First chunk in file is a List chunk which contains all other chunks and th...
Definition RIFF.h:140
@ layout_flat
Not a "real" RIFF file: First chunk in file is an ordinary data chunk, not a List chunk,...
Definition RIFF.h:141
endian_t
Alignment of data bytes in memory (system dependant).
Definition RIFF.h:132
uint64_t file_offset_t
Type used by libgig for handling file positioning during file I/O tasks.
Definition RIFF.h:107
Used for indicating the progress of a certain task.
Definition RIFF.h:163
float __range_min
Only for internal usage, do not modify!
Definition RIFF.h:167
std::vector< progress_t > subdivide(int iSubtasks)
Divides this progress task into the requested amount of equal weighted sub-progress tasks and returns...
Definition RIFF.cpp:93
void(* callback)(progress_t *)
Callback function pointer which has to be assigned to a function for progress notification.
Definition RIFF.h:164
float factor
Reflects current progress as value between 0.0 and 1.0.
Definition RIFF.h:165
void * custom
This pointer can be used for arbitrary data.
Definition RIFF.h:166
float __range_max
Only for internal usage, do not modify!
Definition RIFF.h:168