/[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 1184 by persson, Sun May 13 13:24:22 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 72  namespace RIFF { Line 88  namespace RIFF {
88      /* just symbol prototyping */      /* just symbol prototyping */
89      class Chunk;      class Chunk;
90      class List;      class List;
91        class File;
92    
93      typedef std::string String;      typedef std::string String;
94    
95        /** Whether file stream is open in read or in read/write mode. */
96        typedef enum {
97            stream_mode_read       = 0,
98            stream_mode_read_write = 1,
99            stream_mode_closed     = 2
100        } stream_mode_t;
101    
102      /** Current state of the file stream. */      /** Current state of the file stream. */
103      typedef enum {      typedef enum {
104          stream_ready       = 0,          stream_ready       = 0,
# Line 90  namespace RIFF { Line 114  namespace RIFF {
114          stream_end      = 3          stream_end      = 3
115      } stream_whence_t;      } stream_whence_t;
116    
117        typedef enum {
118            endian_little = 0,
119            endian_big    = 1,
120            endian_native = 2
121        } endian_t;
122    
123      /** Provides convenient methods to access data of RIFF chunks in general. */      /** Provides convenient methods to access data of RIFF chunks in general. */
124      class Chunk {      class Chunk {
125          public:          public:
126              #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  
127              String         GetChunkIDString();              String         GetChunkIDString();
128              uint32_t       GetChunkID() { return ChunkID; };            ///< Chunk ID in unsigned integer representation.              uint32_t       GetChunkID() { return ChunkID; };            ///< Chunk ID in unsigned integer representation.
129              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.
130              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)
131                unsigned long  GetNewSize() { return NewChunkSize;     };   ///< New chunk size if it was modified with Resize().
132              unsigned long  GetPos()     { return ulPos; };              ///< Position within the chunk data body              unsigned long  GetPos()     { return ulPos; };              ///< Position within the chunk data body
133              unsigned long  GetFilePos() { return ulStartPos + ulPos; }; ///< Current, actual offset in file.              unsigned long  GetFilePos() { return ulStartPos + ulPos; }; ///< Current, actual offset in file.
134              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 147  namespace RIFF {
147              uint16_t       ReadUint16();              uint16_t       ReadUint16();
148              int32_t        ReadInt32();              int32_t        ReadInt32();
149              uint32_t       ReadUint32();              uint32_t       ReadUint32();
150              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);
151              void           ReleaseChunkData();  ///< Free loaded chunk body data from memory (RAM).              unsigned long  WriteInt8(int8_t* pData,     unsigned long WordCount = 1);
152                unsigned long  WriteUint8(uint8_t* pData,   unsigned long WordCount = 1);
153                unsigned long  WriteInt16(int16_t* pData,   unsigned long WordCount = 1);
154                unsigned long  WriteUint16(uint16_t* pData, unsigned long WordCount = 1);
155                unsigned long  WriteInt32(int32_t* pData,   unsigned long WordCount = 1);
156                unsigned long  WriteUint32(uint32_t* pData, unsigned long WordCount = 1);
157                void*          LoadChunkData();
158                void           ReleaseChunkData();
159                void           Resize(int iNewSize);
160              virtual ~Chunk();              virtual ~Chunk();
161          protected:          protected:
162              uint32_t      ChunkID;              uint32_t      ChunkID;
163              uint32_t      ChunkSize;            /* in bytes */              uint32_t      CurrentChunkSize;             /* in bytes */
164                uint32_t      NewChunkSize;                 /* in bytes (if chunk was scheduled to be resized) */
165              List*         pParent;              List*         pParent;
166              #if POSIX              File*         pFile;
             int           hFile;  
             #else  
             FILE*         hFile;  
             #endif // POSIX  
167              unsigned long ulStartPos;           /* actual position in file where chunk (without header) starts */              unsigned long ulStartPos;           /* actual position in file where chunk (without header) starts */
168              unsigned long ulPos;                /* # of bytes from ulStartPos */              unsigned long ulPos;                /* # of bytes from ulStartPos */
             bool          bEndianNative;  
169              uint8_t*      pChunkData;              uint8_t*      pChunkData;
170                unsigned long ulChunkDataSize;
171    
172              Chunk();              Chunk(File* pFile);
173                Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize);
174              void          ReadHeader(unsigned long fPos);              void          ReadHeader(unsigned long fPos);
175                void          WriteHeader(unsigned long fPos);
176              unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);              unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);
177              inline void   swapBytes_16(void* Word) {              inline void   swapBytes_16(void* Word) {
178                  uint8_t byteCache = *((uint8_t*) Word);                  uint8_t byteCache = *((uint8_t*) Word);
# Line 171  namespace RIFF { Line 205  namespace RIFF {
205                  }                  }
206                  return result;                  return result;
207              }              }
208                virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
209                virtual void __resetPos(); ///< Sets Chunk's read/write position to zero.
210    
211                friend class List;
212      };      };
213    
214      /** Provides convenient methods to access data of RIFF list chunks and their subchunks. */      /** Provides convenient methods to access data of RIFF list chunks and their subchunks. */
215      class List : public Chunk {      class List : public Chunk {
216          public:          public:
217              #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  
218              String       GetListTypeString();              String       GetListTypeString();
219              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
220              Chunk*       GetSubChunk(uint32_t ChunkID);              Chunk*       GetSubChunk(uint32_t ChunkID);
# Line 193  namespace RIFF { Line 227  namespace RIFF {
227              unsigned int CountSubChunks(uint32_t ChunkID);              unsigned int CountSubChunks(uint32_t ChunkID);
228              unsigned int CountSubLists();              unsigned int CountSubLists();
229              unsigned int CountSubLists(uint32_t ListType);              unsigned int CountSubLists(uint32_t ListType);
230                Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
231                List*        AddSubList(uint32_t uiListType);
232                void         DeleteSubChunk(Chunk* pSubChunk);
233                void         MoveSubChunk(Chunk* pSrc, Chunk* pDst);
234              virtual ~List();              virtual ~List();
235          protected:          protected:
236              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;
# Line 204  namespace RIFF { Line 242  namespace RIFF {
242              ChunkList::iterator ChunksIterator;              ChunkList::iterator ChunksIterator;
243              ChunkList::iterator ListIterator;              ChunkList::iterator ListIterator;
244    
245              List();              List(File* pFile);
246                List(File* pFile, List* pParent, uint32_t uiListID);
247              void ReadHeader(unsigned long fPos);              void ReadHeader(unsigned long fPos);
248                void WriteHeader(unsigned long fPos);
249              void LoadSubChunks();              void LoadSubChunks();
250                void LoadSubChunksRecursively();
251                virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
252                virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.
253      };      };
254    
255      /** Parses arbitrary RIFF files and provides together with it's base classes convenient methods to walk through the RIFF tree. */      /** Parses arbitrary RIFF files and provides together with it's base classes convenient methods to walk through the RIFF tree. */
256      class File : public List {      class File : public List {
257          public:          public:
258                File(uint32_t FileType);
259              File(const String& path);              File(const String& path);
260                stream_mode_t GetMode();
261                bool          SetMode(stream_mode_t NewMode);
262                void SetByteOrder(endian_t Endian);
263                String GetFileName();
264                virtual void Save();
265                virtual void Save(const String& path);
266              virtual ~File();              virtual ~File();
267            protected:
268                #if POSIX
269                int    hFileRead;  ///< handle / descriptor for reading from file
270                int    hFileWrite; ///< handle / descriptor for writing to (some) file
271                #elif defined(WIN32)
272                HANDLE hFileRead;  ///< handle / descriptor for reading from file
273                HANDLE hFileWrite; ///< handle / descriptor for writing to (some) file
274                #else
275                FILE*  hFileRead;  ///< handle / descriptor for reading from file
276                FILE*  hFileWrite; ///< handle / descriptor for writing to (some) file
277                #endif // POSIX
278                String Filename;
279                bool   bEndianNative;
280    
281                void LogAsResized(Chunk* pResizedChunk);
282                void UnlogResized(Chunk* pResizedChunk);
283                friend class Chunk;
284                friend class List;
285          private:          private:
286                stream_mode_t  Mode;
287                ChunkList      ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).
288    
289              unsigned long GetFileSize();              unsigned long GetFileSize();
290                void ResizeFile(unsigned long ulNewSize);
291                #if POSIX
292                unsigned long __GetFileSize(int hFile);
293                #elif defined(WIN32)
294                unsigned long __GetFileSize(HANDLE hFile);
295                #else
296                unsigned long __GetFileSize(FILE* hFile);
297                #endif
298      };      };
299    
300      /** Will be thrown whenever an error occurs while parsing a RIFF file. */      /** Will be thrown whenever an error occurs while parsing a RIFF file. */
Legend:
Removed from v.518  
changed lines
  Added in v.1184
  ViewVC Help
Powered by ViewVC