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

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

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

revision 515 by schoenebeck, Sat May 7 20:19:10 2005 UTC revision 2682 by schoenebeck, Mon Dec 29 16:25:51 2014 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-2014 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 20  Line 20 
20   *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *   *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
21   *   MA  02111-1307  USA                                                   *   *   MA  02111-1307  USA                                                   *
22   ***************************************************************************/   ***************************************************************************/
23  #if 1  
24    #include <algorithm>
25    #include <set>
26    #include <string.h>
27    
28  #include "RIFF.h"  #include "RIFF.h"
29    
30    #include "helper.h"
31    
32    #if POSIX
33    # include <errno.h>
34    #endif
35    
36  namespace RIFF {  namespace RIFF {
37    
38    // *************** Internal functions **************
39    // *
40    
41        /// Returns a human readable path of the given chunk.
42        static String __resolveChunkPath(Chunk* pCk) {
43            String sPath;
44            for (Chunk* pChunk = pCk; pChunk; pChunk = pChunk->GetParent()) {
45                if (pChunk->GetChunkID() == CHUNK_ID_LIST) {
46                    List* pList = (List*) pChunk;
47                    sPath = "->'" + pList->GetListTypeString() + "'" + sPath;
48                } else {
49                    sPath = "->'" + pChunk->GetChunkIDString() + "'" + sPath;
50                }
51            }
52            return sPath;
53        }
54    
55    
56    
57    // *************** progress_t ***************
58    // *
59    
60        progress_t::progress_t() {
61            callback    = NULL;
62            custom      = NULL;
63            __range_min = 0.0f;
64            __range_max = 1.0f;
65        }
66    
67    
68    
69  // *************** Chunk **************  // *************** Chunk **************
70  // *  // *
71    
72      Chunk::Chunk() {      Chunk::Chunk(File* pFile) {
73          #if DEBUG          #if DEBUG
74          std::cout << "Chunk::Chunk()" << std::endl;          std::cout << "Chunk::Chunk(File* pFile)" << std::endl;
75          #endif // DEBUG          #endif // DEBUG
76          ulPos      = 0;          ulPos      = 0;
77          pParent    = NULL;          pParent    = NULL;
78          pChunkData = NULL;          pChunkData = NULL;
79            CurrentChunkSize = 0;
80            NewChunkSize = 0;
81            ulChunkDataSize = 0;
82            ChunkID    = CHUNK_ID_RIFF;
83            this->pFile = pFile;
84      }      }
85    
86      #if POSIX      Chunk::Chunk(File* pFile, unsigned long StartPos, List* Parent) {
     Chunk::Chunk(int hFile, unsigned long StartPos, bool EndianNative, List* Parent) {  
     #else  
     Chunk::Chunk(FILE* hFile, unsigned long StartPos, bool EndianNative, List* Parent) {  
     #endif // POSIX  
87          #if DEBUG          #if DEBUG
88          std::cout << "Chunk::Chunk(FILE,ulong,bool,List*),StartPos=" << StartPos << std::endl;          std::cout << "Chunk::Chunk(File*,ulong,bool,List*),StartPos=" << StartPos << std::endl;
89          #endif // DEBUG          #endif // DEBUG
90          Chunk::hFile  = hFile;          this->pFile   = pFile;
91          ulStartPos    = StartPos + CHUNK_HEADER_SIZE;          ulStartPos    = StartPos + CHUNK_HEADER_SIZE;
         bEndianNative = EndianNative;  
92          pParent       = Parent;          pParent       = Parent;
93          ulPos         = 0;          ulPos         = 0;
94          pChunkData    = NULL;          pChunkData    = NULL;
95            CurrentChunkSize = 0;
96            NewChunkSize = 0;
97            ulChunkDataSize = 0;
98          ReadHeader(StartPos);          ReadHeader(StartPos);
99      }      }
100    
101        Chunk::Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize) {
102            this->pFile      = pFile;
103            ulStartPos       = 0; // arbitrary usually, since it will be updated when we write the chunk
104            this->pParent    = pParent;
105            ulPos            = 0;
106            pChunkData       = NULL;
107            ChunkID          = uiChunkID;
108            ulChunkDataSize  = 0;
109            CurrentChunkSize = 0;
110            NewChunkSize     = uiBodySize;
111        }
112    
113      Chunk::~Chunk() {      Chunk::~Chunk() {
114            if (pFile) pFile->UnlogResized(this);
115          if (pChunkData) delete[] pChunkData;          if (pChunkData) delete[] pChunkData;
116      }      }
117    
# Line 62  namespace RIFF { Line 119  namespace RIFF {
119          #if DEBUG          #if DEBUG
120          std::cout << "Chunk::Readheader(" << fPos << ") ";          std::cout << "Chunk::Readheader(" << fPos << ") ";
121          #endif // DEBUG          #endif // DEBUG
122            ChunkID = 0;
123            NewChunkSize = CurrentChunkSize = 0;
124          #if POSIX          #if POSIX
125          if (lseek(hFile, fPos, SEEK_SET) != -1) {          if (lseek(pFile->hFileRead, fPos, SEEK_SET) != -1) {
126              read(hFile, &ChunkID, 4);              read(pFile->hFileRead, &ChunkID, 4);
127              read(hFile, &ChunkSize, 4);              read(pFile->hFileRead, &CurrentChunkSize, 4);
128          #else          #elif defined(WIN32)
129          if (!fseek(hFile, fPos, SEEK_SET)) {          if (SetFilePointer(pFile->hFileRead, fPos, NULL/*32 bit*/, FILE_BEGIN) != INVALID_SET_FILE_POINTER) {
130              fread(&ChunkID, 4, 1, hFile);              DWORD dwBytesRead;
131              fread(&ChunkSize, 4, 1, hFile);              ReadFile(pFile->hFileRead, &ChunkID, 4, &dwBytesRead, NULL);
132                ReadFile(pFile->hFileRead, &CurrentChunkSize, 4, &dwBytesRead, NULL);
133            #else
134            if (!fseek(pFile->hFileRead, fPos, SEEK_SET)) {
135                fread(&ChunkID, 4, 1, pFile->hFileRead);
136                fread(&CurrentChunkSize, 4, 1, pFile->hFileRead);
137          #endif // POSIX          #endif // POSIX
138              #if WORDS_BIGENDIAN              #if WORDS_BIGENDIAN
139              if (ChunkID == CHUNK_ID_RIFF) {              if (ChunkID == CHUNK_ID_RIFF) {
140                  bEndianNative = false;                  pFile->bEndianNative = false;
141              }              }
142              #else // little endian              #else // little endian
143              if (ChunkID == CHUNK_ID_RIFX) {              if (ChunkID == CHUNK_ID_RIFX) {
144                  bEndianNative = false;                  pFile->bEndianNative = false;
145                  ChunkID = CHUNK_ID_RIFF;                  ChunkID = CHUNK_ID_RIFF;
146              }              }
147              #endif // WORDS_BIGENDIAN              #endif // WORDS_BIGENDIAN
148              if (!bEndianNative) {              if (!pFile->bEndianNative) {
149                  //swapBytes_32(&ChunkID);                  //swapBytes_32(&ChunkID);
150                  swapBytes_32(&ChunkSize);                  swapBytes_32(&CurrentChunkSize);
151              }              }
152              #if DEBUG              #if DEBUG
153              std::cout << "ckID=" << convertToString(ChunkID) << " ";              std::cout << "ckID=" << convertToString(ChunkID) << " ";
154              std::cout << "ckSize=" << ChunkSize << " ";              std::cout << "ckSize=" << CurrentChunkSize << " ";
155              std::cout << "bEndianNative=" << bEndianNative << std::endl;              std::cout << "bEndianNative=" << pFile->bEndianNative << std::endl;
156              #endif // DEBUG              #endif // DEBUG
157                NewChunkSize = CurrentChunkSize;
158          }          }
159      }      }
160    
161        void Chunk::WriteHeader(unsigned long fPos) {
162            uint32_t uiNewChunkID = ChunkID;
163            if (ChunkID == CHUNK_ID_RIFF) {
164                #if WORDS_BIGENDIAN
165                if (pFile->bEndianNative) uiNewChunkID = CHUNK_ID_RIFX;
166                #else // little endian
167                if (!pFile->bEndianNative) uiNewChunkID = CHUNK_ID_RIFX;
168                #endif // WORDS_BIGENDIAN
169            }
170    
171            uint32_t uiNewChunkSize = NewChunkSize;
172            if (!pFile->bEndianNative) {
173                swapBytes_32(&uiNewChunkSize);
174            }
175    
176            #if POSIX
177            if (lseek(pFile->hFileWrite, fPos, SEEK_SET) != -1) {
178                write(pFile->hFileWrite, &uiNewChunkID, 4);
179                write(pFile->hFileWrite, &uiNewChunkSize, 4);
180            }
181            #elif defined(WIN32)
182            if (SetFilePointer(pFile->hFileWrite, fPos, NULL/*32 bit*/, FILE_BEGIN) != INVALID_SET_FILE_POINTER) {
183                DWORD dwBytesWritten;
184                WriteFile(pFile->hFileWrite, &uiNewChunkID, 4, &dwBytesWritten, NULL);
185                WriteFile(pFile->hFileWrite, &uiNewChunkSize, 4, &dwBytesWritten, NULL);
186            }
187            #else
188            if (!fseek(pFile->hFileWrite, fPos, SEEK_SET)) {
189                fwrite(&uiNewChunkID, 4, 1, pFile->hFileWrite);
190                fwrite(&uiNewChunkSize, 4, 1, pFile->hFileWrite);
191            }
192            #endif // POSIX
193        }
194    
195      /**      /**
196       *  Returns the String representation of the chunk's ID (e.g. "RIFF",       *  Returns the String representation of the chunk's ID (e.g. "RIFF",
197       *  "LIST").       *  "LIST").
# Line 105  namespace RIFF { Line 204  namespace RIFF {
204       *  Sets the position within the chunk body, thus within the data portion       *  Sets the position within the chunk body, thus within the data portion
205       *  of the chunk (in bytes).       *  of the chunk (in bytes).
206       *       *
207         *  <b>Caution:</b> the position will be reset to zero whenever
208         *  File::Save() was called.
209         *
210       *  @param Where  - position offset (in bytes)       *  @param Where  - position offset (in bytes)
211       *  @param Whence - optional: defines to what <i>\a Where</i> relates to,       *  @param Whence - optional: defines to what <i>\a Where</i> relates to,
212       *                  if omitted \a Where relates to beginning of the chunk       *                  if omitted \a Where relates to beginning of the chunk
# Line 119  namespace RIFF { Line 221  namespace RIFF {
221                  ulPos += Where;                  ulPos += Where;
222                  break;                  break;
223              case stream_end:              case stream_end:
224                  ulPos = ChunkSize - 1 - Where;                  ulPos = CurrentChunkSize - 1 - Where;
225                  break;                  break;
226              case stream_backward:              case stream_backward:
227                  ulPos -= Where;                  ulPos -= Where;
# Line 128  namespace RIFF { Line 230  namespace RIFF {
230                  ulPos = Where;                  ulPos = Where;
231                  break;                  break;
232          }          }
233          if (ulPos > ChunkSize) ulPos = ChunkSize;          if (ulPos > CurrentChunkSize) ulPos = CurrentChunkSize;
234          return ulPos;          return ulPos;
235      }      }
236    
# Line 144  namespace RIFF { Line 246  namespace RIFF {
246       */       */
247      unsigned long Chunk::RemainingBytes() {      unsigned long Chunk::RemainingBytes() {
248         #if DEBUG         #if DEBUG
249         std::cout << "Chunk::Remainingbytes()=" << ChunkSize - ulPos << std::endl;         std::cout << "Chunk::Remainingbytes()=" << CurrentChunkSize - ulPos << std::endl;
250         #endif // DEBUG         #endif // DEBUG
251          return ChunkSize - ulPos;          return (CurrentChunkSize > ulPos) ? CurrentChunkSize - ulPos : 0;
252      }      }
253    
254      /**      /**
# Line 157  namespace RIFF { Line 259  namespace RIFF {
259       *  - RIFF::stream_closed :       *  - RIFF::stream_closed :
260       *    the data stream was closed somehow, no more reading possible       *    the data stream was closed somehow, no more reading possible
261       *  - RIFF::stream_end_reached :       *  - RIFF::stream_end_reached :
262       *    alreaady reached the end of the chunk data, no more reading       *    already reached the end of the chunk data, no more reading
263       *    possible without SetPos()       *    possible without SetPos()
264       */       */
265      stream_state_t Chunk::GetState() {      stream_state_t Chunk::GetState() {
# Line 165  namespace RIFF { Line 267  namespace RIFF {
267        std::cout << "Chunk::GetState()" << std::endl;        std::cout << "Chunk::GetState()" << std::endl;
268        #endif // DEBUG        #endif // DEBUG
269          #if POSIX          #if POSIX
270          if (hFile == 0)        return stream_closed;          if (pFile->hFileRead == 0) return stream_closed;
271            #elif defined (WIN32)
272            if (pFile->hFileRead == INVALID_HANDLE_VALUE)
273                return stream_closed;
274          #else          #else
275          if (hFile == NULL)     return stream_closed;          if (pFile->hFileRead == NULL) return stream_closed;
276          #endif // POSIX          #endif // POSIX
277          if (ulPos < ChunkSize) return stream_ready;          if (ulPos < CurrentChunkSize) return stream_ready;
278          else                   return stream_end_reached;          else                          return stream_end_reached;
279      }      }
280    
281      /**      /**
# Line 192  namespace RIFF { Line 297  namespace RIFF {
297         #if DEBUG         #if DEBUG
298         std::cout << "Chunk::Read(void*,ulong,ulong)" << std::endl;         std::cout << "Chunk::Read(void*,ulong,ulong)" << std::endl;
299         #endif // DEBUG         #endif // DEBUG
300          if (ulPos >= ChunkSize) return 0;          //if (ulStartPos == 0) return 0; // is only 0 if this is a new chunk, so nothing to read (yet)
301          if (ulPos + WordCount * WordSize >= ChunkSize) WordCount = (ChunkSize - ulPos) / WordSize;          if (ulPos >= CurrentChunkSize) return 0;
302            if (ulPos + WordCount * WordSize >= CurrentChunkSize) WordCount = (CurrentChunkSize - ulPos) / WordSize;
303          #if POSIX          #if POSIX
304          if (lseek(hFile, ulStartPos + ulPos, SEEK_SET) < 0) return 0;          if (lseek(pFile->hFileRead, ulStartPos + ulPos, SEEK_SET) < 0) return 0;
305          unsigned long readWords = read(hFile, pData, WordCount * WordSize);          unsigned long readWords = read(pFile->hFileRead, pData, WordCount * WordSize);
306            if (readWords < 1) return 0;
307            readWords /= WordSize;
308            #elif defined(WIN32)
309            if (SetFilePointer(pFile->hFileRead, ulStartPos + ulPos, NULL/*32 bit*/, FILE_BEGIN) == INVALID_SET_FILE_POINTER) return 0;
310            DWORD readWords;
311            ReadFile(pFile->hFileRead, pData, WordCount * WordSize, &readWords, NULL);
312          if (readWords < 1) return 0;          if (readWords < 1) return 0;
313          readWords /= WordSize;          readWords /= WordSize;
314          #else // standard C functions          #else // standard C functions
315          if (fseek(hFile, ulStartPos + ulPos, SEEK_SET)) return 0;          if (fseek(pFile->hFileRead, ulStartPos + ulPos, SEEK_SET)) return 0;
316          unsigned long readWords = fread(pData, WordSize, WordCount, hFile);          unsigned long readWords = fread(pData, WordSize, WordCount, pFile->hFileRead);
317          #endif // POSIX          #endif // POSIX
318          if (!bEndianNative && WordSize != 1) {          if (!pFile->bEndianNative && WordSize != 1) {
319              switch (WordSize) {              switch (WordSize) {
320                  case 2:                  case 2:
321                      for (unsigned long iWord = 0; iWord < readWords; iWord++)                      for (unsigned long iWord = 0; iWord < readWords; iWord++)
# Line 223  namespace RIFF { Line 335  namespace RIFF {
335          return readWords;          return readWords;
336      }      }
337    
338        /**
339         *  Writes \a WordCount number of data words with given \a WordSize from
340         *  the buffer pointed by \a pData. Be sure to provide the correct
341         *  \a WordSize, as this will be important and taken into account for
342         *  eventual endian correction (swapping of bytes due to different
343         *  native byte order of a system). The position within the chunk will
344         *  automatically be incremented.
345         *
346         *  @param pData      source buffer (containing the data)
347         *  @param WordCount  number of data words to write
348         *  @param WordSize   size of each data word to write
349         *  @returns          number of successfully written data words
350         *  @throws RIFF::Exception  if write operation would exceed current
351         *                           chunk size or any IO error occured
352         *  @see Resize()
353         */
354        unsigned long Chunk::Write(void* pData, unsigned long WordCount, unsigned long WordSize) {
355            if (pFile->Mode != stream_mode_read_write)
356                throw Exception("Cannot write data to chunk, file has to be opened in read+write mode first");
357            if (ulPos >= CurrentChunkSize || ulPos + WordCount * WordSize > CurrentChunkSize)
358                throw Exception("End of chunk reached while trying to write data");
359            if (!pFile->bEndianNative && WordSize != 1) {
360                switch (WordSize) {
361                    case 2:
362                        for (unsigned long iWord = 0; iWord < WordCount; iWord++)
363                            swapBytes_16((uint16_t*) pData + iWord);
364                        break;
365                    case 4:
366                        for (unsigned long iWord = 0; iWord < WordCount; iWord++)
367                            swapBytes_32((uint32_t*) pData + iWord);
368                        break;
369                    default:
370                        for (unsigned long iWord = 0; iWord < WordCount; iWord++)
371                            swapBytes((uint8_t*) pData + iWord * WordSize, WordSize);
372                        break;
373                }
374            }
375            #if POSIX
376            if (lseek(pFile->hFileWrite, ulStartPos + ulPos, SEEK_SET) < 0) {
377                throw Exception("Could not seek to position " + ToString(ulPos) +
378                                " in chunk (" + ToString(ulStartPos + ulPos) + " in file)");
379            }
380            unsigned long writtenWords = write(pFile->hFileWrite, pData, WordCount * WordSize);
381            if (writtenWords < 1) throw Exception("POSIX IO Error while trying to write chunk data");
382            writtenWords /= WordSize;
383            #elif defined(WIN32)
384            if (SetFilePointer(pFile->hFileWrite, ulStartPos + ulPos, NULL/*32 bit*/, FILE_BEGIN) == INVALID_SET_FILE_POINTER) {
385                throw Exception("Could not seek to position " + ToString(ulPos) +
386                                " in chunk (" + ToString(ulStartPos + ulPos) + " in file)");
387            }
388            DWORD writtenWords;
389            WriteFile(pFile->hFileWrite, pData, WordCount * WordSize, &writtenWords, NULL);
390            if (writtenWords < 1) throw Exception("Windows IO Error while trying to write chunk data");
391            writtenWords /= WordSize;
392            #else // standard C functions
393            if (fseek(pFile->hFileWrite, ulStartPos + ulPos, SEEK_SET)) {
394                throw Exception("Could not seek to position " + ToString(ulPos) +
395                                " in chunk (" + ToString(ulStartPos + ulPos) + " in file)");
396            }
397            unsigned long writtenWords = fwrite(pData, WordSize, WordCount, pFile->hFileWrite);
398            #endif // POSIX
399            SetPos(writtenWords * WordSize, stream_curpos);
400            return writtenWords;
401        }
402    
403      /** Just an internal wrapper for the main <i>Read()</i> method with additional Exception throwing on errors. */      /** Just an internal wrapper for the main <i>Read()</i> method with additional Exception throwing on errors. */
404      unsigned long Chunk::ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize) {      unsigned long Chunk::ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize) {
405          unsigned long readWords = Read(pData, WordCount, WordSize);          unsigned long readWords = Read(pData, WordCount, WordSize);
# Line 249  namespace RIFF { Line 426  namespace RIFF {
426      }      }
427    
428      /**      /**
429         * Writes \a WordCount number of 8 Bit signed integer words from the
430         * buffer pointed by \a pData to the chunk's body, directly to the
431         * actual "physical" file. The position within the chunk will
432         * automatically be incremented. Note: you cannot write beyond the
433         * boundaries of the chunk, to append data to the chunk call Resize()
434         * before.
435         *
436         * @param pData             source buffer (containing the data)
437         * @param WordCount         number of 8 Bit signed integers to write
438         * @returns                 number of written integers
439         * @throws RIFF::Exception  if an IO error occured
440         * @see Resize()
441         */
442        unsigned long Chunk::WriteInt8(int8_t* pData, unsigned long WordCount) {
443            return Write(pData, WordCount, 1);
444        }
445    
446        /**
447       * Reads \a WordCount number of 8 Bit unsigned integer words and copies       * Reads \a WordCount number of 8 Bit unsigned integer words and copies
448       * it into the buffer pointed by \a pData. The buffer has to be       * it into the buffer pointed by \a pData. The buffer has to be
449       * allocated. The position within the chunk will automatically be       * allocated. The position within the chunk will automatically be
# Line 268  namespace RIFF { Line 463  namespace RIFF {
463      }      }
464    
465      /**      /**
466         * Writes \a WordCount number of 8 Bit unsigned integer words from the
467         * buffer pointed by \a pData to the chunk's body, directly to the
468         * actual "physical" file. The position within the chunk will
469         * automatically be incremented. Note: you cannot write beyond the
470         * boundaries of the chunk, to append data to the chunk call Resize()
471         * before.
472         *
473         * @param pData             source buffer (containing the data)
474         * @param WordCount         number of 8 Bit unsigned integers to write
475         * @returns                 number of written integers
476         * @throws RIFF::Exception  if an IO error occured
477         * @see Resize()
478         */
479        unsigned long Chunk::WriteUint8(uint8_t* pData, unsigned long WordCount) {
480            return Write(pData, WordCount, 1);
481        }
482    
483        /**
484       * Reads \a WordCount number of 16 Bit signed integer words and copies       * Reads \a WordCount number of 16 Bit signed integer words and copies
485       * it into the buffer pointed by \a pData. The buffer has to be       * it into the buffer pointed by \a pData. The buffer has to be
486       * allocated. Endian correction will automatically be done if needed.       * allocated. Endian correction will automatically be done if needed.
# Line 287  namespace RIFF { Line 500  namespace RIFF {
500      }      }
501    
502      /**      /**
503         * Writes \a WordCount number of 16 Bit signed integer words from the
504         * buffer pointed by \a pData to the chunk's body, directly to the
505         * actual "physical" file. The position within the chunk will
506         * automatically be incremented. Note: you cannot write beyond the
507         * boundaries of the chunk, to append data to the chunk call Resize()
508         * before.
509         *
510         * @param pData             source buffer (containing the data)
511         * @param WordCount         number of 16 Bit signed integers to write
512         * @returns                 number of written integers
513         * @throws RIFF::Exception  if an IO error occured
514         * @see Resize()
515         */
516        unsigned long Chunk::WriteInt16(int16_t* pData, unsigned long WordCount) {
517            return Write(pData, WordCount, 2);
518        }
519    
520        /**
521       * Reads \a WordCount number of 16 Bit unsigned integer words and copies       * Reads \a WordCount number of 16 Bit unsigned integer words and copies
522       * it into the buffer pointed by \a pData. The buffer has to be       * it into the buffer pointed by \a pData. The buffer has to be
523       * allocated. Endian correction will automatically be done if needed.       * allocated. Endian correction will automatically be done if needed.
# Line 306  namespace RIFF { Line 537  namespace RIFF {
537      }      }
538    
539      /**      /**
540         * Writes \a WordCount number of 16 Bit unsigned integer words from the
541         * buffer pointed by \a pData to the chunk's body, directly to the
542         * actual "physical" file. The position within the chunk will
543         * automatically be incremented. Note: you cannot write beyond the
544         * boundaries of the chunk, to append data to the chunk call Resize()
545         * before.
546         *
547         * @param pData             source buffer (containing the data)
548         * @param WordCount         number of 16 Bit unsigned integers to write
549         * @returns                 number of written integers
550         * @throws RIFF::Exception  if an IO error occured
551         * @see Resize()
552         */
553        unsigned long Chunk::WriteUint16(uint16_t* pData, unsigned long WordCount) {
554            return Write(pData, WordCount, 2);
555        }
556    
557        /**
558       * Reads \a WordCount number of 32 Bit signed integer words and copies       * Reads \a WordCount number of 32 Bit signed integer words and copies
559       * it into the buffer pointed by \a pData. The buffer has to be       * it into the buffer pointed by \a pData. The buffer has to be
560       * allocated. Endian correction will automatically be done if needed.       * allocated. Endian correction will automatically be done if needed.
# Line 325  namespace RIFF { Line 574  namespace RIFF {
574      }      }
575    
576      /**      /**
577         * Writes \a WordCount number of 32 Bit signed integer words from the
578         * buffer pointed by \a pData to the chunk's body, directly to the
579         * actual "physical" file. The position within the chunk will
580         * automatically be incremented. Note: you cannot write beyond the
581         * boundaries of the chunk, to append data to the chunk call Resize()
582         * before.
583         *
584         * @param pData             source buffer (containing the data)
585         * @param WordCount         number of 32 Bit signed integers to write
586         * @returns                 number of written integers
587         * @throws RIFF::Exception  if an IO error occured
588         * @see Resize()
589         */
590        unsigned long Chunk::WriteInt32(int32_t* pData, unsigned long WordCount) {
591            return Write(pData, WordCount, 4);
592        }
593    
594        /**
595       * Reads \a WordCount number of 32 Bit unsigned integer words and copies       * Reads \a WordCount number of 32 Bit unsigned integer words and copies
596       * it into the buffer pointed by \a pData. The buffer has to be       * it into the buffer pointed by \a pData. The buffer has to be
597       * allocated. Endian correction will automatically be done if needed.       * allocated. Endian correction will automatically be done if needed.
# Line 344  namespace RIFF { Line 611  namespace RIFF {
611      }      }
612    
613      /**      /**
614         * Reads a null-padded string of size characters and copies it
615         * into the string \a s. The position within the chunk will
616         * automatically be incremented.
617         *
618         * @param s                 destination string
619         * @param size              number of characters to read
620         * @throws RIFF::Exception  if an error occured or less than
621         *                          \a size characters could be read!
622         */
623        void Chunk::ReadString(String& s, int size) {
624            char* buf = new char[size];
625            ReadSceptical(buf, 1, size);
626            s.assign(buf, std::find(buf, buf + size, '\0'));
627            delete[] buf;
628        }
629    
630        /**
631         * Writes \a WordCount number of 32 Bit unsigned integer words from the
632         * buffer pointed by \a pData to the chunk's body, directly to the
633         * actual "physical" file. The position within the chunk will
634         * automatically be incremented. Note: you cannot write beyond the
635         * boundaries of the chunk, to append data to the chunk call Resize()
636         * before.
637         *
638         * @param pData             source buffer (containing the data)
639         * @param WordCount         number of 32 Bit unsigned integers to write
640         * @returns                 number of written integers
641         * @throws RIFF::Exception  if an IO error occured
642         * @see Resize()
643         */
644        unsigned long Chunk::WriteUint32(uint32_t* pData, unsigned long WordCount) {
645            return Write(pData, WordCount, 4);
646        }
647    
648        /**
649       * Reads one 8 Bit signed integer word and increments the position within       * Reads one 8 Bit signed integer word and increments the position within
650       * the chunk.       * the chunk.
651       *       *
# Line 443  namespace RIFF { Line 745  namespace RIFF {
745          return word;          return word;
746      }      }
747    
748        /** @brief Load chunk body into RAM.
749         *
750         * Loads the whole chunk body into memory. You can modify the data in
751         * RAM and save the data by calling File::Save() afterwards.
752         *
753         * <b>Caution:</b> the buffer pointer will be invalidated once
754         * File::Save() was called. You have to call LoadChunkData() again to
755         * get a new, valid pointer whenever File::Save() was called.
756         *
757         * You can call LoadChunkData() again if you previously scheduled to
758         * enlarge this chunk with a Resize() call. In that case the buffer will
759         * be enlarged to the new, scheduled chunk size and you can already
760         * place the new chunk data to the buffer and finally call File::Save()
761         * to enlarge the chunk physically and write the new data in one rush.
762         * This approach is definitely recommended if you have to enlarge and
763         * write new data to a lot of chunks.
764         *
765         * @returns a pointer to the data in RAM on success, NULL otherwise
766         * @throws Exception if data buffer could not be enlarged
767         * @see ReleaseChunkData()
768         */
769      void* Chunk::LoadChunkData() {      void* Chunk::LoadChunkData() {
770          if (!pChunkData) {          if (!pChunkData && pFile->Filename != "" /*&& ulStartPos != 0*/) {
771              #if POSIX              #if POSIX
772              if (lseek(hFile, ulStartPos, SEEK_SET) == -1) return NULL;              if (lseek(pFile->hFileRead, ulStartPos, SEEK_SET) == -1) return NULL;
773              pChunkData = new uint8_t[GetSize()];              #elif defined(WIN32)
774              if (!pChunkData) return NULL;              if (SetFilePointer(pFile->hFileRead, ulStartPos, NULL/*32 bit*/, FILE_BEGIN) == INVALID_SET_FILE_POINTER) return NULL;
             unsigned long readWords = read(hFile, pChunkData, GetSize());  
775              #else              #else
776              if (fseek(hFile, ulStartPos, SEEK_SET)) return NULL;              if (fseek(pFile->hFileRead, ulStartPos, SEEK_SET)) return NULL;
777              pChunkData = new uint8_t[GetSize()];              #endif // POSIX
778                unsigned long ulBufferSize = (CurrentChunkSize > NewChunkSize) ? CurrentChunkSize : NewChunkSize;
779                pChunkData = new uint8_t[ulBufferSize];
780              if (!pChunkData) return NULL;              if (!pChunkData) return NULL;
781              unsigned long readWords = fread(pChunkData, 1, GetSize(), hFile);              memset(pChunkData, 0, ulBufferSize);
782                #if POSIX
783                unsigned long readWords = read(pFile->hFileRead, pChunkData, GetSize());
784                #elif defined(WIN32)
785                DWORD readWords;
786                ReadFile(pFile->hFileRead, pChunkData, GetSize(), &readWords, NULL);
787                #else
788                unsigned long readWords = fread(pChunkData, 1, GetSize(), pFile->hFileRead);
789              #endif // POSIX              #endif // POSIX
790              if (readWords != GetSize()) {              if (readWords != GetSize()) {
791                  delete[] pChunkData;                  delete[] pChunkData;
792                  return (pChunkData = NULL);                  return (pChunkData = NULL);
793              }              }
794                ulChunkDataSize = ulBufferSize;
795            } else if (NewChunkSize > ulChunkDataSize) {
796                uint8_t* pNewBuffer = new uint8_t[NewChunkSize];
797                if (!pNewBuffer) throw Exception("Could not enlarge chunk data buffer to " + ToString(NewChunkSize) + " bytes");
798                memset(pNewBuffer, 0 , NewChunkSize);
799                memcpy(pNewBuffer, pChunkData, ulChunkDataSize);
800                delete[] pChunkData;
801                pChunkData      = pNewBuffer;
802                ulChunkDataSize = NewChunkSize;
803          }          }
804          return pChunkData;          return pChunkData;
805      }      }
806    
807        /** @brief Free loaded chunk body from RAM.
808         *
809         * Frees loaded chunk body data from memory (RAM). You should call
810         * File::Save() before calling this method if you modified the data to
811         * make the changes persistent.
812         */
813      void Chunk::ReleaseChunkData() {      void Chunk::ReleaseChunkData() {
814          if (pChunkData) {          if (pChunkData) {
815              delete[] pChunkData;              delete[] pChunkData;
# Line 471  namespace RIFF { Line 817  namespace RIFF {
817          }          }
818      }      }
819    
820        /** @brief Resize chunk.
821         *
822         * Resizes this chunk's body, that is the actual size of data possible
823         * to be written to this chunk. This call will return immediately and
824         * just schedule the resize operation. You should call File::Save() to
825         * actually perform the resize operation(s) "physically" to the file.
826         * As this can take a while on large files, it is recommended to call
827         * Resize() first on all chunks which have to be resized and finally to
828         * call File::Save() to perform all those resize operations in one rush.
829         *
830         * <b>Caution:</b> You cannot directly write to enlarged chunks before
831         * calling File::Save() as this might exceed the current chunk's body
832         * boundary!
833         *
834         * @param iNewSize - new chunk body size in bytes (must be greater than zero)
835         * @throws RIFF::Exception  if \a iNewSize is less than 1
836         * @see File::Save()
837         */
838        void Chunk::Resize(int iNewSize) {
839            if (iNewSize <= 0)
840                throw Exception("There is at least one empty chunk (zero size): " + __resolveChunkPath(this));
841            if (NewChunkSize == iNewSize) return;
842            NewChunkSize = iNewSize;
843            pFile->LogAsResized(this);
844        }
845    
846        /** @brief Write chunk persistently e.g. to disk.
847         *
848         * Stores the chunk persistently to its actual "physical" file.
849         *
850         * @param ulWritePos - position within the "physical" file where this
851         *                     chunk should be written to
852         * @param ulCurrentDataOffset - offset of current (old) data within
853         *                              the file
854         * @param pProgress - optional: callback function for progress notification
855         * @returns new write position in the "physical" file, that is
856         *          \a ulWritePos incremented by this chunk's new size
857         *          (including its header size of course)
858         */
859        unsigned long Chunk::WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset, progress_t* pProgress) {
860            const unsigned long ulOriginalPos = ulWritePos;
861            ulWritePos += CHUNK_HEADER_SIZE;
862    
863            if (pFile->Mode != stream_mode_read_write)
864                throw Exception("Cannot write list chunk, file has to be opened in read+write mode");
865    
866            // if the whole chunk body was loaded into RAM
867            if (pChunkData) {
868                // make sure chunk data buffer in RAM is at least as large as the new chunk size
869                LoadChunkData();
870                // write chunk data from RAM persistently to the file
871                #if POSIX
872                lseek(pFile->hFileWrite, ulWritePos, SEEK_SET);
873                if (write(pFile->hFileWrite, pChunkData, NewChunkSize) != NewChunkSize) {
874                    throw Exception("Writing Chunk data (from RAM) failed");
875                }
876                #elif defined(WIN32)
877                SetFilePointer(pFile->hFileWrite, ulWritePos, NULL/*32 bit*/, FILE_BEGIN);
878                DWORD dwBytesWritten;
879                WriteFile(pFile->hFileWrite, pChunkData, NewChunkSize, &dwBytesWritten, NULL);
880                if (dwBytesWritten != NewChunkSize) {
881                    throw Exception("Writing Chunk data (from RAM) failed");
882                }
883                #else
884                fseek(pFile->hFileWrite, ulWritePos, SEEK_SET);
885                if (fwrite(pChunkData, 1, NewChunkSize, pFile->hFileWrite) != NewChunkSize) {
886                    throw Exception("Writing Chunk data (from RAM) failed");
887                }
888                #endif // POSIX
889            } else {
890                // move chunk data from the end of the file to the appropriate position
891                int8_t* pCopyBuffer = new int8_t[4096];
892                unsigned long ulToMove = (NewChunkSize < CurrentChunkSize) ? NewChunkSize : CurrentChunkSize;
893                #if defined(WIN32)
894                DWORD iBytesMoved = 1; // we have to pass it via pointer to the Windows API, thus the correct size must be ensured
895                #else
896                int iBytesMoved = 1;
897                #endif
898                for (unsigned long ulOffset = 0; ulToMove > 0 && iBytesMoved > 0; ulOffset += iBytesMoved, ulToMove -= iBytesMoved) {
899                    iBytesMoved = (ulToMove < 4096) ? ulToMove : 4096;
900                    #if POSIX
901                    lseek(pFile->hFileRead, ulStartPos + ulCurrentDataOffset + ulOffset, SEEK_SET);
902                    iBytesMoved = read(pFile->hFileRead, pCopyBuffer, iBytesMoved);
903                    lseek(pFile->hFileWrite, ulWritePos + ulOffset, SEEK_SET);
904                    iBytesMoved = write(pFile->hFileWrite, pCopyBuffer, iBytesMoved);
905                    #elif defined(WIN32)
906                    SetFilePointer(pFile->hFileRead, ulStartPos + ulCurrentDataOffset + ulOffset, NULL/*32 bit*/, FILE_BEGIN);
907                    ReadFile(pFile->hFileRead, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
908                    SetFilePointer(pFile->hFileWrite, ulWritePos + ulOffset, NULL/*32 bit*/, FILE_BEGIN);
909                    WriteFile(pFile->hFileWrite, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
910                    #else
911                    fseek(pFile->hFileRead, ulStartPos + ulCurrentDataOffset + ulOffset, SEEK_SET);
912                    iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, pFile->hFileRead);
913                    fseek(pFile->hFileWrite, ulWritePos + ulOffset, SEEK_SET);
914                    iBytesMoved = fwrite(pCopyBuffer, 1, iBytesMoved, pFile->hFileWrite);
915                    #endif
916                }
917                delete[] pCopyBuffer;
918                if (iBytesMoved < 0) throw Exception("Writing Chunk data (from file) failed");
919            }
920    
921            // update this chunk's header
922            CurrentChunkSize = NewChunkSize;
923            WriteHeader(ulOriginalPos);
924    
925            __notify_progress(pProgress, 1.0); // notify done
926    
927            // update chunk's position pointers
928            ulStartPos = ulOriginalPos + CHUNK_HEADER_SIZE;
929            ulPos      = 0;
930    
931            // add pad byte if needed
932            if ((ulStartPos + NewChunkSize) % 2 != 0) {
933                const char cPadByte = 0;
934                #if POSIX
935                lseek(pFile->hFileWrite, ulStartPos + NewChunkSize, SEEK_SET);
936                write(pFile->hFileWrite, &cPadByte, 1);
937                #elif defined(WIN32)
938                SetFilePointer(pFile->hFileWrite, ulStartPos + NewChunkSize, NULL/*32 bit*/, FILE_BEGIN);
939                DWORD dwBytesWritten;
940                WriteFile(pFile->hFileWrite, &cPadByte, 1, &dwBytesWritten, NULL);
941                #else
942                fseek(pFile->hFileWrite, ulStartPos + NewChunkSize, SEEK_SET);
943                fwrite(&cPadByte, 1, 1, pFile->hFileWrite);
944                #endif
945                return ulStartPos + NewChunkSize + 1;
946            }
947    
948            return ulStartPos + NewChunkSize;
949        }
950    
951        void Chunk::__resetPos() {
952            ulPos = 0;
953        }
954    
955    
956    
957  // *************** List ***************  // *************** List ***************
958  // *  // *
959    
960      List::List() : Chunk() {      List::List(File* pFile) : Chunk(pFile) {
961        #if DEBUG        #if DEBUG
962        std::cout << "List::List()" << std::endl;        std::cout << "List::List(File* pFile)" << std::endl;
963        #endif // DEBUG        #endif // DEBUG
964          pSubChunks    = NULL;          pSubChunks    = NULL;
965          pSubChunksMap = NULL;          pSubChunksMap = NULL;
966      }      }
967    
968      #if POSIX      List::List(File* pFile, unsigned long StartPos, List* Parent)
969      List::List(int hFile, unsigned long StartPos, bool EndianNative, List* Parent)        : Chunk(pFile, StartPos, Parent) {
     #else  
     List::List(FILE* hFile, unsigned long StartPos, bool EndianNative, List* Parent)  
     #endif // POSIX  
       : Chunk(hFile, StartPos, EndianNative, Parent) {  
970          #if DEBUG          #if DEBUG
971          std::cout << "List::List(FILE*,ulong,bool,List*)" << std::endl;          std::cout << "List::List(File*,ulong,bool,List*)" << std::endl;
972          #endif // DEBUG          #endif // DEBUG
973          pSubChunks    = NULL;          pSubChunks    = NULL;
974          pSubChunksMap = NULL;          pSubChunksMap = NULL;
# Line 499  namespace RIFF { Line 976  namespace RIFF {
976          ulStartPos    = StartPos + LIST_HEADER_SIZE;          ulStartPos    = StartPos + LIST_HEADER_SIZE;
977      }      }
978    
979        List::List(File* pFile, List* pParent, uint32_t uiListID)
980          : Chunk(pFile, pParent, CHUNK_ID_LIST, 0) {
981            pSubChunks    = NULL;
982            pSubChunksMap = NULL;
983            ListType      = uiListID;
984        }
985    
986      List::~List() {      List::~List() {
987        #if DEBUG        #if DEBUG
988        std::cout << "List::~List()" << std::endl;        std::cout << "List::~List()" << std::endl;
989        #endif // DEBUG        #endif // DEBUG
990            DeleteChunkList();
991        }
992    
993        void List::DeleteChunkList() {
994          if (pSubChunks) {          if (pSubChunks) {
995              ChunkList::iterator iter = pSubChunks->begin();              ChunkList::iterator iter = pSubChunks->begin();
996              ChunkList::iterator end  = pSubChunks->end();              ChunkList::iterator end  = pSubChunks->end();
# Line 511  namespace RIFF { Line 999  namespace RIFF {
999                  iter++;                  iter++;
1000              }              }
1001              delete pSubChunks;              delete pSubChunks;
1002                pSubChunks = NULL;
1003            }
1004            if (pSubChunksMap) {
1005                delete pSubChunksMap;
1006                pSubChunksMap = NULL;
1007          }          }
         if (pSubChunksMap) delete pSubChunksMap;  
1008      }      }
1009    
1010      /**      /**
# Line 693  namespace RIFF { Line 1185  namespace RIFF {
1185          return result;          return result;
1186      }      }
1187    
1188        /** @brief Creates a new sub chunk.
1189         *
1190         * Creates and adds a new sub chunk to this list chunk. Note that the
1191         * chunk's body size given by \a uiBodySize must be greater than zero.
1192         * You have to call File::Save() to make this change persistent to the
1193         * actual file and <b>before</b> performing any data write operations
1194         * on the new chunk!
1195         *
1196         * @param uiChunkID  - chunk ID of the new chunk
1197         * @param uiBodySize - size of the new chunk's body, that is its actual
1198         *                     data size (without header)
1199         * @throws RIFF::Exception if \a uiBodySize equals zero
1200         */
1201        Chunk* List::AddSubChunk(uint32_t uiChunkID, uint uiBodySize) {
1202            if (uiBodySize == 0) throw Exception("Chunk body size must be at least 1 byte");
1203            if (!pSubChunks) LoadSubChunks();
1204            Chunk* pNewChunk = new Chunk(pFile, this, uiChunkID, 0);
1205            pSubChunks->push_back(pNewChunk);
1206            (*pSubChunksMap)[uiChunkID] = pNewChunk;
1207            pNewChunk->Resize(uiBodySize);
1208            NewChunkSize += CHUNK_HEADER_SIZE;
1209            pFile->LogAsResized(this);
1210            return pNewChunk;
1211        }
1212    
1213        /** @brief Moves a sub chunk witin this list.
1214         *
1215         * Moves a sub chunk from one position in this list to another
1216         * position in the same list. The pSrc chunk is placed before the
1217         * pDst chunk.
1218         *
1219         * @param pSrc - sub chunk to be moved
1220         * @param pDst - the position to move to. pSrc will be placed
1221         *               before pDst. If pDst is 0, pSrc will be placed
1222         *               last in list.
1223         */
1224        void List::MoveSubChunk(Chunk* pSrc, Chunk* pDst) {
1225            if (!pSubChunks) LoadSubChunks();
1226            pSubChunks->remove(pSrc);
1227            ChunkList::iterator iter = find(pSubChunks->begin(), pSubChunks->end(), pDst);
1228            pSubChunks->insert(iter, pSrc);
1229        }
1230    
1231        /** @brief Moves a sub chunk from this list to another list.
1232         *
1233         * Moves a sub chunk from this list list to the end of another
1234         * list.
1235         *
1236         * @param pSrc - sub chunk to be moved
1237         * @param pDst - destination list where the chunk shall be moved to
1238         */
1239        void List::MoveSubChunk(Chunk* pSrc, List* pNewParent) {
1240            if (pNewParent == this || !pNewParent) return;
1241            if (!pSubChunks) LoadSubChunks();
1242            if (!pNewParent->pSubChunks) pNewParent->LoadSubChunks();
1243            pSubChunks->remove(pSrc);
1244            pNewParent->pSubChunks->push_back(pSrc);
1245            // update chunk id map of this List
1246            if ((*pSubChunksMap)[pSrc->GetChunkID()] == pSrc) {
1247                pSubChunksMap->erase(pSrc->GetChunkID());
1248                // try to find another chunk of the same chunk ID
1249                ChunkList::iterator iter = pSubChunks->begin();
1250                ChunkList::iterator end  = pSubChunks->end();
1251                for (; iter != end; ++iter) {
1252                    if ((*iter)->GetChunkID() == pSrc->GetChunkID()) {
1253                        (*pSubChunksMap)[pSrc->GetChunkID()] = *iter;
1254                        break; // we're done, stop search
1255                    }
1256                }
1257            }
1258            // update chunk id map of other list
1259            if (!(*pNewParent->pSubChunksMap)[pSrc->GetChunkID()])
1260                (*pNewParent->pSubChunksMap)[pSrc->GetChunkID()] = pSrc;
1261        }
1262    
1263        /** @brief Creates a new list sub chunk.
1264         *
1265         * Creates and adds a new list sub chunk to this list chunk. Note that
1266         * you have to add sub chunks / sub list chunks to the new created chunk
1267         * <b>before</b> trying to make this change persisten to the actual
1268         * file with File::Save()!
1269         *
1270         * @param uiListType - list ID of the new list chunk
1271         */
1272        List* List::AddSubList(uint32_t uiListType) {
1273            if (!pSubChunks) LoadSubChunks();
1274            List* pNewListChunk = new List(pFile, this, uiListType);
1275            pSubChunks->push_back(pNewListChunk);
1276            (*pSubChunksMap)[CHUNK_ID_LIST] = pNewListChunk;
1277            NewChunkSize += LIST_HEADER_SIZE;
1278            pFile->LogAsResized(this);
1279            return pNewListChunk;
1280        }
1281    
1282        /** @brief Removes a sub chunk.
1283         *
1284         * Removes the sub chunk given by \a pSubChunk from this list and frees
1285         * it completely from RAM. The given chunk can either be a normal sub
1286         * chunk or a list sub chunk. In case the given chunk is a list chunk,
1287         * all its subchunks (if any) will be removed recursively as well. You
1288         * should call File::Save() to make this change persistent at any time.
1289         *
1290         * @param pSubChunk - sub chunk or sub list chunk to be removed
1291         */
1292        void List::DeleteSubChunk(Chunk* pSubChunk) {
1293            if (!pSubChunks) LoadSubChunks();
1294            pSubChunks->remove(pSubChunk);
1295            if ((*pSubChunksMap)[pSubChunk->GetChunkID()] == pSubChunk) {
1296                pSubChunksMap->erase(pSubChunk->GetChunkID());
1297                // try to find another chunk of the same chunk ID
1298                ChunkList::iterator iter = pSubChunks->begin();
1299                ChunkList::iterator end  = pSubChunks->end();
1300                for (; iter != end; ++iter) {
1301                    if ((*iter)->GetChunkID() == pSubChunk->GetChunkID()) {
1302                        (*pSubChunksMap)[pSubChunk->GetChunkID()] = *iter;
1303                        break; // we're done, stop search
1304                    }
1305                }
1306            }
1307            delete pSubChunk;
1308        }
1309    
1310      void List::ReadHeader(unsigned long fPos) {      void List::ReadHeader(unsigned long fPos) {
1311        #if DEBUG        #if DEBUG
1312        std::cout << "List::Readheader(ulong) ";        std::cout << "List::Readheader(ulong) ";
1313        #endif // DEBUG        #endif // DEBUG
1314          Chunk::ReadHeader(fPos);          Chunk::ReadHeader(fPos);
1315          ChunkSize -= 4;          if (CurrentChunkSize < 4) return;
1316            NewChunkSize = CurrentChunkSize -= 4;
1317          #if POSIX          #if POSIX
1318          lseek(hFile, fPos + CHUNK_HEADER_SIZE, SEEK_SET);          lseek(pFile->hFileRead, fPos + CHUNK_HEADER_SIZE, SEEK_SET);
1319          read(hFile, &ListType, 4);          read(pFile->hFileRead, &ListType, 4);
1320            #elif defined(WIN32)
1321            SetFilePointer(pFile->hFileRead, fPos + CHUNK_HEADER_SIZE, NULL/*32 bit*/, FILE_BEGIN);
1322            DWORD dwBytesRead;
1323            ReadFile(pFile->hFileRead, &ListType, 4, &dwBytesRead, NULL);
1324          #else          #else
1325          fseek(hFile, fPos + CHUNK_HEADER_SIZE, SEEK_SET);          fseek(pFile->hFileRead, fPos + CHUNK_HEADER_SIZE, SEEK_SET);
1326          fread(&ListType, 4, 1, hFile);          fread(&ListType, 4, 1, pFile->hFileRead);
1327          #endif // POSIX          #endif // POSIX
1328        #if DEBUG        #if DEBUG
1329        std::cout << "listType=" << convertToString(ListType) << std::endl;        std::cout << "listType=" << convertToString(ListType) << std::endl;
1330        #endif // DEBUG        #endif // DEBUG
1331          if (!bEndianNative) {          if (!pFile->bEndianNative) {
1332              //swapBytes_32(&ListType);              //swapBytes_32(&ListType);
1333          }          }
1334      }      }
1335    
1336      void List::LoadSubChunks() {      void List::WriteHeader(unsigned long fPos) {
1337            // the four list type bytes officially belong the chunk's body in the RIFF format
1338            NewChunkSize += 4;
1339            Chunk::WriteHeader(fPos);
1340            NewChunkSize -= 4; // just revert the +4 incrementation
1341            #if POSIX
1342            lseek(pFile->hFileWrite, fPos + CHUNK_HEADER_SIZE, SEEK_SET);
1343            write(pFile->hFileWrite, &ListType, 4);
1344            #elif defined(WIN32)
1345            SetFilePointer(pFile->hFileWrite, fPos + CHUNK_HEADER_SIZE, NULL/*32 bit*/, FILE_BEGIN);
1346            DWORD dwBytesWritten;
1347            WriteFile(pFile->hFileWrite, &ListType, 4, &dwBytesWritten, NULL);
1348            #else
1349            fseek(pFile->hFileWrite, fPos + CHUNK_HEADER_SIZE, SEEK_SET);
1350            fwrite(&ListType, 4, 1, pFile->hFileWrite);
1351            #endif // POSIX
1352        }
1353    
1354        void List::LoadSubChunks(progress_t* pProgress) {
1355         #if DEBUG         #if DEBUG
1356         std::cout << "List::LoadSubChunks()";         std::cout << "List::LoadSubChunks()";
1357         #endif // DEBUG         #endif // DEBUG
1358          if (!pSubChunks) {          if (!pSubChunks) {
1359              pSubChunks    = new ChunkList();              pSubChunks    = new ChunkList();
1360              pSubChunksMap = new ChunkMap();              pSubChunksMap = new ChunkMap();
1361                #if defined(WIN32)
1362                if (pFile->hFileRead == INVALID_HANDLE_VALUE) return;
1363                #else
1364                if (!pFile->hFileRead) return;
1365                #endif
1366              unsigned long uiOriginalPos = GetPos();              unsigned long uiOriginalPos = GetPos();
1367              SetPos(0); // jump to beginning of list chunk body              SetPos(0); // jump to beginning of list chunk body
1368              while (RemainingBytes() >= CHUNK_HEADER_SIZE) {              while (RemainingBytes() >= CHUNK_HEADER_SIZE) {
# Line 731  namespace RIFF { Line 1373  namespace RIFF {
1373         std::cout << " ckid=" << convertToString(ckid) << std::endl;         std::cout << " ckid=" << convertToString(ckid) << std::endl;
1374         #endif // DEBUG         #endif // DEBUG
1375                  if (ckid == CHUNK_ID_LIST) {                  if (ckid == CHUNK_ID_LIST) {
1376                      ck = new RIFF::List(hFile, ulStartPos + ulPos - 4, bEndianNative, this);                      ck = new RIFF::List(pFile, ulStartPos + ulPos - 4, this);
1377                      SetPos(ck->GetSize() + LIST_HEADER_SIZE - 4, RIFF::stream_curpos);                      SetPos(ck->GetSize() + LIST_HEADER_SIZE - 4, RIFF::stream_curpos);
1378                  }                  }
1379                  else { // simple chunk                  else { // simple chunk
1380                      ck = new RIFF::Chunk(hFile, ulStartPos + ulPos - 4, bEndianNative, this);                      ck = new RIFF::Chunk(pFile, ulStartPos + ulPos - 4, this);
1381                      SetPos(ck->GetSize() + CHUNK_HEADER_SIZE - 4, RIFF::stream_curpos);                      SetPos(ck->GetSize() + CHUNK_HEADER_SIZE - 4, RIFF::stream_curpos);
1382                  }                  }
1383                  pSubChunks->push_back(ck);                  pSubChunks->push_back(ck);
# Line 744  namespace RIFF { Line 1386  namespace RIFF {
1386              }              }
1387              SetPos(uiOriginalPos); // restore position before this call              SetPos(uiOriginalPos); // restore position before this call
1388          }          }
1389            __notify_progress(pProgress, 1.0); // notify done
1390        }
1391    
1392        void List::LoadSubChunksRecursively(progress_t* pProgress) {
1393            const int n = CountSubLists();
1394            int i = 0;
1395            for (List* pList = GetFirstSubList(); pList; pList = GetNextSubList(), ++i) {
1396                // divide local progress into subprogress
1397                progress_t subprogress;
1398                __divide_progress(pProgress, &subprogress, n, i);
1399                // do the actual work
1400                pList->LoadSubChunksRecursively(&subprogress);
1401            }
1402            __notify_progress(pProgress, 1.0); // notify done
1403        }
1404    
1405        /** @brief Write list chunk persistently e.g. to disk.
1406         *
1407         * Stores the list chunk persistently to its actual "physical" file. All
1408         * subchunks (including sub list chunks) will be stored recursively as
1409         * well.
1410         *
1411         * @param ulWritePos - position within the "physical" file where this
1412         *                     list chunk should be written to
1413         * @param ulCurrentDataOffset - offset of current (old) data within
1414         *                              the file
1415         * @param pProgress - optional: callback function for progress notification
1416         * @returns new write position in the "physical" file, that is
1417         *          \a ulWritePos incremented by this list chunk's new size
1418         *          (including its header size of course)
1419         */
1420        unsigned long List::WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset, progress_t* pProgress) {
1421            const unsigned long ulOriginalPos = ulWritePos;
1422            ulWritePos += LIST_HEADER_SIZE;
1423    
1424            if (pFile->Mode != stream_mode_read_write)
1425                throw Exception("Cannot write list chunk, file has to be opened in read+write mode");
1426    
1427            // write all subchunks (including sub list chunks) recursively
1428            if (pSubChunks) {
1429                int i = 0;
1430                const int n = pSubChunks->size();
1431                for (ChunkList::iterator iter = pSubChunks->begin(), end = pSubChunks->end(); iter != end; ++iter, ++i) {
1432                    // divide local progress into subprogress for loading current Instrument
1433                    progress_t subprogress;
1434                    __divide_progress(pProgress, &subprogress, n, i);
1435                    // do the actual work
1436                    ulWritePos = (*iter)->WriteChunk(ulWritePos, ulCurrentDataOffset, &subprogress);
1437                }
1438            }
1439    
1440            // update this list chunk's header
1441            CurrentChunkSize = NewChunkSize = ulWritePos - ulOriginalPos - LIST_HEADER_SIZE;
1442            WriteHeader(ulOriginalPos);
1443    
1444            // offset of this list chunk in new written file may have changed
1445            ulStartPos = ulOriginalPos + LIST_HEADER_SIZE;
1446    
1447             __notify_progress(pProgress, 1.0); // notify done
1448    
1449            return ulWritePos;
1450        }
1451    
1452        void List::__resetPos() {
1453            Chunk::__resetPos();
1454            if (pSubChunks) {
1455                for (ChunkList::iterator iter = pSubChunks->begin(), end = pSubChunks->end(); iter != end; ++iter) {
1456                    (*iter)->__resetPos();
1457                }
1458            }
1459      }      }
1460    
1461      /**      /**
# Line 758  namespace RIFF { Line 1470  namespace RIFF {
1470  // *************** File ***************  // *************** File ***************
1471  // *  // *
1472    
1473      File::File(const String& path) : List() {  //HACK: to avoid breaking DLL compatibility to older versions of libgig we roll the new std::set<Chunk*> into the old std::list<Chunk*> container, should be replaced on member variable level soon though
1474        #if DEBUG  #define _GET_RESIZED_CHUNKS() \
1475        std::cout << "File::File("<<path<<")" << std::endl;          (reinterpret_cast<std::set<Chunk*>*>(ResizedChunks.front()))
1476        #endif // DEBUG  
1477        /** @brief Create new RIFF file.
1478         *
1479         * Use this constructor if you want to create a new RIFF file completely
1480         * "from scratch". Note: there must be no empty chunks or empty list
1481         * chunks when trying to make the new RIFF file persistent with Save()!
1482         *
1483         * Note: by default, the RIFF file will be saved in native endian
1484         * format; that is, as a RIFF file on little-endian machines and
1485         * as a RIFX file on big-endian. To change this behaviour, call
1486         * SetByteOrder() before calling Save().
1487         *
1488         * @param FileType - four-byte identifier of the RIFF file type
1489         * @see AddSubChunk(), AddSubList(), SetByteOrder()
1490         */
1491        File::File(uint32_t FileType)
1492            : List(this), bIsNewFile(true), Layout(layout_standard)
1493        {
1494            //HACK: see _GET_RESIZED_CHUNKS() comment
1495            ResizedChunks.push_back(reinterpret_cast<Chunk*>(new std::set<Chunk*>));
1496            #if defined(WIN32)
1497            hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
1498            #else
1499            hFileRead = hFileWrite = 0;
1500            #endif
1501            Mode = stream_mode_closed;
1502            bEndianNative = true;
1503            ulStartPos = RIFF_HEADER_SIZE;
1504            ListType = FileType;
1505        }
1506    
1507        /** @brief Load existing RIFF file.
1508         *
1509         * Loads an existing RIFF file with all its chunks.
1510         *
1511         * @param path - path and file name of the RIFF file to open
1512         * @throws RIFF::Exception if error occured while trying to load the
1513         *                         given RIFF file
1514         */
1515        File::File(const String& path)
1516            : List(this), Filename(path), bIsNewFile(false), Layout(layout_standard)
1517        {
1518           #if DEBUG
1519           std::cout << "File::File("<<path<<")" << std::endl;
1520           #endif // DEBUG
1521          bEndianNative = true;          bEndianNative = true;
1522            try {
1523                __openExistingFile(path);
1524                if (ChunkID != CHUNK_ID_RIFF && ChunkID != CHUNK_ID_RIFX) {
1525                    throw RIFF::Exception("Not a RIFF file");
1526                }
1527            }
1528            catch (...) {
1529                Cleanup();
1530                throw;
1531            }
1532        }
1533    
1534        /** @brief Load existing RIFF-like file.
1535         *
1536         * Loads an existing file, which is not a "real" RIFF file, but similar to
1537         * an ordinary RIFF file.
1538         *
1539         * A "real" RIFF file contains at top level a List chunk either with chunk
1540         * ID "RIFF" or "RIFX". The simple constructor above expects this to be
1541         * case, and if it finds the toplevel List chunk to have another chunk ID
1542         * than one of those two expected ones, it would throw an Exception and
1543         * would refuse to load the file accordingly.
1544         *
1545         * Since there are however a lot of file formats which use the same simple
1546         * principles of the RIFF format, with another toplevel List chunk ID
1547         * though, you can use this alternative constructor here to be able to load
1548         * and handle those files in the same way as you would do with "real" RIFF
1549         * files.
1550         *
1551         * @param path - path and file name of the RIFF-alike file to be opened
1552         * @param FileType - expected toplevel List chunk ID (this is the very
1553         *                   first chunk found in the file)
1554         * @param Endian - whether the file uses little endian or big endian layout
1555         * @param layout - general file structure type
1556         * @throws RIFF::Exception if error occured while trying to load the
1557         *                         given RIFF-alike file
1558         */
1559        File::File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout)
1560            : List(this), Filename(path), bIsNewFile(false), Layout(layout)
1561        {
1562            SetByteOrder(Endian);
1563            try {
1564                __openExistingFile(path, &FileType);
1565            }
1566            catch (...) {
1567                Cleanup();
1568                throw;
1569            }
1570        }
1571    
1572        /**
1573         * Opens an already existing RIFF file or RIFF-alike file. This method
1574         * shall only be called once (in a File class constructor).
1575         *
1576         * @param path - path and file name of the RIFF file or RIFF-alike file to
1577         *               be opened
1578         * @param FileType - (optional) expected chunk ID of first chunk in file
1579         * @throws RIFF::Exception if error occured while trying to load the
1580         *                         given RIFF file or RIFF-alike file
1581         */
1582        void File::__openExistingFile(const String& path, uint32_t* FileType) {
1583            //HACK: see _GET_RESIZED_CHUNKS() comment
1584            ResizedChunks.push_back(reinterpret_cast<Chunk*>(new std::set<Chunk*>));
1585          #if POSIX          #if POSIX
1586          hFile = open(path.c_str(), O_RDONLY | O_NONBLOCK);          hFileRead = hFileWrite = open(path.c_str(), O_RDONLY | O_NONBLOCK);
1587          if (hFile <= 0) {          if (hFileRead == -1) {
1588              hFile = 0;              hFileRead = hFileWrite = 0;
1589                String sError = strerror(errno);
1590                throw RIFF::Exception("Can't open \"" + path + "\": " + sError);
1591            }
1592            #elif defined(WIN32)
1593            hFileRead = hFileWrite = CreateFile(
1594                                         path.c_str(), GENERIC_READ,
1595                                         FILE_SHARE_READ | FILE_SHARE_WRITE,
1596                                         NULL, OPEN_EXISTING,
1597                                         FILE_ATTRIBUTE_NORMAL |
1598                                         FILE_FLAG_RANDOM_ACCESS, NULL
1599                                     );
1600            if (hFileRead == INVALID_HANDLE_VALUE) {
1601                hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
1602              throw RIFF::Exception("Can't open \"" + path + "\"");              throw RIFF::Exception("Can't open \"" + path + "\"");
1603          }          }
1604          #else          #else
1605          hFile = fopen(path.c_str(), "rb");          hFileRead = hFileWrite = fopen(path.c_str(), "rb");
1606          if (!hFile) throw RIFF::Exception("Can't open \"" + path + "\"");          if (!hFileRead) throw RIFF::Exception("Can't open \"" + path + "\"");
1607          #endif // POSIX          #endif // POSIX
1608          ulStartPos = RIFF_HEADER_SIZE;          Mode = stream_mode_read;
1609          ReadHeader(0);          switch (Layout) {
1610          if (ChunkID != CHUNK_ID_RIFF) {              case layout_standard: // this is a normal RIFF file
1611              throw RIFF::Exception("Not a RIFF file");                  ulStartPos = RIFF_HEADER_SIZE;
1612                    ReadHeader(0);
1613                    if (FileType && ChunkID != *FileType)
1614                        throw RIFF::Exception("Invalid file container ID");
1615                    break;
1616                case layout_flat: // non-standard RIFF-alike file
1617                    ulStartPos = 0;
1618                    NewChunkSize = CurrentChunkSize = GetFileSize();
1619                    if (FileType) {
1620                        uint32_t ckid;
1621                        if (Read(&ckid, 4, 1) != 4) {
1622                            throw RIFF::Exception("Invalid file header ID (premature end of header)");
1623                        } else if (ckid != *FileType) {
1624                            String s = " (expected '" + convertToString(*FileType) + "' but got '" + convertToString(ckid) + "')";
1625                            throw RIFF::Exception("Invalid file header ID" + s);
1626                        }
1627                        SetPos(0); // reset to first byte of file
1628                    }
1629                    LoadSubChunks();
1630                    break;
1631            }
1632        }
1633    
1634        String File::GetFileName() {
1635            return Filename;
1636        }
1637        
1638        void File::SetFileName(const String& path) {
1639            Filename = path;
1640        }
1641    
1642        stream_mode_t File::GetMode() {
1643            return Mode;
1644        }
1645    
1646        layout_t File::GetLayout() const {
1647            return Layout;
1648        }
1649    
1650        /** @brief Change file access mode.
1651         *
1652         * Changes files access mode either to read-only mode or to read/write
1653         * mode.
1654         *
1655         * @param NewMode - new file access mode
1656         * @returns true if mode was changed, false if current mode already
1657         *          equals new mode
1658         * @throws RIFF::Exception if new file access mode is unknown
1659         */
1660        bool File::SetMode(stream_mode_t NewMode) {
1661            if (NewMode != Mode) {
1662                switch (NewMode) {
1663                    case stream_mode_read:
1664                        #if POSIX
1665                        if (hFileRead) close(hFileRead);
1666                        hFileRead = hFileWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);
1667                        if (hFileRead == -1) {
1668                            hFileRead = hFileWrite = 0;
1669                            String sError = strerror(errno);
1670                            throw Exception("Could not (re)open file \"" + Filename + "\" in read mode: " + sError);
1671                        }
1672                        #elif defined(WIN32)
1673                        if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
1674                        hFileRead = hFileWrite = CreateFile(
1675                                                     Filename.c_str(), GENERIC_READ,
1676                                                     FILE_SHARE_READ | FILE_SHARE_WRITE,
1677                                                     NULL, OPEN_EXISTING,
1678                                                     FILE_ATTRIBUTE_NORMAL |
1679                                                     FILE_FLAG_RANDOM_ACCESS,
1680                                                     NULL
1681                                                 );
1682                        if (hFileRead == INVALID_HANDLE_VALUE) {
1683                            hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
1684                            throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");
1685                        }
1686                        #else
1687                        if (hFileRead) fclose(hFileRead);
1688                        hFileRead = hFileWrite = fopen(Filename.c_str(), "rb");
1689                        if (!hFileRead) throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");
1690                        #endif
1691                        __resetPos(); // reset read/write position of ALL 'Chunk' objects
1692                        break;
1693                    case stream_mode_read_write:
1694                        #if POSIX
1695                        if (hFileRead) close(hFileRead);
1696                        hFileRead = hFileWrite = open(Filename.c_str(), O_RDWR | O_NONBLOCK);
1697                        if (hFileRead == -1) {
1698                            hFileRead = hFileWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);
1699                            String sError = strerror(errno);
1700                            throw Exception("Could not open file \"" + Filename + "\" in read+write mode: " + sError);
1701                        }
1702                        #elif defined(WIN32)
1703                        if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
1704                        hFileRead = hFileWrite = CreateFile(
1705                                                     Filename.c_str(),
1706                                                     GENERIC_READ | GENERIC_WRITE,
1707                                                     FILE_SHARE_READ,
1708                                                     NULL, OPEN_ALWAYS,
1709                                                     FILE_ATTRIBUTE_NORMAL |
1710                                                     FILE_FLAG_RANDOM_ACCESS,
1711                                                     NULL
1712                                                 );
1713                        if (hFileRead == INVALID_HANDLE_VALUE) {
1714                            hFileRead = hFileWrite = CreateFile(
1715                                                         Filename.c_str(), GENERIC_READ,
1716                                                         FILE_SHARE_READ | FILE_SHARE_WRITE,
1717                                                         NULL, OPEN_EXISTING,
1718                                                         FILE_ATTRIBUTE_NORMAL |
1719                                                         FILE_FLAG_RANDOM_ACCESS,
1720                                                         NULL
1721                                                     );
1722                            throw Exception("Could not (re)open file \"" + Filename + "\" in read+write mode");
1723                        }
1724                        #else
1725                        if (hFileRead) fclose(hFileRead);
1726                        hFileRead = hFileWrite = fopen(Filename.c_str(), "r+b");
1727                        if (!hFileRead) {
1728                            hFileRead = hFileWrite = fopen(Filename.c_str(), "rb");
1729                            throw Exception("Could not open file \"" + Filename + "\" in read+write mode");
1730                        }
1731                        #endif
1732                        __resetPos(); // reset read/write position of ALL 'Chunk' objects
1733                        break;
1734                    case stream_mode_closed:
1735                        #if POSIX
1736                        if (hFileRead)  close(hFileRead);
1737                        if (hFileWrite) close(hFileWrite);
1738                        #elif defined(WIN32)
1739                        if (hFileRead  != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
1740                        if (hFileWrite != INVALID_HANDLE_VALUE) CloseHandle(hFileWrite);
1741                        #else
1742                        if (hFileRead)  fclose(hFileRead);
1743                        if (hFileWrite) fclose(hFileWrite);
1744                        #endif
1745                        hFileRead = hFileWrite = 0;
1746                        break;
1747                    default:
1748                        throw Exception("Unknown file access mode");
1749                }
1750                Mode = NewMode;
1751                return true;
1752            }
1753            return false;
1754        }
1755    
1756        /** @brief Set the byte order to be used when saving.
1757         *
1758         * Set the byte order to be used in the file. A value of
1759         * endian_little will create a RIFF file, endian_big a RIFX file
1760         * and endian_native will create a RIFF file on little-endian
1761         * machines and RIFX on big-endian machines.
1762         *
1763         * @param Endian - endianess to use when file is saved.
1764         */
1765        void File::SetByteOrder(endian_t Endian) {
1766            #if WORDS_BIGENDIAN
1767            bEndianNative = Endian != endian_little;
1768            #else
1769            bEndianNative = Endian != endian_big;
1770            #endif
1771        }
1772    
1773        /** @brief Save changes to same file.
1774         *
1775         * Make all changes of all chunks persistent by writing them to the
1776         * actual (same) file. The file might temporarily grow to a higher size
1777         * than it will have at the end of the saving process, in case chunks
1778         * were grown.
1779         *
1780         * @param pProgress - optional: callback function for progress notification
1781         * @throws RIFF::Exception if there is an empty chunk or empty list
1782         *                         chunk or any kind of IO error occured
1783         */
1784        void File::Save(progress_t* pProgress) {
1785            //TODO: implementation for the case where first chunk is not a global container (List chunk) is not implemented yet (i.e. Korg files)
1786            if (Layout == layout_flat)
1787                throw Exception("Saving a RIFF file with layout_flat is not implemented yet");
1788    
1789            // make sure the RIFF tree is built (from the original file)
1790            {
1791                // divide progress into subprogress
1792                progress_t subprogress;
1793                __divide_progress(pProgress, &subprogress, 3.f, 0.f); // arbitrarily subdivided into 1/3 of total progress
1794                // do the actual work
1795                LoadSubChunksRecursively(&subprogress);
1796                // notify subprogress done
1797                __notify_progress(&subprogress, 1.f);
1798            }
1799    
1800            // reopen file in write mode
1801            SetMode(stream_mode_read_write);
1802    
1803            // to be able to save the whole file without loading everything into
1804            // RAM and without having to store the data in a temporary file, we
1805            // enlarge the file with the sum of all _positive_ chunk size
1806            // changes, move current data towards the end of the file with the
1807            // calculated sum and finally update / rewrite the file by copying
1808            // the old data back to the right position at the beginning of the file
1809    
1810            // first we sum up all positive chunk size changes (and skip all negative ones)
1811            unsigned long ulPositiveSizeDiff = 0;
1812            std::set<Chunk*>* resizedChunks = _GET_RESIZED_CHUNKS();
1813            for (std::set<Chunk*>::const_iterator iter = resizedChunks->begin(), end = resizedChunks->end(); iter != end; ++iter) {
1814                if ((*iter)->GetNewSize() == 0) {
1815                    throw Exception("There is at least one empty chunk (zero size): " + __resolveChunkPath(*iter));
1816                }
1817                unsigned long newSizePadded = (*iter)->GetNewSize() + (*iter)->GetNewSize() % 2;
1818                unsigned long oldSizePadded = (*iter)->GetSize() + (*iter)->GetSize() % 2;
1819                if (newSizePadded > oldSizePadded) ulPositiveSizeDiff += newSizePadded - oldSizePadded;
1820          }          }
1821    
1822            unsigned long ulWorkingFileSize = GetFileSize();
1823    
1824            // if there are positive size changes...
1825            if (ulPositiveSizeDiff > 0) {
1826                // divide progress into subprogress
1827                progress_t subprogress;
1828                __divide_progress(pProgress, &subprogress, 3.f, 1.f); // arbitrarily subdivided into 1/3 of total progress
1829    
1830                // ... we enlarge this file first ...
1831                ulWorkingFileSize += ulPositiveSizeDiff;
1832                ResizeFile(ulWorkingFileSize);
1833                // ... and move current data by the same amount towards end of file.
1834                int8_t* pCopyBuffer = new int8_t[4096];
1835                const unsigned long ulFileSize = GetSize() + RIFF_HEADER_SIZE;
1836                #if defined(WIN32)
1837                DWORD iBytesMoved = 1; // we have to pass it via pointer to the Windows API, thus the correct size must be ensured
1838                #else
1839                int iBytesMoved = 1;
1840                #endif
1841                for (unsigned long ulPos = ulFileSize, iNotif = 0; iBytesMoved > 0; ++iNotif) {
1842                    iBytesMoved = (ulPos < 4096) ? ulPos : 4096;
1843                    ulPos -= iBytesMoved;
1844                    #if POSIX
1845                    lseek(hFileRead, ulPos, SEEK_SET);
1846                    iBytesMoved = read(hFileRead, pCopyBuffer, iBytesMoved);
1847                    lseek(hFileWrite, ulPos + ulPositiveSizeDiff, SEEK_SET);
1848                    iBytesMoved = write(hFileWrite, pCopyBuffer, iBytesMoved);
1849                    #elif defined(WIN32)
1850                    SetFilePointer(hFileRead, ulPos, NULL/*32 bit*/, FILE_BEGIN);
1851                    ReadFile(hFileRead, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
1852                    SetFilePointer(hFileWrite, ulPos + ulPositiveSizeDiff, NULL/*32 bit*/, FILE_BEGIN);
1853                    WriteFile(hFileWrite, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
1854                    #else
1855                    fseek(hFileRead, ulPos, SEEK_SET);
1856                    iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, hFileRead);
1857                    fseek(hFileWrite, ulPos + ulPositiveSizeDiff, SEEK_SET);
1858                    iBytesMoved = fwrite(pCopyBuffer, 1, iBytesMoved, hFileWrite);
1859                    #endif
1860                    if (!(iNotif % 8) && iBytesMoved > 0)
1861                        __notify_progress(&subprogress, float(ulFileSize - ulPos) / float(ulFileSize));
1862                }
1863                delete[] pCopyBuffer;
1864                if (iBytesMoved < 0) throw Exception("Could not modify file while trying to enlarge it");
1865    
1866                __notify_progress(&subprogress, 1.f); // notify subprogress done
1867            }
1868    
1869            // rebuild / rewrite complete RIFF tree ...
1870    
1871            // divide progress into subprogress
1872            progress_t subprogress;
1873            __divide_progress(pProgress, &subprogress, 3.f, 2.f); // arbitrarily subdivided into 1/3 of total progress
1874            // do the actual work
1875            unsigned long ulTotalSize  = WriteChunk(0, ulPositiveSizeDiff, &subprogress);
1876            unsigned long ulActualSize = __GetFileSize(hFileWrite);
1877            // notify subprogress done
1878            __notify_progress(&subprogress, 1.f);
1879    
1880            // resize file to the final size
1881            if (ulTotalSize < ulActualSize) ResizeFile(ulTotalSize);
1882    
1883            // forget all resized chunks
1884            resizedChunks->clear();
1885    
1886            __notify_progress(pProgress, 1.0); // notify done
1887        }
1888    
1889        /** @brief Save changes to another file.
1890         *
1891         * Make all changes of all chunks persistent by writing them to another
1892         * file. <b>Caution:</b> this method is optimized for writing to
1893         * <b>another</b> file, do not use it to save the changes to the same
1894         * file! Use File::Save() in that case instead! Ignoring this might
1895         * result in a corrupted file, especially in case chunks were resized!
1896         *
1897         * After calling this method, this File object will be associated with
1898         * the new file (given by \a path) afterwards.
1899         *
1900         * @param path - path and file name where everything should be written to
1901         * @param pProgress - optional: callback function for progress notification
1902         */
1903        void File::Save(const String& path, progress_t* pProgress) {
1904            //TODO: we should make a check here if somebody tries to write to the same file and automatically call the other Save() method in that case
1905    
1906            //TODO: implementation for the case where first chunk is not a global container (List chunk) is not implemented yet (i.e. Korg files)
1907            if (Layout == layout_flat)
1908                throw Exception("Saving a RIFF file with layout_flat is not implemented yet");
1909    
1910            // make sure the RIFF tree is built (from the original file)
1911            {
1912                // divide progress into subprogress
1913                progress_t subprogress;
1914                __divide_progress(pProgress, &subprogress, 2.f, 0.f); // arbitrarily subdivided into 1/2 of total progress
1915                // do the actual work
1916                LoadSubChunksRecursively(&subprogress);
1917                // notify subprogress done
1918                __notify_progress(&subprogress, 1.f);
1919            }
1920    
1921            if (!bIsNewFile) SetMode(stream_mode_read);
1922            // open the other (new) file for writing and truncate it to zero size
1923            #if POSIX
1924            hFileWrite = open(path.c_str(), O_RDWR | O_CREAT, S_IRUSR | S_IWUSR | S_IRGRP);
1925            if (hFileWrite == -1) {
1926                hFileWrite = hFileRead;
1927                String sError = strerror(errno);
1928                throw Exception("Could not open file \"" + path + "\" for writing: " + sError);
1929            }
1930            #elif defined(WIN32)
1931            hFileWrite = CreateFile(
1932                             path.c_str(), GENERIC_WRITE, FILE_SHARE_READ,
1933                             NULL, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL |
1934                             FILE_FLAG_RANDOM_ACCESS, NULL
1935                         );
1936            if (hFileWrite == INVALID_HANDLE_VALUE) {
1937                hFileWrite = hFileRead;
1938                throw Exception("Could not open file \"" + path + "\" for writing");
1939            }
1940            #else
1941            hFileWrite = fopen(path.c_str(), "w+b");
1942            if (!hFileWrite) {
1943                hFileWrite = hFileRead;
1944                throw Exception("Could not open file \"" + path + "\" for writing");
1945            }
1946            #endif // POSIX
1947            Mode = stream_mode_read_write;
1948    
1949            // write complete RIFF tree to the other (new) file
1950            unsigned long ulTotalSize;
1951            {
1952                // divide progress into subprogress
1953                progress_t subprogress;
1954                __divide_progress(pProgress, &subprogress, 2.f, 1.f); // arbitrarily subdivided into 1/2 of total progress
1955                // do the actual work
1956                ulTotalSize = WriteChunk(0, 0, &subprogress);
1957                // notify subprogress done
1958                __notify_progress(&subprogress, 1.f);
1959            }
1960            unsigned long ulActualSize = __GetFileSize(hFileWrite);
1961    
1962            // resize file to the final size (if the file was originally larger)
1963            if (ulTotalSize < ulActualSize) ResizeFile(ulTotalSize);
1964    
1965            // forget all resized chunks
1966            _GET_RESIZED_CHUNKS()->clear();
1967    
1968            #if POSIX
1969            if (hFileWrite) close(hFileWrite);
1970            #elif defined(WIN32)
1971            if (hFileWrite != INVALID_HANDLE_VALUE) CloseHandle(hFileWrite);
1972            #else
1973            if (hFileWrite) fclose(hFileWrite);
1974            #endif
1975            hFileWrite = hFileRead;
1976    
1977            // associate new file with this File object from now on
1978            Filename = path;
1979            bIsNewFile = false;
1980            Mode = (stream_mode_t) -1;       // Just set it to an undefined mode ...
1981            SetMode(stream_mode_read_write); // ... so SetMode() has to reopen the file handles.
1982    
1983            __notify_progress(pProgress, 1.0); // notify done
1984        }
1985    
1986        void File::ResizeFile(unsigned long ulNewSize) {
1987            #if POSIX
1988            if (ftruncate(hFileWrite, ulNewSize) < 0)
1989                throw Exception("Could not resize file \"" + Filename + "\"");
1990            #elif defined(WIN32)
1991            if (
1992                SetFilePointer(hFileWrite, ulNewSize, NULL/*32 bit*/, FILE_BEGIN) == INVALID_SET_FILE_POINTER ||
1993                !SetEndOfFile(hFileWrite)
1994            ) throw Exception("Could not resize file \"" + Filename + "\"");
1995            #else
1996            # error Sorry, this version of libgig only supports POSIX and Windows systems yet.
1997            # error Reason: portable implementation of RIFF::File::ResizeFile() is missing (yet)!
1998            #endif
1999      }      }
2000    
2001      File::~File() {      File::~File() {
2002         #if DEBUG         #if DEBUG
2003         std::cout << "File::~File()" << std::endl;         std::cout << "File::~File()" << std::endl;
2004         #endif // DEBUG         #endif // DEBUG
2005            Cleanup();
2006        }
2007        
2008        /**
2009         * Returns @c true if this file has been created new from scratch and
2010         * has not been stored to disk yet.
2011         */
2012        bool File::IsNew() const {
2013            return bIsNewFile;
2014        }
2015    
2016        void File::Cleanup() {
2017          #if POSIX          #if POSIX
2018          if (hFile) close(hFile);          if (hFileRead) close(hFileRead);
2019            #elif defined(WIN32)
2020            if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
2021          #else          #else
2022          if (hFile) fclose(hFile);          if (hFileRead) fclose(hFileRead);
2023          #endif // POSIX          #endif // POSIX
2024            DeleteChunkList();
2025            pFile = NULL;
2026            //HACK: see _GET_RESIZED_CHUNKS() comment
2027            delete _GET_RESIZED_CHUNKS();
2028        }
2029    
2030        void File::LogAsResized(Chunk* pResizedChunk) {
2031            _GET_RESIZED_CHUNKS()->insert(pResizedChunk);
2032        }
2033    
2034        void File::UnlogResized(Chunk* pResizedChunk) {
2035            _GET_RESIZED_CHUNKS()->erase(pResizedChunk);
2036      }      }
2037    
2038      unsigned long File::GetFileSize() {      unsigned long File::GetFileSize() {
2039          #if POSIX          return __GetFileSize(hFileRead);
2040        }
2041    
2042        #if POSIX
2043        unsigned long File::__GetFileSize(int hFile) {
2044          struct stat filestat;          struct stat filestat;
2045          fstat(hFile, &filestat);          fstat(hFile, &filestat);
2046          long size = filestat.st_size;          long size = filestat.st_size;
2047          #else // standard C functions          return size;
2048        }
2049        #elif defined(WIN32)
2050        unsigned long File::__GetFileSize(HANDLE hFile) {
2051            DWORD dwSize = ::GetFileSize(hFile, NULL /*32bit*/);
2052            if (dwSize == INVALID_FILE_SIZE)
2053                throw Exception("Windows FS error: could not determine file size");
2054            return dwSize;
2055        }
2056        #else // standard C functions
2057        unsigned long File::__GetFileSize(FILE* hFile) {
2058          long curpos = ftell(hFile);          long curpos = ftell(hFile);
2059          fseek(hFile, 0, SEEK_END);          fseek(hFile, 0, SEEK_END);
2060          long size = ftell(hFile);          long size = ftell(hFile);
2061          fseek(hFile, curpos, SEEK_SET);          fseek(hFile, curpos, SEEK_SET);
         #endif // POSIX  
2062          return size;          return size;
2063      }      }
2064        #endif
2065    
2066    
2067  // *************** Exception ***************  // *************** Exception ***************
# Line 814  namespace RIFF { Line 2071  namespace RIFF {
2071          std::cout << "RIFF::Exception: " << Message << std::endl;          std::cout << "RIFF::Exception: " << Message << std::endl;
2072      }      }
2073    
2074    
2075    // *************** functions ***************
2076    // *
2077    
2078        /**
2079         * Returns the name of this C++ library. This is usually "libgig" of
2080         * course. This call is equivalent to DLS::libraryName() and
2081         * gig::libraryName().
2082         */
2083        String libraryName() {
2084            return PACKAGE;
2085        }
2086    
2087        /**
2088         * Returns version of this C++ library. This call is equivalent to
2089         * DLS::libraryVersion() and gig::libraryVersion().
2090         */
2091        String libraryVersion() {
2092            return VERSION;
2093        }
2094    
2095  } // namespace RIFF  } // namespace RIFF
 #endif  

Legend:
Removed from v.515  
changed lines
  Added in v.2682

  ViewVC Help
Powered by ViewVC