/[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 384 by schoenebeck, Thu Feb 17 02:22:26 2005 UTC revision 3488 by schoenebeck, Thu Feb 28 17:49:07 2019 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-2019 by Christian Schoenebeck                      *
6   *                              <cuse@users.sourceforge.net>               *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   This library is free software; you can redistribute it and/or modify  *
# Line 20  Line 20 
20   *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *   *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
21   *   MA  02111-1307  USA                                                   *   *   MA  02111-1307  USA                                                   *
22   ***************************************************************************/   ***************************************************************************/
23  #if 1  
24    #include <algorithm>
25    #include <set>
26    #include <string.h>
27    
28  #include "RIFF.h"  #include "RIFF.h"
29    
30    #include "helper.h"
31    
32    #if POSIX
33    # include <errno.h>
34    #endif
35    
36  namespace RIFF {  namespace RIFF {
37    
38    // *************** Internal functions **************
39    // *
40    
41        /// Returns a human readable path of the given chunk.
42        static String __resolveChunkPath(Chunk* pCk) {
43            String sPath;
44            for (Chunk* pChunk = pCk; pChunk; pChunk = pChunk->GetParent()) {
45                if (pChunk->GetChunkID() == CHUNK_ID_LIST) {
46                    List* pList = (List*) pChunk;
47                    sPath = "->'" + pList->GetListTypeString() + "'" + sPath;
48                } else {
49                    sPath = "->'" + pChunk->GetChunkIDString() + "'" + sPath;
50                }
51            }
52            return sPath;
53        }
54    
55    
56    
57    // *************** progress_t ***************
58    // *
59    
60        progress_t::progress_t() {
61            callback    = NULL;
62            custom      = NULL;
63            __range_min = 0.0f;
64            __range_max = 1.0f;
65        }
66    
67        /**
68         * 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    
124    
125  // *************** Chunk **************  // *************** Chunk **************
126  // *  // *
127    
128      Chunk::Chunk() {      Chunk::Chunk(File* pFile) {
129          #if DEBUG          #if DEBUG_RIFF
130          std::cout << "Chunk::Chunk()" << 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;
139            this->pFile = pFile;
140      }      }
141    
142      #if POSIX      Chunk::Chunk(File* pFile, file_offset_t StartPos, List* Parent) {
143      Chunk::Chunk(int hFile, unsigned long StartPos, bool EndianNative, List* Parent) {          #if DEBUG_RIFF
144      #else          std::cout << "Chunk::Chunk(File*,file_offset_t,List*),StartPos=" << StartPos << std::endl;
145      Chunk::Chunk(FILE* hFile, unsigned long StartPos, bool EndianNative, List* Parent) {          #endif // DEBUG_RIFF
146      #endif // POSIX          this->pFile   = pFile;
147          #if DEBUG          ullStartPos   = StartPos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize);
         std::cout << "Chunk::Chunk(FILE,ulong,bool,List*),StartPos=" << StartPos << std::endl;  
         #endif // DEBUG  
         Chunk::hFile  = hFile;  
         ulStartPos    = StartPos + CHUNK_HEADER_SIZE;  
         bEndianNative = EndianNative;  
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, file_offset_t ullBodySize) {
158            this->pFile      = pFile;
159            ullStartPos      = 0; // arbitrary usually, since it will be updated when we write the chunk
160            this->pParent    = pParent;
161            ullPos           = 0;
162            pChunkData       = NULL;
163            ChunkID          = uiChunkID;
164            ullChunkDataSize = 0;
165            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          #if POSIX          ChunkID = 0;
178          if (lseek(hFile, fPos, SEEK_SET) != -1) {          ullNewChunkSize = ullCurrentChunkSize = 0;
179              read(hFile, &ChunkID, 4);          #if POSIX
180              read(hFile, &ChunkSize, 4);          if (lseek(pFile->hFileRead, filePos, SEEK_SET) != -1) {
181          #else              read(pFile->hFileRead, &ChunkID, 4);
182          if (!fseek(hFile, fPos, SEEK_SET)) {              read(pFile->hFileRead, &ullCurrentChunkSize, pFile->FileOffsetSize);
183              fread(&ChunkID, 4, 1, hFile);          #elif defined(WIN32)
184              fread(&ChunkSize, 4, 1, hFile);          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
191            if (!fseeko(pFile->hFileRead, filePos, SEEK_SET)) {
192                fread(&ChunkID, 4, 1, pFile->hFileRead);
193                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) {
201                  bEndianNative = false;                  pFile->bEndianNative = false;
202                  ChunkID = CHUNK_ID_RIFF;                  ChunkID = CHUNK_ID_RIFF;
203              }              }
204              #endif // WORDS_BIGENDIAN              #endif // WORDS_BIGENDIAN
205              if (!bEndianNative) {              if (!pFile->bEndianNative) {
206                  //swapBytes_32(&ChunkID);                  //swapBytes_32(&ChunkID);
207                  swapBytes_32(&ChunkSize);                  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                ullNewChunkSize = ullCurrentChunkSize;
218            }
219        }
220    
221        void Chunk::WriteHeader(file_offset_t filePos) {
222            uint32_t uiNewChunkID = ChunkID;
223            if (ChunkID == CHUNK_ID_RIFF) {
224                #if WORDS_BIGENDIAN
225                if (pFile->bEndianNative) uiNewChunkID = CHUNK_ID_RIFX;
226                #else // little endian
227                if (!pFile->bEndianNative) uiNewChunkID = CHUNK_ID_RIFX;
228                #endif // WORDS_BIGENDIAN
229            }
230    
231            uint64_t ullNewChunkSize = this->ullNewChunkSize;
232            if (!pFile->bEndianNative) {
233                if (pFile->FileOffsetSize == 4)
234                    swapBytes_32(&ullNewChunkSize);
235                else
236                    swapBytes_64(&ullNewChunkSize);
237            }
238    
239            #if POSIX
240            if (lseek(pFile->hFileWrite, filePos, SEEK_SET) != -1) {
241                write(pFile->hFileWrite, &uiNewChunkID, 4);
242                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
253            if (!fseeko(pFile->hFileWrite, filePos, SEEK_SET)) {
254                fwrite(&uiNewChunkID, 4, 1, pFile->hFileWrite);
255                fwrite(&ullNewChunkSize, pFile->FileOffsetSize, 1, pFile->hFileWrite);
256            }
257            #endif // POSIX
258      }      }
259    
260      /**      /**
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 105  namespace RIFF { Line 269  namespace RIFF {
269       *  Sets the position within the chunk body, thus within the data portion       *  Sets the position within the chunk body, thus within the data portion
270       *  of the chunk (in bytes).       *  of the chunk (in bytes).
271       *       *
272         *  <b>Caution:</b> the position will be reset to zero whenever
273         *  File::Save() was called.
274         *
275       *  @param Where  - position offset (in bytes)       *  @param Where  - position offset (in bytes)
276       *  @param Whence - optional: defines to what <i>\a Where</i> relates to,       *  @param Whence - optional: defines to what <i>\a Where</i> relates to,
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 = ChunkSize - 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 > ChunkSize) ulPos = ChunkSize;          if (ullPos > ullCurrentChunkSize) ullPos = ullCurrentChunkSize;
299          return ulPos;          return ullPos;
300      }      }
301    
302      /**      /**
# Line 142  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()=" << ChunkSize - ulPos << std::endl;          std::cout << "Chunk::Remainingbytes()=" << ullCurrentChunkSize - ullPos << std::endl;
315         #endif // DEBUG          #endif // DEBUG_RIFF
316          return ChunkSize - 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 157  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 (hFile == 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 (hFile == NULL)     return stream_closed;          if (pFile->hFileRead == NULL) return stream_closed;
354          #endif // POSIX          #endif // POSIX
355          if (ulPos < ChunkSize) return stream_ready;          if (ullPos < ullCurrentChunkSize) return stream_ready;
356          else                   return stream_end_reached;          else                              return stream_end_reached;
357      }      }
358    
359      /**      /**
# Line 186  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 >= ChunkSize) 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 >= ChunkSize) WordCount = (ChunkSize - 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(hFile, ulStartPos + ulPos, SEEK_SET) < 0) return 0;          if (lseek(pFile->hFileRead, ullStartPos + ullPos, SEEK_SET) < 0) return 0;
383          unsigned long readWords = read(hFile, 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(hFile, ulStartPos + ulPos, SEEK_SET)) return 0;          if (fseeko(pFile->hFileRead, ullStartPos + ullPos, SEEK_SET)) return 0;
402          unsigned long readWords = fread(pData, WordSize, WordCount, hFile);          file_offset_t readWords = fread(pData, WordSize, WordCount, pFile->hFileRead);
403          #endif // POSIX          #endif // POSIX
404          if (!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 223  namespace RIFF { Line 425  namespace RIFF {
425          return readWords;          return readWords;
426      }      }
427    
428        /**
429         *  Writes \a WordCount number of data words with given \a WordSize from
430         *  the buffer pointed by \a pData. Be sure to provide the correct
431         *  \a WordSize, as this will be important and taken into account for
432         *  eventual endian correction (swapping of bytes due to different
433         *  native byte order of a system). The position within the chunk will
434         *  automatically be incremented.
435         *
436         *  @param pData      source buffer (containing the data)
437         *  @param WordCount  number of data words to write
438         *  @param WordSize   size of each data word to write
439         *  @returns          number of successfully written data words
440         *  @throws RIFF::Exception  if write operation would exceed current
441         *                           chunk size or any IO error occurred
442         *  @see Resize()
443         */
444        file_offset_t Chunk::Write(void* pData, file_offset_t WordCount, file_offset_t WordSize) {
445            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");
447            if (ullPos >= ullCurrentChunkSize || ullPos + WordCount * WordSize > ullCurrentChunkSize)
448                throw Exception("End of chunk reached while trying to write data");
449            if (!pFile->bEndianNative && WordSize != 1) {
450                switch (WordSize) {
451                    case 2:
452                        for (file_offset_t iWord = 0; iWord < WordCount; iWord++)
453                            swapBytes_16((uint16_t*) pData + iWord);
454                        break;
455                    case 4:
456                        for (file_offset_t iWord = 0; iWord < WordCount; iWord++)
457                            swapBytes_32((uint32_t*) pData + iWord);
458                        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:
464                        for (file_offset_t iWord = 0; iWord < WordCount; iWord++)
465                            swapBytes((uint8_t*) pData + iWord * WordSize, WordSize);
466                        break;
467                }
468            }
469            #if POSIX
470            if (lseek(pFile->hFileWrite, ullStartPos + ullPos, SEEK_SET) < 0) {
471                throw Exception("Could not seek to position " + ToString(ullPos) +
472                                " in chunk (" + ToString(ullStartPos + ullPos) + " in file)");
473            }
474            ssize_t writtenWords = write(pFile->hFileWrite, pData, WordCount * WordSize);
475            if (writtenWords < 1) throw Exception("POSIX IO Error while trying to write chunk data");
476            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
489            if (fseeko(pFile->hFileWrite, ullStartPos + ullPos, SEEK_SET)) {
490                throw Exception("Could not seek to position " + ToString(ullPos) +
491                                " in chunk (" + ToString(ullStartPos + ullPos) + " in file)");
492            }
493            file_offset_t writtenWords = fwrite(pData, WordSize, WordCount, pFile->hFileWrite);
494            #endif // POSIX
495            SetPos(writtenWords * WordSize, stream_curpos);
496            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 238  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    
524      /**      /**
525         * Writes \a WordCount number of 8 Bit signed integer words from the
526         * buffer pointed by \a pData to the chunk's body, directly to the
527         * actual "physical" file. The position within the chunk will
528         * automatically be incremented. Note: you cannot write beyond the
529         * boundaries of the chunk, to append data to the chunk call Resize()
530         * before.
531         *
532         * @param pData             source buffer (containing the data)
533         * @param WordCount         number of 8 Bit signed integers to write
534         * @returns                 number of written integers
535         * @throws RIFF::Exception  if an IO error occurred
536         * @see Resize()
537         */
538        file_offset_t Chunk::WriteInt8(int8_t* pData, file_offset_t WordCount) {
539            return Write(pData, WordCount, 1);
540        }
541    
542        /**
543       * Reads \a WordCount number of 8 Bit unsigned integer words and copies       * Reads \a WordCount number of 8 Bit unsigned integer words and copies
544       * it into the buffer pointed by \a pData. The buffer has to be       * it into the buffer pointed by \a pData. The buffer has to be
545       * allocated. The position within the chunk will automatically be       * allocated. The position within the chunk will automatically be
# Line 257  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    
561      /**      /**
562         * Writes \a WordCount number of 8 Bit unsigned integer words from the
563         * buffer pointed by \a pData to the chunk's body, directly to the
564         * actual "physical" file. The position within the chunk will
565         * automatically be incremented. Note: you cannot write beyond the
566         * boundaries of the chunk, to append data to the chunk call Resize()
567         * before.
568         *
569         * @param pData             source buffer (containing the data)
570         * @param WordCount         number of 8 Bit unsigned integers to write
571         * @returns                 number of written integers
572         * @throws RIFF::Exception  if an IO error occurred
573         * @see Resize()
574         */
575        file_offset_t Chunk::WriteUint8(uint8_t* pData, file_offset_t WordCount) {
576            return Write(pData, WordCount, 1);
577        }
578    
579        /**
580       * Reads \a WordCount number of 16 Bit signed integer words and copies       * Reads \a WordCount number of 16 Bit signed integer words and copies
581       * it into the buffer pointed by \a pData. The buffer has to be       * it into the buffer pointed by \a pData. The buffer has to be
582       * allocated. Endian correction will automatically be done if needed.       * allocated. Endian correction will automatically be done if needed.
# Line 276  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    
598      /**      /**
599         * Writes \a WordCount number of 16 Bit signed integer words from the
600         * buffer pointed by \a pData to the chunk's body, directly to the
601         * actual "physical" file. The position within the chunk will
602         * automatically be incremented. Note: you cannot write beyond the
603         * boundaries of the chunk, to append data to the chunk call Resize()
604         * before.
605         *
606         * @param pData             source buffer (containing the data)
607         * @param WordCount         number of 16 Bit signed integers to write
608         * @returns                 number of written integers
609         * @throws RIFF::Exception  if an IO error occurred
610         * @see Resize()
611         */
612        file_offset_t Chunk::WriteInt16(int16_t* pData, file_offset_t WordCount) {
613            return Write(pData, WordCount, 2);
614        }
615    
616        /**
617       * Reads \a WordCount number of 16 Bit unsigned integer words and copies       * Reads \a WordCount number of 16 Bit unsigned integer words and copies
618       * it into the buffer pointed by \a pData. The buffer has to be       * it into the buffer pointed by \a pData. The buffer has to be
619       * allocated. Endian correction will automatically be done if needed.       * allocated. Endian correction will automatically be done if needed.
# Line 295  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    
635      /**      /**
636         * Writes \a WordCount number of 16 Bit unsigned integer words from the
637         * buffer pointed by \a pData to the chunk's body, directly to the
638         * actual "physical" file. The position within the chunk will
639         * automatically be incremented. Note: you cannot write beyond the
640         * boundaries of the chunk, to append data to the chunk call Resize()
641         * before.
642         *
643         * @param pData             source buffer (containing the data)
644         * @param WordCount         number of 16 Bit unsigned integers to write
645         * @returns                 number of written integers
646         * @throws RIFF::Exception  if an IO error occurred
647         * @see Resize()
648         */
649        file_offset_t Chunk::WriteUint16(uint16_t* pData, file_offset_t WordCount) {
650            return Write(pData, WordCount, 2);
651        }
652    
653        /**
654       * Reads \a WordCount number of 32 Bit signed integer words and copies       * Reads \a WordCount number of 32 Bit signed integer words and copies
655       * it into the buffer pointed by \a pData. The buffer has to be       * it into the buffer pointed by \a pData. The buffer has to be
656       * allocated. Endian correction will automatically be done if needed.       * allocated. Endian correction will automatically be done if needed.
# Line 314  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    
672      /**      /**
673         * Writes \a WordCount number of 32 Bit signed integer words from the
674         * buffer pointed by \a pData to the chunk's body, directly to the
675         * actual "physical" file. The position within the chunk will
676         * automatically be incremented. Note: you cannot write beyond the
677         * boundaries of the chunk, to append data to the chunk call Resize()
678         * before.
679         *
680         * @param pData             source buffer (containing the data)
681         * @param WordCount         number of 32 Bit signed integers to write
682         * @returns                 number of written integers
683         * @throws RIFF::Exception  if an IO error occurred
684         * @see Resize()
685         */
686        file_offset_t Chunk::WriteInt32(int32_t* pData, file_offset_t WordCount) {
687            return Write(pData, WordCount, 4);
688        }
689    
690        /**
691       * Reads \a WordCount number of 32 Bit unsigned integer words and copies       * Reads \a WordCount number of 32 Bit unsigned integer words and copies
692       * it into the buffer pointed by \a pData. The buffer has to be       * it into the buffer pointed by \a pData. The buffer has to be
693       * allocated. Endian correction will automatically be done if needed.       * allocated. Endian correction will automatically be done if needed.
# Line 333  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
728         * buffer pointed by \a pData to the chunk's body, directly to the
729         * actual "physical" file. The position within the chunk will
730         * automatically be incremented. Note: you cannot write beyond the
731         * boundaries of the chunk, to append data to the chunk call Resize()
732         * before.
733         *
734         * @param pData             source buffer (containing the data)
735         * @param WordCount         number of 32 Bit unsigned integers to write
736         * @returns                 number of written integers
737         * @throws RIFF::Exception  if an IO error occurred
738         * @see Resize()
739         */
740        file_offset_t Chunk::WriteUint32(uint32_t* pData, file_offset_t WordCount) {
741            return Write(pData, WordCount, 4);
742        }
743    
744        /**
745       * Reads one 8 Bit signed integer word and increments the position within       * Reads one 8 Bit signed integer word and increments the position within
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 364  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 381  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 398  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 415  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 432  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;
842      }      }
843    
844        /** @brief Load chunk body into RAM.
845         *
846         * Loads the whole chunk body into memory. You can modify the data in
847         * RAM and save the data by calling File::Save() afterwards.
848         *
849         * <b>Caution:</b> the buffer pointer will be invalidated once
850         * File::Save() was called. You have to call LoadChunkData() again to
851         * 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
862         * @throws Exception if data buffer could not be enlarged
863         * @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(hFile, 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(hFile, 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(hFile, 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(), hFile);              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                memcpy(pNewBuffer, pChunkData, ullChunkDataSize);
898                delete[] pChunkData;
899                pChunkData       = pNewBuffer;
900                ullChunkDataSize = ullNewChunkSize;
901          }          }
902          return pChunkData;          return pChunkData;
903      }      }
904    
905        /** @brief Free loaded chunk body from RAM.
906         *
907         * Frees loaded chunk body data from memory (RAM). You should call
908         * File::Save() before calling this method if you modified the data to
909         * make the changes persistent.
910         */
911      void Chunk::ReleaseChunkData() {      void Chunk::ReleaseChunkData() {
912          if (pChunkData) {          if (pChunkData) {
913              delete[] pChunkData;              delete[] pChunkData;
# Line 471  namespace RIFF { Line 915  namespace RIFF {
915          }          }
916      }      }
917    
918        /** @brief Resize chunk.
919         *
920         * Resizes this chunk's body, that is the actual size of data possible
921         * to be written to this chunk. This call will return immediately and
922         * just schedule the resize operation. You should call File::Save() to
923         * actually perform the resize operation(s) "physically" to the file.
924         * As this can take a while on large files, it is recommended to call
925         * Resize() first on all chunks which have to be resized and finally to
926         * call File::Save() to perform all those resize operations in one rush.
927         *
928         * <b>Caution:</b> You cannot directly write to enlarged chunks before
929         * calling File::Save() as this might exceed the current chunk's body
930         * boundary!
931         *
932         * @param NewSize - new chunk body size in bytes (must be greater than zero)
933         * @throws RIFF::Exception  if \a NewSize is less than 1 or unrealistic large
934         * @see File::Save()
935         */
936        void Chunk::Resize(file_offset_t NewSize) {
937            if (NewSize == 0)
938                throw Exception("There is at least one empty chunk (zero size): " + __resolveChunkPath(this));
939            if ((NewSize >> 48) != 0)
940                throw Exception("Unrealistic high chunk size detected: " + __resolveChunkPath(this));
941            if (ullNewChunkSize == NewSize) return;
942            ullNewChunkSize = NewSize;
943        }
944    
945        /** @brief Write chunk persistently e.g. to disk.
946         *
947         * Stores the chunk persistently to its actual "physical" file.
948         *
949         * @param ullWritePos - position within the "physical" file where this
950         *                     chunk should be written to
951         * @param ullCurrentDataOffset - offset of current (old) data within
952         *                              the file
953         * @param pProgress - optional: callback function for progress notification
954         * @returns new write position in the "physical" file, that is
955         *          \a ullWritePos incremented by this chunk's new size
956         *          (including its header size of course)
957         */
958        file_offset_t Chunk::WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t* pProgress) {
959            const file_offset_t ullOriginalPos = ullWritePos;
960            ullWritePos += CHUNK_HEADER_SIZE(pFile->FileOffsetSize);
961    
962            if (pFile->Mode != stream_mode_read_write)
963                throw Exception("Cannot write list chunk, file has to be opened in read+write mode");
964    
965            // if the whole chunk body was loaded into RAM
966            if (pChunkData) {
967                // make sure chunk data buffer in RAM is at least as large as the new chunk size
968                LoadChunkData();
969                // write chunk data from RAM persistently to the file
970                #if POSIX
971                lseek(pFile->hFileWrite, ullWritePos, SEEK_SET);
972                if (write(pFile->hFileWrite, pChunkData, ullNewChunkSize) != ullNewChunkSize) {
973                    throw Exception("Writing Chunk data (from RAM) failed");
974                }
975                #elif defined(WIN32)
976                LARGE_INTEGER liFilePos;
977                liFilePos.QuadPart = ullWritePos;
978                SetFilePointerEx(pFile->hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
979                DWORD dwBytesWritten;
980                WriteFile(pFile->hFileWrite, pChunkData, ullNewChunkSize, &dwBytesWritten, NULL); //FIXME: won't save chunks larger than 2GB !
981                if (dwBytesWritten != ullNewChunkSize) {
982                    throw Exception("Writing Chunk data (from RAM) failed");
983                }
984                #else
985                fseeko(pFile->hFileWrite, ullWritePos, SEEK_SET);
986                if (fwrite(pChunkData, 1, ullNewChunkSize, pFile->hFileWrite) != ullNewChunkSize) {
987                    throw Exception("Writing Chunk data (from RAM) failed");
988                }
989                #endif // POSIX
990            } else {
991                // move chunk data from the end of the file to the appropriate position
992                int8_t* pCopyBuffer = new int8_t[4096];
993                file_offset_t ullToMove = (ullNewChunkSize < ullCurrentChunkSize) ? ullNewChunkSize : ullCurrentChunkSize;
994                #if defined(WIN32)
995                DWORD iBytesMoved = 1; // we have to pass it via pointer to the Windows API, thus the correct size must be ensured
996                #else
997                int iBytesMoved = 1;
998                #endif
999                for (file_offset_t ullOffset = 0; ullToMove > 0 && iBytesMoved > 0; ullOffset += iBytesMoved, ullToMove -= iBytesMoved) {
1000                    iBytesMoved = (ullToMove < 4096) ? int(ullToMove) : 4096;
1001                    #if POSIX
1002                    lseek(pFile->hFileRead, ullStartPos + ullCurrentDataOffset + ullOffset, SEEK_SET);
1003                    iBytesMoved = (int) read(pFile->hFileRead, pCopyBuffer, (size_t) iBytesMoved);
1004                    lseek(pFile->hFileWrite, ullWritePos + ullOffset, SEEK_SET);
1005                    iBytesMoved = (int) write(pFile->hFileWrite, pCopyBuffer, (size_t) iBytesMoved);
1006                    #elif defined(WIN32)
1007                    LARGE_INTEGER liFilePos;
1008                    liFilePos.QuadPart = ullStartPos + ullCurrentDataOffset + ullOffset;
1009                    SetFilePointerEx(pFile->hFileRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
1010                    ReadFile(pFile->hFileRead, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
1011                    liFilePos.QuadPart = ullWritePos + ullOffset;
1012                    SetFilePointerEx(pFile->hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
1013                    WriteFile(pFile->hFileWrite, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
1014                    #else
1015                    fseeko(pFile->hFileRead, ullStartPos + ullCurrentDataOffset + ullOffset, SEEK_SET);
1016                    iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, pFile->hFileRead);
1017                    fseeko(pFile->hFileWrite, ullWritePos + ullOffset, SEEK_SET);
1018                    iBytesMoved = fwrite(pCopyBuffer, 1, iBytesMoved, pFile->hFileWrite);
1019                    #endif
1020                }
1021                delete[] pCopyBuffer;
1022                if (iBytesMoved < 0) throw Exception("Writing Chunk data (from file) failed");
1023            }
1024    
1025            // update this chunk's header
1026            ullCurrentChunkSize = ullNewChunkSize;
1027            WriteHeader(ullOriginalPos);
1028    
1029            if (pProgress)
1030                __notify_progress(pProgress, 1.0); // notify done
1031    
1032            // update chunk's position pointers
1033            ullStartPos = ullOriginalPos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize);
1034            ullPos      = 0;
1035    
1036            // add pad byte if needed
1037            if ((ullStartPos + ullNewChunkSize) % 2 != 0) {
1038                const char cPadByte = 0;
1039                #if POSIX
1040                lseek(pFile->hFileWrite, ullStartPos + ullNewChunkSize, SEEK_SET);
1041                write(pFile->hFileWrite, &cPadByte, 1);
1042                #elif defined(WIN32)
1043                LARGE_INTEGER liFilePos;
1044                liFilePos.QuadPart = ullStartPos + ullNewChunkSize;
1045                SetFilePointerEx(pFile->hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
1046                DWORD dwBytesWritten;
1047                WriteFile(pFile->hFileWrite, &cPadByte, 1, &dwBytesWritten, NULL);
1048                #else
1049                fseeko(pFile->hFileWrite, ullStartPos + ullNewChunkSize, SEEK_SET);
1050                fwrite(&cPadByte, 1, 1, pFile->hFileWrite);
1051                #endif
1052                return ullStartPos + ullNewChunkSize + 1;
1053            }
1054    
1055            return ullStartPos + ullNewChunkSize;
1056        }
1057    
1058        void Chunk::__resetPos() {
1059            ullPos = 0;
1060        }
1061    
1062    
1063    
1064  // *************** List ***************  // *************** List ***************
1065  // *  // *
1066    
1067      List::List() : Chunk() {      List::List(File* pFile) : Chunk(pFile) {
1068        #if DEBUG          #if DEBUG_RIFF
1069        std::cout << "List::List()" << std::endl;          std::cout << "List::List(File* pFile)" << std::endl;
1070        #endif // DEBUG          #endif // DEBUG_RIFF
1071          pSubChunks    = NULL;          pSubChunks    = NULL;
1072          pSubChunksMap = NULL;          pSubChunksMap = NULL;
1073      }      }
1074    
1075      #if POSIX      List::List(File* pFile, file_offset_t StartPos, List* Parent)
1076      List::List(int hFile, unsigned long StartPos, bool EndianNative, List* Parent)        : Chunk(pFile, StartPos, Parent) {
1077      #else          #if DEBUG_RIFF
1078      List::List(FILE* hFile, unsigned long StartPos, bool EndianNative, List* Parent)          std::cout << "List::List(File*,file_offset_t,List*)" << std::endl;
1079      #endif // POSIX          #endif // DEBUG_RIFF
       : Chunk(hFile, StartPos, EndianNative, Parent) {  
         #if DEBUG  
         std::cout << "List::List(FILE*,ulong,bool,List*)" << std::endl;  
         #endif // DEBUG  
1080          pSubChunks    = NULL;          pSubChunks    = NULL;
1081          pSubChunksMap = NULL;          pSubChunksMap = NULL;
1082          ReadHeader(StartPos);          ReadHeader(StartPos);
1083          ulStartPos    = StartPos + LIST_HEADER_SIZE;          ullStartPos = StartPos + LIST_HEADER_SIZE(pFile->FileOffsetSize);
1084        }
1085    
1086        List::List(File* pFile, List* pParent, uint32_t uiListID)
1087          : Chunk(pFile, pParent, CHUNK_ID_LIST, 0) {
1088            pSubChunks    = NULL;
1089            pSubChunksMap = NULL;
1090            ListType      = uiListID;
1091      }      }
1092    
1093      List::~List() {      List::~List() {
1094        #if DEBUG          #if DEBUG_RIFF
1095        std::cout << "List::~List()" << std::endl;          std::cout << "List::~List()" << std::endl;
1096        #endif // DEBUG          #endif // DEBUG_RIFF
1097            DeleteChunkList();
1098        }
1099    
1100        void List::DeleteChunkList() {
1101          if (pSubChunks) {          if (pSubChunks) {
1102              ChunkList::iterator iter = pSubChunks->begin();              ChunkList::iterator iter = pSubChunks->begin();
1103              ChunkList::iterator end  = pSubChunks->end();              ChunkList::iterator end  = pSubChunks->end();
# Line 511  namespace RIFF { Line 1106  namespace RIFF {
1106                  iter++;                  iter++;
1107              }              }
1108              delete pSubChunks;              delete pSubChunks;
1109                pSubChunks = NULL;
1110            }
1111            if (pSubChunksMap) {
1112                delete pSubChunksMap;
1113                pSubChunksMap = NULL;
1114          }          }
         if (pSubChunksMap) delete pSubChunksMap;  
1115      }      }
1116    
1117      /**      /**
# Line 527  namespace RIFF { Line 1126  namespace RIFF {
1126       *                   that ID       *                   that ID
1127       */       */
1128      Chunk* List::GetSubChunk(uint32_t ChunkID) {      Chunk* List::GetSubChunk(uint32_t ChunkID) {
1129        #if DEBUG          #if DEBUG_RIFF
1130        std::cout << "List::GetSubChunk(uint32_t)" << std::endl;          std::cout << "List::GetSubChunk(uint32_t)" << std::endl;
1131        #endif // DEBUG          #endif // DEBUG_RIFF
1132          if (!pSubChunksMap) LoadSubChunks();          if (!pSubChunksMap) LoadSubChunks();
1133          return (*pSubChunksMap)[ChunkID];          return (*pSubChunksMap)[ChunkID];
1134      }      }
# Line 537  namespace RIFF { Line 1136  namespace RIFF {
1136      /**      /**
1137       *  Returns sublist chunk with list type <i>\a ListType</i> within this       *  Returns sublist chunk with list type <i>\a ListType</i> within this
1138       *  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
1139       *  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
1140       *  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
1141       *  that desired list type, NULL will be returned.       *  that desired list type, NULL will be returned.
1142       *       *
# Line 546  namespace RIFF { Line 1145  namespace RIFF {
1145       *                    that type       *                    that type
1146       */       */
1147      List* List::GetSubList(uint32_t ListType) {      List* List::GetSubList(uint32_t ListType) {
1148          #if DEBUG          #if DEBUG_RIFF
1149          std::cout << "List::GetSubList(uint32_t)" << std::endl;          std::cout << "List::GetSubList(uint32_t)" << std::endl;
1150          #endif // DEBUG          #endif // DEBUG_RIFF
1151          if (!pSubChunks) LoadSubChunks();          if (!pSubChunks) LoadSubChunks();
1152          ChunkList::iterator iter = pSubChunks->begin();          ChunkList::iterator iter = pSubChunks->begin();
1153          ChunkList::iterator end  = pSubChunks->end();          ChunkList::iterator end  = pSubChunks->end();
# Line 563  namespace RIFF { Line 1162  namespace RIFF {
1162      }      }
1163    
1164      /**      /**
1165       *  Returns the first subchunk within the list. You have to call this       *  Returns the first subchunk within the list (which may be an ordinary
1166         *  chunk as well as a list chunk). You have to call this
1167       *  method before you can call GetNextSubChunk(). Recall it when you want       *  method before you can call GetNextSubChunk(). Recall it when you want
1168       *  to start from the beginning of the list again.       *  to start from the beginning of the list again.
1169       *       *
# Line 571  namespace RIFF { Line 1171  namespace RIFF {
1171       *            otherwise       *            otherwise
1172       */       */
1173      Chunk* List::GetFirstSubChunk() {      Chunk* List::GetFirstSubChunk() {
1174          #if DEBUG          #if DEBUG_RIFF
1175          std::cout << "List::GetFirstSubChunk()" << std::endl;          std::cout << "List::GetFirstSubChunk()" << std::endl;
1176          #endif // DEBUG          #endif // DEBUG_RIFF
1177          if (!pSubChunks) LoadSubChunks();          if (!pSubChunks) LoadSubChunks();
1178          ChunksIterator = pSubChunks->begin();          ChunksIterator = pSubChunks->begin();
1179          return (ChunksIterator != pSubChunks->end()) ? *ChunksIterator : NULL;          return (ChunksIterator != pSubChunks->end()) ? *ChunksIterator : NULL;
1180      }      }
1181    
1182      /**      /**
1183       *  Returns the next subchunk within the list. You have to call       *  Returns the next subchunk within the list (which may be an ordinary
1184         *  chunk as well as a list chunk). You have to call
1185       *  GetFirstSubChunk() before you can use this method!       *  GetFirstSubChunk() before you can use this method!
1186       *       *
1187       *  @returns  pointer to the next subchunk within the list or NULL if       *  @returns  pointer to the next subchunk within the list or NULL if
1188       *            end of list is reached       *            end of list is reached
1189       */       */
1190      Chunk* List::GetNextSubChunk() {      Chunk* List::GetNextSubChunk() {
1191          #if DEBUG          #if DEBUG_RIFF
1192          std::cout << "List::GetNextSubChunk()" << std::endl;          std::cout << "List::GetNextSubChunk()" << std::endl;
1193          #endif // DEBUG          #endif // DEBUG_RIFF
1194          if (!pSubChunks) return NULL;          if (!pSubChunks) return NULL;
1195          ChunksIterator++;          ChunksIterator++;
1196          return (ChunksIterator != pSubChunks->end()) ? *ChunksIterator : NULL;          return (ChunksIterator != pSubChunks->end()) ? *ChunksIterator : NULL;
# Line 605  namespace RIFF { Line 1206  namespace RIFF {
1206       *            otherwise       *            otherwise
1207       */       */
1208      List* List::GetFirstSubList() {      List* List::GetFirstSubList() {
1209          #if DEBUG          #if DEBUG_RIFF
1210          std::cout << "List::GetFirstSubList()" << std::endl;          std::cout << "List::GetFirstSubList()" << std::endl;
1211          #endif // DEBUG          #endif // DEBUG_RIFF
1212          if (!pSubChunks) LoadSubChunks();          if (!pSubChunks) LoadSubChunks();
1213          ListIterator            = pSubChunks->begin();          ListIterator            = pSubChunks->begin();
1214          ChunkList::iterator end = pSubChunks->end();          ChunkList::iterator end = pSubChunks->end();
# Line 627  namespace RIFF { Line 1228  namespace RIFF {
1228       *            end of list is reached       *            end of list is reached
1229       */       */
1230      List* List::GetNextSubList() {      List* List::GetNextSubList() {
1231          #if DEBUG          #if DEBUG_RIFF
1232          std::cout << "List::GetNextSubList()" << std::endl;          std::cout << "List::GetNextSubList()" << std::endl;
1233          #endif // DEBUG          #endif // DEBUG_RIFF
1234          if (!pSubChunks) return NULL;          if (!pSubChunks) return NULL;
1235          if (ListIterator == pSubChunks->end()) return NULL;          if (ListIterator == pSubChunks->end()) return NULL;
1236          ListIterator++;          ListIterator++;
# Line 642  namespace RIFF { Line 1243  namespace RIFF {
1243      }      }
1244    
1245      /**      /**
1246       *  Returns number subchunks within the list.       *  Returns number of subchunks within the list (including list chunks).
1247       */       */
1248      unsigned int List::CountSubChunks() {      size_t List::CountSubChunks() {
1249          if (!pSubChunks) LoadSubChunks();          if (!pSubChunks) LoadSubChunks();
1250          return pSubChunks->size();          return pSubChunks->size();
1251      }      }
# Line 653  namespace RIFF { Line 1254  namespace RIFF {
1254       *  Returns number of subchunks within the list with chunk ID       *  Returns number of subchunks within the list with chunk ID
1255       *  <i>\a ChunkId</i>.       *  <i>\a ChunkId</i>.
1256       */       */
1257      unsigned int List::CountSubChunks(uint32_t ChunkID) {      size_t List::CountSubChunks(uint32_t ChunkID) {
1258          unsigned int result = 0;          size_t result = 0;
1259          if (!pSubChunks) LoadSubChunks();          if (!pSubChunks) LoadSubChunks();
1260          ChunkList::iterator iter = pSubChunks->begin();          ChunkList::iterator iter = pSubChunks->begin();
1261          ChunkList::iterator end  = pSubChunks->end();          ChunkList::iterator end  = pSubChunks->end();
# Line 670  namespace RIFF { Line 1271  namespace RIFF {
1271      /**      /**
1272       *  Returns number of sublists within the list.       *  Returns number of sublists within the list.
1273       */       */
1274      unsigned int List::CountSubLists() {      size_t List::CountSubLists() {
1275          return CountSubChunks(CHUNK_ID_LIST);          return CountSubChunks(CHUNK_ID_LIST);
1276      }      }
1277    
# Line 678  namespace RIFF { Line 1279  namespace RIFF {
1279       *  Returns number of sublists within the list with list type       *  Returns number of sublists within the list with list type
1280       *  <i>\a ListType</i>       *  <i>\a ListType</i>
1281       */       */
1282      unsigned int List::CountSubLists(uint32_t ListType) {      size_t List::CountSubLists(uint32_t ListType) {
1283          unsigned int result = 0;          size_t result = 0;
1284          if (!pSubChunks) LoadSubChunks();          if (!pSubChunks) LoadSubChunks();
1285          ChunkList::iterator iter = pSubChunks->begin();          ChunkList::iterator iter = pSubChunks->begin();
1286          ChunkList::iterator end  = pSubChunks->end();          ChunkList::iterator end  = pSubChunks->end();
# Line 693  namespace RIFF { Line 1294  namespace RIFF {
1294          return result;          return result;
1295      }      }
1296    
1297      void List::ReadHeader(unsigned long fPos) {      /** @brief Creates a new sub chunk.
1298        #if DEBUG       *
1299        std::cout << "List::Readheader(ulong) ";       * Creates and adds a new sub chunk to this list chunk. Note that the
1300        #endif // DEBUG       * chunk's body size given by \a ullBodySize must be greater than zero.
1301          Chunk::ReadHeader(fPos);       * You have to call File::Save() to make this change persistent to the
1302          ChunkSize -= 4;       * actual file and <b>before</b> performing any data write operations
1303         * on the new chunk!
1304         *
1305         * @param uiChunkID  - chunk ID of the new chunk
1306         * @param ullBodySize - size of the new chunk's body, that is its actual
1307         *                      data size (without header)
1308         * @throws RIFF::Exception if \a ullBodySize equals zero
1309         */
1310        Chunk* List::AddSubChunk(uint32_t uiChunkID, file_offset_t ullBodySize) {
1311            if (ullBodySize == 0) throw Exception("Chunk body size must be at least 1 byte");
1312            if (!pSubChunks) LoadSubChunks();
1313            Chunk* pNewChunk = new Chunk(pFile, this, uiChunkID, 0);
1314            pSubChunks->push_back(pNewChunk);
1315            (*pSubChunksMap)[uiChunkID] = pNewChunk;
1316            pNewChunk->Resize(ullBodySize);
1317            ullNewChunkSize += CHUNK_HEADER_SIZE(pFile->FileOffsetSize);
1318            return pNewChunk;
1319        }
1320    
1321        /** @brief Moves a sub chunk witin this list.
1322         *
1323         * Moves a sub chunk from one position in this list to another
1324         * position in the same list. The pSrc chunk is placed before the
1325         * pDst chunk.
1326         *
1327         * @param pSrc - sub chunk to be moved
1328         * @param pDst - the position to move to. pSrc will be placed
1329         *               before pDst. If pDst is 0, pSrc will be placed
1330         *               last in list.
1331         */
1332        void List::MoveSubChunk(Chunk* pSrc, Chunk* pDst) {
1333            if (!pSubChunks) LoadSubChunks();
1334            pSubChunks->remove(pSrc);
1335            ChunkList::iterator iter = find(pSubChunks->begin(), pSubChunks->end(), pDst);
1336            pSubChunks->insert(iter, pSrc);
1337        }
1338    
1339        /** @brief Moves a sub chunk from this list to another list.
1340         *
1341         * Moves a sub chunk from this list list to the end of another
1342         * list.
1343         *
1344         * @param pSrc - sub chunk to be moved
1345         * @param pDst - destination list where the chunk shall be moved to
1346         */
1347        void List::MoveSubChunk(Chunk* pSrc, List* pNewParent) {
1348            if (pNewParent == this || !pNewParent) return;
1349            if (!pSubChunks) LoadSubChunks();
1350            if (!pNewParent->pSubChunks) pNewParent->LoadSubChunks();
1351            pSubChunks->remove(pSrc);
1352            pNewParent->pSubChunks->push_back(pSrc);
1353            // update chunk id map of this List
1354            if ((*pSubChunksMap)[pSrc->GetChunkID()] == pSrc) {
1355                pSubChunksMap->erase(pSrc->GetChunkID());
1356                // try to find another chunk of the same chunk ID
1357                ChunkList::iterator iter = pSubChunks->begin();
1358                ChunkList::iterator end  = pSubChunks->end();
1359                for (; iter != end; ++iter) {
1360                    if ((*iter)->GetChunkID() == pSrc->GetChunkID()) {
1361                        (*pSubChunksMap)[pSrc->GetChunkID()] = *iter;
1362                        break; // we're done, stop search
1363                    }
1364                }
1365            }
1366            // update chunk id map of other list
1367            if (!(*pNewParent->pSubChunksMap)[pSrc->GetChunkID()])
1368                (*pNewParent->pSubChunksMap)[pSrc->GetChunkID()] = pSrc;
1369        }
1370    
1371        /** @brief Creates a new list sub chunk.
1372         *
1373         * Creates and adds a new list sub chunk to this list chunk. Note that
1374         * you have to add sub chunks / sub list chunks to the new created chunk
1375         * <b>before</b> trying to make this change persisten to the actual
1376         * file with File::Save()!
1377         *
1378         * @param uiListType - list ID of the new list chunk
1379         */
1380        List* List::AddSubList(uint32_t uiListType) {
1381            if (!pSubChunks) LoadSubChunks();
1382            List* pNewListChunk = new List(pFile, this, uiListType);
1383            pSubChunks->push_back(pNewListChunk);
1384            (*pSubChunksMap)[CHUNK_ID_LIST] = pNewListChunk;
1385            ullNewChunkSize += LIST_HEADER_SIZE(pFile->FileOffsetSize);
1386            return pNewListChunk;
1387        }
1388    
1389        /** @brief Removes a sub chunk.
1390         *
1391         * Removes the sub chunk given by \a pSubChunk from this list and frees
1392         * it completely from RAM. The given chunk can either be a normal sub
1393         * chunk or a list sub chunk. In case the given chunk is a list chunk,
1394         * all its subchunks (if any) will be removed recursively as well. You
1395         * should call File::Save() to make this change persistent at any time.
1396         *
1397         * @param pSubChunk - sub chunk or sub list chunk to be removed
1398         */
1399        void List::DeleteSubChunk(Chunk* pSubChunk) {
1400            if (!pSubChunks) LoadSubChunks();
1401            pSubChunks->remove(pSubChunk);
1402            if ((*pSubChunksMap)[pSubChunk->GetChunkID()] == pSubChunk) {
1403                pSubChunksMap->erase(pSubChunk->GetChunkID());
1404                // try to find another chunk of the same chunk ID
1405                ChunkList::iterator iter = pSubChunks->begin();
1406                ChunkList::iterator end  = pSubChunks->end();
1407                for (; iter != end; ++iter) {
1408                    if ((*iter)->GetChunkID() == pSubChunk->GetChunkID()) {
1409                        (*pSubChunksMap)[pSubChunk->GetChunkID()] = *iter;
1410                        break; // we're done, stop search
1411                    }
1412                }
1413            }
1414            delete pSubChunk;
1415        }
1416    
1417        /**
1418         *  Returns the actual total size in bytes (including List chunk header and
1419         *  all subchunks) of this List Chunk if being stored to a file.
1420         *
1421         *  @param fileOffsetSize - RIFF file offset size (in bytes) assumed when
1422         *                          being saved to a file
1423         */
1424        file_offset_t List::RequiredPhysicalSize(int fileOffsetSize) {
1425            if (!pSubChunks) LoadSubChunks();
1426            file_offset_t size = LIST_HEADER_SIZE(fileOffsetSize);
1427            ChunkList::iterator iter = pSubChunks->begin();
1428            ChunkList::iterator end  = pSubChunks->end();
1429            for (; iter != end; ++iter)
1430                size += (*iter)->RequiredPhysicalSize(fileOffsetSize);
1431            return size;
1432        }
1433    
1434        void List::ReadHeader(file_offset_t filePos) {
1435            #if DEBUG_RIFF
1436            std::cout << "List::Readheader(file_offset_t) ";
1437            #endif // DEBUG_RIFF
1438            Chunk::ReadHeader(filePos);
1439            if (ullCurrentChunkSize < 4) return;
1440            ullNewChunkSize = ullCurrentChunkSize -= 4;
1441          #if POSIX          #if POSIX
1442          lseek(hFile, fPos + CHUNK_HEADER_SIZE, SEEK_SET);          lseek(pFile->hFileRead, filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize), SEEK_SET);
1443          read(hFile, &ListType, 4);          read(pFile->hFileRead, &ListType, 4);
1444            #elif defined(WIN32)
1445            LARGE_INTEGER liFilePos;
1446            liFilePos.QuadPart = filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize);
1447            SetFilePointerEx(pFile->hFileRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
1448            DWORD dwBytesRead;
1449            ReadFile(pFile->hFileRead, &ListType, 4, &dwBytesRead, NULL);
1450          #else          #else
1451          fseek(hFile, fPos + CHUNK_HEADER_SIZE, SEEK_SET);          fseeko(pFile->hFileRead, filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize), SEEK_SET);
1452          fread(&ListType, 4, 1, hFile);          fread(&ListType, 4, 1, pFile->hFileRead);
1453          #endif // POSIX          #endif // POSIX
1454        #if DEBUG          #if DEBUG_RIFF
1455        std::cout << "listType=" << convertToString(ListType) << std::endl;          std::cout << "listType=" << convertToString(ListType) << std::endl;
1456        #endif // DEBUG          #endif // DEBUG_RIFF
1457          if (!bEndianNative) {          if (!pFile->bEndianNative) {
1458              //swapBytes_32(&ListType);              //swapBytes_32(&ListType);
1459          }          }
1460      }      }
1461    
1462      void List::LoadSubChunks() {      void List::WriteHeader(file_offset_t filePos) {
1463         #if DEBUG          // the four list type bytes officially belong the chunk's body in the RIFF format
1464         std::cout << "List::LoadSubChunks()";          ullNewChunkSize += 4;
1465         #endif // DEBUG          Chunk::WriteHeader(filePos);
1466            ullNewChunkSize -= 4; // just revert the +4 incrementation
1467            #if POSIX
1468            lseek(pFile->hFileWrite, filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize), SEEK_SET);
1469            write(pFile->hFileWrite, &ListType, 4);
1470            #elif defined(WIN32)
1471            LARGE_INTEGER liFilePos;
1472            liFilePos.QuadPart = filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize);
1473            SetFilePointerEx(pFile->hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
1474            DWORD dwBytesWritten;
1475            WriteFile(pFile->hFileWrite, &ListType, 4, &dwBytesWritten, NULL);
1476            #else
1477            fseeko(pFile->hFileWrite, filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize), SEEK_SET);
1478            fwrite(&ListType, 4, 1, pFile->hFileWrite);
1479            #endif // POSIX
1480        }
1481    
1482        void List::LoadSubChunks(progress_t* pProgress) {
1483            #if DEBUG_RIFF
1484            std::cout << "List::LoadSubChunks()";
1485            #endif // DEBUG_RIFF
1486          if (!pSubChunks) {          if (!pSubChunks) {
1487              pSubChunks    = new ChunkList();              pSubChunks    = new ChunkList();
1488              pSubChunksMap = new ChunkMap();              pSubChunksMap = new ChunkMap();
1489              while (RemainingBytes() >= CHUNK_HEADER_SIZE) {              #if defined(WIN32)
1490                if (pFile->hFileRead == INVALID_HANDLE_VALUE) return;
1491                #else
1492                if (!pFile->hFileRead) return;
1493                #endif
1494                file_offset_t ullOriginalPos = GetPos();
1495                SetPos(0); // jump to beginning of list chunk body
1496                while (RemainingBytes() >= CHUNK_HEADER_SIZE(pFile->FileOffsetSize)) {
1497                  Chunk* ck;                  Chunk* ck;
1498                  uint32_t ckid;                  uint32_t ckid;
1499                  Read(&ckid, 4, 1);                  Read(&ckid, 4, 1);
1500         #if DEBUG                  #if DEBUG_RIFF
1501         std::cout << " ckid=" << convertToString(ckid) << std::endl;                  std::cout << " ckid=" << convertToString(ckid) << std::endl;
1502         #endif // DEBUG                  #endif // DEBUG_RIFF
1503                  if (ckid == CHUNK_ID_LIST) {                  if (ckid == CHUNK_ID_LIST) {
1504                      ck = new RIFF::List(hFile, ulStartPos + ulPos - 4, bEndianNative, this);                      ck = new RIFF::List(pFile, ullStartPos + ullPos - 4, this);
1505                      SetPos(ck->GetSize() + LIST_HEADER_SIZE - 4, RIFF::stream_curpos);                      SetPos(ck->GetSize() + LIST_HEADER_SIZE(pFile->FileOffsetSize) - 4, RIFF::stream_curpos);
1506                  }                  }
1507                  else { // simple chunk                  else { // simple chunk
1508                      ck = new RIFF::Chunk(hFile, ulStartPos + ulPos - 4, bEndianNative, this);                      ck = new RIFF::Chunk(pFile, ullStartPos + ullPos - 4, this);
1509                      SetPos(ck->GetSize() + CHUNK_HEADER_SIZE - 4, RIFF::stream_curpos);                      SetPos(ck->GetSize() + CHUNK_HEADER_SIZE(pFile->FileOffsetSize) - 4, RIFF::stream_curpos);
1510                  }                  }
1511                  pSubChunks->push_back(ck);                  pSubChunks->push_back(ck);
1512                  (*pSubChunksMap)[ckid] = ck;                  (*pSubChunksMap)[ckid] = ck;
1513                  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
1514              }              }
1515                SetPos(ullOriginalPos); // restore position before this call
1516            }
1517            if (pProgress)
1518                __notify_progress(pProgress, 1.0); // notify done
1519        }
1520    
1521        void List::LoadSubChunksRecursively(progress_t* pProgress) {
1522            const int n = (int) CountSubLists();
1523            int i = 0;
1524            for (List* pList = GetFirstSubList(); pList; pList = GetNextSubList(), ++i) {
1525                if (pProgress) {
1526                    // divide local progress into subprogress
1527                    progress_t subprogress;
1528                    __divide_progress(pProgress, &subprogress, n, i);
1529                    // do the actual work
1530                    pList->LoadSubChunksRecursively(&subprogress);
1531                } else
1532                    pList->LoadSubChunksRecursively(NULL);
1533            }
1534            if (pProgress)
1535                __notify_progress(pProgress, 1.0); // notify done
1536        }
1537    
1538        /** @brief Write list chunk persistently e.g. to disk.
1539         *
1540         * Stores the list chunk persistently to its actual "physical" file. All
1541         * subchunks (including sub list chunks) will be stored recursively as
1542         * well.
1543         *
1544         * @param ullWritePos - position within the "physical" file where this
1545         *                     list chunk should be written to
1546         * @param ullCurrentDataOffset - offset of current (old) data within
1547         *                              the file
1548         * @param pProgress - optional: callback function for progress notification
1549         * @returns new write position in the "physical" file, that is
1550         *          \a ullWritePos incremented by this list chunk's new size
1551         *          (including its header size of course)
1552         */
1553        file_offset_t List::WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t* pProgress) {
1554            const file_offset_t ullOriginalPos = ullWritePos;
1555            ullWritePos += LIST_HEADER_SIZE(pFile->FileOffsetSize);
1556    
1557            if (pFile->Mode != stream_mode_read_write)
1558                throw Exception("Cannot write list chunk, file has to be opened in read+write mode");
1559    
1560            // write all subchunks (including sub list chunks) recursively
1561            if (pSubChunks) {
1562                size_t i = 0;
1563                const size_t n = pSubChunks->size();
1564                for (ChunkList::iterator iter = pSubChunks->begin(), end = pSubChunks->end(); iter != end; ++iter, ++i) {
1565                    if (pProgress) {
1566                        // divide local progress into subprogress for loading current Instrument
1567                        progress_t subprogress;
1568                        __divide_progress(pProgress, &subprogress, n, i);
1569                        // do the actual work
1570                        ullWritePos = (*iter)->WriteChunk(ullWritePos, ullCurrentDataOffset, &subprogress);
1571                    } else
1572                        ullWritePos = (*iter)->WriteChunk(ullWritePos, ullCurrentDataOffset, NULL);
1573                }
1574            }
1575    
1576            // update this list chunk's header
1577            ullCurrentChunkSize = ullNewChunkSize = ullWritePos - ullOriginalPos - LIST_HEADER_SIZE(pFile->FileOffsetSize);
1578            WriteHeader(ullOriginalPos);
1579    
1580            // offset of this list chunk in new written file may have changed
1581            ullStartPos = ullOriginalPos + LIST_HEADER_SIZE(pFile->FileOffsetSize);
1582    
1583            if (pProgress)
1584                __notify_progress(pProgress, 1.0); // notify done
1585    
1586            return ullWritePos;
1587        }
1588    
1589        void List::__resetPos() {
1590            Chunk::__resetPos();
1591            if (pSubChunks) {
1592                for (ChunkList::iterator iter = pSubChunks->begin(), end = pSubChunks->end(); iter != end; ++iter) {
1593                    (*iter)->__resetPos();
1594                }
1595          }          }
1596      }      }
1597    
1598      /**      /**
1599       *  Returns string representation of the lists's id       *  Returns string representation of the lists's id
1600       */       */
1601      String List::GetListTypeString() {      String List::GetListTypeString() const {
1602          return convertToString(ListType);          return convertToString(ListType);
1603      }      }
1604    
# Line 755  namespace RIFF { Line 1607  namespace RIFF {
1607  // *************** File ***************  // *************** File ***************
1608  // *  // *
1609    
1610      File::File(const String& path) : List() {      /** @brief Create new RIFF file.
1611        #if DEBUG       *
1612        std::cout << "File::File("<<path<<")" << std::endl;       * Use this constructor if you want to create a new RIFF file completely
1613        #endif // DEBUG       * "from scratch". Note: there must be no empty chunks or empty list
1614         * chunks when trying to make the new RIFF file persistent with Save()!
1615         *
1616         * Note: by default, the RIFF file will be saved in native endian
1617         * format; that is, as a RIFF file on little-endian machines and
1618         * as a RIFX file on big-endian. To change this behaviour, call
1619         * SetByteOrder() before calling Save().
1620         *
1621         * @param FileType - four-byte identifier of the RIFF file type
1622         * @see AddSubChunk(), AddSubList(), SetByteOrder()
1623         */
1624        File::File(uint32_t FileType)
1625            : List(this), bIsNewFile(true), Layout(layout_standard),
1626              FileOffsetPreference(offset_size_auto)
1627        {
1628            #if defined(WIN32)
1629            hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
1630            #else
1631            hFileRead = hFileWrite = 0;
1632            #endif
1633            Mode = stream_mode_closed;
1634            bEndianNative = true;
1635            ListType = FileType;
1636            FileOffsetSize = 4;
1637            ullStartPos = RIFF_HEADER_SIZE(FileOffsetSize);
1638        }
1639    
1640        /** @brief Load existing RIFF file.
1641         *
1642         * Loads an existing RIFF file with all its chunks.
1643         *
1644         * @param path - path and file name of the RIFF file to open
1645         * @throws RIFF::Exception if error occurred while trying to load the
1646         *                         given RIFF file
1647         */
1648        File::File(const String& path)
1649            : List(this), Filename(path), bIsNewFile(false), Layout(layout_standard),
1650              FileOffsetPreference(offset_size_auto)
1651        {
1652            #if DEBUG_RIFF
1653            std::cout << "File::File("<<path<<")" << std::endl;
1654            #endif // DEBUG_RIFF
1655          bEndianNative = true;          bEndianNative = true;
1656            FileOffsetSize = 4;
1657            try {
1658                __openExistingFile(path);
1659                if (ChunkID != CHUNK_ID_RIFF && ChunkID != CHUNK_ID_RIFX) {
1660                    throw RIFF::Exception("Not a RIFF file");
1661                }
1662            }
1663            catch (...) {
1664                Cleanup();
1665                throw;
1666            }
1667        }
1668    
1669        /** @brief Load existing RIFF-like file.
1670         *
1671         * Loads an existing file, which is not a "real" RIFF file, but similar to
1672         * an ordinary RIFF file.
1673         *
1674         * A "real" RIFF file contains at top level a List chunk either with chunk
1675         * ID "RIFF" or "RIFX". The simple constructor above expects this to be
1676         * case, and if it finds the toplevel List chunk to have another chunk ID
1677         * than one of those two expected ones, it would throw an Exception and
1678         * would refuse to load the file accordingly.
1679         *
1680         * Since there are however a lot of file formats which use the same simple
1681         * principles of the RIFF format, with another toplevel List chunk ID
1682         * though, you can use this alternative constructor here to be able to load
1683         * and handle those files in the same way as you would do with "real" RIFF
1684         * files.
1685         *
1686         * @param path - path and file name of the RIFF-alike file to be opened
1687         * @param FileType - expected toplevel List chunk ID (this is the very
1688         *                   first chunk found in the file)
1689         * @param Endian - whether the file uses little endian or big endian layout
1690         * @param layout - general file structure type
1691         * @param fileOffsetSize - (optional) preference how to deal with large files
1692         * @throws RIFF::Exception if error occurred while trying to load the
1693         *                         given RIFF-alike file
1694         */
1695        File::File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout, offset_size_t fileOffsetSize)
1696            : List(this), Filename(path), bIsNewFile(false), Layout(layout),
1697              FileOffsetPreference(fileOffsetSize)
1698        {
1699            SetByteOrder(Endian);
1700            if (fileOffsetSize < offset_size_auto || fileOffsetSize > offset_size_64bit)
1701                throw Exception("Invalid RIFF::offset_size_t");
1702            FileOffsetSize = 4;
1703            try {
1704                __openExistingFile(path, &FileType);
1705            }
1706            catch (...) {
1707                Cleanup();
1708                throw;
1709            }
1710        }
1711    
1712        /**
1713         * Opens an already existing RIFF file or RIFF-alike file. This method
1714         * shall only be called once (in a File class constructor).
1715         *
1716         * @param path - path and file name of the RIFF file or RIFF-alike file to
1717         *               be opened
1718         * @param FileType - (optional) expected chunk ID of first chunk in file
1719         * @throws RIFF::Exception if error occurred while trying to load the
1720         *                         given RIFF file or RIFF-alike file
1721         */
1722        void File::__openExistingFile(const String& path, uint32_t* FileType) {
1723          #if POSIX          #if POSIX
1724          hFile = open(path.c_str(), O_RDONLY | O_NONBLOCK);          hFileRead = hFileWrite = open(path.c_str(), O_RDONLY | O_NONBLOCK);
1725          if (hFile <= 0) {          if (hFileRead == -1) {
1726              hFile = 0;              hFileRead = hFileWrite = 0;
1727                String sError = strerror(errno);
1728                throw RIFF::Exception("Can't open \"" + path + "\": " + sError);
1729            }
1730            #elif defined(WIN32)
1731            hFileRead = hFileWrite = CreateFile(
1732                                         path.c_str(), GENERIC_READ,
1733                                         FILE_SHARE_READ | FILE_SHARE_WRITE,
1734                                         NULL, OPEN_EXISTING,
1735                                         FILE_ATTRIBUTE_NORMAL |
1736                                         FILE_FLAG_RANDOM_ACCESS, NULL
1737                                     );
1738            if (hFileRead == INVALID_HANDLE_VALUE) {
1739                hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
1740              throw RIFF::Exception("Can't open \"" + path + "\"");              throw RIFF::Exception("Can't open \"" + path + "\"");
1741          }          }
1742          #else          #else
1743          hFile = fopen(path.c_str(), "rb");          hFileRead = hFileWrite = fopen(path.c_str(), "rb");
1744          if (!hFile) throw RIFF::Exception("Can't open \"" + path + "\"");          if (!hFileRead) throw RIFF::Exception("Can't open \"" + path + "\"");
1745          #endif // POSIX          #endif // POSIX
1746          ulStartPos = RIFF_HEADER_SIZE;          Mode = stream_mode_read;
1747          ReadHeader(0);  
1748          if (ChunkID != CHUNK_ID_RIFF) {          // determine RIFF file offset size to be used (in RIFF chunk headers)
1749              throw RIFF::Exception("Not a RIFF file");          // according to the current file offset preference
1750            FileOffsetSize = FileOffsetSizeFor(GetCurrentFileSize());
1751    
1752            switch (Layout) {
1753                case layout_standard: // this is a normal RIFF file
1754                    ullStartPos = RIFF_HEADER_SIZE(FileOffsetSize);
1755                    ReadHeader(0);
1756                    if (FileType && ChunkID != *FileType)
1757                        throw RIFF::Exception("Invalid file container ID");
1758                    break;
1759                case layout_flat: // non-standard RIFF-alike file
1760                    ullStartPos = 0;
1761                    ullNewChunkSize = ullCurrentChunkSize = GetCurrentFileSize();
1762                    if (FileType) {
1763                        uint32_t ckid;
1764                        if (Read(&ckid, 4, 1) != 4) {
1765                            throw RIFF::Exception("Invalid file header ID (premature end of header)");
1766                        } else if (ckid != *FileType) {
1767                            String s = " (expected '" + convertToString(*FileType) + "' but got '" + convertToString(ckid) + "')";
1768                            throw RIFF::Exception("Invalid file header ID" + s);
1769                        }
1770                        SetPos(0); // reset to first byte of file
1771                    }
1772                    LoadSubChunks();
1773                    break;
1774          }          }
1775      }      }
1776    
1777      File::~File() {      String File::GetFileName() const {
1778         #if DEBUG          return Filename;
1779         std::cout << "File::~File()" << std::endl;      }
1780         #endif // DEBUG      
1781        void File::SetFileName(const String& path) {
1782            Filename = path;
1783        }
1784    
1785        stream_mode_t File::GetMode() const {
1786            return Mode;
1787        }
1788    
1789        layout_t File::GetLayout() const {
1790            return Layout;
1791        }
1792    
1793        /** @brief Change file access mode.
1794         *
1795         * Changes files access mode either to read-only mode or to read/write
1796         * mode.
1797         *
1798         * @param NewMode - new file access mode
1799         * @returns true if mode was changed, false if current mode already
1800         *          equals new mode
1801         * @throws RIFF::Exception if new file access mode is unknown
1802         */
1803        bool File::SetMode(stream_mode_t NewMode) {
1804            if (NewMode != Mode) {
1805                switch (NewMode) {
1806                    case stream_mode_read:
1807                        #if POSIX
1808                        if (hFileRead) close(hFileRead);
1809                        hFileRead = hFileWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);
1810                        if (hFileRead == -1) {
1811                            hFileRead = hFileWrite = 0;
1812                            String sError = strerror(errno);
1813                            throw Exception("Could not (re)open file \"" + Filename + "\" in read mode: " + sError);
1814                        }
1815                        #elif defined(WIN32)
1816                        if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
1817                        hFileRead = hFileWrite = CreateFile(
1818                                                     Filename.c_str(), GENERIC_READ,
1819                                                     FILE_SHARE_READ | FILE_SHARE_WRITE,
1820                                                     NULL, OPEN_EXISTING,
1821                                                     FILE_ATTRIBUTE_NORMAL |
1822                                                     FILE_FLAG_RANDOM_ACCESS,
1823                                                     NULL
1824                                                 );
1825                        if (hFileRead == INVALID_HANDLE_VALUE) {
1826                            hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
1827                            throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");
1828                        }
1829                        #else
1830                        if (hFileRead) fclose(hFileRead);
1831                        hFileRead = hFileWrite = fopen(Filename.c_str(), "rb");
1832                        if (!hFileRead) throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");
1833                        #endif
1834                        __resetPos(); // reset read/write position of ALL 'Chunk' objects
1835                        break;
1836                    case stream_mode_read_write:
1837                        #if POSIX
1838                        if (hFileRead) close(hFileRead);
1839                        hFileRead = hFileWrite = open(Filename.c_str(), O_RDWR | O_NONBLOCK);
1840                        if (hFileRead == -1) {
1841                            hFileRead = hFileWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);
1842                            String sError = strerror(errno);
1843                            throw Exception("Could not open file \"" + Filename + "\" in read+write mode: " + sError);
1844                        }
1845                        #elif defined(WIN32)
1846                        if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
1847                        hFileRead = hFileWrite = CreateFile(
1848                                                     Filename.c_str(),
1849                                                     GENERIC_READ | GENERIC_WRITE,
1850                                                     FILE_SHARE_READ,
1851                                                     NULL, OPEN_ALWAYS,
1852                                                     FILE_ATTRIBUTE_NORMAL |
1853                                                     FILE_FLAG_RANDOM_ACCESS,
1854                                                     NULL
1855                                                 );
1856                        if (hFileRead == INVALID_HANDLE_VALUE) {
1857                            hFileRead = hFileWrite = CreateFile(
1858                                                         Filename.c_str(), GENERIC_READ,
1859                                                         FILE_SHARE_READ | FILE_SHARE_WRITE,
1860                                                         NULL, OPEN_EXISTING,
1861                                                         FILE_ATTRIBUTE_NORMAL |
1862                                                         FILE_FLAG_RANDOM_ACCESS,
1863                                                         NULL
1864                                                     );
1865                            throw Exception("Could not (re)open file \"" + Filename + "\" in read+write mode");
1866                        }
1867                        #else
1868                        if (hFileRead) fclose(hFileRead);
1869                        hFileRead = hFileWrite = fopen(Filename.c_str(), "r+b");
1870                        if (!hFileRead) {
1871                            hFileRead = hFileWrite = fopen(Filename.c_str(), "rb");
1872                            throw Exception("Could not open file \"" + Filename + "\" in read+write mode");
1873                        }
1874                        #endif
1875                        __resetPos(); // reset read/write position of ALL 'Chunk' objects
1876                        break;
1877                    case stream_mode_closed:
1878                        #if POSIX
1879                        if (hFileRead)  close(hFileRead);
1880                        if (hFileWrite) close(hFileWrite);
1881                        hFileRead = hFileWrite = 0;
1882                        #elif defined(WIN32)
1883                        if (hFileRead  != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
1884                        if (hFileWrite != INVALID_HANDLE_VALUE) CloseHandle(hFileWrite);
1885                        hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
1886                        #else
1887                        if (hFileRead)  fclose(hFileRead);
1888                        if (hFileWrite) fclose(hFileWrite);
1889                        hFileRead = hFileWrite = NULL;
1890                        #endif
1891                        break;
1892                    default:
1893                        throw Exception("Unknown file access mode");
1894                }
1895                Mode = NewMode;
1896                return true;
1897            }
1898            return false;
1899        }
1900    
1901        /** @brief Set the byte order to be used when saving.
1902         *
1903         * Set the byte order to be used in the file. A value of
1904         * endian_little will create a RIFF file, endian_big a RIFX file
1905         * and endian_native will create a RIFF file on little-endian
1906         * machines and RIFX on big-endian machines.
1907         *
1908         * @param Endian - endianess to use when file is saved.
1909         */
1910        void File::SetByteOrder(endian_t Endian) {
1911            #if WORDS_BIGENDIAN
1912            bEndianNative = Endian != endian_little;
1913            #else
1914            bEndianNative = Endian != endian_big;
1915            #endif
1916        }
1917    
1918        /** @brief Save changes to same file.
1919         *
1920         * Make all changes of all chunks persistent by writing them to the
1921         * actual (same) file.
1922         *
1923         * @param pProgress - optional: callback function for progress notification
1924         * @throws RIFF::Exception if there is an empty chunk or empty list
1925         *                         chunk or any kind of IO error occurred
1926         */
1927        void File::Save(progress_t* pProgress) {
1928            //TODO: implementation for the case where first chunk is not a global container (List chunk) is not implemented yet (i.e. Korg files)
1929            if (Layout == layout_flat)
1930                throw Exception("Saving a RIFF file with layout_flat is not implemented yet");
1931    
1932            // make sure the RIFF tree is built (from the original file)
1933            if (pProgress) {
1934                // divide progress into subprogress
1935                progress_t subprogress;
1936                __divide_progress(pProgress, &subprogress, 3.f, 0.f); // arbitrarily subdivided into 1/3 of total progress
1937                // do the actual work
1938                LoadSubChunksRecursively(&subprogress);
1939                // notify subprogress done
1940                __notify_progress(&subprogress, 1.f);
1941            } else
1942                LoadSubChunksRecursively(NULL);
1943    
1944            // reopen file in write mode
1945            SetMode(stream_mode_read_write);
1946    
1947            // get the current file size as it is now still physically stored on disk
1948            const file_offset_t workingFileSize = GetCurrentFileSize();
1949    
1950            // get the overall file size required to save this file
1951            const file_offset_t newFileSize = GetRequiredFileSize(FileOffsetPreference);
1952    
1953            // determine whether this file will yield in a large file (>=4GB) and
1954            // the RIFF file offset size to be used accordingly for all chunks
1955            FileOffsetSize = FileOffsetSizeFor(newFileSize);
1956    
1957            // to be able to save the whole file without loading everything into
1958            // RAM and without having to store the data in a temporary file, we
1959            // enlarge the file with the overall positive file size change,
1960            // then move current data towards the end of the file by the calculated
1961            // positive file size difference and finally update / rewrite the file
1962            // by copying the old data back to the right position at the beginning
1963            // of the file
1964    
1965            // if there are positive size changes...
1966            file_offset_t positiveSizeDiff = 0;
1967            if (newFileSize > workingFileSize) {
1968                positiveSizeDiff = newFileSize - workingFileSize;
1969    
1970                // divide progress into subprogress
1971                progress_t subprogress;
1972                if (pProgress)
1973                    __divide_progress(pProgress, &subprogress, 3.f, 1.f); // arbitrarily subdivided into 1/3 of total progress
1974    
1975                // ... we enlarge this file first ...
1976                ResizeFile(newFileSize);
1977    
1978                // ... and move current data by the same amount towards end of file.
1979                int8_t* pCopyBuffer = new int8_t[4096];
1980                #if defined(WIN32)
1981                DWORD iBytesMoved = 1; // we have to pass it via pointer to the Windows API, thus the correct size must be ensured
1982                #else
1983                ssize_t iBytesMoved = 1;
1984                #endif
1985                for (file_offset_t ullPos = workingFileSize, iNotif = 0; iBytesMoved > 0; ++iNotif) {
1986                    iBytesMoved = (ullPos < 4096) ? ullPos : 4096;
1987                    ullPos -= iBytesMoved;
1988                    #if POSIX
1989                    lseek(hFileRead, ullPos, SEEK_SET);
1990                    iBytesMoved = read(hFileRead, pCopyBuffer, iBytesMoved);
1991                    lseek(hFileWrite, ullPos + positiveSizeDiff, SEEK_SET);
1992                    iBytesMoved = write(hFileWrite, pCopyBuffer, iBytesMoved);
1993                    #elif defined(WIN32)
1994                    LARGE_INTEGER liFilePos;
1995                    liFilePos.QuadPart = ullPos;
1996                    SetFilePointerEx(hFileRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
1997                    ReadFile(hFileRead, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
1998                    liFilePos.QuadPart = ullPos + positiveSizeDiff;
1999                    SetFilePointerEx(hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
2000                    WriteFile(hFileWrite, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
2001                    #else
2002                    fseeko(hFileRead, ullPos, SEEK_SET);
2003                    iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, hFileRead);
2004                    fseeko(hFileWrite, ullPos + positiveSizeDiff, SEEK_SET);
2005                    iBytesMoved = fwrite(pCopyBuffer, 1, iBytesMoved, hFileWrite);
2006                    #endif
2007                    if (pProgress && !(iNotif % 8) && iBytesMoved > 0)
2008                        __notify_progress(&subprogress, float(workingFileSize - ullPos) / float(workingFileSize));
2009                }
2010                delete[] pCopyBuffer;
2011                if (iBytesMoved < 0) throw Exception("Could not modify file while trying to enlarge it");
2012    
2013                if (pProgress)
2014                    __notify_progress(&subprogress, 1.f); // notify subprogress done
2015            }
2016    
2017            // rebuild / rewrite complete RIFF tree ...
2018    
2019            // divide progress into subprogress
2020            progress_t subprogress;
2021            if (pProgress)
2022                __divide_progress(pProgress, &subprogress, 3.f, 2.f); // arbitrarily subdivided into 1/3 of total progress
2023            // do the actual work
2024            const file_offset_t finalSize = WriteChunk(0, positiveSizeDiff, pProgress ? &subprogress : NULL);
2025            const file_offset_t finalActualSize = __GetFileSize(hFileWrite);
2026            // notify subprogress done
2027            if (pProgress)
2028                __notify_progress(&subprogress, 1.f);
2029    
2030            // resize file to the final size
2031            if (finalSize < finalActualSize) ResizeFile(finalSize);
2032    
2033            if (pProgress)
2034                __notify_progress(pProgress, 1.0); // notify done
2035        }
2036    
2037        /** @brief Save changes to another file.
2038         *
2039         * Make all changes of all chunks persistent by writing them to another
2040         * file. <b>Caution:</b> this method is optimized for writing to
2041         * <b>another</b> file, do not use it to save the changes to the same
2042         * file! Use File::Save() in that case instead! Ignoring this might
2043         * result in a corrupted file, especially in case chunks were resized!
2044         *
2045         * After calling this method, this File object will be associated with
2046         * the new file (given by \a path) afterwards.
2047         *
2048         * @param path - path and file name where everything should be written to
2049         * @param pProgress - optional: callback function for progress notification
2050         */
2051        void File::Save(const String& path, progress_t* pProgress) {
2052            //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
2053    
2054            //TODO: implementation for the case where first chunk is not a global container (List chunk) is not implemented yet (i.e. Korg files)
2055            if (Layout == layout_flat)
2056                throw Exception("Saving a RIFF file with layout_flat is not implemented yet");
2057    
2058            // make sure the RIFF tree is built (from the original file)
2059            if (pProgress) {
2060                // divide progress into subprogress
2061                progress_t subprogress;
2062                __divide_progress(pProgress, &subprogress, 2.f, 0.f); // arbitrarily subdivided into 1/2 of total progress
2063                // do the actual work
2064                LoadSubChunksRecursively(&subprogress);
2065                // notify subprogress done
2066                __notify_progress(&subprogress, 1.f);
2067            } else
2068                LoadSubChunksRecursively(NULL);
2069    
2070            if (!bIsNewFile) SetMode(stream_mode_read);
2071            // open the other (new) file for writing and truncate it to zero size
2072          #if POSIX          #if POSIX
2073          if (hFile) close(hFile);          hFileWrite = open(path.c_str(), O_RDWR | O_CREAT, S_IRUSR | S_IWUSR | S_IRGRP);
2074            if (hFileWrite == -1) {
2075                hFileWrite = hFileRead;
2076                String sError = strerror(errno);
2077                throw Exception("Could not open file \"" + path + "\" for writing: " + sError);
2078            }
2079            #elif defined(WIN32)
2080            hFileWrite = CreateFile(
2081                             path.c_str(), GENERIC_WRITE, FILE_SHARE_READ,
2082                             NULL, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL |
2083                             FILE_FLAG_RANDOM_ACCESS, NULL
2084                         );
2085            if (hFileWrite == INVALID_HANDLE_VALUE) {
2086                hFileWrite = hFileRead;
2087                throw Exception("Could not open file \"" + path + "\" for writing");
2088            }
2089          #else          #else
2090          if (hFile) fclose(hFile);          hFileWrite = fopen(path.c_str(), "w+b");
2091            if (!hFileWrite) {
2092                hFileWrite = hFileRead;
2093                throw Exception("Could not open file \"" + path + "\" for writing");
2094            }
2095          #endif // POSIX          #endif // POSIX
2096            Mode = stream_mode_read_write;
2097    
2098            // get the overall file size required to save this file
2099            const file_offset_t newFileSize = GetRequiredFileSize(FileOffsetPreference);
2100    
2101            // determine whether this file will yield in a large file (>=4GB) and
2102            // the RIFF file offset size to be used accordingly for all chunks
2103            FileOffsetSize = FileOffsetSizeFor(newFileSize);
2104    
2105            // write complete RIFF tree to the other (new) file
2106            file_offset_t ullTotalSize;
2107            if (pProgress) {
2108                // divide progress into subprogress
2109                progress_t subprogress;
2110                __divide_progress(pProgress, &subprogress, 2.f, 1.f); // arbitrarily subdivided into 1/2 of total progress
2111                // do the actual work
2112                ullTotalSize = WriteChunk(0, 0, &subprogress);
2113                // notify subprogress done
2114                __notify_progress(&subprogress, 1.f);
2115            } else
2116                ullTotalSize = WriteChunk(0, 0, NULL);
2117    
2118            file_offset_t ullActualSize = __GetFileSize(hFileWrite);
2119    
2120            // resize file to the final size (if the file was originally larger)
2121            if (ullActualSize > ullTotalSize) ResizeFile(ullTotalSize);
2122    
2123            #if POSIX
2124            if (hFileWrite) close(hFileWrite);
2125            #elif defined(WIN32)
2126            if (hFileWrite != INVALID_HANDLE_VALUE) CloseHandle(hFileWrite);
2127            #else
2128            if (hFileWrite) fclose(hFileWrite);
2129            #endif
2130            hFileWrite = hFileRead;
2131    
2132            // associate new file with this File object from now on
2133            Filename = path;
2134            bIsNewFile = false;
2135            Mode = (stream_mode_t) -1;       // Just set it to an undefined mode ...
2136            SetMode(stream_mode_read_write); // ... so SetMode() has to reopen the file handles.
2137    
2138            if (pProgress)
2139                __notify_progress(pProgress, 1.0); // notify done
2140      }      }
2141    
2142      unsigned long File::GetFileSize() {      void File::ResizeFile(file_offset_t ullNewSize) {
2143          #if POSIX          #if POSIX
2144          struct stat filestat;          if (ftruncate(hFileWrite, ullNewSize) < 0)
2145          fstat(hFile, &filestat);              throw Exception("Could not resize file \"" + Filename + "\"");
2146          long size = filestat.st_size;          #elif defined(WIN32)
2147          #else // standard C functions          LARGE_INTEGER liFilePos;
2148          long curpos = ftell(hFile);          liFilePos.QuadPart = ullNewSize;
2149          fseek(hFile, 0, SEEK_END);          if (
2150          long size = ftell(hFile);              !SetFilePointerEx(hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN) ||
2151          fseek(hFile, curpos, SEEK_SET);              !SetEndOfFile(hFileWrite)
2152            ) throw Exception("Could not resize file \"" + Filename + "\"");
2153            #else
2154            # error Sorry, this version of libgig only supports POSIX and Windows systems yet.
2155            # error Reason: portable implementation of RIFF::File::ResizeFile() is missing (yet)!
2156            #endif
2157        }
2158    
2159        File::~File() {
2160            #if DEBUG_RIFF
2161            std::cout << "File::~File()" << std::endl;
2162            #endif // DEBUG_RIFF
2163            Cleanup();
2164        }
2165    
2166        /**
2167         * Returns @c true if this file has been created new from scratch and
2168         * has not been stored to disk yet.
2169         */
2170        bool File::IsNew() const {
2171            return bIsNewFile;
2172        }
2173    
2174        void File::Cleanup() {
2175            #if POSIX
2176            if (hFileRead) close(hFileRead);
2177            #elif defined(WIN32)
2178            if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
2179            #else
2180            if (hFileRead) fclose(hFileRead);
2181          #endif // POSIX          #endif // POSIX
2182            DeleteChunkList();
2183            pFile = NULL;
2184        }
2185    
2186        /**
2187         * Returns the current size of this file (in bytes) as it is currently
2188         * yet stored on disk. If this file does not yet exist on disk (i.e. when
2189         * this RIFF File has just been created from scratch and Save() has not
2190         * been called yet) then this method returns 0.
2191         */
2192        file_offset_t File::GetCurrentFileSize() const {
2193            file_offset_t size = 0;
2194            try {
2195                size = __GetFileSize(hFileRead);
2196            } catch (...) {
2197                size = 0;
2198            }
2199          return size;          return size;
2200      }      }
2201    
2202        /**
2203         * Returns the required size (in bytes) for this RIFF File to be saved to
2204         * disk. The precise size of the final file on disk depends on the RIFF
2205         * file offset size actually used internally in all headers of the RIFF
2206         * chunks. By default libgig handles the required file offset size
2207         * automatically for you; that means it is using 32 bit offsets for files
2208         * smaller than 4 GB and 64 bit offsets for files equal or larger than
2209         * 4 GB. You may however also override this default behavior by passing the
2210         * respective option to the RIFF File constructor to force one particular
2211         * offset size. In the latter case this method will return the file size
2212         * for the requested forced file offset size that will be used when calling
2213         * Save() later on.
2214         *
2215         * You may also use the overridden method below to get the file size for
2216         * an arbitrary other file offset size instead.
2217         *
2218         * @see offset_size_t
2219         * @see GetFileOffsetSize()
2220         */
2221        file_offset_t File::GetRequiredFileSize() {
2222            return GetRequiredFileSize(FileOffsetPreference);
2223        }
2224    
2225        /**
2226         * Returns the rquired size (in bytes) for this RIFF file to be saved to
2227         * disk, assuming the passed @a fileOffsestSize would be used for the
2228         * Save() operation.
2229         *
2230         * This overridden method essentialy behaves like the above method, with
2231         * the difference that you must provide a specific RIFF @a fileOffsetSize
2232         * for calculating the theoretical final file size.
2233         *
2234         * @see GetFileOffsetSize()
2235         */
2236        file_offset_t File::GetRequiredFileSize(offset_size_t fileOffsetSize) {
2237            switch (fileOffsetSize) {
2238                case offset_size_auto: {
2239                    file_offset_t fileSize = GetRequiredFileSize(offset_size_32bit);
2240                    if (fileSize >> 32)
2241                        return GetRequiredFileSize(offset_size_64bit);
2242                    else
2243                        return fileSize;
2244                }
2245                case offset_size_32bit: break;
2246                case offset_size_64bit: break;
2247                default: throw Exception("Internal error: Invalid RIFF::offset_size_t");
2248            }
2249            return RequiredPhysicalSize(FileOffsetSize);
2250        }
2251    
2252        int File::FileOffsetSizeFor(file_offset_t fileSize) const {
2253            switch (FileOffsetPreference) {
2254                case offset_size_auto:
2255                    return (fileSize >> 32) ? 8 : 4;
2256                case offset_size_32bit:
2257                    return 4;
2258                case offset_size_64bit:
2259                    return 8;
2260                default:
2261                    throw Exception("Internal error: Invalid RIFF::offset_size_t");
2262            }
2263        }
2264    
2265        /**
2266         * Returns the current size (in bytes) of file offsets stored in the
2267         * headers of all chunks of this file.
2268         *
2269         * Most RIFF files are using 32 bit file offsets internally, which limits
2270         * them to a maximum file size of less than 4 GB though. In contrast to the
2271         * common standard, this RIFF File class implementation supports handling of
2272         * RIFF files equal or larger than 4 GB. In such cases 64 bit file offsets
2273         * have to be used in all headers of all RIFF Chunks when being stored to a
2274         * physical file. libgig by default automatically selects the correct file
2275         * offset size for you. You may however also force one particular file
2276         * offset size by supplying the respective option to the RIFF::File
2277         * constructor.
2278         *
2279         * This method can be used to check which RIFF file offset size is currently
2280         * being used for this RIFF File.
2281         *
2282         * @returns current RIFF file offset size used (in bytes)
2283         * @see offset_size_t
2284         */
2285        int File::GetFileOffsetSize() const {
2286            return FileOffsetSize;
2287        }
2288    
2289        /**
2290         * Returns the required size (in bytes) of file offsets stored in the
2291         * headers of all chunks of this file if the current RIFF tree would be
2292         * saved to disk by calling Save().
2293         *
2294         * See GetFileOffsetSize() for mor details about RIFF file offsets.
2295         *
2296         * @returns RIFF file offset size required (in bytes) if being saved
2297         * @see offset_size_t
2298         */
2299        int File::GetRequiredFileOffsetSize() {
2300            return FileOffsetSizeFor(GetCurrentFileSize());
2301        }
2302    
2303        #if POSIX
2304        file_offset_t File::__GetFileSize(int hFile) const {
2305            struct stat filestat;
2306            if (fstat(hFile, &filestat) == -1)
2307                throw Exception("POSIX FS error: could not determine file size");
2308            return filestat.st_size;
2309        }
2310        #elif defined(WIN32)
2311        file_offset_t File::__GetFileSize(HANDLE hFile) const {
2312            LARGE_INTEGER size;
2313            if (!GetFileSizeEx(hFile, &size))
2314                throw Exception("Windows FS error: could not determine file size");
2315            return size.QuadPart;
2316        }
2317        #else // standard C functions
2318        file_offset_t File::__GetFileSize(FILE* hFile) const {
2319            off_t curpos = ftello(hFile);
2320            if (fseeko(hFile, 0, SEEK_END) == -1)
2321                throw Exception("FS error: could not determine file size");
2322            off_t size = ftello(hFile);
2323            fseeko(hFile, curpos, SEEK_SET);
2324            return size;
2325        }
2326        #endif
2327    
2328    
2329  // *************** Exception ***************  // *************** Exception ***************
2330  // *  // *
2331    
2332        Exception::Exception() {
2333        }
2334    
2335        Exception::Exception(String format, ...) {
2336            va_list arg;
2337            va_start(arg, format);
2338            Message = assemble(format, arg);
2339            va_end(arg);
2340        }
2341    
2342        Exception::Exception(String format, va_list arg) {
2343            Message = assemble(format, arg);
2344        }
2345    
2346      void Exception::PrintMessage() {      void Exception::PrintMessage() {
2347          std::cout << "RIFF::Exception: " << Message << std::endl;          std::cout << "RIFF::Exception: " << Message << std::endl;
2348      }      }
2349    
2350        String Exception::assemble(String format, va_list arg) {
2351            char* buf = NULL;
2352            vasprintf(&buf, format.c_str(), arg);
2353            String s = buf;
2354            free(buf);
2355            return s;
2356        }
2357    
2358    
2359    // *************** functions ***************
2360    // *
2361    
2362        /**
2363         * Returns the name of this C++ library. This is usually "libgig" of
2364         * course. This call is equivalent to DLS::libraryName() and
2365         * gig::libraryName().
2366         */
2367        String libraryName() {
2368            return PACKAGE;
2369        }
2370    
2371        /**
2372         * Returns version of this C++ library. This call is equivalent to
2373         * DLS::libraryVersion() and gig::libraryVersion().
2374         */
2375        String libraryVersion() {
2376            return VERSION;
2377        }
2378    
2379  } // namespace RIFF  } // namespace RIFF
 #endif  

Legend:
Removed from v.384  
changed lines
  Added in v.3488

  ViewVC Help
Powered by ViewVC