1 |
/*************************************************************************** |
2 |
* * |
3 |
* libgig - C++ cross-platform Gigasampler format file loader library * |
4 |
* * |
5 |
* Copyright (C) 2003-2005 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 |
#define POSIX 1 |
28 |
#define DEBUG 0 |
29 |
|
30 |
#include <string> |
31 |
#include <list> |
32 |
#include <map> |
33 |
#include <iostream> |
34 |
|
35 |
#ifdef HAVE_CONFIG_H |
36 |
# include <config.h> |
37 |
#endif |
38 |
|
39 |
#if POSIX |
40 |
# include <sys/types.h> |
41 |
# include <sys/stat.h> |
42 |
# include <fcntl.h> |
43 |
# include <unistd.h> |
44 |
#endif // POSIX |
45 |
|
46 |
#include <stdint.h> |
47 |
|
48 |
//typedef unsigned char uint8_t; |
49 |
//typedef unsigned short uint16_t; |
50 |
//typedef unsigned int uint32_t; |
51 |
|
52 |
#include <stdio.h> |
53 |
|
54 |
#if WORDS_BIGENDIAN |
55 |
# define CHUNK_ID_RIFF 0x52494646 |
56 |
# define CHUNK_ID_RIFX 0x52494658 |
57 |
# define CHUNK_ID_LIST 0x4C495354 |
58 |
#else // little endian |
59 |
# define CHUNK_ID_RIFF 0x46464952 |
60 |
# define CHUNK_ID_RIFX 0x58464952 |
61 |
# define CHUNK_ID_LIST 0x5453494C |
62 |
#endif // WORDS_BIGENDIAN |
63 |
|
64 |
#define CHUNK_HEADER_SIZE 8 |
65 |
#define LIST_HEADER_SIZE 12 |
66 |
#define RIFF_HEADER_SIZE 12 |
67 |
|
68 |
|
69 |
/** RIFF specific classes and definitions */ |
70 |
namespace RIFF { |
71 |
|
72 |
/* just symbol prototyping */ |
73 |
class Chunk; |
74 |
class List; |
75 |
class File; |
76 |
|
77 |
typedef std::string String; |
78 |
|
79 |
/** Whether file stream is open in read or in read/write mode. */ |
80 |
typedef enum { |
81 |
stream_mode_read = 0, |
82 |
stream_mode_read_write = 1, |
83 |
stream_mode_closed = 2 |
84 |
} stream_mode_t; |
85 |
|
86 |
/** Current state of the file stream. */ |
87 |
typedef enum { |
88 |
stream_ready = 0, |
89 |
stream_end_reached = 1, |
90 |
stream_closed = 2 |
91 |
} stream_state_t; |
92 |
|
93 |
/** File stream position dependent to these relations. */ |
94 |
typedef enum { |
95 |
stream_start = 0, |
96 |
stream_curpos = 1, |
97 |
stream_backward = 2, |
98 |
stream_end = 3 |
99 |
} stream_whence_t; |
100 |
|
101 |
/** Provides convenient methods to access data of RIFF chunks in general. */ |
102 |
class Chunk { |
103 |
public: |
104 |
Chunk(File* pFile, unsigned long StartPos, List* Parent); |
105 |
String GetChunkIDString(); |
106 |
uint32_t GetChunkID() { return ChunkID; }; ///< Chunk ID in unsigned integer representation. |
107 |
List* GetParent() { return pParent; }; ///< Returns pointer to the chunk's parent list chunk. |
108 |
unsigned long GetSize() { return CurrentChunkSize; }; ///< Chunk size in bytes (without header, thus the chunk data body) |
109 |
unsigned long GetNewSize() { return NewChunkSize; }; ///< New chunk size if it was modified with Resize(). |
110 |
unsigned long GetPos() { return ulPos; }; ///< Position within the chunk data body |
111 |
unsigned long GetFilePos() { return ulStartPos + ulPos; }; ///< Current, actual offset in file. |
112 |
unsigned long SetPos(unsigned long Where, stream_whence_t Whence = stream_start); |
113 |
unsigned long RemainingBytes(); |
114 |
stream_state_t GetState(); |
115 |
unsigned long Read(void* pData, unsigned long WordCount, unsigned long WordSize); |
116 |
unsigned long ReadInt8(int8_t* pData, unsigned long WordCount = 1); |
117 |
unsigned long ReadUint8(uint8_t* pData, unsigned long WordCount = 1); |
118 |
unsigned long ReadInt16(int16_t* pData, unsigned long WordCount = 1); |
119 |
unsigned long ReadUint16(uint16_t* pData, unsigned long WordCount = 1); |
120 |
unsigned long ReadInt32(int32_t* pData, unsigned long WordCount = 1); |
121 |
unsigned long ReadUint32(uint32_t* pData, unsigned long WordCount = 1); |
122 |
int8_t ReadInt8(); |
123 |
uint8_t ReadUint8(); |
124 |
int16_t ReadInt16(); |
125 |
uint16_t ReadUint16(); |
126 |
int32_t ReadInt32(); |
127 |
uint32_t ReadUint32(); |
128 |
unsigned long Write(void* pData, unsigned long WordCount, unsigned long WordSize); |
129 |
unsigned long WriteInt8(int8_t* pData, unsigned long WordCount = 1); |
130 |
unsigned long WriteUint8(uint8_t* pData, unsigned long WordCount = 1); |
131 |
unsigned long WriteInt16(int16_t* pData, unsigned long WordCount = 1); |
132 |
unsigned long WriteUint16(uint16_t* pData, unsigned long WordCount = 1); |
133 |
unsigned long WriteInt32(int32_t* pData, unsigned long WordCount = 1); |
134 |
unsigned long WriteUint32(uint32_t* pData, unsigned long WordCount = 1); |
135 |
void* LoadChunkData(); |
136 |
void ReleaseChunkData(); |
137 |
void Resize(int iNewSize); |
138 |
virtual ~Chunk(); |
139 |
protected: |
140 |
uint32_t ChunkID; |
141 |
uint32_t CurrentChunkSize; /* in bytes */ |
142 |
uint32_t NewChunkSize; /* in bytes (if chunk was scheduled to be resized) */ |
143 |
List* pParent; |
144 |
File* pFile; |
145 |
unsigned long ulStartPos; /* actual position in file where chunk (without header) starts */ |
146 |
unsigned long ulPos; /* # of bytes from ulStartPos */ |
147 |
uint8_t* pChunkData; |
148 |
|
149 |
Chunk(File* pFile); |
150 |
Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize); |
151 |
void ReadHeader(unsigned long fPos); |
152 |
void WriteHeader(unsigned long fPos); |
153 |
unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize); |
154 |
inline void swapBytes_16(void* Word) { |
155 |
uint8_t byteCache = *((uint8_t*) Word); |
156 |
*((uint8_t*) Word) = *((uint8_t*) Word + 1); |
157 |
*((uint8_t*) Word + 1) = byteCache; |
158 |
} |
159 |
inline void swapBytes_32(void* Word) { |
160 |
uint8_t byteCache = *((uint8_t*) Word); |
161 |
*((uint8_t*) Word) = *((uint8_t*) Word + 3); |
162 |
*((uint8_t*) Word + 3) = byteCache; |
163 |
byteCache = *((uint8_t*) Word + 1); |
164 |
*((uint8_t*) Word + 1) = *((uint8_t*) Word + 2); |
165 |
*((uint8_t*) Word + 2) = byteCache; |
166 |
} |
167 |
inline void swapBytes(void* Word, unsigned long WordSize) { |
168 |
uint8_t byteCache; |
169 |
unsigned long lo = 0, hi = WordSize - 1; |
170 |
for (; lo < hi; hi--, lo++) { |
171 |
byteCache = *((uint8_t*) Word + lo); |
172 |
*((uint8_t*) Word + lo) = *((uint8_t*) Word + hi); |
173 |
*((uint8_t*) Word + hi) = byteCache; |
174 |
} |
175 |
} |
176 |
inline String convertToString(uint32_t word) { |
177 |
String result; |
178 |
for (int i = 0; i < 4; i++) { |
179 |
uint8_t byte = *((uint8_t*)(&word) + i); |
180 |
char c = byte; |
181 |
result += c; |
182 |
} |
183 |
return result; |
184 |
} |
185 |
virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset); |
186 |
virtual void __resetPos(); ///< Sets Chunk's read/write position to zero. |
187 |
|
188 |
friend class List; |
189 |
}; |
190 |
|
191 |
/** Provides convenient methods to access data of RIFF list chunks and their subchunks. */ |
192 |
class List : public Chunk { |
193 |
public: |
194 |
List(File* pFile, unsigned long StartPos, List* Parent); |
195 |
String GetListTypeString(); |
196 |
uint32_t GetListType() { return ListType; } ///< Returns unsigned integer representation of the list's ID |
197 |
Chunk* GetSubChunk(uint32_t ChunkID); |
198 |
List* GetSubList(uint32_t ListType); |
199 |
Chunk* GetFirstSubChunk(); |
200 |
Chunk* GetNextSubChunk(); |
201 |
List* GetFirstSubList(); |
202 |
List* GetNextSubList(); |
203 |
unsigned int CountSubChunks(); |
204 |
unsigned int CountSubChunks(uint32_t ChunkID); |
205 |
unsigned int CountSubLists(); |
206 |
unsigned int CountSubLists(uint32_t ListType); |
207 |
Chunk* AddSubChunk(uint32_t uiChunkID, uint uiBodySize); |
208 |
List* AddSubList(uint32_t uiListType); |
209 |
void DeleteSubChunk(Chunk* pSubChunk); |
210 |
virtual ~List(); |
211 |
protected: |
212 |
typedef std::map<uint32_t, RIFF::Chunk*> ChunkMap; |
213 |
typedef std::list<Chunk*> ChunkList; |
214 |
|
215 |
uint32_t ListType; |
216 |
ChunkList* pSubChunks; |
217 |
ChunkMap* pSubChunksMap; |
218 |
ChunkList::iterator ChunksIterator; |
219 |
ChunkList::iterator ListIterator; |
220 |
|
221 |
List(File* pFile); |
222 |
List(File* pFile, List* pParent, uint32_t uiListID); |
223 |
void ReadHeader(unsigned long fPos); |
224 |
void WriteHeader(unsigned long fPos); |
225 |
void LoadSubChunks(); |
226 |
virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset); |
227 |
virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same. |
228 |
}; |
229 |
|
230 |
/** Parses arbitrary RIFF files and provides together with it's base classes convenient methods to walk through the RIFF tree. */ |
231 |
class File : public List { |
232 |
public: |
233 |
File(uint32_t FileType); |
234 |
File(const String& path); |
235 |
stream_mode_t GetMode(); |
236 |
bool SetMode(stream_mode_t NewMode); |
237 |
String GetFileName(); |
238 |
virtual void Save(); |
239 |
virtual void Save(const String& path); |
240 |
virtual ~File(); |
241 |
protected: |
242 |
#if POSIX |
243 |
int hFileRead; ///< handle / descriptor for reading from file |
244 |
int hFileWrite; ///< handle / descriptor for writing to (some) file |
245 |
#else |
246 |
FILE* hFileRead; ///< handle / descriptor for reading from file |
247 |
FILE* hFileWrite; ///< handle / descriptor for writing to (some) file |
248 |
#endif // POSIX |
249 |
String Filename; |
250 |
bool bEndianNative; |
251 |
|
252 |
void LogAsResized(Chunk* pResizedChunk); |
253 |
friend class Chunk; |
254 |
friend class List; |
255 |
private: |
256 |
stream_mode_t Mode; |
257 |
ChunkList ResizedChunks; ///< All chunks which have been resized (enlarged / shortened). |
258 |
|
259 |
unsigned long GetFileSize(); |
260 |
void ResizeFile(unsigned long ulNewSize); |
261 |
#if POSIX |
262 |
unsigned long __GetFileSize(int hFile); |
263 |
#else |
264 |
unsigned long __GetFileSize(FILE* hFile); |
265 |
#endif |
266 |
}; |
267 |
|
268 |
/** Will be thrown whenever an error occurs while parsing a RIFF file. */ |
269 |
class Exception { |
270 |
public: |
271 |
String Message; |
272 |
|
273 |
Exception(String Message) { Exception::Message = Message; }; |
274 |
void PrintMessage(); |
275 |
virtual ~Exception() {}; |
276 |
}; |
277 |
|
278 |
String libraryName(); |
279 |
String libraryVersion(); |
280 |
|
281 |
} // namespace RIFF |
282 |
#endif // __RIFF_H__ |