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

Legend:
Removed from v.24  
changed lines
  Added in v.2703

  ViewVC Help
Powered by ViewVC