libgig  3.3.0.svn3
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-2011 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  unsigned long Write(void* pData, unsigned long WordCount, unsigned long WordSize);
204  unsigned long WriteInt8(int8_t* pData, unsigned long WordCount = 1);
205  unsigned long WriteUint8(uint8_t* pData, unsigned long WordCount = 1);
206  unsigned long WriteInt16(int16_t* pData, unsigned long WordCount = 1);
207  unsigned long WriteUint16(uint16_t* pData, unsigned long WordCount = 1);
208  unsigned long WriteInt32(int32_t* pData, unsigned long WordCount = 1);
209  unsigned long WriteUint32(uint32_t* pData, unsigned long WordCount = 1);
210  void* LoadChunkData();
211  void ReleaseChunkData();
212  void Resize(int iNewSize);
213  virtual ~Chunk();
214  protected:
215  uint32_t ChunkID;
216  uint32_t CurrentChunkSize; /* in bytes */
217  uint32_t NewChunkSize; /* in bytes (if chunk was scheduled to be resized) */
220  unsigned long ulStartPos; /* actual position in file where chunk (without header) starts */
221  unsigned long ulPos; /* # of bytes from ulStartPos */
222  uint8_t* pChunkData;
223  unsigned long ulChunkDataSize;
224 
225  Chunk(File* pFile);
226  Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize);
227  void ReadHeader(unsigned long fPos);
228  void WriteHeader(unsigned long fPos);
229  unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);
230  inline void swapBytes_16(void* Word) {
231  uint8_t byteCache = *((uint8_t*) Word);
232  *((uint8_t*) Word) = *((uint8_t*) Word + 1);
233  *((uint8_t*) Word + 1) = byteCache;
234  }
235  inline void swapBytes_32(void* Word) {
236  uint8_t byteCache = *((uint8_t*) Word);
237  *((uint8_t*) Word) = *((uint8_t*) Word + 3);
238  *((uint8_t*) Word + 3) = byteCache;
239  byteCache = *((uint8_t*) Word + 1);
240  *((uint8_t*) Word + 1) = *((uint8_t*) Word + 2);
241  *((uint8_t*) Word + 2) = byteCache;
242  }
243  inline void swapBytes(void* Word, unsigned long WordSize) {
244  uint8_t byteCache;
245  unsigned long lo = 0, hi = WordSize - 1;
246  for (; lo < hi; hi--, lo++) {
247  byteCache = *((uint8_t*) Word + lo);
248  *((uint8_t*) Word + lo) = *((uint8_t*) Word + hi);
249  *((uint8_t*) Word + hi) = byteCache;
250  }
251  }
252  inline String convertToString(uint32_t word) {
253  String result;
254  for (int i = 0; i < 4; i++) {
255  uint8_t byte = *((uint8_t*)(&word) + i);
256  char c = byte;
257  result += c;
258  }
259  return result;
260  }
261  virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
262  virtual void __resetPos();
263 
264  friend class List;
265  };
266 
272  class List : public Chunk {
273  public:
274  List(File* pFile, unsigned long StartPos, List* Parent);
276  uint32_t GetListType() { return ListType; }
277  Chunk* GetSubChunk(uint32_t ChunkID);
278  List* GetSubList(uint32_t ListType);
282  List* GetNextSubList();
283  unsigned int CountSubChunks();
284  unsigned int CountSubChunks(uint32_t ChunkID);
285  unsigned int CountSubLists();
286  unsigned int CountSubLists(uint32_t ListType);
287  Chunk* AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
288  List* AddSubList(uint32_t uiListType);
289  void DeleteSubChunk(Chunk* pSubChunk);
290  void MoveSubChunk(Chunk* pSrc, Chunk* pDst);
291  virtual ~List();
292  protected:
293  typedef std::map<uint32_t, RIFF::Chunk*> ChunkMap;
294  typedef std::list<Chunk*> ChunkList;
295 
296  uint32_t ListType;
299  ChunkList::iterator ChunksIterator;
300  ChunkList::iterator ListIterator;
301 
302  List(File* pFile);
303  List(File* pFile, List* pParent, uint32_t uiListID);
304  void ReadHeader(unsigned long fPos);
305  void WriteHeader(unsigned long fPos);
306  void LoadSubChunks();
308  virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
309  virtual void __resetPos();
310  void DeleteChunkList();
311  };
312 
319  class File : public List {
320  public:
321  File(uint32_t FileType);
322  File(const String& path);
324  bool SetMode(stream_mode_t NewMode);
325  void SetByteOrder(endian_t Endian);
327  virtual void Save();
328  virtual void Save(const String& path);
329  virtual ~File();
330  protected:
331  #if POSIX
332  int hFileRead;
334  #elif defined(WIN32)
335  HANDLE hFileRead;
336  HANDLE hFileWrite;
337  #else
338  FILE* hFileRead;
339  FILE* hFileWrite;
340  #endif // POSIX
343 
344  void LogAsResized(Chunk* pResizedChunk);
345  void UnlogResized(Chunk* pResizedChunk);
346  friend class Chunk;
347  friend class List;
348  private:
349  stream_mode_t Mode;
350  ChunkList ResizedChunks;
351 
352  unsigned long GetFileSize();
353  void ResizeFile(unsigned long ulNewSize);
354  #if POSIX
355  unsigned long __GetFileSize(int hFile);
356  #elif defined(WIN32)
357  unsigned long __GetFileSize(HANDLE hFile);
358  #else
359  unsigned long __GetFileSize(FILE* hFile);
360  #endif
361  void Cleanup();
362  };
363 
367  class Exception {
368  public:
370 
372  void PrintMessage();
373  virtual ~Exception() {}
374  };
375 
378 
379 } // namespace RIFF
380 #endif // __RIFF_H__