/[svn]/libgig/trunk/src/RIFF.h
ViewVC logotype

Diff of /libgig/trunk/src/RIFF.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 518 by schoenebeck, Sun May 8 16:19:34 2005 UTC revision 1193 by schoenebeck, Thu May 17 17:08:29 2007 UTC
# Line 1  Line 1 
1  /***************************************************************************  /***************************************************************************
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file loader library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2005 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2007 by Christian Schoenebeck                      *
6   *                              <cuse@users.sourceforge.net>               *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   This library is free software; you can redistribute it and/or modify  *
# Line 24  Line 24 
24  #ifndef __RIFF_H__  #ifndef __RIFF_H__
25  #define __RIFF_H__  #define __RIFF_H__
26    
27  #define POSIX 1  #ifdef WIN32
28  #define DEBUG 0  # 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>  #include <string>
40  #include <list>  #include <list>
# Line 45  Line 54 
54    
55  #include <stdint.h>  #include <stdint.h>
56    
57  //typedef unsigned char  uint8_t;  #ifdef WIN32
58  //typedef unsigned short uint16_t;  # include "../win32/libgig_private.h" // like config.h, automatically generated by Dev-C++
59  //typedef unsigned int   uint32_t;  # include <windows.h>
60      typedef unsigned int   uint;
61      typedef unsigned char  uint8_t;
62      typedef unsigned short uint16_t;
63      typedef unsigned int   uint32_t;
64    # define PACKAGE "libgig"
65    # define VERSION VER_STRING // VER_STRING defined in libgig_private.h
66    #endif // WIN32
67    
68  #include <stdio.h>  #include <stdio.h>
69    
# Line 66  Line 82 
82  #define RIFF_HEADER_SIZE        12  #define RIFF_HEADER_SIZE        12
83    
84    
85  /** RIFF specific classes and definitions */  /**
86     * @brief RIFF specific classes and definitions
87     *
88     * The Resource Interchange File Format (RIFF) is a generic tree-structured
89     * meta-format which stores data in so called "chunks". It can be compared
90     * to XML, but in contrast to XML, RIFF is entirely binary encoded, that is
91     * not ASCII based. RIFF is used as basis for many file formats like AVI,
92     * WAV, DLS and of course the Gigasampler file format. ;-)
93     *
94     * RIFF chunks can be seen as containers for data. There are two distinct
95     * types of chunks:
96     *
97     * - @e ordinary @e chunks are the leafs of the data tree which encapsulate
98     *   the actual data of the file (i.e. the sample data of a .wav file)
99     *
100     * - @e list @e chunks are the nodes of the data tree which hold an
101     *   arbitrary amount of subchunks (can be both, list chunks and/or ordinary
102     *   chunks)
103     */
104  namespace RIFF {  namespace RIFF {
105    
106      /* just symbol prototyping */      /* just symbol prototyping */
107      class Chunk;      class Chunk;
108      class List;      class List;
109        class File;
110    
111      typedef std::string String;      typedef std::string String;
112    
113        /** Whether file stream is open in read or in read/write mode. */
114        typedef enum {
115            stream_mode_read       = 0,
116            stream_mode_read_write = 1,
117            stream_mode_closed     = 2
118        } stream_mode_t;
119    
120      /** Current state of the file stream. */      /** Current state of the file stream. */
121      typedef enum {      typedef enum {
122          stream_ready       = 0,          stream_ready       = 0,
# Line 90  namespace RIFF { Line 132  namespace RIFF {
132          stream_end      = 3          stream_end      = 3
133      } stream_whence_t;      } stream_whence_t;
134    
135      /** Provides convenient methods to access data of RIFF chunks in general. */      /** Alignment of data bytes in memory (system dependant). */
136        typedef enum {
137            endian_little = 0,
138            endian_big    = 1,
139            endian_native = 2
140        } endian_t;
141    
142        /** @brief Ordinary RIFF Chunk
143         *
144         * Provides convenient methods to access data of ordinary RIFF chunks
145         * in general.
146         */
147      class Chunk {      class Chunk {
148          public:          public:
149              #if POSIX              Chunk(File* pFile, unsigned long StartPos, List* Parent);
             Chunk(int hFile, unsigned long StartPos, bool EndianNative, List* Parent);  
             #else  
             Chunk(FILE* hFile, unsigned long StartPos, bool EndianNative, List* Parent);  
             #endif // POSIX  
150              String         GetChunkIDString();              String         GetChunkIDString();
151              uint32_t       GetChunkID() { return ChunkID; };            ///< Chunk ID in unsigned integer representation.              uint32_t       GetChunkID() { return ChunkID; };            ///< Chunk ID in unsigned integer representation.
152              List*          GetParent()  { return pParent; };            ///< Returns pointer to the chunk's parent list chunk.              List*          GetParent()  { return pParent; };            ///< Returns pointer to the chunk's parent list chunk.
153              unsigned long  GetSize()    { return ChunkSize; };          ///< Chunk size in bytes (without header, thus the chunk data body)              unsigned long  GetSize()    { return CurrentChunkSize; };   ///< Chunk size in bytes (without header, thus the chunk data body)
154                unsigned long  GetNewSize() { return NewChunkSize;     };   ///< New chunk size if it was modified with Resize().
155              unsigned long  GetPos()     { return ulPos; };              ///< Position within the chunk data body              unsigned long  GetPos()     { return ulPos; };              ///< Position within the chunk data body
156              unsigned long  GetFilePos() { return ulStartPos + ulPos; }; ///< Current, actual offset in file.              unsigned long  GetFilePos() { return ulStartPos + ulPos; }; ///< Current, actual offset in file.
157              unsigned long  SetPos(unsigned long Where, stream_whence_t Whence = stream_start);              unsigned long  SetPos(unsigned long Where, stream_whence_t Whence = stream_start);
# Line 120  namespace RIFF { Line 170  namespace RIFF {
170              uint16_t       ReadUint16();              uint16_t       ReadUint16();
171              int32_t        ReadInt32();              int32_t        ReadInt32();
172              uint32_t       ReadUint32();              uint32_t       ReadUint32();
173              void*          LoadChunkData();     ///< Load the whole chunk body in memory (on success returns a pointer to the data in RAM, else NULL).              unsigned long  Write(void* pData, unsigned long WordCount, unsigned long WordSize);
174              void           ReleaseChunkData();  ///< Free loaded chunk body data from memory (RAM).              unsigned long  WriteInt8(int8_t* pData,     unsigned long WordCount = 1);
175                unsigned long  WriteUint8(uint8_t* pData,   unsigned long WordCount = 1);
176                unsigned long  WriteInt16(int16_t* pData,   unsigned long WordCount = 1);
177                unsigned long  WriteUint16(uint16_t* pData, unsigned long WordCount = 1);
178                unsigned long  WriteInt32(int32_t* pData,   unsigned long WordCount = 1);
179                unsigned long  WriteUint32(uint32_t* pData, unsigned long WordCount = 1);
180                void*          LoadChunkData();
181                void           ReleaseChunkData();
182                void           Resize(int iNewSize);
183              virtual ~Chunk();              virtual ~Chunk();
184          protected:          protected:
185              uint32_t      ChunkID;              uint32_t      ChunkID;
186              uint32_t      ChunkSize;            /* in bytes */              uint32_t      CurrentChunkSize;             /* in bytes */
187                uint32_t      NewChunkSize;                 /* in bytes (if chunk was scheduled to be resized) */
188              List*         pParent;              List*         pParent;
189              #if POSIX              File*         pFile;
             int           hFile;  
             #else  
             FILE*         hFile;  
             #endif // POSIX  
190              unsigned long ulStartPos;           /* actual position in file where chunk (without header) starts */              unsigned long ulStartPos;           /* actual position in file where chunk (without header) starts */
191              unsigned long ulPos;                /* # of bytes from ulStartPos */              unsigned long ulPos;                /* # of bytes from ulStartPos */
             bool          bEndianNative;  
192              uint8_t*      pChunkData;              uint8_t*      pChunkData;
193                unsigned long ulChunkDataSize;
194    
195              Chunk();              Chunk(File* pFile);
196                Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize);
197              void          ReadHeader(unsigned long fPos);              void          ReadHeader(unsigned long fPos);
198                void          WriteHeader(unsigned long fPos);
199              unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);              unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);
200              inline void   swapBytes_16(void* Word) {              inline void   swapBytes_16(void* Word) {
201                  uint8_t byteCache = *((uint8_t*) Word);                  uint8_t byteCache = *((uint8_t*) Word);
# Line 171  namespace RIFF { Line 228  namespace RIFF {
228                  }                  }
229                  return result;                  return result;
230              }              }
231                virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
232                virtual void __resetPos(); ///< Sets Chunk's read/write position to zero.
233    
234                friend class List;
235      };      };
236    
237      /** Provides convenient methods to access data of RIFF list chunks and their subchunks. */      /** @brief RIFF List Chunk
238         *
239         * Provides convenient methods to access data of RIFF list chunks and
240         * their subchunks.
241         */
242      class List : public Chunk {      class List : public Chunk {
243          public:          public:
244              #if POSIX              List(File* pFile, unsigned long StartPos, List* Parent);
             List(int hFile, unsigned long StartPos, bool EndianNative, List* Parent);  
             #else  
             List(FILE* hFile, unsigned long StartPos, bool EndianNative, List* Parent);  
             #endif // POSIX  
245              String       GetListTypeString();              String       GetListTypeString();
246              uint32_t     GetListType() { return ListType; }   ///< Returns unsigned integer representation of the list's ID              uint32_t     GetListType() { return ListType; }   ///< Returns unsigned integer representation of the list's ID
247              Chunk*       GetSubChunk(uint32_t ChunkID);              Chunk*       GetSubChunk(uint32_t ChunkID);
# Line 193  namespace RIFF { Line 254  namespace RIFF {
254              unsigned int CountSubChunks(uint32_t ChunkID);              unsigned int CountSubChunks(uint32_t ChunkID);
255              unsigned int CountSubLists();              unsigned int CountSubLists();
256              unsigned int CountSubLists(uint32_t ListType);              unsigned int CountSubLists(uint32_t ListType);
257                Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
258                List*        AddSubList(uint32_t uiListType);
259                void         DeleteSubChunk(Chunk* pSubChunk);
260                void         MoveSubChunk(Chunk* pSrc, Chunk* pDst);
261              virtual ~List();              virtual ~List();
262          protected:          protected:
263              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;
# Line 204  namespace RIFF { Line 269  namespace RIFF {
269              ChunkList::iterator ChunksIterator;              ChunkList::iterator ChunksIterator;
270              ChunkList::iterator ListIterator;              ChunkList::iterator ListIterator;
271    
272              List();              List(File* pFile);
273                List(File* pFile, List* pParent, uint32_t uiListID);
274              void ReadHeader(unsigned long fPos);              void ReadHeader(unsigned long fPos);
275                void WriteHeader(unsigned long fPos);
276              void LoadSubChunks();              void LoadSubChunks();
277                void LoadSubChunksRecursively();
278                virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
279                virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.
280      };      };
281    
282      /** Parses arbitrary RIFF files and provides together with it's base classes convenient methods to walk through the RIFF tree. */      /** @brief RIFF File
283         *
284         * Handles arbitrary RIFF files and provides together with its base
285         * classes convenient methods to walk through, read and modify the
286         * file's RIFF tree.
287         */
288      class File : public List {      class File : public List {
289          public:          public:
290                File(uint32_t FileType);
291              File(const String& path);              File(const String& path);
292                stream_mode_t GetMode();
293                bool          SetMode(stream_mode_t NewMode);
294                void SetByteOrder(endian_t Endian);
295                String GetFileName();
296                virtual void Save();
297                virtual void Save(const String& path);
298              virtual ~File();              virtual ~File();
299            protected:
300                #if POSIX
301                int    hFileRead;  ///< handle / descriptor for reading from file
302                int    hFileWrite; ///< handle / descriptor for writing to (some) file
303                #elif defined(WIN32)
304                HANDLE hFileRead;  ///< handle / descriptor for reading from file
305                HANDLE hFileWrite; ///< handle / descriptor for writing to (some) file
306                #else
307                FILE*  hFileRead;  ///< handle / descriptor for reading from file
308                FILE*  hFileWrite; ///< handle / descriptor for writing to (some) file
309                #endif // POSIX
310                String Filename;
311                bool   bEndianNative;
312    
313                void LogAsResized(Chunk* pResizedChunk);
314                void UnlogResized(Chunk* pResizedChunk);
315                friend class Chunk;
316                friend class List;
317          private:          private:
318                stream_mode_t  Mode;
319                ChunkList      ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).
320    
321              unsigned long GetFileSize();              unsigned long GetFileSize();
322                void ResizeFile(unsigned long ulNewSize);
323                #if POSIX
324                unsigned long __GetFileSize(int hFile);
325                #elif defined(WIN32)
326                unsigned long __GetFileSize(HANDLE hFile);
327                #else
328                unsigned long __GetFileSize(FILE* hFile);
329                #endif
330      };      };
331    
332      /** Will be thrown whenever an error occurs while parsing a RIFF file. */      /**
333         * Will be thrown whenever an error occurs while handling a RIFF file.
334         */
335      class Exception {      class Exception {
336          public:          public:
337              String Message;              String Message;
Legend:
Removed from v.518  
changed lines
  Added in v.1193
  ViewVC Help
Powered by ViewVC