/[svn]/libgig/trunk/src/RIFF.h
ViewVC logotype

Contents of /libgig/trunk/src/RIFF.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2922 - (show annotations) (download) (as text)
Wed May 18 18:04:49 2016 UTC (4 years, 5 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 18244 byte(s)
* Using now native integer size where appropriate.
* Bumped version (4.0.0.svn5).

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

  ViewVC Help
Powered by ViewVC