/[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 800 by schoenebeck, Wed Nov 9 20:04:11 2005 UTC revision 1678 by persson, Sun Feb 10 16:07:22 2008 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>
41    #include <set>
42  #include <map>  #include <map>
43  #include <iostream>  #include <iostream>
44    
# Line 45  Line 55 
55    
56  #include <stdint.h>  #include <stdint.h>
57    
58  //typedef unsigned char  uint8_t;  #ifdef WIN32
59  //typedef unsigned short uint16_t;  # include <windows.h>
60  //typedef unsigned int   uint32_t;    typedef unsigned int   uint;
61    #endif // WIN32
62    
63  #include <stdio.h>  #include <stdio.h>
64    
# Line 66  Line 77 
77  #define RIFF_HEADER_SIZE        12  #define RIFF_HEADER_SIZE        12
78    
79    
80  /** RIFF specific classes and definitions */  /**
81     * @brief RIFF specific classes and definitions
82     *
83     * The Resource Interchange File Format (RIFF) is a generic tree-structured
84     * meta-format which stores data in so called "chunks". It can be compared
85     * to XML, but in contrast to XML, RIFF is entirely binary encoded, that is
86     * not ASCII based. RIFF is used as basis for many file formats like AVI,
87     * WAV, DLS and of course the Gigasampler file format. ;-)
88     *
89     * RIFF chunks can be seen as containers for data. There are two distinct
90     * types of chunks:
91     *
92     * - @e ordinary @e chunks are the leafs of the data tree which encapsulate
93     *   the actual data of the file (i.e. the sample data of a .wav file)
94     *
95     * - @e list @e chunks are the nodes of the data tree which hold an
96     *   arbitrary amount of subchunks (can be both, list chunks and/or ordinary
97     *   chunks)
98     */
99  namespace RIFF {  namespace RIFF {
100    
101      /* just symbol prototyping */      /* just symbol prototyping */
# Line 98  namespace RIFF { Line 127  namespace RIFF {
127          stream_end      = 3          stream_end      = 3
128      } stream_whence_t;      } stream_whence_t;
129    
130      /** Provides convenient methods to access data of RIFF chunks in general. */      /** Alignment of data bytes in memory (system dependant). */
131        typedef enum {
132            endian_little = 0,
133            endian_big    = 1,
134            endian_native = 2
135        } endian_t;
136    
137        /** @brief Ordinary RIFF Chunk
138         *
139         * Provides convenient methods to access data of ordinary RIFF chunks
140         * in general.
141         */
142      class Chunk {      class Chunk {
143          public:          public:
144              Chunk(File* pFile, unsigned long StartPos, List* Parent);              Chunk(File* pFile, unsigned long StartPos, List* Parent);
# Line 189  namespace RIFF { Line 229  namespace RIFF {
229              friend class List;              friend class List;
230      };      };
231    
232      /** Provides convenient methods to access data of RIFF list chunks and their subchunks. */      /** @brief RIFF List Chunk
233         *
234         * Provides convenient methods to access data of RIFF list chunks and
235         * their subchunks.
236         */
237      class List : public Chunk {      class List : public Chunk {
238          public:          public:
239              List(File* pFile, unsigned long StartPos, List* Parent);              List(File* pFile, unsigned long StartPos, List* Parent);
# Line 208  namespace RIFF { Line 252  namespace RIFF {
252              Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);              Chunk*       AddSubChunk(uint32_t uiChunkID, uint uiBodySize);
253              List*        AddSubList(uint32_t uiListType);              List*        AddSubList(uint32_t uiListType);
254              void         DeleteSubChunk(Chunk* pSubChunk);              void         DeleteSubChunk(Chunk* pSubChunk);
255                void         MoveSubChunk(Chunk* pSrc, Chunk* pDst);
256              virtual ~List();              virtual ~List();
257          protected:          protected:
258              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;              typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;
# Line 224  namespace RIFF { Line 269  namespace RIFF {
269              void ReadHeader(unsigned long fPos);              void ReadHeader(unsigned long fPos);
270              void WriteHeader(unsigned long fPos);              void WriteHeader(unsigned long fPos);
271              void LoadSubChunks();              void LoadSubChunks();
272                void LoadSubChunksRecursively();
273              virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);              virtual unsigned long WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset);
274              virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.              virtual void __resetPos(); ///< Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.
275      };      };
276    
277      /** Parses arbitrary RIFF files and provides together with it's base classes convenient methods to walk through the RIFF tree. */      /** @brief RIFF File
278         *
279         * Handles arbitrary RIFF files and provides together with its base
280         * classes convenient methods to walk through, read and modify the
281         * file's RIFF tree.
282         */
283      class File : public List {      class File : public List {
284          public:          public:
285              File(uint32_t FileType);              File(uint32_t FileType);
286              File(const String& path);              File(const String& path);
287              stream_mode_t GetMode();              stream_mode_t GetMode();
288              bool          SetMode(stream_mode_t NewMode);              bool          SetMode(stream_mode_t NewMode);
289                void SetByteOrder(endian_t Endian);
290              String GetFileName();              String GetFileName();
291              virtual void Save();              virtual void Save();
292              virtual void Save(const String& path);              virtual void Save(const String& path);
# Line 243  namespace RIFF { Line 295  namespace RIFF {
295              #if POSIX              #if POSIX
296              int    hFileRead;  ///< handle / descriptor for reading from file              int    hFileRead;  ///< handle / descriptor for reading from file
297              int    hFileWrite; ///< handle / descriptor for writing to (some) file              int    hFileWrite; ///< handle / descriptor for writing to (some) file
298                #elif defined(WIN32)
299                HANDLE hFileRead;  ///< handle / descriptor for reading from file
300                HANDLE hFileWrite; ///< handle / descriptor for writing to (some) file
301              #else              #else
302              FILE*  hFileRead;  ///< handle / descriptor for reading from file              FILE*  hFileRead;  ///< handle / descriptor for reading from file
303              FILE*  hFileWrite; ///< handle / descriptor for writing to (some) file              FILE*  hFileWrite; ///< handle / descriptor for writing to (some) file
# Line 251  namespace RIFF { Line 306  namespace RIFF {
306              bool   bEndianNative;              bool   bEndianNative;
307    
308              void LogAsResized(Chunk* pResizedChunk);              void LogAsResized(Chunk* pResizedChunk);
309                void UnlogResized(Chunk* pResizedChunk);
310              friend class Chunk;              friend class Chunk;
311              friend class List;              friend class List;
312          private:          private:
313              stream_mode_t  Mode;              stream_mode_t  Mode;
314              ChunkList      ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).              std::set<Chunk*> ResizedChunks; ///< All chunks which have been resized (enlarged / shortened).
315    
316              unsigned long GetFileSize();              unsigned long GetFileSize();
317              void ResizeFile(unsigned long ulNewSize);              void ResizeFile(unsigned long ulNewSize);
318              #if POSIX              #if POSIX
319              unsigned long __GetFileSize(int hFile);              unsigned long __GetFileSize(int hFile);
320                #elif defined(WIN32)
321                unsigned long __GetFileSize(HANDLE hFile);
322              #else              #else
323              unsigned long __GetFileSize(FILE* hFile);              unsigned long __GetFileSize(FILE* hFile);
324              #endif              #endif
325      };      };
326    
327      /** Will be thrown whenever an error occurs while parsing a RIFF file. */      /**
328         * Will be thrown whenever an error occurs while handling a RIFF file.
329         */
330      class Exception {      class Exception {
331          public:          public:
332              String Message;              String Message;
Legend:
Removed from v.800  
changed lines
  Added in v.1678
  ViewVC Help
Powered by ViewVC