libgig  3.3.0.svn4
RIFF.h
Go to the documentation of this file.
1 /***************************************************************************
2  * *
3  * libgig - C++ cross-platform Gigasampler format file access library *
4  * *
5  * Copyright (C) 2003-2013 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 <iostream>
43 
44 #ifdef HAVE_CONFIG_H
45 # include <config.h>
46 #endif
47 
48 #if POSIX
49 # include <sys/types.h>
50 # include <sys/stat.h>
51 # include <fcntl.h>
52 # include <unistd.h>
53 #endif // POSIX
54 
55 #ifdef _MSC_VER
56 // Visual C++ 2008 doesn't have stdint.h
57 typedef __int8 int8_t;
58 typedef __int16 int16_t;
59 typedef __int32 int32_t;
60 typedef __int64 int64_t;
61 typedef unsigned __int8 uint8_t;
62 typedef unsigned __int16 uint16_t;
63 typedef unsigned __int32 uint32_t;
64 typedef unsigned __int64 uint64_t;
65 #else
66 #include <stdint.h>
67 #endif
68 
69 #ifdef WIN32
70 # include <windows.h>
71  typedef unsigned int uint;
72 #endif // WIN32
73 
74 #include <stdio.h>
75 
76 #if WORDS_BIGENDIAN
77 # define CHUNK_ID_RIFF 0x52494646
78 # define CHUNK_ID_RIFX 0x52494658
79 # define CHUNK_ID_LIST 0x4C495354
80 
81 # define LIST_TYPE_INFO 0x494E464F
82 # define CHUNK_ID_ICMT 0x49434D54
83 # define CHUNK_ID_ICOP 0x49434F50
84 # define CHUNK_ID_ICRD 0x49435244
85 # define CHUNK_ID_IENG 0x49454E47
86 # define CHUNK_ID_INAM 0x494E414D
87 # define CHUNK_ID_IPRD 0x49505244
88 # define CHUNK_ID_ISFT 0x49534654
89 
90 # define CHUNK_ID_SMPL 0x736D706C
91 
92 #else // little endian
93 # define CHUNK_ID_RIFF 0x46464952
94 # define CHUNK_ID_RIFX 0x58464952
95 # define CHUNK_ID_LIST 0x5453494C
96 
97 # define LIST_TYPE_INFO 0x4F464E49
98 # define CHUNK_ID_ICMT 0x544D4349
99 # define CHUNK_ID_ICOP 0x504F4349
100 # define CHUNK_ID_ICRD 0x44524349
101 # define CHUNK_ID_IENG 0x474E4549
102 # define CHUNK_ID_INAM 0x4D414E49
103 # define CHUNK_ID_IPRD 0x44525049
104 # define CHUNK_ID_ISFT 0x54465349
105 
106 # define CHUNK_ID_SMPL 0x6C706D73
107 
108 #endif // WORDS_BIGENDIAN
109 
110 #define CHUNK_HEADER_SIZE 8
111 #define LIST_HEADER_SIZE 12
112 #define RIFF_HEADER_SIZE 12
113 
114 
134 namespace RIFF {
135 
136  /* just symbol prototyping */
137  class Chunk;
138  class List;
139  class File;
140 
141  typedef std::string String;
142 
144  typedef enum {
148  } stream_mode_t;
149 
151  typedef enum {
155  } stream_state_t;
156 
158  typedef enum {
163  } stream_whence_t;
164 
166  typedef enum {
170  } endian_t;
171 
177  class Chunk {
178  public:
179  Chunk(File* pFile, unsigned long StartPos, List* Parent);
181  uint32_t GetChunkID() { return ChunkID; }
182  List* GetParent() { return pParent; }
183  unsigned long GetSize() { return CurrentChunkSize; }
184  unsigned long GetNewSize() { return NewChunkSize; }
185  unsigned long GetPos() { return ulPos; }
186  unsigned long GetFilePos() { return ulStartPos + ulPos; }
187  unsigned long SetPos(unsigned long Where, stream_whence_t Whence = stream_start);
188  unsigned long RemainingBytes();
190  unsigned long Read(void* pData, unsigned long WordCount, unsigned long WordSize);
191  unsigned long ReadInt8(int8_t* pData, unsigned long WordCount = 1);
192  unsigned long ReadUint8(uint8_t* pData, unsigned long WordCount = 1);
193  unsigned long ReadInt16(int16_t* pData, unsigned long WordCount = 1);
194  unsigned long ReadUint16(uint16_t* pData, unsigned long WordCount = 1);
195  unsigned long ReadInt32(int32_t* pData, unsigned long WordCount = 1);
196  unsigned long ReadUint32(uint32_t* pData, unsigned long WordCount = 1);
197  int8_t ReadInt8();
198  uint8_t ReadUint8();
199  int16_t ReadInt16();
200  uint16_t ReadUint16();
201  int32_t ReadInt32();
202  uint32_t ReadUint32();
203  void ReadString(String& s, int size);
204  unsigned long Write(void* pData, unsigned long WordCount, unsigned long WordSize);
205  unsigned long WriteInt8(int8_t* pData, unsigned long WordCount = 1);
206  unsigned long WriteUint8(uint8_t* pData, unsigned long WordCount = 1);
207  unsigned long WriteInt16(int16_t* pData, unsigned long WordCount = 1);
208  unsigned long WriteUint16(uint16_t* pData, unsigned long WordCount = 1);
209  unsigned long WriteInt32(int32_t* pData, unsigned long WordCount = 1);
210  unsigned long WriteUint32(uint32_t* pData, unsigned long WordCount = 1);
211  void* LoadChunkData();
212  void ReleaseChunkData();
213  void Resize(int iNewSize);
214  virtual ~Chunk();
215  protected:
216  uint32_t ChunkID;
217  uint32_t CurrentChunkSize; /* in bytes */
218  uint32_t NewChunkSize; /* in bytes (if chunk was scheduled to be resized) */
221  unsigned long ulStartPos; /* actual position in file where chunk (without header) starts */
222  unsigned long ulPos; /* # of bytes from ulStartPos */
223  uint8_t* pChunkData;
224  unsigned long ulChunkDataSize;
225 
226  Chunk(File* pFile);
227  Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize);
228  void ReadHeader(unsigned long fPos);
229  void WriteHeader(unsigned long fPos);
230  unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);
231  inline void swapBytes_16(void* Word) {
232  uint8_t byteCache = *((uint8_t*) Word);
233  *((uint8_t*) Word) = *((uint8_t*) Word + 1);
234  *((uint8_t*) Word + 1) = byteCache;
235  }
236  inline void swapBytes_32(void* Word) {
237  uint8_t byteCache = *((uint8_t*) Word);
238  *((uint8_t*) Word) = *((uint8_t*) Word + 3);
239  *((uint8_t*) Word + 3) = byteCache;
240  byteCache = *((uint8_t*) Word + 1);
241  *((uint8_t*) Word + 1) = *((uint8_t*) Word + 2);
242  *((uint8_t*) Word + 2) = byteCache;
243  }
244  inline void swapBytes(void* Word, unsigned long WordSize) {
245  uint8_t byteCache;
246  unsigned long lo = 0, hi = WordSize - 1;
247  for (; lo < hi; hi--, lo++) {
248  byteCache = *((uint8_t*) Word + lo);
249  *((uint8_t*) Word + lo) = *((uint8_t*) Word + hi);
250  *((uint8_t*) Word + hi) = byteCache;
251  }
252  }
253  inline String convertToString(uint32_t word) {
254  String result;
255  for (int i = 0; i < 4; i++) {
256  uint8_t byte = *((uint8_t*)(&word) + i);
257  char c = byte;
258  result += c;
259  }
260  return result;
261  }
262  virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
263  virtual void __resetPos();
264 
265  friend class List;
266  };
267 
273  class List : public Chunk {
274  public:
275  List(File* pFile, unsigned long StartPos, List* Parent);
277  uint32_t GetListType() { return ListType; }
278  Chunk* GetSubChunk(uint32_t ChunkID);
279  List* GetSubList(uint32_t ListType);
283  List* GetNextSubList();
284  unsigned int CountSubChunks();
285  unsigned int CountSubChunks(uint32_t ChunkID);
286  unsigned int CountSubLists();
287  unsigned int CountSubLists(uint32_t ListType);
288  Chunk* AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
289  List* AddSubList(uint32_t uiListType);
290  void DeleteSubChunk(Chunk* pSubChunk);
291  void MoveSubChunk(Chunk* pSrc, Chunk* pDst);
292  virtual ~List();
293  protected:
294  typedef std::map<uint32_t, RIFF::Chunk*> ChunkMap;
295  typedef std::list<Chunk*> ChunkList;
296 
297  uint32_t ListType;
300  ChunkList::iterator ChunksIterator;
301  ChunkList::iterator ListIterator;
302 
303  List(File* pFile);
304  List(File* pFile, List* pParent, uint32_t uiListID);
305  void ReadHeader(unsigned long fPos);
306  void WriteHeader(unsigned long fPos);
307  void LoadSubChunks();
309  virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
310  virtual void __resetPos();
311  void DeleteChunkList();
312  };
313 
320  class File : public List {
321  public:
322  File(uint32_t FileType);
323  File(const String& path);
325  bool SetMode(stream_mode_t NewMode);
326  void SetByteOrder(endian_t Endian);
328  virtual void Save();
329  virtual void Save(const String& path);
330  virtual ~File();
331  protected:
332  #if POSIX
333  int hFileRead;
335  #elif defined(WIN32)
336  HANDLE hFileRead;
337  HANDLE hFileWrite;
338  #else
339  FILE* hFileRead;
340  FILE* hFileWrite;
341  #endif // POSIX
344 
345  void LogAsResized(Chunk* pResizedChunk);
346  void UnlogResized(Chunk* pResizedChunk);
347  friend class Chunk;
348  friend class List;
349  private:
350  stream_mode_t Mode;
351  ChunkList ResizedChunks;
352 
353  unsigned long GetFileSize();
354  void ResizeFile(unsigned long ulNewSize);
355  #if POSIX
356  unsigned long __GetFileSize(int hFile);
357  #elif defined(WIN32)
358  unsigned long __GetFileSize(HANDLE hFile);
359  #else
360  unsigned long __GetFileSize(FILE* hFile);
361  #endif
362  void Cleanup();
363  };
364 
368  class Exception {
369  public:
371 
373  void PrintMessage();
374  virtual ~Exception() {}
375  };
376 
379 
380 } // namespace RIFF
381 #endif // __RIFF_H__
virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset)
Write chunk persistently e.g.
Definition: RIFF.cpp:842
unsigned long WriteUint32(uint32_t *pData, unsigned long WordCount=1)
Writes WordCount number of 32 Bit unsigned integer words from the buffer pointed by pData to the chun...
Definition: RIFF.cpp:628
int16_t ReadInt16()
Reads one 16 Bit signed integer word and increments the position within the chunk.
Definition: RIFF.cpp:672
bool bEndianNative
Definition: RIFF.h:343
void UnlogResized(Chunk *pResizedChunk)
Definition: RIFF.cpp:1813
void swapBytes_16(void *Word)
Definition: RIFF.h:231
List * pParent
Definition: RIFF.h:219
stream_whence_t
File stream position dependent to these relations.
Definition: RIFF.h:158
unsigned long Read(void *pData, unsigned long WordCount, unsigned long WordSize)
Reads WordCount number of data words with given WordSize and copies it into a buffer pointed by pData...
Definition: RIFF.cpp:280
Chunk * GetFirstSubChunk()
Returns the first subchunk within the list.
Definition: RIFF.cpp:1046
String libraryName()
Returns the name of this C++ library.
Definition: RIFF.cpp:1862
File(uint32_t FileType)
Create new RIFF file.
Definition: RIFF.cpp:1422
unsigned long WriteUint16(uint16_t *pData, unsigned long WordCount=1)
Writes WordCount number of 16 Bit unsigned integer words from the buffer pointed by pData to the chun...
Definition: RIFF.cpp:537
uint32_t GetChunkID()
Chunk ID in unsigned integer representation.
Definition: RIFF.h:181
String GetFileName()
Definition: RIFF.cpp:1487
void ReadHeader(unsigned long fPos)
Definition: RIFF.cpp:1259
void swapBytes(void *Word, unsigned long WordSize)
Definition: RIFF.h:244
stream_state_t
Current state of the file stream.
Definition: RIFF.h:151
unsigned long SetPos(unsigned long 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:199
void ReadString(String &s, int size)
Reads a null-padded string of size characters and copies it into the string s.
Definition: RIFF.cpp:607
void WriteHeader(unsigned long fPos)
Definition: RIFF.cpp:1285
String libraryVersion()
Returns version of this C++ library.
Definition: RIFF.cpp:1870
List * GetSubList(uint32_t ListType)
Returns sublist chunk with list type ListType within this chunk list.
Definition: RIFF.cpp:1021
void DeleteSubChunk(Chunk *pSubChunk)
Removes a sub chunk.
Definition: RIFF.cpp:1241
unsigned long WriteInt16(int16_t *pData, unsigned long WordCount=1)
Writes WordCount number of 16 Bit signed integer words from the buffer pointed by pData to the chunk&#39;...
Definition: RIFF.cpp:500
int hFileWrite
handle / descriptor for writing to (some) file
Definition: RIFF.h:334
String Filename
Definition: RIFF.h:342
unsigned long RemainingBytes()
Returns the number of bytes left to read in the chunk body.
Definition: RIFF.cpp:231
List * GetFirstSubList()
Returns the first sublist within the list (that is a subchunk with chunk ID &quot;LIST&quot;).
Definition: RIFF.cpp:1080
Exception(String Message)
Definition: RIFF.h:372
stream_mode_t
Whether file stream is open in read or in read/write mode.
Definition: RIFF.h:144
std::list< Chunk * > ChunkList
Definition: RIFF.h:295
std::string String
Definition: RIFF.h:139
unsigned long GetPos()
Position within the chunk data body.
Definition: RIFF.h:185
void SetByteOrder(endian_t Endian)
Set the byte order to be used when saving.
Definition: RIFF.cpp:1608
unsigned long GetSize()
Chunk size in bytes (without header, thus the chunk data body)
Definition: RIFF.h:183
RIFF List Chunk.
Definition: RIFF.h:273
File * pFile
Definition: RIFF.h:220
int8_t ReadInt8()
Reads one 8 Bit signed integer word and increments the position within the chunk. ...
Definition: RIFF.cpp:639
void ReadHeader(unsigned long fPos)
Definition: RIFF.cpp:102
String GetListTypeString()
Returns string representation of the lists&#39;s id.
Definition: RIFF.cpp:1395
ChunkList::iterator ListIterator
Definition: RIFF.h:301
String Message
Definition: RIFF.h:370
unsigned long ulPos
Definition: RIFF.h:222
unsigned long WriteInt32(int32_t *pData, unsigned long WordCount=1)
Writes WordCount number of 32 Bit signed integer words from the buffer pointed by pData to the chunk&#39;...
Definition: RIFF.cpp:574
void DeleteChunkList()
Definition: RIFF.cpp:974
Chunk * GetSubChunk(uint32_t ChunkID)
Returns subchunk with chunk ID ChunkID within this chunk list.
Definition: RIFF.cpp:1002
Chunk * GetNextSubChunk()
Returns the next subchunk within the list.
Definition: RIFF.cpp:1062
unsigned long ReadSceptical(void *pData, unsigned long WordCount, unsigned long WordSize)
Just an internal wrapper for the main Read() method with additional Exception throwing on errors...
Definition: RIFF.cpp:388
int32_t ReadInt32()
Reads one 32 Bit signed integer word and increments the position within the chunk.
Definition: RIFF.cpp:706
stream_state_t GetState()
Returns the current state of the chunk object.
Definition: RIFF.cpp:249
void LoadSubChunks()
Definition: RIFF.cpp:1303
Ordinary RIFF Chunk.
Definition: RIFF.h:177
uint32_t GetListType()
Returns unsigned integer representation of the list&#39;s ID.
Definition: RIFF.h:277
unsigned long GetFilePos()
Current, actual offset in file.
Definition: RIFF.h:186
uint32_t ReadUint32()
Reads one 32 Bit unsigned integer word and increments the position within the chunk.
Definition: RIFF.cpp:723
ChunkList::iterator ChunksIterator
Definition: RIFF.h:300
unsigned long ulStartPos
Definition: RIFF.h:221
unsigned long Write(void *pData, unsigned long WordCount, unsigned long WordSize)
Writes WordCount number of data words with given WordSize from the buffer pointed by pData...
Definition: RIFF.cpp:338
ChunkList * pSubChunks
Definition: RIFF.h:298
List * GetParent()
Returns pointer to the chunk&#39;s parent list chunk.
Definition: RIFF.h:182
void swapBytes_32(void *Word)
Definition: RIFF.h:236
Chunk * AddSubChunk(uint32_t uiChunkID, uint uiBodySize)
Creates a new sub chunk.
Definition: RIFF.cpp:1182
void PrintMessage()
Definition: RIFF.cpp:1849
int hFileRead
handle / descriptor for reading from file
Definition: RIFF.h:333
ChunkMap * pSubChunksMap
Definition: RIFF.h:299
virtual ~Chunk()
Definition: RIFF.cpp:97
void LogAsResized(Chunk *pResizedChunk)
Definition: RIFF.cpp:1809
virtual void __resetPos()
Sets Chunk&#39;s read/write position to zero.
Definition: RIFF.cpp:932
uint16_t ReadUint16()
Reads one 16 Bit unsigned integer word and increments the position within the chunk.
Definition: RIFF.cpp:689
virtual void __resetPos()
Sets List Chunk&#39;s read/write position to zero and causes all sub chunks to do the same...
Definition: RIFF.cpp:1383
uint8_t * pChunkData
Definition: RIFF.h:223
uint32_t CurrentChunkSize
Definition: RIFF.h:217
endian_t
Alignment of data bytes in memory (system dependant).
Definition: RIFF.h:166
void * LoadChunkData()
Load chunk body into RAM.
Definition: RIFF.cpp:753
unsigned long WriteInt8(int8_t *pData, unsigned long WordCount=1)
Writes WordCount number of 8 Bit signed integer words from the buffer pointed by pData to the chunk&#39;s...
Definition: RIFF.cpp:426
unsigned long ulChunkDataSize
Definition: RIFF.h:224
RIFF File.
Definition: RIFF.h:320
List * AddSubList(uint32_t uiListType)
Creates a new list sub chunk.
Definition: RIFF.cpp:1221
void LoadSubChunksRecursively()
Definition: RIFF.cpp:1340
List(File *pFile, unsigned long StartPos, List *Parent)
Definition: RIFF.cpp:949
virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset)
Write list chunk persistently e.g.
Definition: RIFF.cpp:1359
void MoveSubChunk(Chunk *pSrc, Chunk *pDst)
Moves a sub chunk.
Definition: RIFF.cpp:1205
unsigned int CountSubChunks()
Returns number of subchunks within the list.
Definition: RIFF.cpp:1120
virtual ~List()
Definition: RIFF.cpp:967
String convertToString(uint32_t word)
Definition: RIFF.h:253
bool SetMode(stream_mode_t NewMode)
Change file access mode.
Definition: RIFF.cpp:1505
virtual ~Exception()
Definition: RIFF.h:374
virtual void Save()
Save changes to same file.
Definition: RIFF.cpp:1626
Will be thrown whenever an error occurs while handling a RIFF file.
Definition: RIFF.h:368
unsigned long WriteUint8(uint8_t *pData, unsigned long WordCount=1)
Writes WordCount number of 8 Bit unsigned integer words from the buffer pointed by pData to the chunk...
Definition: RIFF.cpp:463
stream_mode_t GetMode()
Definition: RIFF.cpp:1491
void ReleaseChunkData()
Free loaded chunk body from RAM.
Definition: RIFF.cpp:797
virtual ~File()
Definition: RIFF.cpp:1788
unsigned int CountSubLists()
Returns number of sublists within the list.
Definition: RIFF.cpp:1146
String GetChunkIDString()
Returns the String representation of the chunk&#39;s ID (e.g.
Definition: RIFF.cpp:183
unsigned long GetNewSize()
New chunk size if it was modified with Resize().
Definition: RIFF.h:184
uint32_t NewChunkSize
Definition: RIFF.h:218
void WriteHeader(unsigned long fPos)
Definition: RIFF.cpp:145
uint32_t ChunkID
Definition: RIFF.h:216
std::map< uint32_t, RIFF::Chunk * > ChunkMap
Definition: RIFF.h:294
void Resize(int iNewSize)
Resize chunk.
Definition: RIFF.cpp:822
List * GetNextSubList()
Returns the next sublist (that is a subchunk with chunk ID &quot;LIST&quot;) within the list.
Definition: RIFF.cpp:1102
Chunk(File *pFile, unsigned long StartPos, List *Parent)
Definition: RIFF.cpp:70
uint8_t ReadUint8()
Reads one 8 Bit unsigned integer word and increments the position within the chunk.
Definition: RIFF.cpp:655
uint32_t ListType
Definition: RIFF.h:297