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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3916 - (hide annotations) (download) (as text)
Mon Jun 7 19:42:17 2021 UTC (15 months, 3 weeks ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 19786 byte(s)
* RIFF: Fix deadlock in File::SetMode().

* Bumped version (4.3.0.svn8).

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

  ViewVC Help
Powered by ViewVC