libgig  3.3.0.svn20
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-2014 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 
173  enum layout_t {
176  };
177 
183  class Chunk {
184  public:
185  Chunk(File* pFile, unsigned long StartPos, List* Parent);
186  String GetChunkIDString();
187  uint32_t GetChunkID() { return ChunkID; }
188  File* GetFile() { return pFile; }
189  List* GetParent() { return pParent; }
190  unsigned long GetSize() const { return CurrentChunkSize; }
191  unsigned long GetNewSize() { return NewChunkSize; }
192  unsigned long GetPos() { return ulPos; }
193  unsigned long GetFilePos() { return ulStartPos + ulPos; }
194  unsigned long SetPos(unsigned long Where, stream_whence_t Whence = stream_start);
195  unsigned long RemainingBytes();
197  unsigned long Read(void* pData, unsigned long WordCount, unsigned long WordSize);
198  unsigned long ReadInt8(int8_t* pData, unsigned long WordCount = 1);
199  unsigned long ReadUint8(uint8_t* pData, unsigned long WordCount = 1);
200  unsigned long ReadInt16(int16_t* pData, unsigned long WordCount = 1);
201  unsigned long ReadUint16(uint16_t* pData, unsigned long WordCount = 1);
202  unsigned long ReadInt32(int32_t* pData, unsigned long WordCount = 1);
203  unsigned long ReadUint32(uint32_t* pData, unsigned long WordCount = 1);
204  int8_t ReadInt8();
205  uint8_t ReadUint8();
206  int16_t ReadInt16();
207  uint16_t ReadUint16();
208  int32_t ReadInt32();
209  uint32_t ReadUint32();
210  void ReadString(String& s, int size);
211  unsigned long Write(void* pData, unsigned long WordCount, unsigned long WordSize);
212  unsigned long WriteInt8(int8_t* pData, unsigned long WordCount = 1);
213  unsigned long WriteUint8(uint8_t* pData, unsigned long WordCount = 1);
214  unsigned long WriteInt16(int16_t* pData, unsigned long WordCount = 1);
215  unsigned long WriteUint16(uint16_t* pData, unsigned long WordCount = 1);
216  unsigned long WriteInt32(int32_t* pData, unsigned long WordCount = 1);
217  unsigned long WriteUint32(uint32_t* pData, unsigned long WordCount = 1);
218  void* LoadChunkData();
219  void ReleaseChunkData();
220  void Resize(int iNewSize);
221  virtual ~Chunk();
222  protected:
223  uint32_t ChunkID;
224  uint32_t CurrentChunkSize; /* in bytes */
225  uint32_t NewChunkSize; /* in bytes (if chunk was scheduled to be resized) */
228  unsigned long ulStartPos; /* actual position in file where chunk (without header) starts */
229  unsigned long ulPos; /* # of bytes from ulStartPos */
230  uint8_t* pChunkData;
231  unsigned long ulChunkDataSize;
232 
233  Chunk(File* pFile);
234  Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize);
235  void ReadHeader(unsigned long fPos);
236  void WriteHeader(unsigned long fPos);
237  unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);
238  inline void swapBytes_16(void* Word) {
239  uint8_t byteCache = *((uint8_t*) Word);
240  *((uint8_t*) Word) = *((uint8_t*) Word + 1);
241  *((uint8_t*) Word + 1) = byteCache;
242  }
243  inline void swapBytes_32(void* Word) {
244  uint8_t byteCache = *((uint8_t*) Word);
245  *((uint8_t*) Word) = *((uint8_t*) Word + 3);
246  *((uint8_t*) Word + 3) = byteCache;
247  byteCache = *((uint8_t*) Word + 1);
248  *((uint8_t*) Word + 1) = *((uint8_t*) Word + 2);
249  *((uint8_t*) Word + 2) = byteCache;
250  }
251  inline void swapBytes(void* Word, unsigned long WordSize) {
252  uint8_t byteCache;
253  unsigned long lo = 0, hi = WordSize - 1;
254  for (; lo < hi; hi--, lo++) {
255  byteCache = *((uint8_t*) Word + lo);
256  *((uint8_t*) Word + lo) = *((uint8_t*) Word + hi);
257  *((uint8_t*) Word + hi) = byteCache;
258  }
259  }
260  inline String convertToString(uint32_t word) {
261  String result;
262  for (int i = 0; i < 4; i++) {
263  uint8_t byte = *((uint8_t*)(&word) + i);
264  char c = byte;
265  result += c;
266  }
267  return result;
268  }
269  virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
270  virtual void __resetPos();
271 
272  friend class List;
273  };
274 
280  class List : public Chunk {
281  public:
282  List(File* pFile, unsigned long StartPos, List* Parent);
283  String GetListTypeString();
284  uint32_t GetListType() { return ListType; }
285  Chunk* GetSubChunk(uint32_t ChunkID);
286  List* GetSubList(uint32_t ListType);
290  List* GetNextSubList();
291  unsigned int CountSubChunks();
292  unsigned int CountSubChunks(uint32_t ChunkID);
293  unsigned int CountSubLists();
294  unsigned int CountSubLists(uint32_t ListType);
295  Chunk* AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
296  List* AddSubList(uint32_t uiListType);
297  void DeleteSubChunk(Chunk* pSubChunk);
298  void MoveSubChunk(Chunk* pSrc, Chunk* pDst); // read API doc comments !!!
299  void MoveSubChunk(Chunk* pSrc, List* pNewParent);
300  virtual ~List();
301  protected:
302  typedef std::map<uint32_t, RIFF::Chunk*> ChunkMap;
303  typedef std::list<Chunk*> ChunkList;
304 
305  uint32_t ListType;
306  ChunkList* pSubChunks;
307  ChunkMap* pSubChunksMap;
308  ChunkList::iterator ChunksIterator;
309  ChunkList::iterator ListIterator;
310 
311  List(File* pFile);
312  List(File* pFile, List* pParent, uint32_t uiListID);
313  void ReadHeader(unsigned long fPos);
314  void WriteHeader(unsigned long fPos);
315  void LoadSubChunks();
317  virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
318  virtual void __resetPos();
319  void DeleteChunkList();
320  };
321 
328  class File : public List {
329  public:
330  File(uint32_t FileType);
331  File(const String& path);
332  File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout);
334  bool SetMode(stream_mode_t NewMode);
335  void SetByteOrder(endian_t Endian);
336  String GetFileName();
337  void SetFileName(const String& path);
338  bool IsNew() const;
339  layout_t GetLayout() const;
340  virtual void Save();
341  virtual void Save(const String& path);
342  virtual ~File();
343  protected:
344  #if POSIX
345  int hFileRead;
347  #elif defined(WIN32)
348  HANDLE hFileRead;
349  HANDLE hFileWrite;
350  #else
351  FILE* hFileRead;
352  FILE* hFileWrite;
353  #endif // POSIX
354  String Filename;
358 
359  void LogAsResized(Chunk* pResizedChunk);
360  void UnlogResized(Chunk* pResizedChunk);
361  friend class Chunk;
362  friend class List;
363  private:
364  stream_mode_t Mode;
365  ChunkList ResizedChunks;
366 
367  void __openExistingFile(const String& path, uint32_t* FileType = NULL);
368  unsigned long GetFileSize();
369  void ResizeFile(unsigned long ulNewSize);
370  #if POSIX
371  unsigned long __GetFileSize(int hFile);
372  #elif defined(WIN32)
373  unsigned long __GetFileSize(HANDLE hFile);
374  #else
375  unsigned long __GetFileSize(FILE* hFile);
376  #endif
377  void Cleanup();
378  };
379 
383  class Exception {
384  public:
385  String Message;
386 
387  Exception(String Message) { Exception::Message = Message; }
388  void PrintMessage();
389  virtual ~Exception() {}
390  };
391 
392  String libraryName();
393  String libraryVersion();
394 
395 } // namespace RIFF
396 #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:355
void UnlogResized(Chunk *pResizedChunk)
Definition: RIFF.cpp:1947
void swapBytes_16(void *Word)
Definition: RIFF.h:238
List * pParent
Definition: RIFF.h:226
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:1996
File(uint32_t FileType)
Create new RIFF file.
Definition: RIFF.cpp:1454
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:187
layout_t Layout
An ordinary RIFF file is always set to layout_standard.
Definition: RIFF.h:357
layout_t GetLayout() const
Definition: RIFF.cpp:1608
String GetFileName()
Definition: RIFF.cpp:1596
void ReadHeader(unsigned long fPos)
Definition: RIFF.cpp:1291
void swapBytes(void *Word, unsigned long WordSize)
Definition: RIFF.h:251
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
bool bIsNewFile
Definition: RIFF.h:356
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:1317
String libraryVersion()
Returns version of this C++ library.
Definition: RIFF.cpp:2004
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:1273
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:346
String Filename
Definition: RIFF.h:354
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:1080
Exception(String Message)
Definition: RIFF.h:387
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:303
std::string String
Definition: RIFF.h:139
unsigned long GetPos()
Position within the chunk data body.
Definition: RIFF.h:192
void SetByteOrder(endian_t Endian)
Set the byte order to be used when saving.
Definition: RIFF.cpp:1725
RIFF List Chunk.
Definition: RIFF.h:280
File * pFile
Definition: RIFF.h:227
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's id.
Definition: RIFF.cpp:1427
ChunkList::iterator ListIterator
Definition: RIFF.h:309
String Message
Definition: RIFF.h:385
unsigned long ulPos
Definition: RIFF.h:229
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: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
layout_t
General chunk structure of a file.
Definition: RIFF.h:173
stream_state_t GetState()
Returns the current state of the chunk object.
Definition: RIFF.cpp:249
void LoadSubChunks()
Definition: RIFF.cpp:1335
Ordinary RIFF Chunk.
Definition: RIFF.h:183
uint32_t GetListType()
Returns unsigned integer representation of the list's ID.
Definition: RIFF.h:284
unsigned long GetFilePos()
Current, actual offset in file.
Definition: RIFF.h:193
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:308
File * GetFile()
Returns pointer to the chunk's File object.
Definition: RIFF.h:188
unsigned long ulStartPos
Definition: RIFF.h:228
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:306
List * GetParent()
Returns pointer to the chunk's parent list chunk.
Definition: RIFF.h:189
void swapBytes_32(void *Word)
Definition: RIFF.h:243
Chunk * AddSubChunk(uint32_t uiChunkID, uint uiBodySize)
Creates a new sub chunk.
Definition: RIFF.cpp:1182
void PrintMessage()
Definition: RIFF.cpp:1983
int hFileRead
handle / descriptor for reading from file
Definition: RIFF.h:345
Not a "real" RIFF file: First chunk in file is an ordinary data chunk, not a List chunk...
Definition: RIFF.h:175
ChunkMap * pSubChunksMap
Definition: RIFF.h:307
virtual ~Chunk()
Definition: RIFF.cpp:97
void LogAsResized(Chunk *pResizedChunk)
Definition: RIFF.cpp:1943
virtual void __resetPos()
Sets Chunk'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's read/write position to zero and causes all sub chunks to do the same...
Definition: RIFF.cpp:1415
uint8_t * pChunkData
Definition: RIFF.h:230
uint32_t CurrentChunkSize
Definition: RIFF.h:224
endian_t
Alignment of data bytes in memory (system dependant).
Definition: RIFF.h:166
void SetFileName(const String &path)
Definition: RIFF.cpp:1600
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's...
Definition: RIFF.cpp:426
Standard RIFF file layout: First chunk in file is a List chunk which contains all other chunks and th...
Definition: RIFF.h:174
unsigned long GetSize() const
Chunk size in bytes (without header, thus the chunk data body)
Definition: RIFF.h:190
unsigned long ulChunkDataSize
Definition: RIFF.h:231
RIFF File.
Definition: RIFF.h:328
List * AddSubList(uint32_t uiListType)
Creates a new list sub chunk.
Definition: RIFF.cpp:1253
void LoadSubChunksRecursively()
Definition: RIFF.cpp:1372
RIFF specific classes and definitions.
Definition: RIFF.h:134
bool IsNew() const
Returns true if this file has been created new from scratch and has not been stored to disk yet...
Definition: RIFF.cpp:1925
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:1391
void MoveSubChunk(Chunk *pSrc, Chunk *pDst)
Moves a sub chunk witin this list.
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:260
bool SetMode(stream_mode_t NewMode)
Change file access mode.
Definition: RIFF.cpp:1622
virtual ~Exception()
Definition: RIFF.h:389
virtual void Save()
Save changes to same file.
Definition: RIFF.cpp:1743
Will be thrown whenever an error occurs while handling a RIFF file.
Definition: RIFF.h:383
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:1604
void ReleaseChunkData()
Free loaded chunk body from RAM.
Definition: RIFF.cpp:797
virtual ~File()
Definition: RIFF.cpp:1914
unsigned int CountSubLists()
Returns number of sublists within the list.
Definition: RIFF.cpp:1146
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:191
uint32_t NewChunkSize
Definition: RIFF.h:225
void WriteHeader(unsigned long fPos)
Definition: RIFF.cpp:145
uint32_t ChunkID
Definition: RIFF.h:223
std::map< uint32_t, RIFF::Chunk * > ChunkMap
Definition: RIFF.h:302
void Resize(int iNewSize)
Resize chunk.
Definition: RIFF.cpp:822
List * GetNextSubList()
Returns the next sublist (that is a subchunk with chunk ID "LIST") 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:305