/[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 11 by schoenebeck, Sun Nov 16 17:47:00 2003 UTC revision 1102 by persson, Sun Mar 18 07:13:06 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 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  *
9   *   it under the terms of the GNU General Public License as published by  *   *   it under the terms of the GNU General Public License as published by  *
# 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 93  namespace RIFF { Line 117  namespace RIFF {
117      /** Provides convenient methods to access data of RIFF chunks in general. */      /** Provides convenient methods to access data of RIFF chunks in general. */
118      class Chunk {      class Chunk {
119          public:          public:
120              #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  
121              String         GetChunkIDString();              String         GetChunkIDString();
122              uint32_t       GetChunkID() { return ChunkID; };            ///< Chunk ID in unsigned integer representation.              uint32_t       GetChunkID() { return ChunkID; };            ///< Chunk ID in unsigned integer representation.
123              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.
124              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)
125                unsigned long  GetNewSize() { return NewChunkSize;     };   ///< New chunk size if it was modified with Resize().
126              unsigned long  GetPos()     { return ulPos; };              ///< Position within the chunk data body              unsigned long  GetPos()     { return ulPos; };              ///< Position within the chunk data body
127              unsigned long  GetFilePos() { return ulStartPos + ulPos; }; ///< Current, actual offset in file.              unsigned long  GetFilePos() { return ulStartPos + ulPos; }; ///< Current, actual offset in file.
128              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 141  namespace RIFF {
141              uint16_t       ReadUint16();              uint16_t       ReadUint16();
142              int32_t        ReadInt32();              int32_t        ReadInt32();
143              uint32_t       ReadUint32();              uint32_t       ReadUint32();
144              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);
145              void           ReleaseChunkData();  ///< Free loaded chunk body data from memory (RAM).              unsigned long  WriteInt8(int8_t* pData,     unsigned long WordCount = 1);
146             ~Chunk();              unsigned long  WriteUint8(uint8_t* pData,   unsigned long WordCount = 1);
147                unsigned long  WriteInt16(int16_t* pData,   unsigned long WordCount = 1);
148                unsigned long  WriteUint16(uint16_t* pData, unsigned long WordCount = 1);
149                unsigned long  WriteInt32(int32_t* pData,   unsigned long WordCount = 1);
150                unsigned long  WriteUint32(uint32_t* pData, unsigned long WordCount = 1);
151                void*          LoadChunkData();
152                void           ReleaseChunkData();
153                void           Resize(int iNewSize);
154                virtual ~Chunk();
155          protected:          protected:
156              uint32_t      ChunkID;              uint32_t      ChunkID;
157              uint32_t      ChunkSize;            /* in bytes */              uint32_t      CurrentChunkSize;             /* in bytes */
158                uint32_t      NewChunkSize;                 /* in bytes (if chunk was scheduled to be resized) */
159              List*         pParent;              List*         pParent;
160              #if POSIX              File*         pFile;
             int           hFile;  
             #else  
             FILE*         hFile;  
             #endif // POSIX  
161              unsigned long ulStartPos;           /* actual position in file where chunk (without header) starts */              unsigned long ulStartPos;           /* actual position in file where chunk (without header) starts */
162              unsigned long ulPos;                /* # of bytes from ulStartPos */              unsigned long ulPos;                /* # of bytes from ulStartPos */
             bool          bEndianNative;  
163              uint8_t*      pChunkData;              uint8_t*      pChunkData;
164                unsigned long ulChunkDataSize;
165    
166              Chunk();              Chunk(File* pFile);
167                Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize);
168              void          ReadHeader(unsigned long fPos);              void          ReadHeader(unsigned long fPos);
169                void          WriteHeader(unsigned long fPos);
170              unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);              unsigned long ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize);
171              inline void   swapBytes_16(void* Word) {              inline void   swapBytes_16(void* Word) {
172                  uint8_t byteCache = *((uint8_t*) Word);                  uint8_t byteCache = *((uint8_t*) Word);
# Line 171  namespace RIFF { Line 199  namespace RIFF {
199                  }                  }
200                  return result;                  return result;
201              }              }
202                virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
203                virtual void __resetPos(); ///< Sets Chunk's read/write position to zero.
204    
205                friend class List;
206      };      };
207    
208      /** 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. */
209      class List : public Chunk {      class List : public Chunk {
210          public:          public:
211              #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  
212              String       GetListTypeString();              String       GetListTypeString();
213              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
214              Chunk*       GetSubChunk(uint32_t ChunkID);              Chunk*       GetSubChunk(uint32_t ChunkID);
# Line 193  namespace RIFF { Line 221  namespace RIFF {
221              unsigned int CountSubChunks(uint32_t ChunkID);              unsigned int CountSubChunks(uint32_t ChunkID);
222              unsigned int CountSubLists();              unsigned int CountSubLists();
223              unsigned int CountSubLists(uint32_t ListType);              unsigned int CountSubLists(uint32_t ListType);
224             ~List();              Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
225                List*        AddSubList(uint32_t uiListType);
226                void         DeleteSubChunk(Chunk* pSubChunk);
227                void         MoveSubChunk(Chunk* pSrc, Chunk* pDst);
228                virtual ~List();
229          protected:          protected:
230              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;
231              typedef std::list<Chunk*>                 ChunkList;              typedef std::list<Chunk*>                 ChunkList;
# Line 204  namespace RIFF { Line 236  namespace RIFF {
236              ChunkList::iterator ChunksIterator;              ChunkList::iterator ChunksIterator;
237              ChunkList::iterator ListIterator;              ChunkList::iterator ListIterator;
238    
239              List();              List(File* pFile);
240                List(File* pFile, List* pParent, uint32_t uiListID);
241              void ReadHeader(unsigned long fPos);              void ReadHeader(unsigned long fPos);
242                void WriteHeader(unsigned long fPos);
243              void LoadSubChunks();              void LoadSubChunks();
244                void LoadSubChunksRecursively();
245                virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
246                virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.
247      };      };
248    
249      /** 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. */
250      class File : public List {      class File : public List {
251          public:          public:
252                File(uint32_t FileType);
253              File(const String& path);              File(const String& path);
254             ~File();              stream_mode_t GetMode();
255                bool          SetMode(stream_mode_t NewMode);
256                String GetFileName();
257                virtual void Save();
258                virtual void Save(const String& path);
259                virtual ~File();
260            protected:
261                #if POSIX
262                int    hFileRead;  ///< handle / descriptor for reading from file
263                int    hFileWrite; ///< handle / descriptor for writing to (some) file
264                #elif defined(WIN32)
265                HANDLE hFileRead;  ///< handle / descriptor for reading from file
266                HANDLE hFileWrite; ///< handle / descriptor for writing to (some) file
267                #else
268                FILE*  hFileRead;  ///< handle / descriptor for reading from file
269                FILE*  hFileWrite; ///< handle / descriptor for writing to (some) file
270                #endif // POSIX
271                String Filename;
272                bool   bEndianNative;
273    
274                void LogAsResized(Chunk* pResizedChunk);
275                void UnlogResized(Chunk* pResizedChunk);
276                friend class Chunk;
277                friend class List;
278          private:          private:
279                stream_mode_t  Mode;
280                ChunkList      ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).
281    
282              unsigned long GetFileSize();              unsigned long GetFileSize();
283                void ResizeFile(unsigned long ulNewSize);
284                #if POSIX
285                unsigned long __GetFileSize(int hFile);
286                #elif defined(WIN32)
287                unsigned long __GetFileSize(HANDLE hFile);
288                #else
289                unsigned long __GetFileSize(FILE* hFile);
290                #endif
291      };      };
292    
293      /** Will be thrown whenever an error occurs while parsing a RIFF file. */      /** Will be thrown whenever an error occurs while parsing a RIFF file. */
# Line 228  namespace RIFF { Line 300  namespace RIFF {
300              virtual ~Exception() {};              virtual ~Exception() {};
301      };      };
302    
303        String libraryName();
304        String libraryVersion();
305    
306  } // namespace RIFF  } // namespace RIFF
307  #endif // __RIFF_H__  #endif // __RIFF_H__
Legend:
Removed from v.11  
changed lines
  Added in v.1102
  ViewVC Help
Powered by ViewVC