/[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 798 by schoenebeck, Thu Nov 3 23:49:11 2005 UTC revision 3912 by schoenebeck, Fri Jun 4 11:20:19 2021 UTC
# Line 1  Line 1 
1  /***************************************************************************  /***************************************************************************
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file loader library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2005 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2021 by Christian Schoenebeck                      *
6   *                              <cuse@users.sourceforge.net>               *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   This library is free software; you can redistribute it and/or modify  *
# Line 21  Line 21 
21   *   MA  02111-1307  USA                                                   *   *   MA  02111-1307  USA                                                   *
22   ***************************************************************************/   ***************************************************************************/
23    
24    #include <algorithm>
25    #include <set>
26  #include <string.h>  #include <string.h>
 #include <sstream>  
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  // *************** Helper Functions **************  // *************** Internal functions **************
39  // *  // *
40    
41      template<class T> inline String ToString(T o) {      /// Returns a human readable path of the given chunk.
42          std::stringstream ss;      static String __resolveChunkPath(Chunk* pCk) {
43          ss << o;          String sPath;
44          return ss.str();          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         * Divides this progress task into the requested amount of equal weighted
69         * sub-progress tasks and returns a vector with those subprogress tasks.
70         *
71         * @param iSubtasks - total amount sub tasks this task should be subdivided
72         * @returns subtasks
73         */
74        std::vector<progress_t> progress_t::subdivide(int iSubtasks) {
75            std::vector<progress_t> v;
76            for (int i = 0; i < iSubtasks; ++i) {
77                progress_t p;
78                __divide_progress(this, &p, iSubtasks, i);
79                v.push_back(p);
80            }
81            return v;
82        }
83    
84        /**
85         * Divides this progress task into the requested amount of sub-progress
86         * tasks, where each one of those new sub-progress tasks is created with its
87         * requested individual weight / portion, and finally returns a vector
88         * with those new subprogress tasks.
89         *
90         * The amount of subprogresses to be created is determined by this method
91         * by calling @c vSubTaskPortions.size() .
92         *
93         * Example: consider you wanted to create 3 subprogresses where the 1st
94         * subtask should be assigned 10% of the new 3 subprogresses' overall
95         * progress, the 2nd subtask should be assigned 50% of the new 3
96         * subprogresses' overall progress, and the 3rd subtask should be assigned
97         * 40%, then you might call this method like this:
98         * @code
99         * std::vector<progress_t> subprogresses = progress.subdivide({0.1, 0.5, 0.4});
100         * @endcode
101         *
102         * @param vSubTaskPortions - amount and individual weight of subtasks to be
103         *                           created
104         * @returns subtasks
105         */
106        std::vector<progress_t> progress_t::subdivide(std::vector<float> vSubTaskPortions) {
107            float fTotal = 0.f; // usually 1.0, but we sum the portions up below to be sure
108            for (int i = 0; i < vSubTaskPortions.size(); ++i)
109                fTotal += vSubTaskPortions[i];
110    
111            float fLow = 0.f, fHigh = 0.f;
112            std::vector<progress_t> v;
113            for (int i = 0; i < vSubTaskPortions.size(); ++i) {
114                fLow  = fHigh;
115                fHigh = vSubTaskPortions[i];
116                progress_t p;
117                __divide_progress(this, &p, fTotal, fLow, fHigh);
118                v.push_back(p);
119            }
120            return v;
121      }      }
122    
123    
# Line 43  namespace RIFF { Line 126  namespace RIFF {
126  // *  // *
127    
128      Chunk::Chunk(File* pFile) {      Chunk::Chunk(File* pFile) {
129          #if DEBUG          #if DEBUG_RIFF
130          std::cout << "Chunk::Chunk(File* pFile)" << std::endl;          std::cout << "Chunk::Chunk(File* pFile)" << std::endl;
131          #endif // DEBUG          #endif // DEBUG_RIFF
132          ulPos      = 0;          ullPos     = 0;
133          pParent    = NULL;          pParent    = NULL;
134          pChunkData = NULL;          pChunkData = NULL;
135            ullCurrentChunkSize = 0;
136            ullNewChunkSize = 0;
137            ullChunkDataSize = 0;
138          ChunkID    = CHUNK_ID_RIFF;          ChunkID    = CHUNK_ID_RIFF;
139          this->pFile = pFile;          this->pFile = pFile;
140      }      }
141    
142      Chunk::Chunk(File* pFile, unsigned long StartPos, List* Parent) {      Chunk::Chunk(File* pFile, file_offset_t StartPos, List* Parent) {
143          #if DEBUG          #if DEBUG_RIFF
144          std::cout << "Chunk::Chunk(File*,ulong,bool,List*),StartPos=" << StartPos << std::endl;          std::cout << "Chunk::Chunk(File*,file_offset_t,List*),StartPos=" << StartPos << std::endl;
145          #endif // DEBUG          #endif // DEBUG_RIFF
146          this->pFile   = pFile;          this->pFile   = pFile;
147          ulStartPos    = StartPos + CHUNK_HEADER_SIZE;          ullStartPos   = StartPos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize);
148          pParent       = Parent;          pParent       = Parent;
149          ulPos         = 0;          ullPos        = 0;
150          pChunkData    = NULL;          pChunkData    = NULL;
151            ullCurrentChunkSize = 0;
152            ullNewChunkSize = 0;
153            ullChunkDataSize = 0;
154          ReadHeader(StartPos);          ReadHeader(StartPos);
155      }      }
156    
157      Chunk::Chunk(File* pFile, List* pParent, uint32_t uiChunkID, uint uiBodySize) {      Chunk::Chunk(File* pFile, List* pParent, uint32_t uiChunkID, file_offset_t ullBodySize) {
158          this->pFile      = pFile;          this->pFile      = pFile;
159          ulStartPos       = 0; // arbitrary usually, since it will be updated when we write the chunk          ullStartPos      = 0; // arbitrary usually, since it will be updated when we write the chunk
160          this->pParent    = pParent;          this->pParent    = pParent;
161          ulPos            = 0;          ullPos           = 0;
162          pChunkData       = NULL;          pChunkData       = NULL;
163          ChunkID          = uiChunkID;          ChunkID          = uiChunkID;
164          CurrentChunkSize = 0;          ullChunkDataSize = 0;
165          NewChunkSize     = uiBodySize;          ullCurrentChunkSize = 0;
166            ullNewChunkSize  = ullBodySize;
167      }      }
168    
169      Chunk::~Chunk() {      Chunk::~Chunk() {
170          if (pChunkData) delete[] pChunkData;          if (pChunkData) delete[] pChunkData;
171      }      }
172    
173      void Chunk::ReadHeader(unsigned long fPos) {      void Chunk::ReadHeader(file_offset_t filePos) {
174          #if DEBUG          #if DEBUG_RIFF
175          std::cout << "Chunk::Readheader(" << fPos << ") ";          std::cout << "Chunk::Readheader(" << filePos << ") ";
176          #endif // DEBUG          #endif // DEBUG_RIFF
177            ChunkID = 0;
178            ullNewChunkSize = ullCurrentChunkSize = 0;
179          #if POSIX          #if POSIX
180          if (lseek(pFile->hFileRead, fPos, SEEK_SET) != -1) {          if (lseek(pFile->hFileRead, filePos, SEEK_SET) != -1) {
181              read(pFile->hFileRead, &ChunkID, 4);              read(pFile->hFileRead, &ChunkID, 4);
182              read(pFile->hFileRead, &CurrentChunkSize, 4);              read(pFile->hFileRead, &ullCurrentChunkSize, pFile->FileOffsetSize);
183            #elif defined(WIN32)
184            LARGE_INTEGER liFilePos;
185            liFilePos.QuadPart = filePos;
186            if (SetFilePointerEx(pFile->hFileRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN)) {
187                DWORD dwBytesRead;
188                ReadFile(pFile->hFileRead, &ChunkID, 4, &dwBytesRead, NULL);
189                ReadFile(pFile->hFileRead, &ullCurrentChunkSize, pFile->FileOffsetSize, &dwBytesRead, NULL);
190          #else          #else
191          if (!fseek(pFile->hFileRead, fPos, SEEK_SET)) {          if (!fseeko(pFile->hFileRead, filePos, SEEK_SET)) {
192              fread(&ChunkID, 4, 1, pFile->hFileRead);              fread(&ChunkID, 4, 1, pFile->hFileRead);
193              fread(&CurrentChunkSize, 4, 1, pFile->hFileRead);              fread(&ullCurrentChunkSize, pFile->FileOffsetSize, 1, pFile->hFileRead);
194          #endif // POSIX          #endif // POSIX
195              #if WORDS_BIGENDIAN              #if WORDS_BIGENDIAN
196              if (ChunkID == CHUNK_ID_RIFF) {              if (ChunkID == CHUNK_ID_RIFF) {
197                  bEndianNative = false;                  pFile->bEndianNative = false;
198              }              }
199              #else // little endian              #else // little endian
200              if (ChunkID == CHUNK_ID_RIFX) {              if (ChunkID == CHUNK_ID_RIFX) {
# Line 105  namespace RIFF { Line 204  namespace RIFF {
204              #endif // WORDS_BIGENDIAN              #endif // WORDS_BIGENDIAN
205              if (!pFile->bEndianNative) {              if (!pFile->bEndianNative) {
206                  //swapBytes_32(&ChunkID);                  //swapBytes_32(&ChunkID);
207                  swapBytes_32(&CurrentChunkSize);                  if (pFile->FileOffsetSize == 4)
208                        swapBytes_32(&ullCurrentChunkSize);
209                    else
210                        swapBytes_64(&ullCurrentChunkSize);
211              }              }
212              #if DEBUG              #if DEBUG_RIFF
213              std::cout << "ckID=" << convertToString(ChunkID) << " ";              std::cout << "ckID=" << convertToString(ChunkID) << " ";
214              std::cout << "ckSize=" << ChunkSize << " ";              std::cout << "ckSize=" << ullCurrentChunkSize << " ";
215              std::cout << "bEndianNative=" << bEndianNative << std::endl;              std::cout << "bEndianNative=" << pFile->bEndianNative << std::endl;
216              #endif // DEBUG              #endif // DEBUG_RIFF
217              NewChunkSize = CurrentChunkSize;              ullNewChunkSize = ullCurrentChunkSize;
218          }          }
219      }      }
220    
221      void Chunk::WriteHeader(unsigned long fPos) {      void Chunk::WriteHeader(file_offset_t filePos) {
222          uint32_t uiNewChunkID = ChunkID;          uint32_t uiNewChunkID = ChunkID;
223          if (ChunkID == CHUNK_ID_RIFF) {          if (ChunkID == CHUNK_ID_RIFF) {
224              #if WORDS_BIGENDIAN              #if WORDS_BIGENDIAN
# Line 126  namespace RIFF { Line 228  namespace RIFF {
228              #endif // WORDS_BIGENDIAN              #endif // WORDS_BIGENDIAN
229          }          }
230    
231          uint32_t uiNewChunkSize = NewChunkSize;          uint64_t ullNewChunkSize = this->ullNewChunkSize;
232          if (!pFile->bEndianNative) {          if (!pFile->bEndianNative) {
233              swapBytes_32(&uiNewChunkSize);              if (pFile->FileOffsetSize == 4)
234                    swapBytes_32(&ullNewChunkSize);
235                else
236                    swapBytes_64(&ullNewChunkSize);
237          }          }
238    
239          #if POSIX          #if POSIX
240          if (lseek(pFile->hFileWrite, fPos, SEEK_SET) != -1) {          if (lseek(pFile->hFileWrite, filePos, SEEK_SET) != -1) {
241              write(pFile->hFileWrite, &uiNewChunkID, 4);              write(pFile->hFileWrite, &uiNewChunkID, 4);
242              write(pFile->hFileWrite, &uiNewChunkSize, 4);              write(pFile->hFileWrite, &ullNewChunkSize, pFile->FileOffsetSize);
243            }
244            #elif defined(WIN32)
245            LARGE_INTEGER liFilePos;
246            liFilePos.QuadPart = filePos;
247            if (SetFilePointerEx(pFile->hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN)) {
248                DWORD dwBytesWritten;
249                WriteFile(pFile->hFileWrite, &uiNewChunkID, 4, &dwBytesWritten, NULL);
250                WriteFile(pFile->hFileWrite, &ullNewChunkSize, pFile->FileOffsetSize, &dwBytesWritten, NULL);
251          }          }
252          #else          #else
253          if (!fseek(pFile->hFileWrite, fPos, SEEK_SET)) {          if (!fseeko(pFile->hFileWrite, filePos, SEEK_SET)) {
254              fwrite(&uiNewChunkID, 4, 1, pFile->hFileWrite);              fwrite(&uiNewChunkID, 4, 1, pFile->hFileWrite);
255              fwrite(&uiNewChunkSize, 4, 1, pFile->hFileWrite);              fwrite(&ullNewChunkSize, pFile->FileOffsetSize, 1, pFile->hFileWrite);
256          }          }
257          #endif // POSIX          #endif // POSIX
258      }      }
# Line 148  namespace RIFF { Line 261  namespace RIFF {
261       *  Returns the String representation of the chunk's ID (e.g. "RIFF",       *  Returns the String representation of the chunk's ID (e.g. "RIFF",
262       *  "LIST").       *  "LIST").
263       */       */
264      String Chunk::GetChunkIDString() {      String Chunk::GetChunkIDString() const {
265          return convertToString(ChunkID);          return convertToString(ChunkID);
266      }      }
267    
# Line 164  namespace RIFF { Line 277  namespace RIFF {
277       *                  if omitted \a Where relates to beginning of the chunk       *                  if omitted \a Where relates to beginning of the chunk
278       *                  data       *                  data
279       */       */
280      unsigned long Chunk::SetPos(unsigned long Where, stream_whence_t Whence) {      file_offset_t Chunk::SetPos(file_offset_t Where, stream_whence_t Whence) {
281       #if DEBUG          #if DEBUG_RIFF
282       std::cout << "Chunk::SetPos(ulong)" << std::endl;          std::cout << "Chunk::SetPos(file_offset_t,stream_whence_t)" << std::endl;
283       #endif // DEBUG          #endif // DEBUG_RIFF
284          switch (Whence) {          switch (Whence) {
285              case stream_curpos:              case stream_curpos:
286                  ulPos += Where;                  ullPos += Where;
287                  break;                  break;
288              case stream_end:              case stream_end:
289                  ulPos = CurrentChunkSize - 1 - Where;                  ullPos = ullCurrentChunkSize - 1 - Where;
290                  break;                  break;
291              case stream_backward:              case stream_backward:
292                  ulPos -= Where;                  ullPos -= Where;
293                  break;                  break;
294              case stream_start: default:              case stream_start: default:
295                  ulPos = Where;                  ullPos = Where;
296                  break;                  break;
297          }          }
298          if (ulPos > CurrentChunkSize) ulPos = CurrentChunkSize;          if (ullPos > ullCurrentChunkSize) ullPos = ullCurrentChunkSize;
299          return ulPos;          return ullPos;
300      }      }
301    
302      /**      /**
# Line 196  namespace RIFF { Line 309  namespace RIFF {
309       *       *
310       *  @returns  number of bytes left to read       *  @returns  number of bytes left to read
311       */       */
312      unsigned long Chunk::RemainingBytes() {      file_offset_t Chunk::RemainingBytes() const {
313         #if DEBUG          #if DEBUG_RIFF
314         std::cout << "Chunk::Remainingbytes()=" << CurrentChunkSize - ulPos << std::endl;          std::cout << "Chunk::Remainingbytes()=" << ullCurrentChunkSize - ullPos << std::endl;
315         #endif // DEBUG          #endif // DEBUG_RIFF
316          return CurrentChunkSize - ulPos;          return (ullCurrentChunkSize > ullPos) ? ullCurrentChunkSize - ullPos : 0;
317        }
318    
319        /**
320         *  Returns the actual total size in bytes (including header) of this Chunk
321         *  if being stored to a file.
322         *
323         *  @param fileOffsetSize - RIFF file offset size (in bytes) assumed when
324         *                          being saved to a file
325         */
326        file_offset_t Chunk::RequiredPhysicalSize(int fileOffsetSize) {
327            return CHUNK_HEADER_SIZE(fileOffsetSize) + // RIFF chunk header
328                   ullNewChunkSize + // chunks's actual data body
329                   ullNewChunkSize % 2; // optional pad byte
330      }      }
331    
332      /**      /**
# Line 211  namespace RIFF { Line 337  namespace RIFF {
337       *  - RIFF::stream_closed :       *  - RIFF::stream_closed :
338       *    the data stream was closed somehow, no more reading possible       *    the data stream was closed somehow, no more reading possible
339       *  - RIFF::stream_end_reached :       *  - RIFF::stream_end_reached :
340       *    alreaady reached the end of the chunk data, no more reading       *    already reached the end of the chunk data, no more reading
341       *    possible without SetPos()       *    possible without SetPos()
342       */       */
343      stream_state_t Chunk::GetState() {      stream_state_t Chunk::GetState() const {
344        #if DEBUG          #if DEBUG_RIFF
345        std::cout << "Chunk::GetState()" << std::endl;          std::cout << "Chunk::GetState()" << std::endl;
346        #endif // DEBUG          #endif // DEBUG_RIFF
347          #if POSIX          #if POSIX
348          if (pFile->hFileRead == 0)    return stream_closed;          if (pFile->hFileRead == 0) return stream_closed;
349            #elif defined (WIN32)
350            if (pFile->hFileRead == INVALID_HANDLE_VALUE)
351                return stream_closed;
352          #else          #else
353          if (pFile->hFileRead == NULL) return stream_closed;          if (pFile->hFileRead == NULL) return stream_closed;
354          #endif // POSIX          #endif // POSIX
355          if (ulPos < CurrentChunkSize) return stream_ready;          if (ullPos < ullCurrentChunkSize) return stream_ready;
356          else                          return stream_end_reached;          else                              return stream_end_reached;
357      }      }
358    
359      /**      /**
# Line 240  namespace RIFF { Line 369  namespace RIFF {
369       *  @param WordCount  number of data words to read       *  @param WordCount  number of data words to read
370       *  @param WordSize   size of each data word to read       *  @param WordSize   size of each data word to read
371       *  @returns          number of successfully read data words or 0 if end       *  @returns          number of successfully read data words or 0 if end
372       *                    of file reached or error occured       *                    of file reached or error occurred
373       */       */
374      unsigned long Chunk::Read(void* pData, unsigned long WordCount, unsigned long WordSize) {      file_offset_t Chunk::Read(void* pData, file_offset_t WordCount, file_offset_t WordSize) {
375         #if DEBUG          #if DEBUG_RIFF
376         std::cout << "Chunk::Read(void*,ulong,ulong)" << std::endl;          std::cout << "Chunk::Read(void*,file_offset_t,file_offset_t)" << std::endl;
377         #endif // DEBUG          #endif // DEBUG_RIFF
378          if (ulPos >= CurrentChunkSize) return 0;          //if (ulStartPos == 0) return 0; // is only 0 if this is a new chunk, so nothing to read (yet)
379          if (ulPos + WordCount * WordSize >= CurrentChunkSize) WordCount = (CurrentChunkSize - ulPos) / WordSize;          if (ullPos >= ullCurrentChunkSize) return 0;
380            if (ullPos + WordCount * WordSize >= ullCurrentChunkSize) WordCount = (ullCurrentChunkSize - ullPos) / WordSize;
381          #if POSIX          #if POSIX
382          if (lseek(pFile->hFileRead, ulStartPos + ulPos, SEEK_SET) < 0) return 0;          if (lseek(pFile->hFileRead, ullStartPos + ullPos, SEEK_SET) < 0) return 0;
383          unsigned long readWords = read(pFile->hFileRead, pData, WordCount * WordSize);          ssize_t readWords = read(pFile->hFileRead, pData, WordCount * WordSize);
384            if (readWords < 1) {
385                #if DEBUG_RIFF
386                std::cerr << "POSIX read() failed: " << strerror(errno) << std::endl << std::flush;
387                #endif // DEBUG_RIFF
388                return 0;
389            }
390            readWords /= WordSize;
391            #elif defined(WIN32)
392            LARGE_INTEGER liFilePos;
393            liFilePos.QuadPart = ullStartPos + ullPos;
394            if (!SetFilePointerEx(pFile->hFileRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN))
395                return 0;
396            DWORD readWords;
397            ReadFile(pFile->hFileRead, pData, WordCount * WordSize, &readWords, NULL); //FIXME: does not work for reading buffers larger than 2GB (even though this should rarely be the case in practice)
398          if (readWords < 1) return 0;          if (readWords < 1) return 0;
399          readWords /= WordSize;          readWords /= WordSize;
400          #else // standard C functions          #else // standard C functions
401          if (fseek(pFile->hFileRead, ulStartPos + ulPos, SEEK_SET)) return 0;          if (fseeko(pFile->hFileRead, ullStartPos + ullPos, SEEK_SET)) return 0;
402          unsigned long readWords = fread(pData, WordSize, WordCount, pFile->hFileRead);          file_offset_t readWords = fread(pData, WordSize, WordCount, pFile->hFileRead);
403          #endif // POSIX          #endif // POSIX
404          if (!pFile->bEndianNative && WordSize != 1) {          if (!pFile->bEndianNative && WordSize != 1) {
405              switch (WordSize) {              switch (WordSize) {
406                  case 2:                  case 2:
407                      for (unsigned long iWord = 0; iWord < readWords; iWord++)                      for (file_offset_t iWord = 0; iWord < readWords; iWord++)
408                          swapBytes_16((uint16_t*) pData + iWord);                          swapBytes_16((uint16_t*) pData + iWord);
409                      break;                      break;
410                  case 4:                  case 4:
411                      for (unsigned long iWord = 0; iWord < readWords; iWord++)                      for (file_offset_t iWord = 0; iWord < readWords; iWord++)
412                          swapBytes_32((uint32_t*) pData + iWord);                          swapBytes_32((uint32_t*) pData + iWord);
413                      break;                      break;
414                    case 8:
415                        for (file_offset_t iWord = 0; iWord < readWords; iWord++)
416                            swapBytes_64((uint64_t*) pData + iWord);
417                        break;
418                  default:                  default:
419                      for (unsigned long iWord = 0; iWord < readWords; iWord++)                      for (file_offset_t iWord = 0; iWord < readWords; iWord++)
420                          swapBytes((uint8_t*) pData + iWord * WordSize, WordSize);                          swapBytes((uint8_t*) pData + iWord * WordSize, WordSize);
421                      break;                      break;
422              }              }
# Line 290  namespace RIFF { Line 438  namespace RIFF {
438       *  @param WordSize   size of each data word to write       *  @param WordSize   size of each data word to write
439       *  @returns          number of successfully written data words       *  @returns          number of successfully written data words
440       *  @throws RIFF::Exception  if write operation would exceed current       *  @throws RIFF::Exception  if write operation would exceed current
441       *                           chunk size or any IO error occured       *                           chunk size or any IO error occurred
442       *  @see Resize()       *  @see Resize()
443       */       */
444      unsigned long Chunk::Write(void* pData, unsigned long WordCount, unsigned long WordSize) {      file_offset_t Chunk::Write(void* pData, file_offset_t WordCount, file_offset_t WordSize) {
445          if (pFile->Mode != stream_mode_read_write)          if (pFile->Mode != stream_mode_read_write)
446              throw Exception("Cannot write data to chunk, file has to be opened in read+write mode first");              throw Exception("Cannot write data to chunk, file has to be opened in read+write mode first");
447          if (ulPos >= CurrentChunkSize || ulPos + WordCount * WordSize > CurrentChunkSize)          if (ullPos >= ullCurrentChunkSize || ullPos + WordCount * WordSize > ullCurrentChunkSize)
448              throw Exception("End of chunk reached while trying to write data");              throw Exception("End of chunk reached while trying to write data");
449          if (!pFile->bEndianNative && WordSize != 1) {          if (!pFile->bEndianNative && WordSize != 1) {
450              switch (WordSize) {              switch (WordSize) {
451                  case 2:                  case 2:
452                      for (unsigned long iWord = 0; iWord < WordCount; iWord++)                      for (file_offset_t iWord = 0; iWord < WordCount; iWord++)
453                          swapBytes_16((uint16_t*) pData + iWord);                          swapBytes_16((uint16_t*) pData + iWord);
454                      break;                      break;
455                  case 4:                  case 4:
456                      for (unsigned long iWord = 0; iWord < WordCount; iWord++)                      for (file_offset_t iWord = 0; iWord < WordCount; iWord++)
457                          swapBytes_32((uint32_t*) pData + iWord);                          swapBytes_32((uint32_t*) pData + iWord);
458                      break;                      break;
459                    case 8:
460                        for (file_offset_t iWord = 0; iWord < WordCount; iWord++)
461                            swapBytes_64((uint64_t*) pData + iWord);
462                        break;
463                  default:                  default:
464                      for (unsigned long iWord = 0; iWord < WordCount; iWord++)                      for (file_offset_t iWord = 0; iWord < WordCount; iWord++)
465                          swapBytes((uint8_t*) pData + iWord * WordSize, WordSize);                          swapBytes((uint8_t*) pData + iWord * WordSize, WordSize);
466                      break;                      break;
467              }              }
468          }          }
469          #if POSIX          #if POSIX
470          if (lseek(pFile->hFileWrite, ulStartPos + ulPos, SEEK_SET) < 0) {          if (lseek(pFile->hFileWrite, ullStartPos + ullPos, SEEK_SET) < 0) {
471              throw Exception("Could not seek to position " + ToString(ulPos) +              throw Exception("Could not seek to position " + ToString(ullPos) +
472                              " in chunk (" + ToString(ulStartPos + ulPos) + " in file)");                              " in chunk (" + ToString(ullStartPos + ullPos) + " in file)");
473          }          }
474          unsigned long writtenWords = write(pFile->hFileWrite, pData, WordCount * WordSize);          ssize_t writtenWords = write(pFile->hFileWrite, pData, WordCount * WordSize);
475          if (writtenWords < 1) throw Exception("POSIX IO Error while trying to write chunk data");          if (writtenWords < 1) throw Exception("POSIX IO Error while trying to write chunk data");
476          writtenWords /= WordSize;          writtenWords /= WordSize;
477            #elif defined(WIN32)
478            LARGE_INTEGER liFilePos;
479            liFilePos.QuadPart = ullStartPos + ullPos;
480            if (!SetFilePointerEx(pFile->hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN)) {
481                throw Exception("Could not seek to position " + ToString(ullPos) +
482                                " in chunk (" + ToString(ullStartPos + ullPos) + " in file)");
483            }
484            DWORD writtenWords;
485            WriteFile(pFile->hFileWrite, pData, WordCount * WordSize, &writtenWords, NULL); //FIXME: does not work for writing buffers larger than 2GB (even though this should rarely be the case in practice)
486            if (writtenWords < 1) throw Exception("Windows IO Error while trying to write chunk data");
487            writtenWords /= WordSize;
488          #else // standard C functions          #else // standard C functions
489          if (fseek(pFile->hFileWrite, ulStartPos + ulPos, SEEK_SET)) {          if (fseeko(pFile->hFileWrite, ullStartPos + ullPos, SEEK_SET)) {
490              throw Exception("Could not seek to position " + ToString(ulPos) +              throw Exception("Could not seek to position " + ToString(ullPos) +
491                              " in chunk (" + ToString(ulStartPos + ulPos) + " in file)");                              " in chunk (" + ToString(ullStartPos + ullPos) + " in file)");
492          }          }
493          unsigned long writtenWords = fwrite(pData, WordSize, WordCount, pFile->hFileWrite);          file_offset_t writtenWords = fwrite(pData, WordSize, WordCount, pFile->hFileWrite);
494          #endif // POSIX          #endif // POSIX
495          SetPos(writtenWords * WordSize, stream_curpos);          SetPos(writtenWords * WordSize, stream_curpos);
496          return writtenWords;          return writtenWords;
497      }      }
498    
499      /** 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. */
500      unsigned long Chunk::ReadSceptical(void* pData, unsigned long WordCount, unsigned long WordSize) {      file_offset_t Chunk::ReadSceptical(void* pData, file_offset_t WordCount, file_offset_t WordSize) {
501          unsigned long readWords = Read(pData, WordCount, WordSize);          file_offset_t readWords = Read(pData, WordCount, WordSize);
502          if (readWords != WordCount) throw RIFF::Exception("End of chunk data reached.");          if (readWords != WordCount) throw RIFF::Exception("End of chunk data reached.");
503          return readWords;          return readWords;
504      }      }
# Line 348  namespace RIFF { Line 511  namespace RIFF {
511       * @param pData             destination buffer       * @param pData             destination buffer
512       * @param WordCount         number of 8 Bit signed integers to read       * @param WordCount         number of 8 Bit signed integers to read
513       * @returns                 number of read integers       * @returns                 number of read integers
514       * @throws RIFF::Exception  if an error occured or less than       * @throws RIFF::Exception  if an error occurred or less than
515       *                          \a WordCount integers could be read!       *                          \a WordCount integers could be read!
516       */       */
517      unsigned long Chunk::ReadInt8(int8_t* pData, unsigned long WordCount) {      file_offset_t Chunk::ReadInt8(int8_t* pData, file_offset_t WordCount) {
518         #if DEBUG          #if DEBUG_RIFF
519         std::cout << "Chunk::ReadInt8(int8_t*,ulong)" << std::endl;          std::cout << "Chunk::ReadInt8(int8_t*,file_offset_t)" << std::endl;
520         #endif // DEBUG          #endif // DEBUG_RIFF
521          return ReadSceptical(pData, WordCount, 1);          return ReadSceptical(pData, WordCount, 1);
522      }      }
523    
# Line 369  namespace RIFF { Line 532  namespace RIFF {
532       * @param pData             source buffer (containing the data)       * @param pData             source buffer (containing the data)
533       * @param WordCount         number of 8 Bit signed integers to write       * @param WordCount         number of 8 Bit signed integers to write
534       * @returns                 number of written integers       * @returns                 number of written integers
535       * @throws RIFF::Exception  if an IO error occured       * @throws RIFF::Exception  if an IO error occurred
536       * @see Resize()       * @see Resize()
537       */       */
538      unsigned long Chunk::WriteInt8(int8_t* pData, unsigned long WordCount) {      file_offset_t Chunk::WriteInt8(int8_t* pData, file_offset_t WordCount) {
539          return Write(pData, WordCount, 1);          return Write(pData, WordCount, 1);
540      }      }
541    
# Line 385  namespace RIFF { Line 548  namespace RIFF {
548       * @param pData             destination buffer       * @param pData             destination buffer
549       * @param WordCount         number of 8 Bit unsigned integers to read       * @param WordCount         number of 8 Bit unsigned integers to read
550       * @returns                 number of read integers       * @returns                 number of read integers
551       * @throws RIFF::Exception  if an error occured or less than       * @throws RIFF::Exception  if an error occurred or less than
552       *                          \a WordCount integers could be read!       *                          \a WordCount integers could be read!
553       */       */
554      unsigned long Chunk::ReadUint8(uint8_t* pData, unsigned long WordCount) {      file_offset_t Chunk::ReadUint8(uint8_t* pData, file_offset_t WordCount) {
555         #if DEBUG          #if DEBUG_RIFF
556         std::cout << "Chunk::ReadUint8(uint8_t*,ulong)" << std::endl;          std::cout << "Chunk::ReadUint8(uint8_t*,file_offset_t)" << std::endl;
557         #endif // DEBUG          #endif // DEBUG_RIFF
558          return ReadSceptical(pData, WordCount, 1);          return ReadSceptical(pData, WordCount, 1);
559      }      }
560    
# Line 406  namespace RIFF { Line 569  namespace RIFF {
569       * @param pData             source buffer (containing the data)       * @param pData             source buffer (containing the data)
570       * @param WordCount         number of 8 Bit unsigned integers to write       * @param WordCount         number of 8 Bit unsigned integers to write
571       * @returns                 number of written integers       * @returns                 number of written integers
572       * @throws RIFF::Exception  if an IO error occured       * @throws RIFF::Exception  if an IO error occurred
573       * @see Resize()       * @see Resize()
574       */       */
575      unsigned long Chunk::WriteUint8(uint8_t* pData, unsigned long WordCount) {      file_offset_t Chunk::WriteUint8(uint8_t* pData, file_offset_t WordCount) {
576          return Write(pData, WordCount, 1);          return Write(pData, WordCount, 1);
577      }      }
578    
# Line 422  namespace RIFF { Line 585  namespace RIFF {
585       * @param pData             destination buffer       * @param pData             destination buffer
586       * @param WordCount         number of 16 Bit signed integers to read       * @param WordCount         number of 16 Bit signed integers to read
587       * @returns                 number of read integers       * @returns                 number of read integers
588       * @throws RIFF::Exception  if an error occured or less than       * @throws RIFF::Exception  if an error occurred or less than
589       *                          \a WordCount integers could be read!       *                          \a WordCount integers could be read!
590       */       */
591      unsigned long Chunk::ReadInt16(int16_t* pData, unsigned long WordCount) {      file_offset_t Chunk::ReadInt16(int16_t* pData, file_offset_t WordCount) {
592        #if DEBUG          #if DEBUG_RIFF
593        std::cout << "Chunk::ReadInt16(int16_t*,ulong)" << std::endl;          std::cout << "Chunk::ReadInt16(int16_t*,file_offset_t)" << std::endl;
594        #endif // DEBUG          #endif // DEBUG_RIFF
595          return ReadSceptical(pData, WordCount, 2);          return ReadSceptical(pData, WordCount, 2);
596      }      }
597    
# Line 443  namespace RIFF { Line 606  namespace RIFF {
606       * @param pData             source buffer (containing the data)       * @param pData             source buffer (containing the data)
607       * @param WordCount         number of 16 Bit signed integers to write       * @param WordCount         number of 16 Bit signed integers to write
608       * @returns                 number of written integers       * @returns                 number of written integers
609       * @throws RIFF::Exception  if an IO error occured       * @throws RIFF::Exception  if an IO error occurred
610       * @see Resize()       * @see Resize()
611       */       */
612      unsigned long Chunk::WriteInt16(int16_t* pData, unsigned long WordCount) {      file_offset_t Chunk::WriteInt16(int16_t* pData, file_offset_t WordCount) {
613          return Write(pData, WordCount, 2);          return Write(pData, WordCount, 2);
614      }      }
615    
# Line 459  namespace RIFF { Line 622  namespace RIFF {
622       * @param pData             destination buffer       * @param pData             destination buffer
623       * @param WordCount         number of 8 Bit unsigned integers to read       * @param WordCount         number of 8 Bit unsigned integers to read
624       * @returns                 number of read integers       * @returns                 number of read integers
625       * @throws RIFF::Exception  if an error occured or less than       * @throws RIFF::Exception  if an error occurred or less than
626       *                          \a WordCount integers could be read!       *                          \a WordCount integers could be read!
627       */       */
628      unsigned long Chunk::ReadUint16(uint16_t* pData, unsigned long WordCount) {      file_offset_t Chunk::ReadUint16(uint16_t* pData, file_offset_t WordCount) {
629        #if DEBUG          #if DEBUG_RIFF
630        std::cout << "Chunk::ReadUint16(uint16_t*,ulong)" << std::endl;          std::cout << "Chunk::ReadUint16(uint16_t*,file_offset_t)" << std::endl;
631        #endif // DEBUG          #endif // DEBUG_RIFF
632          return ReadSceptical(pData, WordCount, 2);          return ReadSceptical(pData, WordCount, 2);
633      }      }
634    
# Line 480  namespace RIFF { Line 643  namespace RIFF {
643       * @param pData             source buffer (containing the data)       * @param pData             source buffer (containing the data)
644       * @param WordCount         number of 16 Bit unsigned integers to write       * @param WordCount         number of 16 Bit unsigned integers to write
645       * @returns                 number of written integers       * @returns                 number of written integers
646       * @throws RIFF::Exception  if an IO error occured       * @throws RIFF::Exception  if an IO error occurred
647       * @see Resize()       * @see Resize()
648       */       */
649      unsigned long Chunk::WriteUint16(uint16_t* pData, unsigned long WordCount) {      file_offset_t Chunk::WriteUint16(uint16_t* pData, file_offset_t WordCount) {
650          return Write(pData, WordCount, 2);          return Write(pData, WordCount, 2);
651      }      }
652    
# Line 496  namespace RIFF { Line 659  namespace RIFF {
659       * @param pData             destination buffer       * @param pData             destination buffer
660       * @param WordCount         number of 32 Bit signed integers to read       * @param WordCount         number of 32 Bit signed integers to read
661       * @returns                 number of read integers       * @returns                 number of read integers
662       * @throws RIFF::Exception  if an error occured or less than       * @throws RIFF::Exception  if an error occurred or less than
663       *                          \a WordCount integers could be read!       *                          \a WordCount integers could be read!
664       */       */
665      unsigned long Chunk::ReadInt32(int32_t* pData, unsigned long WordCount) {      file_offset_t Chunk::ReadInt32(int32_t* pData, file_offset_t WordCount) {
666         #if DEBUG          #if DEBUG_RIFF
667         std::cout << "Chunk::ReadInt32(int32_t*,ulong)" << std::endl;          std::cout << "Chunk::ReadInt32(int32_t*,file_offset_t)" << std::endl;
668         #endif // DEBUG          #endif // DEBUG_RIFF
669          return ReadSceptical(pData, WordCount, 4);          return ReadSceptical(pData, WordCount, 4);
670      }      }
671    
# Line 517  namespace RIFF { Line 680  namespace RIFF {
680       * @param pData             source buffer (containing the data)       * @param pData             source buffer (containing the data)
681       * @param WordCount         number of 32 Bit signed integers to write       * @param WordCount         number of 32 Bit signed integers to write
682       * @returns                 number of written integers       * @returns                 number of written integers
683       * @throws RIFF::Exception  if an IO error occured       * @throws RIFF::Exception  if an IO error occurred
684       * @see Resize()       * @see Resize()
685       */       */
686      unsigned long Chunk::WriteInt32(int32_t* pData, unsigned long WordCount) {      file_offset_t Chunk::WriteInt32(int32_t* pData, file_offset_t WordCount) {
687          return Write(pData, WordCount, 4);          return Write(pData, WordCount, 4);
688      }      }
689    
# Line 533  namespace RIFF { Line 696  namespace RIFF {
696       * @param pData             destination buffer       * @param pData             destination buffer
697       * @param WordCount         number of 32 Bit unsigned integers to read       * @param WordCount         number of 32 Bit unsigned integers to read
698       * @returns                 number of read integers       * @returns                 number of read integers
699       * @throws RIFF::Exception  if an error occured or less than       * @throws RIFF::Exception  if an error occurred or less than
700       *                          \a WordCount integers could be read!       *                          \a WordCount integers could be read!
701       */       */
702      unsigned long Chunk::ReadUint32(uint32_t* pData, unsigned long WordCount) {      file_offset_t Chunk::ReadUint32(uint32_t* pData, file_offset_t WordCount) {
703         #if DEBUG          #if DEBUG_RIFF
704         std::cout << "Chunk::ReadUint32(uint32_t*,ulong)" << std::endl;          std::cout << "Chunk::ReadUint32(uint32_t*,file_offset_t)" << std::endl;
705         #endif // DEBUG          #endif // DEBUG_RIFF
706          return ReadSceptical(pData, WordCount, 4);          return ReadSceptical(pData, WordCount, 4);
707      }      }
708    
709      /**      /**
710         * Reads a null-padded string of size characters and copies it
711         * into the string \a s. The position within the chunk will
712         * automatically be incremented.
713         *
714         * @param s                 destination string
715         * @param size              number of characters to read
716         * @throws RIFF::Exception  if an error occurred or less than
717         *                          \a size characters could be read!
718         */
719        void Chunk::ReadString(String& s, int size) {
720            char* buf = new char[size];
721            ReadSceptical(buf, 1, size);
722            s.assign(buf, std::find(buf, buf + size, '\0'));
723            delete[] buf;
724        }
725    
726        /**
727       * Writes \a WordCount number of 32 Bit unsigned integer words from the       * Writes \a WordCount number of 32 Bit unsigned integer words from the
728       * buffer pointed by \a pData to the chunk's body, directly to the       * buffer pointed by \a pData to the chunk's body, directly to the
729       * actual "physical" file. The position within the chunk will       * actual "physical" file. The position within the chunk will
# Line 554  namespace RIFF { Line 734  namespace RIFF {
734       * @param pData             source buffer (containing the data)       * @param pData             source buffer (containing the data)
735       * @param WordCount         number of 32 Bit unsigned integers to write       * @param WordCount         number of 32 Bit unsigned integers to write
736       * @returns                 number of written integers       * @returns                 number of written integers
737       * @throws RIFF::Exception  if an IO error occured       * @throws RIFF::Exception  if an IO error occurred
738       * @see Resize()       * @see Resize()
739       */       */
740      unsigned long Chunk::WriteUint32(uint32_t* pData, unsigned long WordCount) {      file_offset_t Chunk::WriteUint32(uint32_t* pData, file_offset_t WordCount) {
741          return Write(pData, WordCount, 4);          return Write(pData, WordCount, 4);
742      }      }
743    
# Line 566  namespace RIFF { Line 746  namespace RIFF {
746       * the chunk.       * the chunk.
747       *       *
748       * @returns                 read integer word       * @returns                 read integer word
749       * @throws RIFF::Exception  if an error occured       * @throws RIFF::Exception  if an error occurred
750       */       */
751      int8_t Chunk::ReadInt8() {      int8_t Chunk::ReadInt8() {
752        #if DEBUG          #if DEBUG_RIFF
753        std::cout << "Chunk::ReadInt8()" << std::endl;          std::cout << "Chunk::ReadInt8()" << std::endl;
754        #endif // DEBUG          #endif // DEBUG_RIFF
755          int8_t word;          int8_t word;
756          ReadSceptical(&word,1,1);          ReadSceptical(&word,1,1);
757          return word;          return word;
# Line 582  namespace RIFF { Line 762  namespace RIFF {
762       * within the chunk.       * within the chunk.
763       *       *
764       * @returns                 read integer word       * @returns                 read integer word
765       * @throws RIFF::Exception  if an error occured       * @throws RIFF::Exception  if an error occurred
766       */       */
767      uint8_t Chunk::ReadUint8() {      uint8_t Chunk::ReadUint8() {
768        #if DEBUG          #if DEBUG_RIFF
769        std::cout << "Chunk::ReadUint8()" << std::endl;          std::cout << "Chunk::ReadUint8()" << std::endl;
770        #endif // DEBUG          #endif // DEBUG_RIFF
771          uint8_t word;          uint8_t word;
772          ReadSceptical(&word,1,1);          ReadSceptical(&word,1,1);
773          return word;          return word;
# Line 599  namespace RIFF { Line 779  namespace RIFF {
779       * needed.       * needed.
780       *       *
781       * @returns                 read integer word       * @returns                 read integer word
782       * @throws RIFF::Exception  if an error occured       * @throws RIFF::Exception  if an error occurred
783       */       */
784      int16_t Chunk::ReadInt16() {      int16_t Chunk::ReadInt16() {
785        #if DEBUG          #if DEBUG_RIFF
786        std::cout << "Chunk::ReadInt16()" << std::endl;          std::cout << "Chunk::ReadInt16()" << std::endl;
787        #endif // DEBUG          #endif // DEBUG_RIFF
788          int16_t word;          int16_t word;
789          ReadSceptical(&word,1,2);          ReadSceptical(&word,1,2);
790          return word;          return word;
# Line 616  namespace RIFF { Line 796  namespace RIFF {
796       * needed.       * needed.
797       *       *
798       * @returns                 read integer word       * @returns                 read integer word
799       * @throws RIFF::Exception  if an error occured       * @throws RIFF::Exception  if an error occurred
800       */       */
801      uint16_t Chunk::ReadUint16() {      uint16_t Chunk::ReadUint16() {
802        #if DEBUG          #if DEBUG_RIFF
803        std::cout << "Chunk::ReadUint16()" << std::endl;          std::cout << "Chunk::ReadUint16()" << std::endl;
804        #endif // DEBUG          #endif // DEBUG_RIFF
805          uint16_t word;          uint16_t word;
806          ReadSceptical(&word,1,2);          ReadSceptical(&word,1,2);
807          return word;          return word;
# Line 633  namespace RIFF { Line 813  namespace RIFF {
813       * needed.       * needed.
814       *       *
815       * @returns                 read integer word       * @returns                 read integer word
816       * @throws RIFF::Exception  if an error occured       * @throws RIFF::Exception  if an error occurred
817       */       */
818      int32_t Chunk::ReadInt32() {      int32_t Chunk::ReadInt32() {
819        #if DEBUG          #if DEBUG_RIFF
820        std::cout << "Chunk::ReadInt32()" << std::endl;          std::cout << "Chunk::ReadInt32()" << std::endl;
821        #endif // DEBUG          #endif // DEBUG_RIFF
822          int32_t word;          int32_t word;
823          ReadSceptical(&word,1,4);          ReadSceptical(&word,1,4);
824          return word;          return word;
# Line 650  namespace RIFF { Line 830  namespace RIFF {
830       * needed.       * needed.
831       *       *
832       * @returns                 read integer word       * @returns                 read integer word
833       * @throws RIFF::Exception  if an error occured       * @throws RIFF::Exception  if an error occurred
834       */       */
835      uint32_t Chunk::ReadUint32() {      uint32_t Chunk::ReadUint32() {
836        #if DEBUG          #if DEBUG_RIFF
837        std::cout << "Chunk::ReadUint32()" << std::endl;          std::cout << "Chunk::ReadUint32()" << std::endl;
838        #endif // DEBUG          #endif // DEBUG_RIFF
839          uint32_t word;          uint32_t word;
840          ReadSceptical(&word,1,4);          ReadSceptical(&word,1,4);
841          return word;          return word;
# Line 668  namespace RIFF { Line 848  namespace RIFF {
848       *       *
849       * <b>Caution:</b> the buffer pointer will be invalidated once       * <b>Caution:</b> the buffer pointer will be invalidated once
850       * File::Save() was called. You have to call LoadChunkData() again to       * File::Save() was called. You have to call LoadChunkData() again to
851       * get a new pointer whenever File::Save() was called.       * get a new, valid pointer whenever File::Save() was called.
852         *
853         * You can call LoadChunkData() again if you previously scheduled to
854         * enlarge this chunk with a Resize() call. In that case the buffer will
855         * be enlarged to the new, scheduled chunk size and you can already
856         * place the new chunk data to the buffer and finally call File::Save()
857         * to enlarge the chunk physically and write the new data in one rush.
858         * This approach is definitely recommended if you have to enlarge and
859         * write new data to a lot of chunks.
860       *       *
861       * @returns a pointer to the data in RAM on success, NULL otherwise       * @returns a pointer to the data in RAM on success, NULL otherwise
862         * @throws Exception if data buffer could not be enlarged
863       * @see ReleaseChunkData()       * @see ReleaseChunkData()
864       */       */
865      void* Chunk::LoadChunkData() {      void* Chunk::LoadChunkData() {
866          if (!pChunkData) {          if (!pChunkData && pFile->Filename != "" /*&& ulStartPos != 0*/) {
867              #if POSIX              #if POSIX
868              if (lseek(pFile->hFileRead, ulStartPos, SEEK_SET) == -1) return NULL;              if (lseek(pFile->hFileRead, ullStartPos, SEEK_SET) == -1) return NULL;
869              pChunkData = new uint8_t[GetSize()];              #elif defined(WIN32)
870              if (!pChunkData) return NULL;              LARGE_INTEGER liFilePos;
871              unsigned long readWords = read(pFile->hFileRead, pChunkData, GetSize());              liFilePos.QuadPart = ullStartPos;
872                if (!SetFilePointerEx(pFile->hFileRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN)) return NULL;
873              #else              #else
874              if (fseek(pFile->hFileRead, ulStartPos, SEEK_SET)) return NULL;              if (fseeko(pFile->hFileRead, ullStartPos, SEEK_SET)) return NULL;
875              pChunkData = new uint8_t[GetSize()];              #endif // POSIX
876                file_offset_t ullBufferSize = (ullCurrentChunkSize > ullNewChunkSize) ? ullCurrentChunkSize : ullNewChunkSize;
877                pChunkData = new uint8_t[ullBufferSize];
878              if (!pChunkData) return NULL;              if (!pChunkData) return NULL;
879              unsigned long readWords = fread(pChunkData, 1, GetSize(), pFile->hFileRead);              memset(pChunkData, 0, ullBufferSize);
880                #if POSIX
881                file_offset_t readWords = read(pFile->hFileRead, pChunkData, GetSize());
882                #elif defined(WIN32)
883                DWORD readWords;
884                ReadFile(pFile->hFileRead, pChunkData, GetSize(), &readWords, NULL); //FIXME: won't load chunks larger than 2GB !
885                #else
886                file_offset_t readWords = fread(pChunkData, 1, GetSize(), pFile->hFileRead);
887              #endif // POSIX              #endif // POSIX
888              if (readWords != GetSize()) {              if (readWords != GetSize()) {
889                  delete[] pChunkData;                  delete[] pChunkData;
890                  return (pChunkData = NULL);                  return (pChunkData = NULL);
891              }              }
892                ullChunkDataSize = ullBufferSize;
893            } else if (ullNewChunkSize > ullChunkDataSize) {
894                uint8_t* pNewBuffer = new uint8_t[ullNewChunkSize];
895                if (!pNewBuffer) throw Exception("Could not enlarge chunk data buffer to " + ToString(ullNewChunkSize) + " bytes");
896                memset(pNewBuffer, 0 , ullNewChunkSize);
897                if (pChunkData) {
898                    memcpy(pNewBuffer, pChunkData, ullChunkDataSize);
899                    delete[] pChunkData;
900                }
901                pChunkData       = pNewBuffer;
902                ullChunkDataSize = ullNewChunkSize;
903          }          }
904          return pChunkData;          return pChunkData;
905      }      }
# Line 719  namespace RIFF { Line 929  namespace RIFF {
929       *       *
930       * <b>Caution:</b> You cannot directly write to enlarged chunks before       * <b>Caution:</b> You cannot directly write to enlarged chunks before
931       * calling File::Save() as this might exceed the current chunk's body       * calling File::Save() as this might exceed the current chunk's body
932       * boundary.       * boundary!
933       *       *
934       * @param iNewSize - new chunk body size in bytes (must be greater than zero)       * @param NewSize - new chunk body size in bytes (must be greater than zero)
935       * @throws RIFF::Exception  if \a iNewSize is less than 1       * @throws RIFF::Exception  if \a NewSize is less than 1 or unrealistic large
936       * @see File::Save()       * @see File::Save()
937       */       */
938      void Chunk::Resize(int iNewSize) {      void Chunk::Resize(file_offset_t NewSize) {
939          if (iNewSize <= 0) throw Exception("Chunk size must be at least one byte");          if (NewSize == 0)
940          NewChunkSize = iNewSize;              throw Exception("There is at least one empty chunk (zero size): " + __resolveChunkPath(this));
941          pFile->LogAsResized(this);          if ((NewSize >> 48) != 0)
942                throw Exception("Unrealistic high chunk size detected: " + __resolveChunkPath(this));
943            if (ullNewChunkSize == NewSize) return;
944            ullNewChunkSize = NewSize;
945      }      }
946    
947      /** @brief Write chunk persistently e.g. to disk.      /** @brief Write chunk persistently e.g. to disk.
948       *       *
949       * Stores the chunk persistently to its actual "physical" file.       * Stores the chunk persistently to its actual "physical" file.
950       *       *
951       * @param ulWritePos - position within the "physical" file where this       * @param ullWritePos - position within the "physical" file where this
952       *                     chunk should be written to       *                     chunk should be written to
953       * @param ulCurrentDataOffset - offset of current (old) data within       * @param ullCurrentDataOffset - offset of current (old) data within
954       *                              the file       *                              the file
955         * @param pProgress - optional: callback function for progress notification
956       * @returns new write position in the "physical" file, that is       * @returns new write position in the "physical" file, that is
957       *          \a ulWritePos incremented by this chunk's new size       *          \a ullWritePos incremented by this chunk's new size
958       *          (including its header size of course)       *          (including its header size of course)
959       */       */
960      unsigned long Chunk::WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset) {      file_offset_t Chunk::WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t* pProgress) {
961          const unsigned long ulOriginalPos = ulWritePos;          const file_offset_t ullOriginalPos = ullWritePos;
962          ulWritePos += CHUNK_HEADER_SIZE;          ullWritePos += CHUNK_HEADER_SIZE(pFile->FileOffsetSize);
963    
964          if (pFile->Mode != stream_mode_read_write)          if (pFile->Mode != stream_mode_read_write)
965              throw Exception("Cannot write list chunk, file has to be opened in read+write mode");              throw Exception("Cannot write list chunk, file has to be opened in read+write mode");
966    
967          // if the whole chunk body was loaded into RAM          // if the whole chunk body was loaded into RAM
968          if (pChunkData) {          if (pChunkData) {
969              // in case the chunk size was changed, reallocate the data in RAM with the chunk's new size              // make sure chunk data buffer in RAM is at least as large as the new chunk size
970              if (NewChunkSize != CurrentChunkSize) {              LoadChunkData();
                 uint8_t* pNewBuffer = new uint8_t[NewChunkSize];  
                 if (NewChunkSize > CurrentChunkSize) {  
                     memcpy(pNewBuffer, pChunkData, CurrentChunkSize);  
                     memset(pNewBuffer + CurrentChunkSize, 0, NewChunkSize - CurrentChunkSize);  
                 } else {  
                     memcpy(pNewBuffer, pChunkData, NewChunkSize);  
                 }  
                 delete[] pChunkData;  
                 pChunkData = pNewBuffer;  
             }  
   
971              // write chunk data from RAM persistently to the file              // write chunk data from RAM persistently to the file
972              #if POSIX              #if POSIX
973              lseek(pFile->hFileWrite, ulWritePos, SEEK_SET);              lseek(pFile->hFileWrite, ullWritePos, SEEK_SET);
974              if (write(pFile->hFileWrite, pChunkData, NewChunkSize) != NewChunkSize) {              if (write(pFile->hFileWrite, pChunkData, ullNewChunkSize) != ullNewChunkSize) {
975                    throw Exception("Writing Chunk data (from RAM) failed");
976                }
977                #elif defined(WIN32)
978                LARGE_INTEGER liFilePos;
979                liFilePos.QuadPart = ullWritePos;
980                SetFilePointerEx(pFile->hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
981                DWORD dwBytesWritten;
982                WriteFile(pFile->hFileWrite, pChunkData, ullNewChunkSize, &dwBytesWritten, NULL); //FIXME: won't save chunks larger than 2GB !
983                if (dwBytesWritten != ullNewChunkSize) {
984                  throw Exception("Writing Chunk data (from RAM) failed");                  throw Exception("Writing Chunk data (from RAM) failed");
985              }              }
986              #else              #else
987              fseek(pFile->hFileWrite, ulWritePos, SEEK_SET);              fseeko(pFile->hFileWrite, ullWritePos, SEEK_SET);
988              if (fwrite(pChunkData, 1, NewChunkSize, pFile->hFileWrite) != NewChunkSize) {              if (fwrite(pChunkData, 1, ullNewChunkSize, pFile->hFileWrite) != ullNewChunkSize) {
989                  throw Exception("Writing Chunk data (from RAM) failed");                  throw Exception("Writing Chunk data (from RAM) failed");
990              }              }
991              #endif // POSIX              #endif // POSIX
992          } else {          } else {
993              // move chunk data from the end of the file to the appropriate position              // move chunk data from the end of the file to the appropriate position
994              int8_t* pCopyBuffer = new int8_t[4096];              int8_t* pCopyBuffer = new int8_t[4096];
995              unsigned long ulToMove = (NewChunkSize < CurrentChunkSize) ? NewChunkSize : CurrentChunkSize;              file_offset_t ullToMove = (ullNewChunkSize < ullCurrentChunkSize) ? ullNewChunkSize : ullCurrentChunkSize;
996                #if defined(WIN32)
997                DWORD iBytesMoved = 1; // we have to pass it via pointer to the Windows API, thus the correct size must be ensured
998                #else
999              int iBytesMoved = 1;              int iBytesMoved = 1;
1000              for (unsigned long ulOffset = 0; iBytesMoved > 0; ulOffset += iBytesMoved, ulToMove -= iBytesMoved) {              #endif
1001                  iBytesMoved = (ulToMove < 4096) ? ulToMove : 4096;              for (file_offset_t ullOffset = 0; ullToMove > 0 && iBytesMoved > 0; ullOffset += iBytesMoved, ullToMove -= iBytesMoved) {
1002                    iBytesMoved = (ullToMove < 4096) ? int(ullToMove) : 4096;
1003                  #if POSIX                  #if POSIX
1004                  lseek(pFile->hFileRead, ulStartPos + ulCurrentDataOffset + ulOffset, SEEK_SET);                  lseek(pFile->hFileRead, ullStartPos + ullCurrentDataOffset + ullOffset, SEEK_SET);
1005                  iBytesMoved = read(pFile->hFileRead, pCopyBuffer, iBytesMoved);                  iBytesMoved = (int) read(pFile->hFileRead, pCopyBuffer, (size_t) iBytesMoved);
1006                  lseek(pFile->hFileWrite, ulWritePos + ulOffset, SEEK_SET);                  lseek(pFile->hFileWrite, ullWritePos + ullOffset, SEEK_SET);
1007                  iBytesMoved = write(pFile->hFileWrite, pCopyBuffer, iBytesMoved);                  iBytesMoved = (int) write(pFile->hFileWrite, pCopyBuffer, (size_t) iBytesMoved);
1008                    #elif defined(WIN32)
1009                    LARGE_INTEGER liFilePos;
1010                    liFilePos.QuadPart = ullStartPos + ullCurrentDataOffset + ullOffset;
1011                    SetFilePointerEx(pFile->hFileRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
1012                    ReadFile(pFile->hFileRead, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
1013                    liFilePos.QuadPart = ullWritePos + ullOffset;
1014                    SetFilePointerEx(pFile->hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
1015                    WriteFile(pFile->hFileWrite, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
1016                  #else                  #else
1017                  fseek(pFile->hFileRead, ulStartPos + ulCurrentDataOffset + ulOffset, SEEK_SET);                  fseeko(pFile->hFileRead, ullStartPos + ullCurrentDataOffset + ullOffset, SEEK_SET);
1018                  iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, pFile->hFileRead);                  iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, pFile->hFileRead);
1019                  fseek(pFile->hFileWrite, ulWritePos + ulOffset, SEEK_SET);                  fseeko(pFile->hFileWrite, ullWritePos + ullOffset, SEEK_SET);
1020                  iBytesMoved = fwrite(pCopyBuffer, 1, iBytesMoved, pFile->hFileWrite);                  iBytesMoved = fwrite(pCopyBuffer, 1, iBytesMoved, pFile->hFileWrite);
1021                  #endif                  #endif
1022              }              }
# Line 801  namespace RIFF { Line 1025  namespace RIFF {
1025          }          }
1026    
1027          // update this chunk's header          // update this chunk's header
1028          CurrentChunkSize = NewChunkSize;          ullCurrentChunkSize = ullNewChunkSize;
1029          WriteHeader(ulOriginalPos);          WriteHeader(ullOriginalPos);
1030    
1031            if (pProgress)
1032                __notify_progress(pProgress, 1.0); // notify done
1033    
1034          // update chunk's position pointers          // update chunk's position pointers
1035          ulStartPos = ulOriginalPos + CHUNK_HEADER_SIZE;          ullStartPos = ullOriginalPos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize);
1036          ulPos      = 0;          ullPos      = 0;
1037    
1038          // add pad byte if needed          // add pad byte if needed
1039          if ((ulStartPos + NewChunkSize) % 2 != 0) {          if ((ullStartPos + ullNewChunkSize) % 2 != 0) {
1040              const char cPadByte = 0;              const char cPadByte = 0;
1041              #if POSIX              #if POSIX
1042              lseek(pFile->hFileWrite, ulStartPos + NewChunkSize, SEEK_SET);              lseek(pFile->hFileWrite, ullStartPos + ullNewChunkSize, SEEK_SET);
1043              write(pFile->hFileWrite, &cPadByte, 1);              write(pFile->hFileWrite, &cPadByte, 1);
1044                #elif defined(WIN32)
1045                LARGE_INTEGER liFilePos;
1046                liFilePos.QuadPart = ullStartPos + ullNewChunkSize;
1047                SetFilePointerEx(pFile->hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
1048                DWORD dwBytesWritten;
1049                WriteFile(pFile->hFileWrite, &cPadByte, 1, &dwBytesWritten, NULL);
1050              #else              #else
1051              fseek(pFile->hFileWrite, ulStartPos + NewChunkSize, SEEK_SET);              fseeko(pFile->hFileWrite, ullStartPos + ullNewChunkSize, SEEK_SET);
1052              fwrite(&cPadByte, 1, 1, pFile->hFileWrite);              fwrite(&cPadByte, 1, 1, pFile->hFileWrite);
1053              #endif              #endif
1054              return ulStartPos + NewChunkSize + 1;              return ullStartPos + ullNewChunkSize + 1;
1055          }          }
1056    
1057          return ulStartPos + NewChunkSize;          return ullStartPos + ullNewChunkSize;
1058      }      }
1059    
1060      void Chunk::__resetPos() {      void Chunk::__resetPos() {
1061          ulPos = 0;          ullPos = 0;
1062      }      }
1063    
1064    
# Line 834  namespace RIFF { Line 1067  namespace RIFF {
1067  // *  // *
1068    
1069      List::List(File* pFile) : Chunk(pFile) {      List::List(File* pFile) : Chunk(pFile) {
1070        #if DEBUG          #if DEBUG_RIFF
1071        std::cout << "List::List(File* pFile)" << std::endl;          std::cout << "List::List(File* pFile)" << std::endl;
1072        #endif // DEBUG          #endif // DEBUG_RIFF
1073          pSubChunks    = NULL;          pSubChunks    = NULL;
1074          pSubChunksMap = NULL;          pSubChunksMap = NULL;
1075      }      }
1076    
1077      List::List(File* pFile, unsigned long StartPos, List* Parent)      List::List(File* pFile, file_offset_t StartPos, List* Parent)
1078        : Chunk(pFile, StartPos, Parent) {        : Chunk(pFile, StartPos, Parent) {
1079          #if DEBUG          #if DEBUG_RIFF
1080          std::cout << "List::List(File*,ulong,bool,List*)" << std::endl;          std::cout << "List::List(File*,file_offset_t,List*)" << std::endl;
1081          #endif // DEBUG          #endif // DEBUG_RIFF
1082          pSubChunks    = NULL;          pSubChunks    = NULL;
1083          pSubChunksMap = NULL;          pSubChunksMap = NULL;
1084          ReadHeader(StartPos);          ReadHeader(StartPos);
1085          ulStartPos    = StartPos + LIST_HEADER_SIZE;          ullStartPos = StartPos + LIST_HEADER_SIZE(pFile->FileOffsetSize);
1086      }      }
1087    
1088      List::List(File* pFile, List* pParent, uint32_t uiListID)      List::List(File* pFile, List* pParent, uint32_t uiListID)
# Line 860  namespace RIFF { Line 1093  namespace RIFF {
1093      }      }
1094    
1095      List::~List() {      List::~List() {
1096        #if DEBUG          #if DEBUG_RIFF
1097        std::cout << "List::~List()" << std::endl;          std::cout << "List::~List()" << std::endl;
1098        #endif // DEBUG          #endif // DEBUG_RIFF
1099            DeleteChunkList();
1100        }
1101    
1102        void List::DeleteChunkList() {
1103          if (pSubChunks) {          if (pSubChunks) {
1104              ChunkList::iterator iter = pSubChunks->begin();              ChunkList::iterator iter = pSubChunks->begin();
1105              ChunkList::iterator end  = pSubChunks->end();              ChunkList::iterator end  = pSubChunks->end();
# Line 871  namespace RIFF { Line 1108  namespace RIFF {
1108                  iter++;                  iter++;
1109              }              }
1110              delete pSubChunks;              delete pSubChunks;
1111                pSubChunks = NULL;
1112            }
1113            if (pSubChunksMap) {
1114                delete pSubChunksMap;
1115                pSubChunksMap = NULL;
1116          }          }
         if (pSubChunksMap) delete pSubChunksMap;  
1117      }      }
1118    
1119      /**      /**
# Line 887  namespace RIFF { Line 1128  namespace RIFF {
1128       *                   that ID       *                   that ID
1129       */       */
1130      Chunk* List::GetSubChunk(uint32_t ChunkID) {      Chunk* List::GetSubChunk(uint32_t ChunkID) {
1131        #if DEBUG          #if DEBUG_RIFF
1132        std::cout << "List::GetSubChunk(uint32_t)" << std::endl;          std::cout << "List::GetSubChunk(uint32_t)" << std::endl;
1133        #endif // DEBUG          #endif // DEBUG_RIFF
1134          if (!pSubChunksMap) LoadSubChunks();          if (!pSubChunksMap) LoadSubChunks();
1135          return (*pSubChunksMap)[ChunkID];          return (*pSubChunksMap)[ChunkID];
1136      }      }
# Line 897  namespace RIFF { Line 1138  namespace RIFF {
1138      /**      /**
1139       *  Returns sublist chunk with list type <i>\a ListType</i> within this       *  Returns sublist chunk with list type <i>\a ListType</i> within this
1140       *  chunk list. Use this method if you expect only one sublist chunk of       *  chunk list. Use this method if you expect only one sublist chunk of
1141       *  that type in the list. It there are more than one, it's undetermined       *  that type in the list. If there are more than one, it's undetermined
1142       *  which one of them will be returned! If there are no sublists with       *  which one of them will be returned! If there are no sublists with
1143       *  that desired list type, NULL will be returned.       *  that desired list type, NULL will be returned.
1144       *       *
# Line 906  namespace RIFF { Line 1147  namespace RIFF {
1147       *                    that type       *                    that type
1148       */       */
1149      List* List::GetSubList(uint32_t ListType) {      List* List::GetSubList(uint32_t ListType) {
1150          #if DEBUG          #if DEBUG_RIFF
1151          std::cout << "List::GetSubList(uint32_t)" << std::endl;          std::cout << "List::GetSubList(uint32_t)" << std::endl;
1152          #endif // DEBUG          #endif // DEBUG_RIFF
1153          if (!pSubChunks) LoadSubChunks();          if (!pSubChunks) LoadSubChunks();
1154          ChunkList::iterator iter = pSubChunks->begin();          ChunkList::iterator iter = pSubChunks->begin();
1155          ChunkList::iterator end  = pSubChunks->end();          ChunkList::iterator end  = pSubChunks->end();
# Line 923  namespace RIFF { Line 1164  namespace RIFF {
1164      }      }
1165    
1166      /**      /**
1167       *  Returns the first subchunk within the list. You have to call this       *  Returns the first subchunk within the list (which may be an ordinary
1168         *  chunk as well as a list chunk). You have to call this
1169       *  method before you can call GetNextSubChunk(). Recall it when you want       *  method before you can call GetNextSubChunk(). Recall it when you want
1170       *  to start from the beginning of the list again.       *  to start from the beginning of the list again.
1171       *       *
# Line 931  namespace RIFF { Line 1173  namespace RIFF {
1173       *            otherwise       *            otherwise
1174       */       */
1175      Chunk* List::GetFirstSubChunk() {      Chunk* List::GetFirstSubChunk() {
1176          #if DEBUG          #if DEBUG_RIFF
1177          std::cout << "List::GetFirstSubChunk()" << std::endl;          std::cout << "List::GetFirstSubChunk()" << std::endl;
1178          #endif // DEBUG          #endif // DEBUG_RIFF
1179          if (!pSubChunks) LoadSubChunks();          if (!pSubChunks) LoadSubChunks();
1180          ChunksIterator = pSubChunks->begin();          ChunksIterator = pSubChunks->begin();
1181          return (ChunksIterator != pSubChunks->end()) ? *ChunksIterator : NULL;          return (ChunksIterator != pSubChunks->end()) ? *ChunksIterator : NULL;
1182      }      }
1183    
1184      /**      /**
1185       *  Returns the next subchunk within the list. You have to call       *  Returns the next subchunk within the list (which may be an ordinary
1186         *  chunk as well as a list chunk). You have to call
1187       *  GetFirstSubChunk() before you can use this method!       *  GetFirstSubChunk() before you can use this method!
1188       *       *
1189       *  @returns  pointer to the next subchunk within the list or NULL if       *  @returns  pointer to the next subchunk within the list or NULL if
1190       *            end of list is reached       *            end of list is reached
1191       */       */
1192      Chunk* List::GetNextSubChunk() {      Chunk* List::GetNextSubChunk() {
1193          #if DEBUG          #if DEBUG_RIFF
1194          std::cout << "List::GetNextSubChunk()" << std::endl;          std::cout << "List::GetNextSubChunk()" << std::endl;
1195          #endif // DEBUG          #endif // DEBUG_RIFF
1196          if (!pSubChunks) return NULL;          if (!pSubChunks) return NULL;
1197          ChunksIterator++;          ChunksIterator++;
1198          return (ChunksIterator != pSubChunks->end()) ? *ChunksIterator : NULL;          return (ChunksIterator != pSubChunks->end()) ? *ChunksIterator : NULL;
# Line 965  namespace RIFF { Line 1208  namespace RIFF {
1208       *            otherwise       *            otherwise
1209       */       */
1210      List* List::GetFirstSubList() {      List* List::GetFirstSubList() {
1211          #if DEBUG          #if DEBUG_RIFF
1212          std::cout << "List::GetFirstSubList()" << std::endl;          std::cout << "List::GetFirstSubList()" << std::endl;
1213          #endif // DEBUG          #endif // DEBUG_RIFF
1214          if (!pSubChunks) LoadSubChunks();          if (!pSubChunks) LoadSubChunks();
1215          ListIterator            = pSubChunks->begin();          ListIterator            = pSubChunks->begin();
1216          ChunkList::iterator end = pSubChunks->end();          ChunkList::iterator end = pSubChunks->end();
# Line 987  namespace RIFF { Line 1230  namespace RIFF {
1230       *            end of list is reached       *            end of list is reached
1231       */       */
1232      List* List::GetNextSubList() {      List* List::GetNextSubList() {
1233          #if DEBUG          #if DEBUG_RIFF
1234          std::cout << "List::GetNextSubList()" << std::endl;          std::cout << "List::GetNextSubList()" << std::endl;
1235          #endif // DEBUG          #endif // DEBUG_RIFF
1236          if (!pSubChunks) return NULL;          if (!pSubChunks) return NULL;
1237          if (ListIterator == pSubChunks->end()) return NULL;          if (ListIterator == pSubChunks->end()) return NULL;
1238          ListIterator++;          ListIterator++;
# Line 1002  namespace RIFF { Line 1245  namespace RIFF {
1245      }      }
1246    
1247      /**      /**
1248       *  Returns number of subchunks within the list.       *  Returns number of subchunks within the list (including list chunks).
1249       */       */
1250      unsigned int List::CountSubChunks() {      size_t List::CountSubChunks() {
1251          if (!pSubChunks) LoadSubChunks();          if (!pSubChunks) LoadSubChunks();
1252          return pSubChunks->size();          return pSubChunks->size();
1253      }      }
# Line 1013  namespace RIFF { Line 1256  namespace RIFF {
1256       *  Returns number of subchunks within the list with chunk ID       *  Returns number of subchunks within the list with chunk ID
1257       *  <i>\a ChunkId</i>.       *  <i>\a ChunkId</i>.
1258       */       */
1259      unsigned int List::CountSubChunks(uint32_t ChunkID) {      size_t List::CountSubChunks(uint32_t ChunkID) {
1260          unsigned int result = 0;          size_t result = 0;
1261          if (!pSubChunks) LoadSubChunks();          if (!pSubChunks) LoadSubChunks();
1262          ChunkList::iterator iter = pSubChunks->begin();          ChunkList::iterator iter = pSubChunks->begin();
1263          ChunkList::iterator end  = pSubChunks->end();          ChunkList::iterator end  = pSubChunks->end();
# Line 1030  namespace RIFF { Line 1273  namespace RIFF {
1273      /**      /**
1274       *  Returns number of sublists within the list.       *  Returns number of sublists within the list.
1275       */       */
1276      unsigned int List::CountSubLists() {      size_t List::CountSubLists() {
1277          return CountSubChunks(CHUNK_ID_LIST);          return CountSubChunks(CHUNK_ID_LIST);
1278      }      }
1279    
# Line 1038  namespace RIFF { Line 1281  namespace RIFF {
1281       *  Returns number of sublists within the list with list type       *  Returns number of sublists within the list with list type
1282       *  <i>\a ListType</i>       *  <i>\a ListType</i>
1283       */       */
1284      unsigned int List::CountSubLists(uint32_t ListType) {      size_t List::CountSubLists(uint32_t ListType) {
1285          unsigned int result = 0;          size_t result = 0;
1286          if (!pSubChunks) LoadSubChunks();          if (!pSubChunks) LoadSubChunks();
1287          ChunkList::iterator iter = pSubChunks->begin();          ChunkList::iterator iter = pSubChunks->begin();
1288          ChunkList::iterator end  = pSubChunks->end();          ChunkList::iterator end  = pSubChunks->end();
# Line 1056  namespace RIFF { Line 1299  namespace RIFF {
1299      /** @brief Creates a new sub chunk.      /** @brief Creates a new sub chunk.
1300       *       *
1301       * Creates and adds a new sub chunk to this list chunk. Note that the       * Creates and adds a new sub chunk to this list chunk. Note that the
1302       * chunk's body size given by \a uiBodySize must be greater than zero.       * chunk's body size given by \a ullBodySize must be greater than zero.
1303       * You have to call File::Save() to make this change persistent to the       * You have to call File::Save() to make this change persistent to the
1304       * actual file and <b>before</b> performing any data write operations       * actual file and <b>before</b> performing any data write operations
1305       * on the new chunk!       * on the new chunk!
1306       *       *
1307       * @param uiChunkID  - chunk ID of the new chunk       * @param uiChunkID  - chunk ID of the new chunk
1308       * @param uiBodySize - size of the new chunk's body, that is its actual       * @param ullBodySize - size of the new chunk's body, that is its actual
1309       *                     data size (without header)       *                      data size (without header)
1310       * @throws RIFF::Exception if \a uiBodySize equals zero       * @throws RIFF::Exception if \a ullBodySize equals zero
1311       */       */
1312      Chunk* List::AddSubChunk(uint32_t uiChunkID, uint uiBodySize) {      Chunk* List::AddSubChunk(uint32_t uiChunkID, file_offset_t ullBodySize) {
1313          if (uiBodySize == 0) throw Exception("Chunk body size must be at least 1 byte");          if (ullBodySize == 0) throw Exception("Chunk body size must be at least 1 byte");
1314          if (!pSubChunks) LoadSubChunks();          if (!pSubChunks) LoadSubChunks();
1315          Chunk* pNewChunk = new Chunk(pFile, this, uiChunkID, 0);          Chunk* pNewChunk = new Chunk(pFile, this, uiChunkID, 0);
1316          pSubChunks->push_back(pNewChunk);          pSubChunks->push_back(pNewChunk);
1317          (*pSubChunksMap)[uiChunkID] = pNewChunk;          (*pSubChunksMap)[uiChunkID] = pNewChunk;
1318          pNewChunk->Resize(uiBodySize);          pNewChunk->Resize(ullBodySize);
1319            ullNewChunkSize += CHUNK_HEADER_SIZE(pFile->FileOffsetSize);
1320          return pNewChunk;          return pNewChunk;
1321      }      }
1322    
1323        /** @brief Moves a sub chunk witin this list.
1324         *
1325         * Moves a sub chunk from one position in this list to another
1326         * position in the same list. The pSrc chunk is placed before the
1327         * pDst chunk.
1328         *
1329         * @param pSrc - sub chunk to be moved
1330         * @param pDst - the position to move to. pSrc will be placed
1331         *               before pDst. If pDst is 0, pSrc will be placed
1332         *               last in list.
1333         */
1334        void List::MoveSubChunk(Chunk* pSrc, Chunk* pDst) {
1335            if (!pSubChunks) LoadSubChunks();
1336            pSubChunks->remove(pSrc);
1337            ChunkList::iterator iter = find(pSubChunks->begin(), pSubChunks->end(), pDst);
1338            pSubChunks->insert(iter, pSrc);
1339        }
1340    
1341        /** @brief Moves a sub chunk from this list to another list.
1342         *
1343         * Moves a sub chunk from this list list to the end of another
1344         * list.
1345         *
1346         * @param pSrc - sub chunk to be moved
1347         * @param pDst - destination list where the chunk shall be moved to
1348         */
1349        void List::MoveSubChunk(Chunk* pSrc, List* pNewParent) {
1350            if (pNewParent == this || !pNewParent) return;
1351            if (!pSubChunks) LoadSubChunks();
1352            if (!pNewParent->pSubChunks) pNewParent->LoadSubChunks();
1353            pSubChunks->remove(pSrc);
1354            pNewParent->pSubChunks->push_back(pSrc);
1355            // update chunk id map of this List
1356            if ((*pSubChunksMap)[pSrc->GetChunkID()] == pSrc) {
1357                pSubChunksMap->erase(pSrc->GetChunkID());
1358                // try to find another chunk of the same chunk ID
1359                ChunkList::iterator iter = pSubChunks->begin();
1360                ChunkList::iterator end  = pSubChunks->end();
1361                for (; iter != end; ++iter) {
1362                    if ((*iter)->GetChunkID() == pSrc->GetChunkID()) {
1363                        (*pSubChunksMap)[pSrc->GetChunkID()] = *iter;
1364                        break; // we're done, stop search
1365                    }
1366                }
1367            }
1368            // update chunk id map of other list
1369            if (!(*pNewParent->pSubChunksMap)[pSrc->GetChunkID()])
1370                (*pNewParent->pSubChunksMap)[pSrc->GetChunkID()] = pSrc;
1371        }
1372    
1373      /** @brief Creates a new list sub chunk.      /** @brief Creates a new list sub chunk.
1374       *       *
1375       * Creates and adds a new list sub chunk to this list chunk. Note that       * Creates and adds a new list sub chunk to this list chunk. Note that
# Line 1090  namespace RIFF { Line 1384  namespace RIFF {
1384          List* pNewListChunk = new List(pFile, this, uiListType);          List* pNewListChunk = new List(pFile, this, uiListType);
1385          pSubChunks->push_back(pNewListChunk);          pSubChunks->push_back(pNewListChunk);
1386          (*pSubChunksMap)[CHUNK_ID_LIST] = pNewListChunk;          (*pSubChunksMap)[CHUNK_ID_LIST] = pNewListChunk;
1387            ullNewChunkSize += LIST_HEADER_SIZE(pFile->FileOffsetSize);
1388          return pNewListChunk;          return pNewListChunk;
1389      }      }
1390    
# Line 1097  namespace RIFF { Line 1392  namespace RIFF {
1392       *       *
1393       * Removes the sub chunk given by \a pSubChunk from this list and frees       * Removes the sub chunk given by \a pSubChunk from this list and frees
1394       * it completely from RAM. The given chunk can either be a normal sub       * it completely from RAM. The given chunk can either be a normal sub
1395       * chunk or a list sub chunk. You should call File::Save() to make this       * chunk or a list sub chunk. In case the given chunk is a list chunk,
1396       * change persistent at any time.       * all its subchunks (if any) will be removed recursively as well. You
1397         * should call File::Save() to make this change persistent at any time.
1398       *       *
1399       * @param pSubChunk - sub chunk or sub list chunk to be removed       * @param pSubChunk - sub chunk or sub list chunk to be removed
1400       */       */
# Line 1120  namespace RIFF { Line 1416  namespace RIFF {
1416          delete pSubChunk;          delete pSubChunk;
1417      }      }
1418    
1419      void List::ReadHeader(unsigned long fPos) {      /**
1420        #if DEBUG       *  Returns the actual total size in bytes (including List chunk header and
1421        std::cout << "List::Readheader(ulong) ";       *  all subchunks) of this List Chunk if being stored to a file.
1422        #endif // DEBUG       *
1423          Chunk::ReadHeader(fPos);       *  @param fileOffsetSize - RIFF file offset size (in bytes) assumed when
1424          NewChunkSize = CurrentChunkSize -= 4;       *                          being saved to a file
1425         */
1426        file_offset_t List::RequiredPhysicalSize(int fileOffsetSize) {
1427            if (!pSubChunks) LoadSubChunks();
1428            file_offset_t size = LIST_HEADER_SIZE(fileOffsetSize);
1429            ChunkList::iterator iter = pSubChunks->begin();
1430            ChunkList::iterator end  = pSubChunks->end();
1431            for (; iter != end; ++iter)
1432                size += (*iter)->RequiredPhysicalSize(fileOffsetSize);
1433            return size;
1434        }
1435    
1436        void List::ReadHeader(file_offset_t filePos) {
1437            #if DEBUG_RIFF
1438            std::cout << "List::Readheader(file_offset_t) ";
1439            #endif // DEBUG_RIFF
1440            Chunk::ReadHeader(filePos);
1441            if (ullCurrentChunkSize < 4) return;
1442            ullNewChunkSize = ullCurrentChunkSize -= 4;
1443          #if POSIX          #if POSIX
1444          lseek(pFile->hFileRead, fPos + CHUNK_HEADER_SIZE, SEEK_SET);          lseek(pFile->hFileRead, filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize), SEEK_SET);
1445          read(pFile->hFileRead, &ListType, 4);          read(pFile->hFileRead, &ListType, 4);
1446            #elif defined(WIN32)
1447            LARGE_INTEGER liFilePos;
1448            liFilePos.QuadPart = filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize);
1449            SetFilePointerEx(pFile->hFileRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
1450            DWORD dwBytesRead;
1451            ReadFile(pFile->hFileRead, &ListType, 4, &dwBytesRead, NULL);
1452          #else          #else
1453          fseek(pFile->hFileRead, fPos + CHUNK_HEADER_SIZE, SEEK_SET);          fseeko(pFile->hFileRead, filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize), SEEK_SET);
1454          fread(&ListType, 4, 1, pFile->hFileRead);          fread(&ListType, 4, 1, pFile->hFileRead);
1455          #endif // POSIX          #endif // POSIX
1456        #if DEBUG          #if DEBUG_RIFF
1457        std::cout << "listType=" << convertToString(ListType) << std::endl;          std::cout << "listType=" << convertToString(ListType) << std::endl;
1458        #endif // DEBUG          #endif // DEBUG_RIFF
1459          if (!pFile->bEndianNative) {          if (!pFile->bEndianNative) {
1460              //swapBytes_32(&ListType);              //swapBytes_32(&ListType);
1461          }          }
1462      }      }
1463    
1464      void List::WriteHeader(unsigned long fPos) {      void List::WriteHeader(file_offset_t filePos) {
1465          // the four list type bytes officially belong the chunk's body in the RIFF format          // the four list type bytes officially belong the chunk's body in the RIFF format
1466          NewChunkSize += 4;          ullNewChunkSize += 4;
1467          Chunk::WriteHeader(fPos);          Chunk::WriteHeader(filePos);
1468          NewChunkSize -= 4; // just revert the +4 incrementation          ullNewChunkSize -= 4; // just revert the +4 incrementation
1469          #if POSIX          #if POSIX
1470          lseek(pFile->hFileWrite, fPos + CHUNK_HEADER_SIZE, SEEK_SET);          lseek(pFile->hFileWrite, filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize), SEEK_SET);
1471          write(pFile->hFileWrite, &ListType, 4);          write(pFile->hFileWrite, &ListType, 4);
1472            #elif defined(WIN32)
1473            LARGE_INTEGER liFilePos;
1474            liFilePos.QuadPart = filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize);
1475            SetFilePointerEx(pFile->hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
1476            DWORD dwBytesWritten;
1477            WriteFile(pFile->hFileWrite, &ListType, 4, &dwBytesWritten, NULL);
1478          #else          #else
1479          fseek(pFile->hFileWrite, fPos + CHUNK_HEADER_SIZE, SEEK_SET);          fseeko(pFile->hFileWrite, filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize), SEEK_SET);
1480          fwrite(&ListType, 4, 1, pFile->hFileWrite);          fwrite(&ListType, 4, 1, pFile->hFileWrite);
1481          #endif // POSIX          #endif // POSIX
1482      }      }
1483    
1484      void List::LoadSubChunks() {      void List::LoadSubChunks(progress_t* pProgress) {
1485         #if DEBUG          #if DEBUG_RIFF
1486         std::cout << "List::LoadSubChunks()";          std::cout << "List::LoadSubChunks()";
1487         #endif // DEBUG          #endif // DEBUG_RIFF
1488          if (!pSubChunks) {          if (!pSubChunks) {
1489              pSubChunks    = new ChunkList();              pSubChunks    = new ChunkList();
1490              pSubChunksMap = new ChunkMap();              pSubChunksMap = new ChunkMap();
1491                #if defined(WIN32)
1492                if (pFile->hFileRead == INVALID_HANDLE_VALUE) return;
1493                #else
1494              if (!pFile->hFileRead) return;              if (!pFile->hFileRead) return;
1495              unsigned long uiOriginalPos = GetPos();              #endif
1496                file_offset_t ullOriginalPos = GetPos();
1497              SetPos(0); // jump to beginning of list chunk body              SetPos(0); // jump to beginning of list chunk body
1498              while (RemainingBytes() >= CHUNK_HEADER_SIZE) {              while (RemainingBytes() >= CHUNK_HEADER_SIZE(pFile->FileOffsetSize)) {
1499                  Chunk* ck;                  Chunk* ck;
1500                  uint32_t ckid;                  uint32_t ckid;
1501                  Read(&ckid, 4, 1);                  // return value check is required here to prevent a potential
1502         #if DEBUG                  // garbage data use of 'ckid' below in case Read() failed
1503         std::cout << " ckid=" << convertToString(ckid) << std::endl;                  if (Read(&ckid, 4, 1) != 4)
1504         #endif // DEBUG                      throw Exception("LoadSubChunks(): Failed reading RIFF chunk ID");
1505                    #if DEBUG_RIFF
1506                    std::cout << " ckid=" << convertToString(ckid) << std::endl;
1507                    #endif // DEBUG_RIFF
1508                  if (ckid == CHUNK_ID_LIST) {                  if (ckid == CHUNK_ID_LIST) {
1509                      ck = new RIFF::List(pFile, ulStartPos + ulPos - 4, this);                      ck = new RIFF::List(pFile, ullStartPos + ullPos - 4, this);
1510                      SetPos(ck->GetSize() + LIST_HEADER_SIZE - 4, RIFF::stream_curpos);                      SetPos(ck->GetSize() + LIST_HEADER_SIZE(pFile->FileOffsetSize) - 4, RIFF::stream_curpos);
1511                  }                  }
1512                  else { // simple chunk                  else { // simple chunk
1513                      ck = new RIFF::Chunk(pFile, ulStartPos + ulPos - 4, this);                      ck = new RIFF::Chunk(pFile, ullStartPos + ullPos - 4, this);
1514                      SetPos(ck->GetSize() + CHUNK_HEADER_SIZE - 4, RIFF::stream_curpos);                      SetPos(ck->GetSize() + CHUNK_HEADER_SIZE(pFile->FileOffsetSize) - 4, RIFF::stream_curpos);
1515                  }                  }
1516                  pSubChunks->push_back(ck);                  pSubChunks->push_back(ck);
1517                  (*pSubChunksMap)[ckid] = ck;                  (*pSubChunksMap)[ckid] = ck;
1518                  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
1519              }              }
1520              SetPos(uiOriginalPos); // restore position before this call              SetPos(ullOriginalPos); // restore position before this call
1521          }          }
1522            if (pProgress)
1523                __notify_progress(pProgress, 1.0); // notify done
1524        }
1525    
1526        void List::LoadSubChunksRecursively(progress_t* pProgress) {
1527            const int n = (int) CountSubLists();
1528            int i = 0;
1529            for (List* pList = GetFirstSubList(); pList; pList = GetNextSubList(), ++i) {
1530                if (pProgress) {
1531                    // divide local progress into subprogress
1532                    progress_t subprogress;
1533                    __divide_progress(pProgress, &subprogress, n, i);
1534                    // do the actual work
1535                    pList->LoadSubChunksRecursively(&subprogress);
1536                } else
1537                    pList->LoadSubChunksRecursively(NULL);
1538            }
1539            if (pProgress)
1540                __notify_progress(pProgress, 1.0); // notify done
1541      }      }
1542    
1543      /** @brief Write list chunk persistently e.g. to disk.      /** @brief Write list chunk persistently e.g. to disk.
# Line 1194  namespace RIFF { Line 1546  namespace RIFF {
1546       * subchunks (including sub list chunks) will be stored recursively as       * subchunks (including sub list chunks) will be stored recursively as
1547       * well.       * well.
1548       *       *
1549       * @param ulWritePos - position within the "physical" file where this       * @param ullWritePos - position within the "physical" file where this
1550       *                     list chunk should be written to       *                     list chunk should be written to
1551       * @param ulCurrentDataOffset - offset of current (old) data within       * @param ullCurrentDataOffset - offset of current (old) data within
1552       *                              the file       *                              the file
1553         * @param pProgress - optional: callback function for progress notification
1554       * @returns new write position in the "physical" file, that is       * @returns new write position in the "physical" file, that is
1555       *          \a ulWritePos incremented by this list chunk's new size       *          \a ullWritePos incremented by this list chunk's new size
1556       *          (including its header size of course)       *          (including its header size of course)
1557       */       */
1558      unsigned long List::WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset) {      file_offset_t List::WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t* pProgress) {
1559          const unsigned long ulOriginalPos = ulWritePos;          const file_offset_t ullOriginalPos = ullWritePos;
1560          ulWritePos += LIST_HEADER_SIZE;          ullWritePos += LIST_HEADER_SIZE(pFile->FileOffsetSize);
1561    
1562          if (pFile->Mode != stream_mode_read_write)          if (pFile->Mode != stream_mode_read_write)
1563              throw Exception("Cannot write list chunk, file has to be opened in read+write mode");              throw Exception("Cannot write list chunk, file has to be opened in read+write mode");
1564    
1565          // write all subchunks (including sub list chunks) recursively          // write all subchunks (including sub list chunks) recursively
1566          if (pSubChunks) {          if (pSubChunks) {
1567              for (ChunkList::iterator iter = pSubChunks->begin(), end = pSubChunks->end(); iter != end; ++iter) {              size_t i = 0;
1568                  ulWritePos = (*iter)->WriteChunk(ulWritePos, ulCurrentDataOffset);              const size_t n = pSubChunks->size();
1569                for (ChunkList::iterator iter = pSubChunks->begin(), end = pSubChunks->end(); iter != end; ++iter, ++i) {
1570                    if (pProgress) {
1571                        // divide local progress into subprogress for loading current Instrument
1572                        progress_t subprogress;
1573                        __divide_progress(pProgress, &subprogress, n, i);
1574                        // do the actual work
1575                        ullWritePos = (*iter)->WriteChunk(ullWritePos, ullCurrentDataOffset, &subprogress);
1576                    } else
1577                        ullWritePos = (*iter)->WriteChunk(ullWritePos, ullCurrentDataOffset, NULL);
1578              }              }
1579          }          }
1580    
1581          // update this list chunk's header          // update this list chunk's header
1582          CurrentChunkSize = NewChunkSize = ulWritePos - ulOriginalPos - LIST_HEADER_SIZE;          ullCurrentChunkSize = ullNewChunkSize = ullWritePos - ullOriginalPos - LIST_HEADER_SIZE(pFile->FileOffsetSize);
1583          WriteHeader(ulOriginalPos);          WriteHeader(ullOriginalPos);
1584    
1585          // offset of this list chunk in new written file may have changed          // offset of this list chunk in new written file may have changed
1586          ulStartPos = ulOriginalPos + LIST_HEADER_SIZE;          ullStartPos = ullOriginalPos + LIST_HEADER_SIZE(pFile->FileOffsetSize);
1587    
1588            if (pProgress)
1589                __notify_progress(pProgress, 1.0); // notify done
1590    
1591          return ulWritePos;          return ullWritePos;
1592      }      }
1593    
1594      void List::__resetPos() {      void List::__resetPos() {
# Line 1238  namespace RIFF { Line 1603  namespace RIFF {
1603      /**      /**
1604       *  Returns string representation of the lists's id       *  Returns string representation of the lists's id
1605       */       */
1606      String List::GetListTypeString() {      String List::GetListTypeString() const {
1607          return convertToString(ListType);          return convertToString(ListType);
1608      }      }
1609    
# Line 1253  namespace RIFF { Line 1618  namespace RIFF {
1618       * "from scratch". Note: there must be no empty chunks or empty list       * "from scratch". Note: there must be no empty chunks or empty list
1619       * chunks when trying to make the new RIFF file persistent with Save()!       * chunks when trying to make the new RIFF file persistent with Save()!
1620       *       *
1621         * Note: by default, the RIFF file will be saved in native endian
1622         * format; that is, as a RIFF file on little-endian machines and
1623         * as a RIFX file on big-endian. To change this behaviour, call
1624         * SetByteOrder() before calling Save().
1625         *
1626       * @param FileType - four-byte identifier of the RIFF file type       * @param FileType - four-byte identifier of the RIFF file type
1627       * @see AddSubChunk(), AddSubList()       * @see AddSubChunk(), AddSubList(), SetByteOrder()
1628       */       */
1629      File::File(uint32_t FileType) : List(this) {      File::File(uint32_t FileType)
1630            : List(this), bIsNewFile(true), Layout(layout_standard),
1631              FileOffsetPreference(offset_size_auto)
1632        {
1633            #if defined(WIN32)
1634            hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
1635            #else
1636          hFileRead = hFileWrite = 0;          hFileRead = hFileWrite = 0;
1637            #endif
1638          Mode = stream_mode_closed;          Mode = stream_mode_closed;
1639          bEndianNative = true;          bEndianNative = true;
         ulStartPos = RIFF_HEADER_SIZE;  
1640          ListType = FileType;          ListType = FileType;
1641            FileOffsetSize = 4;
1642            ullStartPos = RIFF_HEADER_SIZE(FileOffsetSize);
1643      }      }
1644    
1645      /** @brief Load existing RIFF file.      /** @brief Load existing RIFF file.
# Line 1269  namespace RIFF { Line 1647  namespace RIFF {
1647       * Loads an existing RIFF file with all its chunks.       * Loads an existing RIFF file with all its chunks.
1648       *       *
1649       * @param path - path and file name of the RIFF file to open       * @param path - path and file name of the RIFF file to open
1650       * @throws RIFF::Exception if error occured while trying to load the       * @throws RIFF::Exception if error occurred while trying to load the
1651       *                         given RIFF file       *                         given RIFF file
1652       */       */
1653      File::File(const String& path) : List(this), Filename(path) {      File::File(const String& path)
1654        #if DEBUG          : List(this), Filename(path), bIsNewFile(false), Layout(layout_standard),
1655        std::cout << "File::File("<<path<<")" << std::endl;            FileOffsetPreference(offset_size_auto)
1656        #endif // DEBUG      {
1657            #if DEBUG_RIFF
1658            std::cout << "File::File("<<path<<")" << std::endl;
1659            #endif // DEBUG_RIFF
1660          bEndianNative = true;          bEndianNative = true;
1661            FileOffsetSize = 4;
1662            try {
1663                __openExistingFile(path);
1664                if (ChunkID != CHUNK_ID_RIFF && ChunkID != CHUNK_ID_RIFX) {
1665                    throw RIFF::Exception("Not a RIFF file");
1666                }
1667            }
1668            catch (...) {
1669                Cleanup();
1670                throw;
1671            }
1672        }
1673    
1674        /** @brief Load existing RIFF-like file.
1675         *
1676         * Loads an existing file, which is not a "real" RIFF file, but similar to
1677         * an ordinary RIFF file.
1678         *
1679         * A "real" RIFF file contains at top level a List chunk either with chunk
1680         * ID "RIFF" or "RIFX". The simple constructor above expects this to be
1681         * case, and if it finds the toplevel List chunk to have another chunk ID
1682         * than one of those two expected ones, it would throw an Exception and
1683         * would refuse to load the file accordingly.
1684         *
1685         * Since there are however a lot of file formats which use the same simple
1686         * principles of the RIFF format, with another toplevel List chunk ID
1687         * though, you can use this alternative constructor here to be able to load
1688         * and handle those files in the same way as you would do with "real" RIFF
1689         * files.
1690         *
1691         * @param path - path and file name of the RIFF-alike file to be opened
1692         * @param FileType - expected toplevel List chunk ID (this is the very
1693         *                   first chunk found in the file)
1694         * @param Endian - whether the file uses little endian or big endian layout
1695         * @param layout - general file structure type
1696         * @param fileOffsetSize - (optional) preference how to deal with large files
1697         * @throws RIFF::Exception if error occurred while trying to load the
1698         *                         given RIFF-alike file
1699         */
1700        File::File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout, offset_size_t fileOffsetSize)
1701            : List(this), Filename(path), bIsNewFile(false), Layout(layout),
1702              FileOffsetPreference(fileOffsetSize)
1703        {
1704            SetByteOrder(Endian);
1705            if (fileOffsetSize < offset_size_auto || fileOffsetSize > offset_size_64bit)
1706                throw Exception("Invalid RIFF::offset_size_t");
1707            FileOffsetSize = 4;
1708            try {
1709                __openExistingFile(path, &FileType);
1710            }
1711            catch (...) {
1712                Cleanup();
1713                throw;
1714            }
1715        }
1716    
1717        /**
1718         * Opens an already existing RIFF file or RIFF-alike file. This method
1719         * shall only be called once (in a File class constructor).
1720         *
1721         * @param path - path and file name of the RIFF file or RIFF-alike file to
1722         *               be opened
1723         * @param FileType - (optional) expected chunk ID of first chunk in file
1724         * @throws RIFF::Exception if error occurred while trying to load the
1725         *                         given RIFF file or RIFF-alike file
1726         */
1727        void File::__openExistingFile(const String& path, uint32_t* FileType) {
1728          #if POSIX          #if POSIX
1729          hFileRead = hFileWrite = open(path.c_str(), O_RDONLY | O_NONBLOCK);          hFileRead = hFileWrite = open(path.c_str(), O_RDONLY | O_NONBLOCK);
1730          if (hFileRead <= 0) {          if (hFileRead == -1) {
1731              hFileRead = hFileWrite = 0;              hFileRead = hFileWrite = 0;
1732                String sError = strerror(errno);
1733                throw RIFF::Exception("Can't open \"" + path + "\": " + sError);
1734            }
1735            #elif defined(WIN32)
1736            hFileRead = hFileWrite = CreateFile(
1737                                         path.c_str(), GENERIC_READ,
1738                                         FILE_SHARE_READ | FILE_SHARE_WRITE,
1739                                         NULL, OPEN_EXISTING,
1740                                         FILE_ATTRIBUTE_NORMAL |
1741                                         FILE_FLAG_RANDOM_ACCESS, NULL
1742                                     );
1743            if (hFileRead == INVALID_HANDLE_VALUE) {
1744                hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
1745              throw RIFF::Exception("Can't open \"" + path + "\"");              throw RIFF::Exception("Can't open \"" + path + "\"");
1746          }          }
1747          #else          #else
1748          hFileRead = hFileWrite = fopen(path.c_str(), "rb");          hFileRead = hFileWrite = fopen(path.c_str(), "rb");
1749          if (!hFile) throw RIFF::Exception("Can't open \"" + path + "\"");          if (!hFileRead) throw RIFF::Exception("Can't open \"" + path + "\"");
1750          #endif // POSIX          #endif // POSIX
1751          Mode = stream_mode_read;          Mode = stream_mode_read;
1752          ulStartPos = RIFF_HEADER_SIZE;  
1753          ReadHeader(0);          // determine RIFF file offset size to be used (in RIFF chunk headers)
1754          if (ChunkID != CHUNK_ID_RIFF) {          // according to the current file offset preference
1755              throw RIFF::Exception("Not a RIFF file");          FileOffsetSize = FileOffsetSizeFor(GetCurrentFileSize());
1756    
1757            switch (Layout) {
1758                case layout_standard: // this is a normal RIFF file
1759                    ullStartPos = RIFF_HEADER_SIZE(FileOffsetSize);
1760                    ReadHeader(0);
1761                    if (FileType && ChunkID != *FileType)
1762                        throw RIFF::Exception("Invalid file container ID");
1763                    break;
1764                case layout_flat: // non-standard RIFF-alike file
1765                    ullStartPos = 0;
1766                    ullNewChunkSize = ullCurrentChunkSize = GetCurrentFileSize();
1767                    if (FileType) {
1768                        uint32_t ckid;
1769                        if (Read(&ckid, 4, 1) != 4) {
1770                            throw RIFF::Exception("Invalid file header ID (premature end of header)");
1771                        } else if (ckid != *FileType) {
1772                            String s = " (expected '" + convertToString(*FileType) + "' but got '" + convertToString(ckid) + "')";
1773                            throw RIFF::Exception("Invalid file header ID" + s);
1774                        }
1775                        SetPos(0); // reset to first byte of file
1776                    }
1777                    LoadSubChunks();
1778                    break;
1779          }          }
1780      }      }
1781    
1782      String File::GetFileName() {      String File::GetFileName() const {
1783          return Filename;          return Filename;
1784      }      }
1785        
1786        void File::SetFileName(const String& path) {
1787            Filename = path;
1788        }
1789    
1790      stream_mode_t File::GetMode() {      stream_mode_t File::GetMode() const {
1791          return Mode;          return Mode;
1792      }      }
1793    
1794        layout_t File::GetLayout() const {
1795            return Layout;
1796        }
1797    
1798      /** @brief Change file access mode.      /** @brief Change file access mode.
1799       *       *
1800       * Changes files access mode either to read-only mode or to read/write       * Changes files access mode either to read-only mode or to read/write
# Line 1311  namespace RIFF { Line 1803  namespace RIFF {
1803       * @param NewMode - new file access mode       * @param NewMode - new file access mode
1804       * @returns true if mode was changed, false if current mode already       * @returns true if mode was changed, false if current mode already
1805       *          equals new mode       *          equals new mode
1806       * @throws RIFF::Exception if new file access mode is unknown       * @throws RIFF::Exception if file could not be opened in requested file
1807         *         access mode or if passed access mode is unknown
1808       */       */
1809      bool File::SetMode(stream_mode_t NewMode) {      bool File::SetMode(stream_mode_t NewMode) {
1810          if (NewMode != Mode) {          if (NewMode != Mode) {
# Line 1320  namespace RIFF { Line 1813  namespace RIFF {
1813                      #if POSIX                      #if POSIX
1814                      if (hFileRead) close(hFileRead);                      if (hFileRead) close(hFileRead);
1815                      hFileRead = hFileWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);                      hFileRead = hFileWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);
1816                      if (hFileRead < 0) {                      if (hFileRead == -1) {
1817                          hFileRead = hFileWrite = 0;                          hFileRead = hFileWrite = 0;
1818                            String sError = strerror(errno);
1819                            throw Exception("Could not (re)open file \"" + Filename + "\" in read mode: " + sError);
1820                        }
1821                        #elif defined(WIN32)
1822                        if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
1823                        hFileRead = hFileWrite = CreateFile(
1824                                                     Filename.c_str(), GENERIC_READ,
1825                                                     FILE_SHARE_READ | FILE_SHARE_WRITE,
1826                                                     NULL, OPEN_EXISTING,
1827                                                     FILE_ATTRIBUTE_NORMAL |
1828                                                     FILE_FLAG_RANDOM_ACCESS,
1829                                                     NULL
1830                                                 );
1831                        if (hFileRead == INVALID_HANDLE_VALUE) {
1832                            hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
1833                          throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");                          throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");
1834                      }                      }
1835                      #else                      #else
1836                      if (hFileRead) fclose(hFileRead);                      if (hFileRead) fclose(hFileRead);
1837                      hFileRead = hFileWrite = fopen(path.c_str(), "rb");                      hFileRead = hFileWrite = fopen(Filename.c_str(), "rb");
1838                      if (!hFileRead) throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");                      if (!hFileRead) throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");
1839                      #endif                      #endif
1840                      __resetPos(); // reset read/write position of ALL 'Chunk' objects                      __resetPos(); // reset read/write position of ALL 'Chunk' objects
# Line 1335  namespace RIFF { Line 1843  namespace RIFF {
1843                      #if POSIX                      #if POSIX
1844                      if (hFileRead) close(hFileRead);                      if (hFileRead) close(hFileRead);
1845                      hFileRead = hFileWrite = open(Filename.c_str(), O_RDWR | O_NONBLOCK);                      hFileRead = hFileWrite = open(Filename.c_str(), O_RDWR | O_NONBLOCK);
1846                      if (hFileRead < 0) {                      if (hFileRead == -1) {
1847                          hFileRead = hFileWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);                          hFileRead = hFileWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);
1848                          throw Exception("Could not open file \"" + Filename + "\" in read+write mode");                          String sError = strerror(errno);
1849                            throw Exception("Could not open file \"" + Filename + "\" in read+write mode: " + sError);
1850                        }
1851                        #elif defined(WIN32)
1852                        if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
1853                        hFileRead = hFileWrite = CreateFile(
1854                                                     Filename.c_str(),
1855                                                     GENERIC_READ | GENERIC_WRITE,
1856                                                     FILE_SHARE_READ,
1857                                                     NULL, OPEN_ALWAYS,
1858                                                     FILE_ATTRIBUTE_NORMAL |
1859                                                     FILE_FLAG_RANDOM_ACCESS,
1860                                                     NULL
1861                                                 );
1862                        if (hFileRead == INVALID_HANDLE_VALUE) {
1863                            hFileRead = hFileWrite = CreateFile(
1864                                                         Filename.c_str(), GENERIC_READ,
1865                                                         FILE_SHARE_READ | FILE_SHARE_WRITE,
1866                                                         NULL, OPEN_EXISTING,
1867                                                         FILE_ATTRIBUTE_NORMAL |
1868                                                         FILE_FLAG_RANDOM_ACCESS,
1869                                                         NULL
1870                                                     );
1871                            throw Exception("Could not (re)open file \"" + Filename + "\" in read+write mode");
1872                      }                      }
1873                      #else                      #else
1874                      if (hFileRead) fclose(hFileRead);                      if (hFileRead) fclose(hFileRead);
1875                      hFileRead = hFileWrite = fopen(path.c_str(), "r+b");                      hFileRead = hFileWrite = fopen(Filename.c_str(), "r+b");
1876                      if (!hFileRead) {                      if (!hFileRead) {
1877                          hFileRead = hFileWrite = fopen(path.c_str(), "rb");                          hFileRead = hFileWrite = fopen(Filename.c_str(), "rb");
1878                          throw Exception("Could not open file \"" + Filename + "\" in read+write mode");                          throw Exception("Could not open file \"" + Filename + "\" in read+write mode");
1879                      }                      }
1880                      #endif                      #endif
# Line 1353  namespace RIFF { Line 1884  namespace RIFF {
1884                      #if POSIX                      #if POSIX
1885                      if (hFileRead)  close(hFileRead);                      if (hFileRead)  close(hFileRead);
1886                      if (hFileWrite) close(hFileWrite);                      if (hFileWrite) close(hFileWrite);
1887                        hFileRead = hFileWrite = 0;
1888                        #elif defined(WIN32)
1889                        if (hFileRead  != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
1890                        if (hFileWrite != INVALID_HANDLE_VALUE) CloseHandle(hFileWrite);
1891                        hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
1892                      #else                      #else
1893                      if (hFileRead)  fclose(hFileRead);                      if (hFileRead)  fclose(hFileRead);
1894                      if (hFileWrite) fclose(hFileWrite);                      if (hFileWrite) fclose(hFileWrite);
1895                        hFileRead = hFileWrite = NULL;
1896                      #endif                      #endif
                     hFileRead = hFileWrite = 0;  
1897                      break;                      break;
1898                  default:                  default:
1899                      throw Exception("Unknown file access mode");                      throw Exception("Unknown file access mode");
# Line 1368  namespace RIFF { Line 1904  namespace RIFF {
1904          return false;          return false;
1905      }      }
1906    
1907        /** @brief Set the byte order to be used when saving.
1908         *
1909         * Set the byte order to be used in the file. A value of
1910         * endian_little will create a RIFF file, endian_big a RIFX file
1911         * and endian_native will create a RIFF file on little-endian
1912         * machines and RIFX on big-endian machines.
1913         *
1914         * @param Endian - endianess to use when file is saved.
1915         */
1916        void File::SetByteOrder(endian_t Endian) {
1917            #if WORDS_BIGENDIAN
1918            bEndianNative = Endian != endian_little;
1919            #else
1920            bEndianNative = Endian != endian_big;
1921            #endif
1922        }
1923    
1924      /** @brief Save changes to same file.      /** @brief Save changes to same file.
1925       *       *
1926       * Make all changes of all chunks persistent by writing them to the       * Make all changes of all chunks persistent by writing them to the
1927       * actual (same) file. The file might temporarily grow to a higher size       * actual (same) file.
      * than it will have at the end of the saving process, in case chunks  
      * were grown.  
1928       *       *
1929         * @param pProgress - optional: callback function for progress notification
1930       * @throws RIFF::Exception if there is an empty chunk or empty list       * @throws RIFF::Exception if there is an empty chunk or empty list
1931       *                         chunk or any kind of IO error occured       *                         chunk or any kind of IO error occurred
1932       */       */
1933      void File::Save() {      void File::Save(progress_t* pProgress) {
1934            //TODO: implementation for the case where first chunk is not a global container (List chunk) is not implemented yet (i.e. Korg files)
1935            if (Layout == layout_flat)
1936                throw Exception("Saving a RIFF file with layout_flat is not implemented yet");
1937    
1938            // make sure the RIFF tree is built (from the original file)
1939            if (pProgress) {
1940                // divide progress into subprogress
1941                progress_t subprogress;
1942                __divide_progress(pProgress, &subprogress, 3.f, 0.f); // arbitrarily subdivided into 1/3 of total progress
1943                // do the actual work
1944                LoadSubChunksRecursively(&subprogress);
1945                // notify subprogress done
1946                __notify_progress(&subprogress, 1.f);
1947            } else
1948                LoadSubChunksRecursively(NULL);
1949    
1950          // reopen file in write mode          // reopen file in write mode
1951          SetMode(stream_mode_read_write);          SetMode(stream_mode_read_write);
1952    
1953            // get the current file size as it is now still physically stored on disk
1954            const file_offset_t workingFileSize = GetCurrentFileSize();
1955    
1956            // get the overall file size required to save this file
1957            const file_offset_t newFileSize = GetRequiredFileSize(FileOffsetPreference);
1958    
1959            // determine whether this file will yield in a large file (>=4GB) and
1960            // the RIFF file offset size to be used accordingly for all chunks
1961            FileOffsetSize = FileOffsetSizeFor(newFileSize);
1962    
1963          // to be able to save the whole file without loading everything into          // to be able to save the whole file without loading everything into
1964          // RAM and without having to store the data in a temporary file, we          // RAM and without having to store the data in a temporary file, we
1965          // enlarge the file with the sum of all _positive_ chunk size          // enlarge the file with the overall positive file size change,
1966          // changes, move current data towards the end of the file with the          // then move current data towards the end of the file by the calculated
1967          // calculated sum and finally update / rewrite the file by copying          // positive file size difference and finally update / rewrite the file
1968          // the old data back to the right position at the beginning of the file          // by copying the old data back to the right position at the beginning
1969            // of the file
         // first we sum up all positive chunk size changes (and skip all negative ones)  
         unsigned long ulPositiveSizeDiff = 0;  
         for (ChunkList::iterator iter = ResizedChunks.begin(), end = ResizedChunks.end(); iter != end; ++iter) {  
             if ((*iter)->GetNewSize() == 0) throw Exception("There is at least one empty chunk (zero size)");  
             if ((*iter)->GetNewSize() + 1L > (*iter)->GetSize()) {  
                 unsigned long ulDiff = (*iter)->GetNewSize() - (*iter)->GetSize() + 1L; // +1 in case we have to add a pad byte  
                 ulPositiveSizeDiff += ulDiff;  
             }  
         }  
   
         unsigned long ulWorkingFileSize = GetFileSize();  
1970    
1971          // if there are positive size changes...          // if there are positive size changes...
1972          if (ulPositiveSizeDiff > 0) {          file_offset_t positiveSizeDiff = 0;
1973            if (newFileSize > workingFileSize) {
1974                positiveSizeDiff = newFileSize - workingFileSize;
1975    
1976                // divide progress into subprogress
1977                progress_t subprogress;
1978                if (pProgress)
1979                    __divide_progress(pProgress, &subprogress, 3.f, 1.f); // arbitrarily subdivided into 1/3 of total progress
1980    
1981              // ... we enlarge this file first ...              // ... we enlarge this file first ...
1982              ulWorkingFileSize += ulPositiveSizeDiff;              ResizeFile(newFileSize);
1983              ResizeFile(ulWorkingFileSize);  
1984              // ... and move current data by the same amount towards end of file.              // ... and move current data by the same amount towards end of file.
1985              int8_t* pCopyBuffer = new int8_t[4096];              int8_t* pCopyBuffer = new int8_t[4096];
1986              const unsigned long ulFileSize = GetSize() + RIFF_HEADER_SIZE;              #if defined(WIN32)
1987              int iBytesMoved = 1;              DWORD iBytesMoved = 1; // we have to pass it via pointer to the Windows API, thus the correct size must be ensured
1988              for (unsigned long ulPos = 0; iBytesMoved > 0; ulPos += iBytesMoved) {              #else
1989                  const unsigned long ulToMove = ulFileSize - ulPos;              ssize_t iBytesMoved = 1;
1990                  iBytesMoved = (ulToMove < 4096) ? ulToMove : 4096;              #endif
1991                for (file_offset_t ullPos = workingFileSize, iNotif = 0; iBytesMoved > 0; ++iNotif) {
1992                    iBytesMoved = (ullPos < 4096) ? ullPos : 4096;
1993                    ullPos -= iBytesMoved;
1994                  #if POSIX                  #if POSIX
1995                  lseek(hFileRead, ulPos, SEEK_SET);                  lseek(hFileRead, ullPos, SEEK_SET);
1996                  iBytesMoved = read(hFileRead, pCopyBuffer, iBytesMoved);                  iBytesMoved = read(hFileRead, pCopyBuffer, iBytesMoved);
1997                  lseek(hFileWrite, ulPos + ulPositiveSizeDiff, SEEK_SET);                  lseek(hFileWrite, ullPos + positiveSizeDiff, SEEK_SET);
1998                  iBytesMoved = write(hFileWrite, pCopyBuffer, iBytesMoved);                  iBytesMoved = write(hFileWrite, pCopyBuffer, iBytesMoved);
1999                    #elif defined(WIN32)
2000                    LARGE_INTEGER liFilePos;
2001                    liFilePos.QuadPart = ullPos;
2002                    SetFilePointerEx(hFileRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
2003                    ReadFile(hFileRead, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
2004                    liFilePos.QuadPart = ullPos + positiveSizeDiff;
2005                    SetFilePointerEx(hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
2006                    WriteFile(hFileWrite, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
2007                  #else                  #else
2008                  fseek(hFileRead, ulPos, SEEK_SET);                  fseeko(hFileRead, ullPos, SEEK_SET);
2009                  iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, hFileRead);                  iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, hFileRead);
2010                  fseek(hFileWrite, ulPos + ulPositiveSizeDiff, SEEK_SET);                  fseeko(hFileWrite, ullPos + positiveSizeDiff, SEEK_SET);
2011                  iBytesMoved = fwrite(pCopyBuffer, 1, iBytesMoved, hFileWrite);                  iBytesMoved = fwrite(pCopyBuffer, 1, iBytesMoved, hFileWrite);
2012                  #endif                  #endif
2013                    if (pProgress && !(iNotif % 8) && iBytesMoved > 0)
2014                        __notify_progress(&subprogress, float(workingFileSize - ullPos) / float(workingFileSize));
2015              }              }
2016              delete[] pCopyBuffer;              delete[] pCopyBuffer;
2017              if (iBytesMoved < 0) throw Exception("Could not modify file while trying to enlarge it");              if (iBytesMoved < 0) throw Exception("Could not modify file while trying to enlarge it");
2018    
2019                if (pProgress)
2020                    __notify_progress(&subprogress, 1.f); // notify subprogress done
2021          }          }
2022    
2023          // rebuild / rewrite complete RIFF tree          // rebuild / rewrite complete RIFF tree ...
2024          unsigned long ulTotalSize  = WriteChunk(0, ulPositiveSizeDiff);  
2025          unsigned long ulActualSize = __GetFileSize(hFileWrite);          // divide progress into subprogress
2026            progress_t subprogress;
2027            if (pProgress)
2028                __divide_progress(pProgress, &subprogress, 3.f, 2.f); // arbitrarily subdivided into 1/3 of total progress
2029            // do the actual work
2030            const file_offset_t finalSize = WriteChunk(0, positiveSizeDiff, pProgress ? &subprogress : NULL);
2031            const file_offset_t finalActualSize = __GetFileSize(hFileWrite);
2032            // notify subprogress done
2033            if (pProgress)
2034                __notify_progress(&subprogress, 1.f);
2035    
2036          // resize file to the final size          // resize file to the final size
2037          if (ulTotalSize < ulActualSize) ResizeFile(ulTotalSize);          if (finalSize < finalActualSize) ResizeFile(finalSize);
2038    
2039          // forget all resized chunks          if (pProgress)
2040          ResizedChunks.clear();              __notify_progress(pProgress, 1.0); // notify done
2041      }      }
2042    
2043      /** @brief Save changes to another file.      /** @brief Save changes to another file.
# Line 1452  namespace RIFF { Line 2052  namespace RIFF {
2052       * the new file (given by \a path) afterwards.       * the new file (given by \a path) afterwards.
2053       *       *
2054       * @param path - path and file name where everything should be written to       * @param path - path and file name where everything should be written to
2055         * @param pProgress - optional: callback function for progress notification
2056       */       */
2057      void File::Save(const String& path) {      void File::Save(const String& path, progress_t* pProgress) {
2058          //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          //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
2059    
2060          if (Filename.length() > 0) SetMode(stream_mode_read);          //TODO: implementation for the case where first chunk is not a global container (List chunk) is not implemented yet (i.e. Korg files)
2061            if (Layout == layout_flat)
2062                throw Exception("Saving a RIFF file with layout_flat is not implemented yet");
2063    
2064            // make sure the RIFF tree is built (from the original file)
2065            if (pProgress) {
2066                // divide progress into subprogress
2067                progress_t subprogress;
2068                __divide_progress(pProgress, &subprogress, 2.f, 0.f); // arbitrarily subdivided into 1/2 of total progress
2069                // do the actual work
2070                LoadSubChunksRecursively(&subprogress);
2071                // notify subprogress done
2072                __notify_progress(&subprogress, 1.f);
2073            } else
2074                LoadSubChunksRecursively(NULL);
2075    
2076            if (!bIsNewFile) SetMode(stream_mode_read);
2077          // open the other (new) file for writing and truncate it to zero size          // open the other (new) file for writing and truncate it to zero size
2078          #if POSIX          #if POSIX
2079          hFileWrite = open(path.c_str(), O_RDWR | O_CREAT, S_IRUSR | S_IWUSR | S_IRGRP);          hFileWrite = open(path.c_str(), O_RDWR | O_CREAT, S_IRUSR | S_IWUSR | S_IRGRP);
2080          if (hFileWrite < 0) {          if (hFileWrite == -1) {
2081                hFileWrite = hFileRead;
2082                String sError = strerror(errno);
2083                throw Exception("Could not open file \"" + path + "\" for writing: " + sError);
2084            }
2085            #elif defined(WIN32)
2086            hFileWrite = CreateFile(
2087                             path.c_str(), GENERIC_WRITE, FILE_SHARE_READ,
2088                             NULL, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL |
2089                             FILE_FLAG_RANDOM_ACCESS, NULL
2090                         );
2091            if (hFileWrite == INVALID_HANDLE_VALUE) {
2092              hFileWrite = hFileRead;              hFileWrite = hFileRead;
2093              throw Exception("Could not open file \"" + path + "\" for writing");              throw Exception("Could not open file \"" + path + "\" for writing");
2094          }          }
# Line 1473  namespace RIFF { Line 2101  namespace RIFF {
2101          #endif // POSIX          #endif // POSIX
2102          Mode = stream_mode_read_write;          Mode = stream_mode_read_write;
2103    
2104            // get the overall file size required to save this file
2105            const file_offset_t newFileSize = GetRequiredFileSize(FileOffsetPreference);
2106    
2107            // determine whether this file will yield in a large file (>=4GB) and
2108            // the RIFF file offset size to be used accordingly for all chunks
2109            FileOffsetSize = FileOffsetSizeFor(newFileSize);
2110    
2111          // write complete RIFF tree to the other (new) file          // write complete RIFF tree to the other (new) file
2112          unsigned long ulTotalSize  = WriteChunk(0, 0);          file_offset_t ullTotalSize;
2113          unsigned long ulActualSize = __GetFileSize(hFileWrite);          if (pProgress) {
2114                // divide progress into subprogress
2115                progress_t subprogress;
2116                __divide_progress(pProgress, &subprogress, 2.f, 1.f); // arbitrarily subdivided into 1/2 of total progress
2117                // do the actual work
2118                ullTotalSize = WriteChunk(0, 0, &subprogress);
2119                // notify subprogress done
2120                __notify_progress(&subprogress, 1.f);
2121            } else
2122                ullTotalSize = WriteChunk(0, 0, NULL);
2123    
2124          // resize file to the final size (if the file was originally larger)          file_offset_t ullActualSize = __GetFileSize(hFileWrite);
         if (ulTotalSize < ulActualSize) ResizeFile(ulTotalSize);  
2125    
2126          // forget all resized chunks          // resize file to the final size (if the file was originally larger)
2127          ResizedChunks.clear();          if (ullActualSize > ullTotalSize) ResizeFile(ullTotalSize);
2128    
2129          if (Filename.length() > 0) {          #if POSIX
2130              #if POSIX          if (hFileWrite) close(hFileWrite);
2131              close(hFileWrite);          #elif defined(WIN32)
2132              #else          if (hFileWrite != INVALID_HANDLE_VALUE) CloseHandle(hFileWrite);
2133              fclose(hFileWrite);          #else
2134              #endif          if (hFileWrite) fclose(hFileWrite);
2135              hFileWrite = hFileRead;          #endif
2136          }          hFileWrite = hFileRead;
2137    
2138          // associate new file with this File object from now on          // associate new file with this File object from now on
2139          Filename = path;          Filename = path;
2140            bIsNewFile = false;
2141          Mode = (stream_mode_t) -1;       // Just set it to an undefined mode ...          Mode = (stream_mode_t) -1;       // Just set it to an undefined mode ...
2142          SetMode(stream_mode_read_write); // ... so SetMode() has to reopen the file handles.          SetMode(stream_mode_read_write); // ... so SetMode() has to reopen the file handles.
2143    
2144            if (pProgress)
2145                __notify_progress(pProgress, 1.0); // notify done
2146      }      }
2147    
2148      void File::ResizeFile(unsigned long ulNewSize) {      void File::ResizeFile(file_offset_t ullNewSize) {
2149          #if POSIX          #if POSIX
2150          if (ftruncate(hFileWrite, ulNewSize) < 0)          if (ftruncate(hFileWrite, ullNewSize) < 0)
2151              throw Exception("Could not resize file \"" + Filename + "\"");              throw Exception("Could not resize file \"" + Filename + "\"");
2152            #elif defined(WIN32)
2153            LARGE_INTEGER liFilePos;
2154            liFilePos.QuadPart = ullNewSize;
2155            if (
2156                !SetFilePointerEx(hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN) ||
2157                !SetEndOfFile(hFileWrite)
2158            ) throw Exception("Could not resize file \"" + Filename + "\"");
2159          #else          #else
2160          # error Sorry, this version of libgig only supports POSIX systems yet.          # error Sorry, this version of libgig only supports POSIX and Windows systems yet.
2161          # error Reason: portable implementation of RIFF::File::ResizeFile() is missing (yet)!          # error Reason: portable implementation of RIFF::File::ResizeFile() is missing (yet)!
2162          #endif          #endif
2163      }      }
2164    
2165      File::~File() {      File::~File() {
2166         #if DEBUG          #if DEBUG_RIFF
2167         std::cout << "File::~File()" << std::endl;          std::cout << "File::~File()" << std::endl;
2168         #endif // DEBUG          #endif // DEBUG_RIFF
2169            Cleanup();
2170        }
2171    
2172        /**
2173         * Returns @c true if this file has been created new from scratch and
2174         * has not been stored to disk yet.
2175         */
2176        bool File::IsNew() const {
2177            return bIsNewFile;
2178        }
2179    
2180        void File::Cleanup() {
2181          #if POSIX          #if POSIX
2182          if (hFileRead) close(hFileRead);          if (hFileRead) close(hFileRead);
2183            #elif defined(WIN32)
2184            if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
2185          #else          #else
2186          if (hFileRead) fclose(hFileRead);          if (hFileRead) fclose(hFileRead);
2187          #endif // POSIX          #endif // POSIX
2188            DeleteChunkList();
2189            pFile = NULL;
2190        }
2191    
2192        /**
2193         * Returns the current size of this file (in bytes) as it is currently
2194         * yet stored on disk. If this file does not yet exist on disk (i.e. when
2195         * this RIFF File has just been created from scratch and Save() has not
2196         * been called yet) then this method returns 0.
2197         */
2198        file_offset_t File::GetCurrentFileSize() const {
2199            file_offset_t size = 0;
2200            try {
2201                size = __GetFileSize(hFileRead);
2202            } catch (...) {
2203                size = 0;
2204            }
2205            return size;
2206        }
2207    
2208        /**
2209         * Returns the required size (in bytes) for this RIFF File to be saved to
2210         * disk. The precise size of the final file on disk depends on the RIFF
2211         * file offset size actually used internally in all headers of the RIFF
2212         * chunks. By default libgig handles the required file offset size
2213         * automatically for you; that means it is using 32 bit offsets for files
2214         * smaller than 4 GB and 64 bit offsets for files equal or larger than
2215         * 4 GB. You may however also override this default behavior by passing the
2216         * respective option to the RIFF File constructor to force one particular
2217         * offset size. In the latter case this method will return the file size
2218         * for the requested forced file offset size that will be used when calling
2219         * Save() later on.
2220         *
2221         * You may also use the overridden method below to get the file size for
2222         * an arbitrary other file offset size instead.
2223         *
2224         * @see offset_size_t
2225         * @see GetFileOffsetSize()
2226         */
2227        file_offset_t File::GetRequiredFileSize() {
2228            return GetRequiredFileSize(FileOffsetPreference);
2229        }
2230    
2231        /**
2232         * Returns the rquired size (in bytes) for this RIFF file to be saved to
2233         * disk, assuming the passed @a fileOffsestSize would be used for the
2234         * Save() operation.
2235         *
2236         * This overridden method essentialy behaves like the above method, with
2237         * the difference that you must provide a specific RIFF @a fileOffsetSize
2238         * for calculating the theoretical final file size.
2239         *
2240         * @see GetFileOffsetSize()
2241         */
2242        file_offset_t File::GetRequiredFileSize(offset_size_t fileOffsetSize) {
2243            switch (fileOffsetSize) {
2244                case offset_size_auto: {
2245                    file_offset_t fileSize = GetRequiredFileSize(offset_size_32bit);
2246                    if (fileSize >> 32)
2247                        return GetRequiredFileSize(offset_size_64bit);
2248                    else
2249                        return fileSize;
2250                }
2251                case offset_size_32bit: break;
2252                case offset_size_64bit: break;
2253                default: throw Exception("Internal error: Invalid RIFF::offset_size_t");
2254            }
2255            return RequiredPhysicalSize(FileOffsetSize);
2256      }      }
2257    
2258      void File::LogAsResized(Chunk* pResizedChunk) {      int File::FileOffsetSizeFor(file_offset_t fileSize) const {
2259          ResizedChunks.push_back(pResizedChunk);          switch (FileOffsetPreference) {
2260                case offset_size_auto:
2261                    return (fileSize >> 32) ? 8 : 4;
2262                case offset_size_32bit:
2263                    return 4;
2264                case offset_size_64bit:
2265                    return 8;
2266                default:
2267                    throw Exception("Internal error: Invalid RIFF::offset_size_t");
2268            }
2269      }      }
2270    
2271      unsigned long File::GetFileSize() {      /**
2272          return __GetFileSize(hFileRead);       * Returns the current size (in bytes) of file offsets stored in the
2273         * headers of all chunks of this file.
2274         *
2275         * Most RIFF files are using 32 bit file offsets internally, which limits
2276         * them to a maximum file size of less than 4 GB though. In contrast to the
2277         * common standard, this RIFF File class implementation supports handling of
2278         * RIFF files equal or larger than 4 GB. In such cases 64 bit file offsets
2279         * have to be used in all headers of all RIFF Chunks when being stored to a
2280         * physical file. libgig by default automatically selects the correct file
2281         * offset size for you. You may however also force one particular file
2282         * offset size by supplying the respective option to the RIFF::File
2283         * constructor.
2284         *
2285         * This method can be used to check which RIFF file offset size is currently
2286         * being used for this RIFF File.
2287         *
2288         * @returns current RIFF file offset size used (in bytes)
2289         * @see offset_size_t
2290         */
2291        int File::GetFileOffsetSize() const {
2292            return FileOffsetSize;
2293        }
2294    
2295        /**
2296         * Returns the required size (in bytes) of file offsets stored in the
2297         * headers of all chunks of this file if the current RIFF tree would be
2298         * saved to disk by calling Save().
2299         *
2300         * See GetFileOffsetSize() for mor details about RIFF file offsets.
2301         *
2302         * @returns RIFF file offset size required (in bytes) if being saved
2303         * @see offset_size_t
2304         */
2305        int File::GetRequiredFileOffsetSize() {
2306            return FileOffsetSizeFor(GetCurrentFileSize());
2307      }      }
2308    
2309      #if POSIX      #if POSIX
2310      unsigned long File::__GetFileSize(int hFile) {      file_offset_t File::__GetFileSize(int hFile) const {
2311          struct stat filestat;          struct stat filestat;
2312          fstat(hFile, &filestat);          if (fstat(hFile, &filestat) == -1)
2313          long size = filestat.st_size;              throw Exception("POSIX FS error: could not determine file size");
2314          return size;          return filestat.st_size;
2315        }
2316        #elif defined(WIN32)
2317        file_offset_t File::__GetFileSize(HANDLE hFile) const {
2318            LARGE_INTEGER size;
2319            if (!GetFileSizeEx(hFile, &size))
2320                throw Exception("Windows FS error: could not determine file size");
2321            return size.QuadPart;
2322      }      }
2323      #else // standard C functions      #else // standard C functions
2324      unsigned long File::__GetFileSize(FILE* hFile) {      file_offset_t File::__GetFileSize(FILE* hFile) const {
2325          long curpos = ftell(hFile);          off_t curpos = ftello(hFile);
2326          fseek(hFile, 0, SEEK_END);          if (fseeko(hFile, 0, SEEK_END) == -1)
2327          long size = ftell(hFile);              throw Exception("FS error: could not determine file size");
2328          fseek(hFile, curpos, SEEK_SET);          off_t size = ftello(hFile);
2329            fseeko(hFile, curpos, SEEK_SET);
2330          return size;          return size;
2331      }      }
2332      #endif      #endif
# Line 1548  namespace RIFF { Line 2335  namespace RIFF {
2335  // *************** Exception ***************  // *************** Exception ***************
2336  // *  // *
2337    
2338        Exception::Exception() {
2339        }
2340    
2341        Exception::Exception(String format, ...) {
2342            va_list arg;
2343            va_start(arg, format);
2344            Message = assemble(format, arg);
2345            va_end(arg);
2346        }
2347    
2348        Exception::Exception(String format, va_list arg) {
2349            Message = assemble(format, arg);
2350        }
2351    
2352      void Exception::PrintMessage() {      void Exception::PrintMessage() {
2353          std::cout << "RIFF::Exception: " << Message << std::endl;          std::cout << "RIFF::Exception: " << Message << std::endl;
2354      }      }
2355    
2356        String Exception::assemble(String format, va_list arg) {
2357            char* buf = NULL;
2358            vasprintf(&buf, format.c_str(), arg);
2359            String s = buf;
2360            free(buf);
2361            return s;
2362        }
2363    
2364    
2365  // *************** functions ***************  // *************** functions ***************
2366  // *  // *

Legend:
Removed from v.798  
changed lines
  Added in v.3912

  ViewVC Help
Powered by ViewVC