libgig  3.3.0
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-2009 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 #else // little endian
81 # define CHUNK_ID_RIFF 0x46464952
82 # define CHUNK_ID_RIFX 0x58464952
83 # define CHUNK_ID_LIST 0x5453494C
84 #endif // WORDS_BIGENDIAN
85 
86 #define CHUNK_HEADER_SIZE 8
87 #define LIST_HEADER_SIZE 12
88 #define RIFF_HEADER_SIZE 12
89 
90 
110 namespace RIFF {
111 
112  /* just symbol prototyping */
113  class Chunk;
114  class List;
115  class File;
116 
117  typedef std::string String;
118 
120  typedef enum {
124  } stream_mode_t;
125 
127  typedef enum {
131  } stream_state_t;
132 
134  typedef enum {
139  } stream_whence_t;
140 
142  typedef enum {
146  } endian_t;
147 
153  class Chunk {
154  public:
155  Chunk(File* pFile, unsigned long StartPos, List* Parent);
157  uint32_t GetChunkID() { return ChunkID; }
158  List* GetParent() { return pParent; }
159  unsigned long GetSize() { return CurrentChunkSize; }
160  unsigned long GetNewSize() { return NewChunkSize; }
161  unsigned long GetPos() { return ulPos; }
162  unsigned long GetFilePos() { return ulStartPos + ulPos; }
163  unsigned long SetPos(unsigned long Where, stream_whence_t Whence = stream_start);
164  unsigned long RemainingBytes();
166  unsigned long Read(void* pData, unsigned long WordCount, unsigned long WordSize);
167  unsigned long ReadInt8(int8_t* pData, unsigned long WordCount = 1);
168  unsigned long ReadUint8(uint8_t* pData, unsigned long WordCount = 1);
169  unsigned long ReadInt16(int16_t* pData, unsigned long WordCount = 1);
170  unsigned long ReadUint16(uint16_t* pData, unsigned long WordCount = 1);
171  unsigned long ReadInt32(int32_t* pData, unsigned long WordCount = 1);
172  unsigned long ReadUint32(uint32_t* pData, unsigned long WordCount = 1);
173  int8_t ReadInt8();
174  uint8_t ReadUint8();
175  int16_t ReadInt16();
176  uint16_t ReadUint16();
177  int32_t ReadInt32();
178  uint32_t ReadUint32();
179  unsigned long Write(void* pData, unsigned long WordCount, unsigned long WordSize);
180  unsigned long WriteInt8(int8_t* pData, unsigned long WordCount = 1);
181  unsigned long WriteUint8(uint8_t* pData, unsigned long WordCount = 1);
182  unsigned long WriteInt16(int16_t* pData, unsigned long WordCount = 1);
183  unsigned long WriteUint16(uint16_t* pData, unsigned long WordCount = 1);
184  unsigned long WriteInt32(int32_t* pData, unsigned long WordCount = 1);
185  unsigned long WriteUint32(uint32_t* pData, unsigned long WordCount = 1);
186  void* LoadChunkData();
187  void ReleaseChunkData();
188  void Resize(int iNewSize);
189  virtual ~Chunk();
190  protected:
191  uint32_t ChunkID;
192  uint32_t CurrentChunkSize; /* in bytes */
193  uint32_t NewChunkSize; /* in bytes (if chunk was scheduled to be resized) */
196  unsigned long ulStartPos; /* actual position in file where chunk (without header) starts */
197  unsigned long ulPos; /* # of bytes from ulStartPos */
198  uint8_t* pChunkData;
199  unsigned long ulChunkDataSize;
200 
201  Chunk(File* pFile);
202  Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize);
203  void ReadHeader(unsigned long fPos);
204  void WriteHeader(unsigned long fPos);
205  unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);
206  inline void swapBytes_16(void* Word) {
207  uint8_t byteCache = *((uint8_t*) Word);
208  *((uint8_t*) Word) = *((uint8_t*) Word + 1);
209  *((uint8_t*) Word + 1) = byteCache;
210  }
211  inline void swapBytes_32(void* Word) {
212  uint8_t byteCache = *((uint8_t*) Word);
213  *((uint8_t*) Word) = *((uint8_t*) Word + 3);
214  *((uint8_t*) Word + 3) = byteCache;
215  byteCache = *((uint8_t*) Word + 1);
216  *((uint8_t*) Word + 1) = *((uint8_t*) Word + 2);
217  *((uint8_t*) Word + 2) = byteCache;
218  }
219  inline void swapBytes(void* Word, unsigned long WordSize) {
220  uint8_t byteCache;
221  unsigned long lo = 0, hi = WordSize - 1;
222  for (; lo < hi; hi--, lo++) {
223  byteCache = *((uint8_t*) Word + lo);
224  *((uint8_t*) Word + lo) = *((uint8_t*) Word + hi);
225  *((uint8_t*) Word + hi) = byteCache;
226  }
227  }
228  inline String convertToString(uint32_t word) {
229  String result;
230  for (int i = 0; i < 4; i++) {
231  uint8_t byte = *((uint8_t*)(&word) + i);
232  char c = byte;
233  result += c;
234  }
235  return result;
236  }
237  virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
238  virtual void __resetPos();
239 
240  friend class List;
241  };
242 
248  class List : public Chunk {
249  public:
250  List(File* pFile, unsigned long StartPos, List* Parent);
252  uint32_t GetListType() { return ListType; }
253  Chunk* GetSubChunk(uint32_t ChunkID);
254  List* GetSubList(uint32_t ListType);
258  List* GetNextSubList();
259  unsigned int CountSubChunks();
260  unsigned int CountSubChunks(uint32_t ChunkID);
261  unsigned int CountSubLists();
262  unsigned int CountSubLists(uint32_t ListType);
263  Chunk* AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
264  List* AddSubList(uint32_t uiListType);
265  void DeleteSubChunk(Chunk* pSubChunk);
266  void MoveSubChunk(Chunk* pSrc, Chunk* pDst);
267  virtual ~List();
268  protected:
269  typedef std::map<uint32_t, RIFF::Chunk*> ChunkMap;
270  typedef std::list<Chunk*> ChunkList;
271 
272  uint32_t ListType;
275  ChunkList::iterator ChunksIterator;
276  ChunkList::iterator ListIterator;
277 
278  List(File* pFile);
279  List(File* pFile, List* pParent, uint32_t uiListID);
280  void ReadHeader(unsigned long fPos);
281  void WriteHeader(unsigned long fPos);
282  void LoadSubChunks();
284  virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
285  virtual void __resetPos();
286  void DeleteChunkList();
287  };
288 
295  class File : public List {
296  public:
297  File(uint32_t FileType);
298  File(const String& path);
300  bool SetMode(stream_mode_t NewMode);
301  void SetByteOrder(endian_t Endian);
303  virtual void Save();
304  virtual void Save(const String& path);
305  virtual ~File();
306  protected:
307  #if POSIX
308  int hFileRead;
310  #elif defined(WIN32)
311  HANDLE hFileRead;
312  HANDLE hFileWrite;
313  #else
314  FILE* hFileRead;
315  FILE* hFileWrite;
316  #endif // POSIX
319 
320  void LogAsResized(Chunk* pResizedChunk);
321  void UnlogResized(Chunk* pResizedChunk);
322  friend class Chunk;
323  friend class List;
324  private:
325  stream_mode_t Mode;
326  ChunkList ResizedChunks;
327 
328  unsigned long GetFileSize();
329  void ResizeFile(unsigned long ulNewSize);
330  #if POSIX
331  unsigned long __GetFileSize(int hFile);
332  #elif defined(WIN32)
333  unsigned long __GetFileSize(HANDLE hFile);
334  #else
335  unsigned long __GetFileSize(FILE* hFile);
336  #endif
337  };
338 
342  class Exception {
343  public:
345 
347  void PrintMessage();
348  virtual ~Exception() {}
349  };
350 
353 
354 } // namespace RIFF
355 #endif // __RIFF_H__
virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset)
Write chunk persistently e.g.
Definition: RIFF.cpp:825
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:611
int16_t ReadInt16()
Reads one 16 Bit signed integer word and increments the position within the chunk.
Definition: RIFF.cpp:655
bool bEndianNative
Definition: RIFF.h:318
void UnlogResized(Chunk *pResizedChunk)
Definition: RIFF.cpp:1780
void swapBytes_16(void *Word)
Definition: RIFF.h:206
List * pParent
Definition: RIFF.h:194
stream_whence_t
File stream position dependent to these relations.
Definition: RIFF.h:134
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:1023
String libraryName()
Returns the name of this C++ library.
Definition: RIFF.cpp:1829
File(uint32_t FileType)
Create new RIFF file.
Definition: RIFF.cpp:1399
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:157
String GetFileName()
Definition: RIFF.cpp:1458
void ReadHeader(unsigned long fPos)
Definition: RIFF.cpp:1236
void swapBytes(void *Word, unsigned long WordSize)
Definition: RIFF.h:219
stream_state_t
Current state of the file stream.
Definition: RIFF.h:127
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 WriteHeader(unsigned long fPos)
Definition: RIFF.cpp:1262
String libraryVersion()
Returns version of this C++ library.
Definition: RIFF.cpp:1837
List * GetSubList(uint32_t ListType)
Returns sublist chunk with list type ListType within this chunk list.
Definition: RIFF.cpp:998
void DeleteSubChunk(Chunk *pSubChunk)
Removes a sub chunk.
Definition: RIFF.cpp:1218
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'...
Definition: RIFF.cpp:500
int hFileWrite
handle / descriptor for writing to (some) file
Definition: RIFF.h:309
String Filename
Definition: RIFF.h:317
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 "LIST").
Definition: RIFF.cpp:1057
Exception(String Message)
Definition: RIFF.h:346
stream_mode_t
Whether file stream is open in read or in read/write mode.
Definition: RIFF.h:120
std::list< Chunk * > ChunkList
Definition: RIFF.h:270
std::string String
Definition: RIFF.h:115
unsigned long GetPos()
Position within the chunk data body.
Definition: RIFF.h:161
void SetByteOrder(endian_t Endian)
Set the byte order to be used when saving.
Definition: RIFF.cpp:1579
unsigned long GetSize()
Chunk size in bytes (without header, thus the chunk data body)
Definition: RIFF.h:159
RIFF List Chunk.
Definition: RIFF.h:248
File * pFile
Definition: RIFF.h:195
int8_t ReadInt8()
Reads one 8 Bit signed integer word and increments the position within the chunk. ...
Definition: RIFF.cpp:622
void ReadHeader(unsigned long fPos)
Definition: RIFF.cpp:102
String GetListTypeString()
Returns string representation of the lists's id.
Definition: RIFF.cpp:1372
ChunkList::iterator ListIterator
Definition: RIFF.h:276
String Message
Definition: RIFF.h:344
unsigned long ulPos
Definition: RIFF.h:197
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'...
Definition: RIFF.cpp:574
void DeleteChunkList()
Definition: RIFF.cpp:957
Chunk * GetSubChunk(uint32_t ChunkID)
Returns subchunk with chunk ID ChunkID within this chunk list.
Definition: RIFF.cpp:979
Chunk * GetNextSubChunk()
Returns the next subchunk within the list.
Definition: RIFF.cpp:1039
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:689
stream_state_t GetState()
Returns the current state of the chunk object.
Definition: RIFF.cpp:249
void LoadSubChunks()
Definition: RIFF.cpp:1280
Ordinary RIFF Chunk.
Definition: RIFF.h:153
uint32_t GetListType()
Returns unsigned integer representation of the list's ID.
Definition: RIFF.h:252
unsigned long GetFilePos()
Current, actual offset in file.
Definition: RIFF.h:162
uint32_t ReadUint32()
Reads one 32 Bit unsigned integer word and increments the position within the chunk.
Definition: RIFF.cpp:706
ChunkList::iterator ChunksIterator
Definition: RIFF.h:275
unsigned long ulStartPos
Definition: RIFF.h:196
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:273
List * GetParent()
Returns pointer to the chunk's parent list chunk.
Definition: RIFF.h:158
void swapBytes_32(void *Word)
Definition: RIFF.h:211
Chunk * AddSubChunk(uint32_t uiChunkID, uint uiBodySize)
Creates a new sub chunk.
Definition: RIFF.cpp:1159
void PrintMessage()
Definition: RIFF.cpp:1816
int hFileRead
handle / descriptor for reading from file
Definition: RIFF.h:308
ChunkMap * pSubChunksMap
Definition: RIFF.h:274
virtual ~Chunk()
Definition: RIFF.cpp:97
void LogAsResized(Chunk *pResizedChunk)
Definition: RIFF.cpp:1776
virtual void __resetPos()
Sets Chunk's read/write position to zero.
Definition: RIFF.cpp:915
uint16_t ReadUint16()
Reads one 16 Bit unsigned integer word and increments the position within the chunk.
Definition: RIFF.cpp:672
virtual void __resetPos()
Sets List Chunk's read/write position to zero and causes all sub chunks to do the same...
Definition: RIFF.cpp:1360
uint8_t * pChunkData
Definition: RIFF.h:198
uint32_t CurrentChunkSize
Definition: RIFF.h:192
endian_t
Alignment of data bytes in memory (system dependant).
Definition: RIFF.h:142
void * LoadChunkData()
Load chunk body into RAM.
Definition: RIFF.cpp:736
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's...
Definition: RIFF.cpp:426
unsigned long ulChunkDataSize
Definition: RIFF.h:199
RIFF File.
Definition: RIFF.h:295
List * AddSubList(uint32_t uiListType)
Creates a new list sub chunk.
Definition: RIFF.cpp:1198
void LoadSubChunksRecursively()
Definition: RIFF.cpp:1317
List(File *pFile, unsigned long StartPos, List *Parent)
Definition: RIFF.cpp:932
virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset)
Write list chunk persistently e.g.
Definition: RIFF.cpp:1336
void MoveSubChunk(Chunk *pSrc, Chunk *pDst)
Moves a sub chunk.
Definition: RIFF.cpp:1182
unsigned int CountSubChunks()
Returns number of subchunks within the list.
Definition: RIFF.cpp:1097
virtual ~List()
Definition: RIFF.cpp:950
String convertToString(uint32_t word)
Definition: RIFF.h:228
bool SetMode(stream_mode_t NewMode)
Change file access mode.
Definition: RIFF.cpp:1476
virtual ~Exception()
Definition: RIFF.h:348
virtual void Save()
Save changes to same file.
Definition: RIFF.cpp:1597
Will be thrown whenever an error occurs while handling a RIFF file.
Definition: RIFF.h:342
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:1462
void ReleaseChunkData()
Free loaded chunk body from RAM.
Definition: RIFF.cpp:780
virtual ~File()
Definition: RIFF.cpp:1759
unsigned int CountSubLists()
Returns number of sublists within the list.
Definition: RIFF.cpp:1123
String GetChunkIDString()
Returns the String representation of the chunk's ID (e.g.
Definition: RIFF.cpp:183
unsigned long GetNewSize()
New chunk size if it was modified with Resize().
Definition: RIFF.h:160
uint32_t NewChunkSize
Definition: RIFF.h:193
void WriteHeader(unsigned long fPos)
Definition: RIFF.cpp:145
uint32_t ChunkID
Definition: RIFF.h:191
std::map< uint32_t, RIFF::Chunk * > ChunkMap
Definition: RIFF.h:269
void Resize(int iNewSize)
Resize chunk.
Definition: RIFF.cpp:805
List * GetNextSubList()
Returns the next sublist (that is a subchunk with chunk ID "LIST") within the list.
Definition: RIFF.cpp:1079
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:638
uint32_t ListType
Definition: RIFF.h:272