/[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 3481 by schoenebeck, Fri Feb 22 12:12:50 2019 UTC revision 3919 by schoenebeck, Sat Jun 12 13:51:10 2021 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file access library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2019 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2021 by Christian Schoenebeck                      *
6   *                              <cuse@users.sourceforge.net>               *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   This library is free software; you can redistribute it and/or modify  *
# Line 52  namespace RIFF { Line 52  namespace RIFF {
52          return sPath;          return sPath;
53      }      }
54    
55        inline static bool _isValidHandle(File::Handle handle) {
56            #if defined(WIN32)
57            return handle != INVALID_HANDLE_VALUE;
58            #else
59            return handle;
60            #endif
61        }
62    
63        inline static void _close(File::Handle handle) {
64            if (!_isValidHandle(handle)) return;
65            #if POSIX
66            close(handle);
67            #elif defined(WIN32)
68            CloseHandle(handle);
69            #else
70            fclose(handle);
71            #endif
72        }
73    
74    
75    
76  // *************** progress_t ***************  // *************** progress_t ***************
# Line 129  namespace RIFF { Line 148  namespace RIFF {
148          #if DEBUG_RIFF          #if DEBUG_RIFF
149          std::cout << "Chunk::Chunk(File* pFile)" << std::endl;          std::cout << "Chunk::Chunk(File* pFile)" << std::endl;
150          #endif // DEBUG_RIFF          #endif // DEBUG_RIFF
151          ullPos     = 0;          chunkPos.ullPos = 0;
152          pParent    = NULL;          pParent    = NULL;
153          pChunkData = NULL;          pChunkData = NULL;
154          ullCurrentChunkSize = 0;          ullCurrentChunkSize = 0;
# Line 146  namespace RIFF { Line 165  namespace RIFF {
165          this->pFile   = pFile;          this->pFile   = pFile;
166          ullStartPos   = StartPos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize);          ullStartPos   = StartPos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize);
167          pParent       = Parent;          pParent       = Parent;
168          ullPos        = 0;          chunkPos.ullPos = 0;
169          pChunkData    = NULL;          pChunkData    = NULL;
170          ullCurrentChunkSize = 0;          ullCurrentChunkSize = 0;
171          ullNewChunkSize = 0;          ullNewChunkSize = 0;
# Line 158  namespace RIFF { Line 177  namespace RIFF {
177          this->pFile      = pFile;          this->pFile      = pFile;
178          ullStartPos      = 0; // arbitrary usually, since it will be updated when we write the chunk          ullStartPos      = 0; // arbitrary usually, since it will be updated when we write the chunk
179          this->pParent    = pParent;          this->pParent    = pParent;
180          ullPos           = 0;          chunkPos.ullPos  = 0;
181          pChunkData       = NULL;          pChunkData       = NULL;
182          ChunkID          = uiChunkID;          ChunkID          = uiChunkID;
183          ullChunkDataSize = 0;          ullChunkDataSize = 0;
# Line 176  namespace RIFF { Line 195  namespace RIFF {
195          #endif // DEBUG_RIFF          #endif // DEBUG_RIFF
196          ChunkID = 0;          ChunkID = 0;
197          ullNewChunkSize = ullCurrentChunkSize = 0;          ullNewChunkSize = ullCurrentChunkSize = 0;
198    
199            const File::Handle hRead = pFile->FileHandle();
200    
201          #if POSIX          #if POSIX
202          if (lseek(pFile->hFileRead, filePos, SEEK_SET) != -1) {          if (lseek(hRead, filePos, SEEK_SET) != -1) {
203              read(pFile->hFileRead, &ChunkID, 4);              read(hRead, &ChunkID, 4);
204              read(pFile->hFileRead, &ullCurrentChunkSize, pFile->FileOffsetSize);              read(hRead, &ullCurrentChunkSize, pFile->FileOffsetSize);
205          #elif defined(WIN32)          #elif defined(WIN32)
206          LARGE_INTEGER liFilePos;          LARGE_INTEGER liFilePos;
207          liFilePos.QuadPart = filePos;          liFilePos.QuadPart = filePos;
208          if (SetFilePointerEx(pFile->hFileRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN)) {          if (SetFilePointerEx(hRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN)) {
209              DWORD dwBytesRead;              DWORD dwBytesRead;
210              ReadFile(pFile->hFileRead, &ChunkID, 4, &dwBytesRead, NULL);              ReadFile(hRead, &ChunkID, 4, &dwBytesRead, NULL);
211              ReadFile(pFile->hFileRead, &ullCurrentChunkSize, pFile->FileOffsetSize, &dwBytesRead, NULL);              ReadFile(hRead, &ullCurrentChunkSize, pFile->FileOffsetSize, &dwBytesRead, NULL);
212          #else          #else
213          if (!fseeko(pFile->hFileRead, filePos, SEEK_SET)) {          if (!fseeko(hRead, filePos, SEEK_SET)) {
214              fread(&ChunkID, 4, 1, pFile->hFileRead);              fread(&ChunkID, 4, 1, hRead);
215              fread(&ullCurrentChunkSize, pFile->FileOffsetSize, 1, pFile->hFileRead);              fread(&ullCurrentChunkSize, pFile->FileOffsetSize, 1, hRead);
216          #endif // POSIX          #endif // POSIX
217              #if WORDS_BIGENDIAN              #if WORDS_BIGENDIAN
218              if (ChunkID == CHUNK_ID_RIFF) {              if (ChunkID == CHUNK_ID_RIFF) {
# Line 236  namespace RIFF { Line 258  namespace RIFF {
258                  swapBytes_64(&ullNewChunkSize);                  swapBytes_64(&ullNewChunkSize);
259          }          }
260    
261            const File::Handle hWrite = pFile->FileWriteHandle();
262    
263          #if POSIX          #if POSIX
264          if (lseek(pFile->hFileWrite, filePos, SEEK_SET) != -1) {          if (lseek(hWrite, filePos, SEEK_SET) != -1) {
265              write(pFile->hFileWrite, &uiNewChunkID, 4);              write(hWrite, &uiNewChunkID, 4);
266              write(pFile->hFileWrite, &ullNewChunkSize, pFile->FileOffsetSize);              write(hWrite, &ullNewChunkSize, pFile->FileOffsetSize);
267          }          }
268          #elif defined(WIN32)          #elif defined(WIN32)
269          LARGE_INTEGER liFilePos;          LARGE_INTEGER liFilePos;
270          liFilePos.QuadPart = filePos;          liFilePos.QuadPart = filePos;
271          if (SetFilePointerEx(pFile->hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN)) {          if (SetFilePointerEx(hWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN)) {
272              DWORD dwBytesWritten;              DWORD dwBytesWritten;
273              WriteFile(pFile->hFileWrite, &uiNewChunkID, 4, &dwBytesWritten, NULL);              WriteFile(hWrite, &uiNewChunkID, 4, &dwBytesWritten, NULL);
274              WriteFile(pFile->hFileWrite, &ullNewChunkSize, pFile->FileOffsetSize, &dwBytesWritten, NULL);              WriteFile(hWrite, &ullNewChunkSize, pFile->FileOffsetSize, &dwBytesWritten, NULL);
275          }          }
276          #else          #else
277          if (!fseeko(pFile->hFileWrite, filePos, SEEK_SET)) {          if (!fseeko(hWrite, filePos, SEEK_SET)) {
278              fwrite(&uiNewChunkID, 4, 1, pFile->hFileWrite);              fwrite(&uiNewChunkID, 4, 1, hWrite);
279              fwrite(&ullNewChunkSize, pFile->FileOffsetSize, 1, pFile->hFileWrite);              fwrite(&ullNewChunkSize, pFile->FileOffsetSize, 1, hWrite);
280          }          }
281          #endif // POSIX          #endif // POSIX
282      }      }
# Line 266  namespace RIFF { Line 290  namespace RIFF {
290      }      }
291    
292      /**      /**
293         * This is an internal-only method which must not be used by any application
294         * and might change at any time.
295         *
296         * Returns a reference (memory location) of the chunk's current file
297         * (read/write) position variable which depends on the current value of
298         * File::IsIOPerThread().
299         */
300        file_offset_t& Chunk::GetPosUnsafeRef() {
301            if (!pFile->IsIOPerThread()) return chunkPos.ullPos;
302            const std::thread::id tid = std::this_thread::get_id();
303            return chunkPos.byThread[tid];
304        }
305    
306        /**
307         * Current read/write position within the chunk data body (starting with 0).
308         *
309         * @see File::IsIOPerThread() for multi-threaded streaming
310         */
311        file_offset_t Chunk::GetPos() const {
312            if (!pFile->IsIOPerThread()) return chunkPos.ullPos;
313            const std::thread::id tid = std::this_thread::get_id();
314            std::lock_guard<std::mutex> lock(chunkPos.mutex);
315            return chunkPos.byThread[tid];
316        }
317    
318        /**
319         * Current, actual offset in file of current chunk data body read/write
320         * position.
321         *
322         * @see File::IsIOPerThread() for multi-threaded streaming
323         */
324        file_offset_t Chunk::GetFilePos() const {
325            return ullStartPos + GetPos();
326        }
327    
328        /**
329       *  Sets the position within the chunk body, thus within the data portion       *  Sets the position within the chunk body, thus within the data portion
330       *  of the chunk (in bytes).       *  of the chunk (in bytes).
331       *       *
# Line 276  namespace RIFF { Line 336  namespace RIFF {
336       *  @param Whence - optional: defines to what <i>\a Where</i> relates to,       *  @param Whence - optional: defines to what <i>\a Where</i> relates to,
337       *                  if omitted \a Where relates to beginning of the chunk       *                  if omitted \a Where relates to beginning of the chunk
338       *                  data       *                  data
339         *  @see File::IsIOPerThread() for multi-threaded streaming
340       */       */
341      file_offset_t Chunk::SetPos(file_offset_t Where, stream_whence_t Whence) {      file_offset_t Chunk::SetPos(file_offset_t Where, stream_whence_t Whence) {
342          #if DEBUG_RIFF          #if DEBUG_RIFF
343          std::cout << "Chunk::SetPos(file_offset_t,stream_whence_t)" << std::endl;          std::cout << "Chunk::SetPos(file_offset_t,stream_whence_t)" << std::endl;
344          #endif // DEBUG_RIFF          #endif // DEBUG_RIFF
345            std::lock_guard<std::mutex> lock(chunkPos.mutex);
346            file_offset_t& pos = GetPosUnsafeRef();
347          switch (Whence) {          switch (Whence) {
348              case stream_curpos:              case stream_curpos:
349                  ullPos += Where;                  pos += Where;
350                  break;                  break;
351              case stream_end:              case stream_end:
352                  ullPos = ullCurrentChunkSize - 1 - Where;                  pos = ullCurrentChunkSize - 1 - Where;
353                  break;                  break;
354              case stream_backward:              case stream_backward:
355                  ullPos -= Where;                  pos -= Where;
356                  break;                  break;
357              case stream_start: default:              case stream_start: default:
358                  ullPos = Where;                  pos = Where;
359                  break;                  break;
360          }          }
361          if (ullPos > ullCurrentChunkSize) ullPos = ullCurrentChunkSize;          if (pos > ullCurrentChunkSize) pos = ullCurrentChunkSize;
362          return ullPos;          return pos;
363      }      }
364    
365      /**      /**
# Line 308  namespace RIFF { Line 371  namespace RIFF {
371       *  of the chunk data.       *  of the chunk data.
372       *       *
373       *  @returns  number of bytes left to read       *  @returns  number of bytes left to read
374         *  @see File::IsIOPerThread() for multi-threaded streaming
375       */       */
376      file_offset_t Chunk::RemainingBytes() const {      file_offset_t Chunk::RemainingBytes() const {
377          #if DEBUG_RIFF          #if DEBUG_RIFF
378          std::cout << "Chunk::Remainingbytes()=" << ullCurrentChunkSize - ullPos << std::endl;          std::cout << "Chunk::Remainingbytes()=" << ullCurrentChunkSize - ullPos << std::endl;
379          #endif // DEBUG_RIFF          #endif // DEBUG_RIFF
380          return (ullCurrentChunkSize > ullPos) ? ullCurrentChunkSize - ullPos : 0;          const file_offset_t pos = GetPos();
381            return (ullCurrentChunkSize > pos) ? ullCurrentChunkSize - pos : 0;
382      }      }
383    
384      /**      /**
# Line 339  namespace RIFF { Line 404  namespace RIFF {
404       *  - RIFF::stream_end_reached :       *  - RIFF::stream_end_reached :
405       *    already reached the end of the chunk data, no more reading       *    already reached the end of the chunk data, no more reading
406       *    possible without SetPos()       *    possible without SetPos()
407         *
408         *  @see File::IsIOPerThread() for multi-threaded streaming
409       */       */
410      stream_state_t Chunk::GetState() const {      stream_state_t Chunk::GetState() const {
411          #if DEBUG_RIFF          #if DEBUG_RIFF
412          std::cout << "Chunk::GetState()" << std::endl;          std::cout << "Chunk::GetState()" << std::endl;
413          #endif // DEBUG_RIFF          #endif // DEBUG_RIFF
414          #if POSIX  
415          if (pFile->hFileRead == 0) return stream_closed;          const File::Handle hRead = pFile->FileHandle();
416          #elif defined (WIN32)  
417          if (pFile->hFileRead == INVALID_HANDLE_VALUE)          if (!_isValidHandle(hRead))
418              return stream_closed;              return stream_closed;
419          #else  
420          if (pFile->hFileRead == NULL) return stream_closed;          const file_offset_t pos = GetPos();
421          #endif // POSIX          if (pos < ullCurrentChunkSize)    return stream_ready;
         if (ullPos < ullCurrentChunkSize) return stream_ready;  
422          else                              return stream_end_reached;          else                              return stream_end_reached;
423      }      }
424    
# Line 370  namespace RIFF { Line 436  namespace RIFF {
436       *  @param WordSize   size of each data word to read       *  @param WordSize   size of each data word to read
437       *  @returns          number of successfully read data words or 0 if end       *  @returns          number of successfully read data words or 0 if end
438       *                    of file reached or error occurred       *                    of file reached or error occurred
439         *  @see File::IsIOPerThread() for multi-threaded streaming
440       */       */
441      file_offset_t Chunk::Read(void* pData, file_offset_t WordCount, file_offset_t WordSize) {      file_offset_t Chunk::Read(void* pData, file_offset_t WordCount, file_offset_t WordSize) {
442          #if DEBUG_RIFF          #if DEBUG_RIFF
443          std::cout << "Chunk::Read(void*,file_offset_t,file_offset_t)" << std::endl;          std::cout << "Chunk::Read(void*,file_offset_t,file_offset_t)" << std::endl;
444          #endif // DEBUG_RIFF          #endif // DEBUG_RIFF
445          //if (ulStartPos == 0) return 0; // is only 0 if this is a new chunk, so nothing to read (yet)          //if (ulStartPos == 0) return 0; // is only 0 if this is a new chunk, so nothing to read (yet)
446          if (ullPos >= ullCurrentChunkSize) return 0;          const file_offset_t pos = GetPos();
447          if (ullPos + WordCount * WordSize >= ullCurrentChunkSize) WordCount = (ullCurrentChunkSize - ullPos) / WordSize;          if (pos >= ullCurrentChunkSize) return 0;
448            if (pos + WordCount * WordSize >= ullCurrentChunkSize)
449                WordCount = (ullCurrentChunkSize - pos) / WordSize;
450    
451            const File::Handle hRead = pFile->FileHandle();
452    
453          #if POSIX          #if POSIX
454          if (lseek(pFile->hFileRead, ullStartPos + ullPos, SEEK_SET) < 0) return 0;          if (lseek(hRead, ullStartPos + pos, SEEK_SET) < 0) return 0;
455          ssize_t readWords = read(pFile->hFileRead, pData, WordCount * WordSize);          ssize_t readWords = read(hRead, pData, WordCount * WordSize);
456          if (readWords < 1) {          if (readWords < 1) {
457              #if DEBUG_RIFF              #if DEBUG_RIFF
458              std::cerr << "POSIX read() failed: " << strerror(errno) << std::endl << std::flush;              std::cerr << "POSIX read() failed: " << strerror(errno) << std::endl << std::flush;
# Line 390  namespace RIFF { Line 462  namespace RIFF {
462          readWords /= WordSize;          readWords /= WordSize;
463          #elif defined(WIN32)          #elif defined(WIN32)
464          LARGE_INTEGER liFilePos;          LARGE_INTEGER liFilePos;
465          liFilePos.QuadPart = ullStartPos + ullPos;          liFilePos.QuadPart = ullStartPos + pos;
466          if (!SetFilePointerEx(pFile->hFileRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN))          if (!SetFilePointerEx(hRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN))
467              return 0;              return 0;
468          DWORD readWords;          DWORD readWords;
469          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)          ReadFile(hRead, 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)
470          if (readWords < 1) return 0;          if (readWords < 1) return 0;
471          readWords /= WordSize;          readWords /= WordSize;
472          #else // standard C functions          #else // standard C functions
473          if (fseeko(pFile->hFileRead, ullStartPos + ullPos, SEEK_SET)) return 0;          if (fseeko(hRead, ullStartPos + pos, SEEK_SET)) return 0;
474          file_offset_t readWords = fread(pData, WordSize, WordCount, pFile->hFileRead);          file_offset_t readWords = fread(pData, WordSize, WordCount, hRead);
475          #endif // POSIX          #endif // POSIX
476          if (!pFile->bEndianNative && WordSize != 1) {          if (!pFile->bEndianNative && WordSize != 1) {
477              switch (WordSize) {              switch (WordSize) {
# Line 440  namespace RIFF { Line 512  namespace RIFF {
512       *  @throws RIFF::Exception  if write operation would exceed current       *  @throws RIFF::Exception  if write operation would exceed current
513       *                           chunk size or any IO error occurred       *                           chunk size or any IO error occurred
514       *  @see Resize()       *  @see Resize()
515         *  @see File::IsIOPerThread() for multi-threaded streaming
516       */       */
517      file_offset_t Chunk::Write(void* pData, file_offset_t WordCount, file_offset_t WordSize) {      file_offset_t Chunk::Write(void* pData, file_offset_t WordCount, file_offset_t WordSize) {
518          if (pFile->Mode != stream_mode_read_write)          const File::HandlePair io = pFile->FileHandlePair();
519            if (io.Mode != stream_mode_read_write)
520              throw Exception("Cannot write data to chunk, file has to be opened in read+write mode first");              throw Exception("Cannot write data to chunk, file has to be opened in read+write mode first");
521          if (ullPos >= ullCurrentChunkSize || ullPos + WordCount * WordSize > ullCurrentChunkSize)          const file_offset_t pos = GetPos();
522            if (pos >= ullCurrentChunkSize || pos + WordCount * WordSize > ullCurrentChunkSize)
523              throw Exception("End of chunk reached while trying to write data");              throw Exception("End of chunk reached while trying to write data");
524          if (!pFile->bEndianNative && WordSize != 1) {          if (!pFile->bEndianNative && WordSize != 1) {
525              switch (WordSize) {              switch (WordSize) {
# Line 467  namespace RIFF { Line 542  namespace RIFF {
542              }              }
543          }          }
544          #if POSIX          #if POSIX
545          if (lseek(pFile->hFileWrite, ullStartPos + ullPos, SEEK_SET) < 0) {          if (lseek(io.hWrite, ullStartPos + pos, SEEK_SET) < 0) {
546              throw Exception("Could not seek to position " + ToString(ullPos) +              throw Exception("Could not seek to position " + ToString(pos) +
547                              " in chunk (" + ToString(ullStartPos + ullPos) + " in file)");                              " in chunk (" + ToString(ullStartPos + pos) + " in file)");
548          }          }
549          ssize_t writtenWords = write(pFile->hFileWrite, pData, WordCount * WordSize);          ssize_t writtenWords = write(io.hWrite, pData, WordCount * WordSize);
550          if (writtenWords < 1) throw Exception("POSIX IO Error while trying to write chunk data");          if (writtenWords < 1) throw Exception("POSIX IO Error while trying to write chunk data");
551          writtenWords /= WordSize;          writtenWords /= WordSize;
552          #elif defined(WIN32)          #elif defined(WIN32)
553          LARGE_INTEGER liFilePos;          LARGE_INTEGER liFilePos;
554          liFilePos.QuadPart = ullStartPos + ullPos;          liFilePos.QuadPart = ullStartPos + pos;
555          if (!SetFilePointerEx(pFile->hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN)) {          if (!SetFilePointerEx(io.hWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN)) {
556              throw Exception("Could not seek to position " + ToString(ullPos) +              throw Exception("Could not seek to position " + ToString(pos) +
557                              " in chunk (" + ToString(ullStartPos + ullPos) + " in file)");                              " in chunk (" + ToString(ullStartPos + pos) + " in file)");
558          }          }
559          DWORD writtenWords;          DWORD writtenWords;
560          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)          WriteFile(io.hWrite, 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)
561          if (writtenWords < 1) throw Exception("Windows IO Error while trying to write chunk data");          if (writtenWords < 1) throw Exception("Windows IO Error while trying to write chunk data");
562          writtenWords /= WordSize;          writtenWords /= WordSize;
563          #else // standard C functions          #else // standard C functions
564          if (fseeko(pFile->hFileWrite, ullStartPos + ullPos, SEEK_SET)) {          if (fseeko(io.hWrite, ullStartPos + pos, SEEK_SET)) {
565              throw Exception("Could not seek to position " + ToString(ullPos) +              throw Exception("Could not seek to position " + ToString(pos) +
566                              " in chunk (" + ToString(ullStartPos + ullPos) + " in file)");                              " in chunk (" + ToString(ullStartPos + pos) + " in file)");
567          }          }
568          file_offset_t writtenWords = fwrite(pData, WordSize, WordCount, pFile->hFileWrite);          file_offset_t writtenWords = fwrite(pData, WordSize, WordCount, io.hWrite);
569          #endif // POSIX          #endif // POSIX
570          SetPos(writtenWords * WordSize, stream_curpos);          SetPos(writtenWords * WordSize, stream_curpos);
571          return writtenWords;          return writtenWords;
# Line 513  namespace RIFF { Line 588  namespace RIFF {
588       * @returns                 number of read integers       * @returns                 number of read integers
589       * @throws RIFF::Exception  if an error occurred or less than       * @throws RIFF::Exception  if an error occurred or less than
590       *                          \a WordCount integers could be read!       *                          \a WordCount integers could be read!
591         * @see File::IsIOPerThread() for multi-threaded streaming
592       */       */
593      file_offset_t Chunk::ReadInt8(int8_t* pData, file_offset_t WordCount) {      file_offset_t Chunk::ReadInt8(int8_t* pData, file_offset_t WordCount) {
594          #if DEBUG_RIFF          #if DEBUG_RIFF
# Line 534  namespace RIFF { Line 610  namespace RIFF {
610       * @returns                 number of written integers       * @returns                 number of written integers
611       * @throws RIFF::Exception  if an IO error occurred       * @throws RIFF::Exception  if an IO error occurred
612       * @see Resize()       * @see Resize()
613         * @see File::IsIOPerThread() for multi-threaded streaming
614       */       */
615      file_offset_t Chunk::WriteInt8(int8_t* pData, file_offset_t WordCount) {      file_offset_t Chunk::WriteInt8(int8_t* pData, file_offset_t WordCount) {
616          return Write(pData, WordCount, 1);          return Write(pData, WordCount, 1);
# Line 550  namespace RIFF { Line 627  namespace RIFF {
627       * @returns                 number of read integers       * @returns                 number of read integers
628       * @throws RIFF::Exception  if an error occurred or less than       * @throws RIFF::Exception  if an error occurred or less than
629       *                          \a WordCount integers could be read!       *                          \a WordCount integers could be read!
630         * @see File::IsIOPerThread() for multi-threaded streaming
631       */       */
632      file_offset_t Chunk::ReadUint8(uint8_t* pData, file_offset_t WordCount) {      file_offset_t Chunk::ReadUint8(uint8_t* pData, file_offset_t WordCount) {
633          #if DEBUG_RIFF          #if DEBUG_RIFF
# Line 571  namespace RIFF { Line 649  namespace RIFF {
649       * @returns                 number of written integers       * @returns                 number of written integers
650       * @throws RIFF::Exception  if an IO error occurred       * @throws RIFF::Exception  if an IO error occurred
651       * @see Resize()       * @see Resize()
652         * @see File::IsIOPerThread() for multi-threaded streaming
653       */       */
654      file_offset_t Chunk::WriteUint8(uint8_t* pData, file_offset_t WordCount) {      file_offset_t Chunk::WriteUint8(uint8_t* pData, file_offset_t WordCount) {
655          return Write(pData, WordCount, 1);          return Write(pData, WordCount, 1);
# Line 587  namespace RIFF { Line 666  namespace RIFF {
666       * @returns                 number of read integers       * @returns                 number of read integers
667       * @throws RIFF::Exception  if an error occurred or less than       * @throws RIFF::Exception  if an error occurred or less than
668       *                          \a WordCount integers could be read!       *                          \a WordCount integers could be read!
669         * @see File::IsIOPerThread() for multi-threaded streaming
670       */       */
671      file_offset_t Chunk::ReadInt16(int16_t* pData, file_offset_t WordCount) {      file_offset_t Chunk::ReadInt16(int16_t* pData, file_offset_t WordCount) {
672          #if DEBUG_RIFF          #if DEBUG_RIFF
# Line 608  namespace RIFF { Line 688  namespace RIFF {
688       * @returns                 number of written integers       * @returns                 number of written integers
689       * @throws RIFF::Exception  if an IO error occurred       * @throws RIFF::Exception  if an IO error occurred
690       * @see Resize()       * @see Resize()
691         * @see File::IsIOPerThread() for multi-threaded streaming
692       */       */
693      file_offset_t Chunk::WriteInt16(int16_t* pData, file_offset_t WordCount) {      file_offset_t Chunk::WriteInt16(int16_t* pData, file_offset_t WordCount) {
694          return Write(pData, WordCount, 2);          return Write(pData, WordCount, 2);
# Line 624  namespace RIFF { Line 705  namespace RIFF {
705       * @returns                 number of read integers       * @returns                 number of read integers
706       * @throws RIFF::Exception  if an error occurred or less than       * @throws RIFF::Exception  if an error occurred or less than
707       *                          \a WordCount integers could be read!       *                          \a WordCount integers could be read!
708         * @see File::IsIOPerThread() for multi-threaded streaming
709       */       */
710      file_offset_t Chunk::ReadUint16(uint16_t* pData, file_offset_t WordCount) {      file_offset_t Chunk::ReadUint16(uint16_t* pData, file_offset_t WordCount) {
711          #if DEBUG_RIFF          #if DEBUG_RIFF
# Line 645  namespace RIFF { Line 727  namespace RIFF {
727       * @returns                 number of written integers       * @returns                 number of written integers
728       * @throws RIFF::Exception  if an IO error occurred       * @throws RIFF::Exception  if an IO error occurred
729       * @see Resize()       * @see Resize()
730         * @see File::IsIOPerThread() for multi-threaded streaming
731       */       */
732      file_offset_t Chunk::WriteUint16(uint16_t* pData, file_offset_t WordCount) {      file_offset_t Chunk::WriteUint16(uint16_t* pData, file_offset_t WordCount) {
733          return Write(pData, WordCount, 2);          return Write(pData, WordCount, 2);
# Line 661  namespace RIFF { Line 744  namespace RIFF {
744       * @returns                 number of read integers       * @returns                 number of read integers
745       * @throws RIFF::Exception  if an error occurred or less than       * @throws RIFF::Exception  if an error occurred or less than
746       *                          \a WordCount integers could be read!       *                          \a WordCount integers could be read!
747         * @see File::IsIOPerThread() for multi-threaded streaming
748       */       */
749      file_offset_t Chunk::ReadInt32(int32_t* pData, file_offset_t WordCount) {      file_offset_t Chunk::ReadInt32(int32_t* pData, file_offset_t WordCount) {
750          #if DEBUG_RIFF          #if DEBUG_RIFF
# Line 682  namespace RIFF { Line 766  namespace RIFF {
766       * @returns                 number of written integers       * @returns                 number of written integers
767       * @throws RIFF::Exception  if an IO error occurred       * @throws RIFF::Exception  if an IO error occurred
768       * @see Resize()       * @see Resize()
769         * @see File::IsIOPerThread() for multi-threaded streaming
770       */       */
771      file_offset_t Chunk::WriteInt32(int32_t* pData, file_offset_t WordCount) {      file_offset_t Chunk::WriteInt32(int32_t* pData, file_offset_t WordCount) {
772          return Write(pData, WordCount, 4);          return Write(pData, WordCount, 4);
# Line 698  namespace RIFF { Line 783  namespace RIFF {
783       * @returns                 number of read integers       * @returns                 number of read integers
784       * @throws RIFF::Exception  if an error occurred or less than       * @throws RIFF::Exception  if an error occurred or less than
785       *                          \a WordCount integers could be read!       *                          \a WordCount integers could be read!
786         * @see File::IsIOPerThread() for multi-threaded streaming
787       */       */
788      file_offset_t Chunk::ReadUint32(uint32_t* pData, file_offset_t WordCount) {      file_offset_t Chunk::ReadUint32(uint32_t* pData, file_offset_t WordCount) {
789          #if DEBUG_RIFF          #if DEBUG_RIFF
# Line 715  namespace RIFF { Line 801  namespace RIFF {
801       * @param size              number of characters to read       * @param size              number of characters to read
802       * @throws RIFF::Exception  if an error occurred or less than       * @throws RIFF::Exception  if an error occurred or less than
803       *                          \a size characters could be read!       *                          \a size characters could be read!
804         * @see File::IsIOPerThread() for multi-threaded streaming
805       */       */
806      void Chunk::ReadString(String& s, int size) {      void Chunk::ReadString(String& s, int size) {
807          char* buf = new char[size];          char* buf = new char[size];
# Line 736  namespace RIFF { Line 823  namespace RIFF {
823       * @returns                 number of written integers       * @returns                 number of written integers
824       * @throws RIFF::Exception  if an IO error occurred       * @throws RIFF::Exception  if an IO error occurred
825       * @see Resize()       * @see Resize()
826         * @see File::IsIOPerThread() for multi-threaded streaming
827       */       */
828      file_offset_t Chunk::WriteUint32(uint32_t* pData, file_offset_t WordCount) {      file_offset_t Chunk::WriteUint32(uint32_t* pData, file_offset_t WordCount) {
829          return Write(pData, WordCount, 4);          return Write(pData, WordCount, 4);
# Line 747  namespace RIFF { Line 835  namespace RIFF {
835       *       *
836       * @returns                 read integer word       * @returns                 read integer word
837       * @throws RIFF::Exception  if an error occurred       * @throws RIFF::Exception  if an error occurred
838         * @see File::IsIOPerThread() for multi-threaded streaming
839       */       */
840      int8_t Chunk::ReadInt8() {      int8_t Chunk::ReadInt8() {
841          #if DEBUG_RIFF          #if DEBUG_RIFF
# Line 763  namespace RIFF { Line 852  namespace RIFF {
852       *       *
853       * @returns                 read integer word       * @returns                 read integer word
854       * @throws RIFF::Exception  if an error occurred       * @throws RIFF::Exception  if an error occurred
855         * @see File::IsIOPerThread() for multi-threaded streaming
856       */       */
857      uint8_t Chunk::ReadUint8() {      uint8_t Chunk::ReadUint8() {
858          #if DEBUG_RIFF          #if DEBUG_RIFF
# Line 780  namespace RIFF { Line 870  namespace RIFF {
870       *       *
871       * @returns                 read integer word       * @returns                 read integer word
872       * @throws RIFF::Exception  if an error occurred       * @throws RIFF::Exception  if an error occurred
873         * @see File::IsIOPerThread() for multi-threaded streaming
874       */       */
875      int16_t Chunk::ReadInt16() {      int16_t Chunk::ReadInt16() {
876          #if DEBUG_RIFF          #if DEBUG_RIFF
# Line 797  namespace RIFF { Line 888  namespace RIFF {
888       *       *
889       * @returns                 read integer word       * @returns                 read integer word
890       * @throws RIFF::Exception  if an error occurred       * @throws RIFF::Exception  if an error occurred
891         * @see File::IsIOPerThread() for multi-threaded streaming
892       */       */
893      uint16_t Chunk::ReadUint16() {      uint16_t Chunk::ReadUint16() {
894          #if DEBUG_RIFF          #if DEBUG_RIFF
# Line 814  namespace RIFF { Line 906  namespace RIFF {
906       *       *
907       * @returns                 read integer word       * @returns                 read integer word
908       * @throws RIFF::Exception  if an error occurred       * @throws RIFF::Exception  if an error occurred
909         * @see File::IsIOPerThread() for multi-threaded streaming
910       */       */
911      int32_t Chunk::ReadInt32() {      int32_t Chunk::ReadInt32() {
912          #if DEBUG_RIFF          #if DEBUG_RIFF
# Line 831  namespace RIFF { Line 924  namespace RIFF {
924       *       *
925       * @returns                 read integer word       * @returns                 read integer word
926       * @throws RIFF::Exception  if an error occurred       * @throws RIFF::Exception  if an error occurred
927         * @see File::IsIOPerThread() for multi-threaded streamings
928       */       */
929      uint32_t Chunk::ReadUint32() {      uint32_t Chunk::ReadUint32() {
930          #if DEBUG_RIFF          #if DEBUG_RIFF
# Line 861  namespace RIFF { Line 955  namespace RIFF {
955       * @returns a pointer to the data in RAM on success, NULL otherwise       * @returns a pointer to the data in RAM on success, NULL otherwise
956       * @throws Exception if data buffer could not be enlarged       * @throws Exception if data buffer could not be enlarged
957       * @see ReleaseChunkData()       * @see ReleaseChunkData()
958         * @see File::IsIOPerThread() for multi-threaded streaming
959       */       */
960      void* Chunk::LoadChunkData() {      void* Chunk::LoadChunkData() {
961          if (!pChunkData && pFile->Filename != "" /*&& ulStartPos != 0*/) {          if (!pChunkData && pFile->Filename != "" /*&& ulStartPos != 0*/) {
962                File::Handle hRead = pFile->FileHandle();
963              #if POSIX              #if POSIX
964              if (lseek(pFile->hFileRead, ullStartPos, SEEK_SET) == -1) return NULL;              if (lseek(hRead, ullStartPos, SEEK_SET) == -1) return NULL;
965              #elif defined(WIN32)              #elif defined(WIN32)
966              LARGE_INTEGER liFilePos;              LARGE_INTEGER liFilePos;
967              liFilePos.QuadPart = ullStartPos;              liFilePos.QuadPart = ullStartPos;
968              if (!SetFilePointerEx(pFile->hFileRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN)) return NULL;              if (!SetFilePointerEx(hRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN)) return NULL;
969              #else              #else
970              if (fseeko(pFile->hFileRead, ullStartPos, SEEK_SET)) return NULL;              if (fseeko(hRead, ullStartPos, SEEK_SET)) return NULL;
971              #endif // POSIX              #endif // POSIX
972              file_offset_t ullBufferSize = (ullCurrentChunkSize > ullNewChunkSize) ? ullCurrentChunkSize : ullNewChunkSize;              file_offset_t ullBufferSize = (ullCurrentChunkSize > ullNewChunkSize) ? ullCurrentChunkSize : ullNewChunkSize;
973              pChunkData = new uint8_t[ullBufferSize];              pChunkData = new uint8_t[ullBufferSize];
974              if (!pChunkData) return NULL;              if (!pChunkData) return NULL;
975              memset(pChunkData, 0, ullBufferSize);              memset(pChunkData, 0, ullBufferSize);
976              #if POSIX              #if POSIX
977              file_offset_t readWords = read(pFile->hFileRead, pChunkData, GetSize());              file_offset_t readWords = read(hRead, pChunkData, GetSize());
978              #elif defined(WIN32)              #elif defined(WIN32)
979              DWORD readWords;              DWORD readWords;
980              ReadFile(pFile->hFileRead, pChunkData, GetSize(), &readWords, NULL); //FIXME: won't load chunks larger than 2GB !              ReadFile(hRead, pChunkData, GetSize(), &readWords, NULL); //FIXME: won't load chunks larger than 2GB !
981              #else              #else
982              file_offset_t readWords = fread(pChunkData, 1, GetSize(), pFile->hFileRead);              file_offset_t readWords = fread(pChunkData, 1, GetSize(), hRead);
983              #endif // POSIX              #endif // POSIX
984              if (readWords != GetSize()) {              if (readWords != GetSize()) {
985                  delete[] pChunkData;                  delete[] pChunkData;
# Line 894  namespace RIFF { Line 990  namespace RIFF {
990              uint8_t* pNewBuffer = new uint8_t[ullNewChunkSize];              uint8_t* pNewBuffer = new uint8_t[ullNewChunkSize];
991              if (!pNewBuffer) throw Exception("Could not enlarge chunk data buffer to " + ToString(ullNewChunkSize) + " bytes");              if (!pNewBuffer) throw Exception("Could not enlarge chunk data buffer to " + ToString(ullNewChunkSize) + " bytes");
992              memset(pNewBuffer, 0 , ullNewChunkSize);              memset(pNewBuffer, 0 , ullNewChunkSize);
993              memcpy(pNewBuffer, pChunkData, ullChunkDataSize);              if (pChunkData) {
994              delete[] pChunkData;                  memcpy(pNewBuffer, pChunkData, ullChunkDataSize);
995                    delete[] pChunkData;
996                }
997              pChunkData       = pNewBuffer;              pChunkData       = pNewBuffer;
998              ullChunkDataSize = ullNewChunkSize;              ullChunkDataSize = ullNewChunkSize;
999          }          }
# Line 954  namespace RIFF { Line 1052  namespace RIFF {
1052       * @returns new write position in the "physical" file, that is       * @returns new write position in the "physical" file, that is
1053       *          \a ullWritePos incremented by this chunk's new size       *          \a ullWritePos incremented by this chunk's new size
1054       *          (including its header size of course)       *          (including its header size of course)
1055         * @see File::IsIOPerThread() for multi-threaded streaming
1056       */       */
1057      file_offset_t Chunk::WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t* pProgress) {      file_offset_t Chunk::WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t* pProgress) {
1058          const file_offset_t ullOriginalPos = ullWritePos;          const file_offset_t ullOriginalPos = ullWritePos;
1059          ullWritePos += CHUNK_HEADER_SIZE(pFile->FileOffsetSize);          ullWritePos += CHUNK_HEADER_SIZE(pFile->FileOffsetSize);
1060    
1061          if (pFile->Mode != stream_mode_read_write)          const File::HandlePair io = pFile->FileHandlePair();
1062    
1063            if (io.Mode != stream_mode_read_write)
1064              throw Exception("Cannot write list chunk, file has to be opened in read+write mode");              throw Exception("Cannot write list chunk, file has to be opened in read+write mode");
1065    
1066          // if the whole chunk body was loaded into RAM          // if the whole chunk body was loaded into RAM
# Line 968  namespace RIFF { Line 1069  namespace RIFF {
1069              LoadChunkData();              LoadChunkData();
1070              // write chunk data from RAM persistently to the file              // write chunk data from RAM persistently to the file
1071              #if POSIX              #if POSIX
1072              lseek(pFile->hFileWrite, ullWritePos, SEEK_SET);              lseek(io.hWrite, ullWritePos, SEEK_SET);
1073              if (write(pFile->hFileWrite, pChunkData, ullNewChunkSize) != ullNewChunkSize) {              if (write(io.hWrite, pChunkData, ullNewChunkSize) != ullNewChunkSize) {
1074                  throw Exception("Writing Chunk data (from RAM) failed");                  throw Exception("Writing Chunk data (from RAM) failed");
1075              }              }
1076              #elif defined(WIN32)              #elif defined(WIN32)
1077              LARGE_INTEGER liFilePos;              LARGE_INTEGER liFilePos;
1078              liFilePos.QuadPart = ullWritePos;              liFilePos.QuadPart = ullWritePos;
1079              SetFilePointerEx(pFile->hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);              SetFilePointerEx(io.hWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
1080              DWORD dwBytesWritten;              DWORD dwBytesWritten;
1081              WriteFile(pFile->hFileWrite, pChunkData, ullNewChunkSize, &dwBytesWritten, NULL); //FIXME: won't save chunks larger than 2GB !              WriteFile(io.hWrite, pChunkData, ullNewChunkSize, &dwBytesWritten, NULL); //FIXME: won't save chunks larger than 2GB !
1082              if (dwBytesWritten != ullNewChunkSize) {              if (dwBytesWritten != ullNewChunkSize) {
1083                  throw Exception("Writing Chunk data (from RAM) failed");                  throw Exception("Writing Chunk data (from RAM) failed");
1084              }              }
1085              #else              #else
1086              fseeko(pFile->hFileWrite, ullWritePos, SEEK_SET);              fseeko(io.hWrite, ullWritePos, SEEK_SET);
1087              if (fwrite(pChunkData, 1, ullNewChunkSize, pFile->hFileWrite) != ullNewChunkSize) {              if (fwrite(pChunkData, 1, ullNewChunkSize, io.hWrite) != ullNewChunkSize) {
1088                  throw Exception("Writing Chunk data (from RAM) failed");                  throw Exception("Writing Chunk data (from RAM) failed");
1089              }              }
1090              #endif // POSIX              #endif // POSIX
# Line 999  namespace RIFF { Line 1100  namespace RIFF {
1100              for (file_offset_t ullOffset = 0; ullToMove > 0 && iBytesMoved > 0; ullOffset += iBytesMoved, ullToMove -= iBytesMoved) {              for (file_offset_t ullOffset = 0; ullToMove > 0 && iBytesMoved > 0; ullOffset += iBytesMoved, ullToMove -= iBytesMoved) {
1101                  iBytesMoved = (ullToMove < 4096) ? int(ullToMove) : 4096;                  iBytesMoved = (ullToMove < 4096) ? int(ullToMove) : 4096;
1102                  #if POSIX                  #if POSIX
1103                  lseek(pFile->hFileRead, ullStartPos + ullCurrentDataOffset + ullOffset, SEEK_SET);                  lseek(io.hRead, ullStartPos + ullCurrentDataOffset + ullOffset, SEEK_SET);
1104                  iBytesMoved = (int) read(pFile->hFileRead, pCopyBuffer, (size_t) iBytesMoved);                  iBytesMoved = (int) read(io.hRead, pCopyBuffer, (size_t) iBytesMoved);
1105                  lseek(pFile->hFileWrite, ullWritePos + ullOffset, SEEK_SET);                  lseek(io.hWrite, ullWritePos + ullOffset, SEEK_SET);
1106                  iBytesMoved = (int) write(pFile->hFileWrite, pCopyBuffer, (size_t) iBytesMoved);                  iBytesMoved = (int) write(io.hWrite, pCopyBuffer, (size_t) iBytesMoved);
1107                  #elif defined(WIN32)                  #elif defined(WIN32)
1108                  LARGE_INTEGER liFilePos;                  LARGE_INTEGER liFilePos;
1109                  liFilePos.QuadPart = ullStartPos + ullCurrentDataOffset + ullOffset;                  liFilePos.QuadPart = ullStartPos + ullCurrentDataOffset + ullOffset;
1110                  SetFilePointerEx(pFile->hFileRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);                  SetFilePointerEx(io.hRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
1111                  ReadFile(pFile->hFileRead, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);                  ReadFile(io.hRead, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
1112                  liFilePos.QuadPart = ullWritePos + ullOffset;                  liFilePos.QuadPart = ullWritePos + ullOffset;
1113                  SetFilePointerEx(pFile->hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);                  SetFilePointerEx(io.hWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
1114                  WriteFile(pFile->hFileWrite, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);                  WriteFile(io.hWrite, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
1115                  #else                  #else
1116                  fseeko(pFile->hFileRead, ullStartPos + ullCurrentDataOffset + ullOffset, SEEK_SET);                  fseeko(io.hRead, ullStartPos + ullCurrentDataOffset + ullOffset, SEEK_SET);
1117                  iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, pFile->hFileRead);                  iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, io.hRead);
1118                  fseeko(pFile->hFileWrite, ullWritePos + ullOffset, SEEK_SET);                  fseeko(io.hWrite, ullWritePos + ullOffset, SEEK_SET);
1119                  iBytesMoved = fwrite(pCopyBuffer, 1, iBytesMoved, pFile->hFileWrite);                  iBytesMoved = fwrite(pCopyBuffer, 1, iBytesMoved, io.hWrite);
1120                  #endif                  #endif
1121              }              }
1122              delete[] pCopyBuffer;              delete[] pCopyBuffer;
# Line 1026  namespace RIFF { Line 1127  namespace RIFF {
1127          ullCurrentChunkSize = ullNewChunkSize;          ullCurrentChunkSize = ullNewChunkSize;
1128          WriteHeader(ullOriginalPos);          WriteHeader(ullOriginalPos);
1129    
1130          __notify_progress(pProgress, 1.0); // notify done          if (pProgress)
1131                __notify_progress(pProgress, 1.0); // notify done
1132    
1133          // update chunk's position pointers          // update chunk's position pointers
1134          ullStartPos = ullOriginalPos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize);          ullStartPos = ullOriginalPos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize);
1135          ullPos      = 0;          Chunk::__resetPos();
1136    
1137          // add pad byte if needed          // add pad byte if needed
1138          if ((ullStartPos + ullNewChunkSize) % 2 != 0) {          if ((ullStartPos + ullNewChunkSize) % 2 != 0) {
1139              const char cPadByte = 0;              const char cPadByte = 0;
1140              #if POSIX              #if POSIX
1141              lseek(pFile->hFileWrite, ullStartPos + ullNewChunkSize, SEEK_SET);              lseek(io.hWrite, ullStartPos + ullNewChunkSize, SEEK_SET);
1142              write(pFile->hFileWrite, &cPadByte, 1);              write(io.hWrite, &cPadByte, 1);
1143              #elif defined(WIN32)              #elif defined(WIN32)
1144              LARGE_INTEGER liFilePos;              LARGE_INTEGER liFilePos;
1145              liFilePos.QuadPart = ullStartPos + ullNewChunkSize;              liFilePos.QuadPart = ullStartPos + ullNewChunkSize;
1146              SetFilePointerEx(pFile->hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);              SetFilePointerEx(io.hWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
1147              DWORD dwBytesWritten;              DWORD dwBytesWritten;
1148              WriteFile(pFile->hFileWrite, &cPadByte, 1, &dwBytesWritten, NULL);              WriteFile(io.hWrite, &cPadByte, 1, &dwBytesWritten, NULL);
1149              #else              #else
1150              fseeko(pFile->hFileWrite, ullStartPos + ullNewChunkSize, SEEK_SET);              fseeko(io.hWrite, ullStartPos + ullNewChunkSize, SEEK_SET);
1151              fwrite(&cPadByte, 1, 1, pFile->hFileWrite);              fwrite(&cPadByte, 1, 1, io.hWrite);
1152              #endif              #endif
1153              return ullStartPos + ullNewChunkSize + 1;              return ullStartPos + ullNewChunkSize + 1;
1154          }          }
# Line 1055  namespace RIFF { Line 1157  namespace RIFF {
1157      }      }
1158    
1159      void Chunk::__resetPos() {      void Chunk::__resetPos() {
1160          ullPos = 0;          std::lock_guard<std::mutex> lock(chunkPos.mutex);
1161            chunkPos.ullPos = 0;
1162            chunkPos.byThread.clear();
1163      }      }
1164    
1165    
# Line 1437  namespace RIFF { Line 1541  namespace RIFF {
1541          Chunk::ReadHeader(filePos);          Chunk::ReadHeader(filePos);
1542          if (ullCurrentChunkSize < 4) return;          if (ullCurrentChunkSize < 4) return;
1543          ullNewChunkSize = ullCurrentChunkSize -= 4;          ullNewChunkSize = ullCurrentChunkSize -= 4;
1544    
1545            const File::Handle hRead = pFile->FileHandle();
1546    
1547          #if POSIX          #if POSIX
1548          lseek(pFile->hFileRead, filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize), SEEK_SET);          lseek(hRead, filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize), SEEK_SET);
1549          read(pFile->hFileRead, &ListType, 4);          read(hRead, &ListType, 4);
1550          #elif defined(WIN32)          #elif defined(WIN32)
1551          LARGE_INTEGER liFilePos;          LARGE_INTEGER liFilePos;
1552          liFilePos.QuadPart = filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize);          liFilePos.QuadPart = filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize);
1553          SetFilePointerEx(pFile->hFileRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);          SetFilePointerEx(hRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
1554          DWORD dwBytesRead;          DWORD dwBytesRead;
1555          ReadFile(pFile->hFileRead, &ListType, 4, &dwBytesRead, NULL);          ReadFile(hRead, &ListType, 4, &dwBytesRead, NULL);
1556          #else          #else
1557          fseeko(pFile->hFileRead, filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize), SEEK_SET);          fseeko(hRead, filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize), SEEK_SET);
1558          fread(&ListType, 4, 1, pFile->hFileRead);          fread(&ListType, 4, 1, hRead);
1559          #endif // POSIX          #endif // POSIX
1560          #if DEBUG_RIFF          #if DEBUG_RIFF
1561          std::cout << "listType=" << convertToString(ListType) << std::endl;          std::cout << "listType=" << convertToString(ListType) << std::endl;
# Line 1463  namespace RIFF { Line 1570  namespace RIFF {
1570          ullNewChunkSize += 4;          ullNewChunkSize += 4;
1571          Chunk::WriteHeader(filePos);          Chunk::WriteHeader(filePos);
1572          ullNewChunkSize -= 4; // just revert the +4 incrementation          ullNewChunkSize -= 4; // just revert the +4 incrementation
1573    
1574            const File::Handle hWrite = pFile->FileWriteHandle();
1575    
1576          #if POSIX          #if POSIX
1577          lseek(pFile->hFileWrite, filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize), SEEK_SET);          lseek(hWrite, filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize), SEEK_SET);
1578          write(pFile->hFileWrite, &ListType, 4);          write(hWrite, &ListType, 4);
1579          #elif defined(WIN32)          #elif defined(WIN32)
1580          LARGE_INTEGER liFilePos;          LARGE_INTEGER liFilePos;
1581          liFilePos.QuadPart = filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize);          liFilePos.QuadPart = filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize);
1582          SetFilePointerEx(pFile->hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);          SetFilePointerEx(hWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
1583          DWORD dwBytesWritten;          DWORD dwBytesWritten;
1584          WriteFile(pFile->hFileWrite, &ListType, 4, &dwBytesWritten, NULL);          WriteFile(hWrite, &ListType, 4, &dwBytesWritten, NULL);
1585          #else          #else
1586          fseeko(pFile->hFileWrite, filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize), SEEK_SET);          fseeko(hWrite, filePos + CHUNK_HEADER_SIZE(pFile->FileOffsetSize), SEEK_SET);
1587          fwrite(&ListType, 4, 1, pFile->hFileWrite);          fwrite(&ListType, 4, 1, hWrite);
1588          #endif // POSIX          #endif // POSIX
1589      }      }
1590    
# Line 1485  namespace RIFF { Line 1595  namespace RIFF {
1595          if (!pSubChunks) {          if (!pSubChunks) {
1596              pSubChunks    = new ChunkList();              pSubChunks    = new ChunkList();
1597              pSubChunksMap = new ChunkMap();              pSubChunksMap = new ChunkMap();
1598              #if defined(WIN32)  
1599              if (pFile->hFileRead == INVALID_HANDLE_VALUE) return;              const File::Handle hRead = pFile->FileHandle();
1600              #else              if (!_isValidHandle(hRead)) return;
1601              if (!pFile->hFileRead) return;  
1602              #endif              const file_offset_t ullOriginalPos = GetPos();
             file_offset_t ullOriginalPos = GetPos();  
1603              SetPos(0); // jump to beginning of list chunk body              SetPos(0); // jump to beginning of list chunk body
1604              while (RemainingBytes() >= CHUNK_HEADER_SIZE(pFile->FileOffsetSize)) {              while (RemainingBytes() >= CHUNK_HEADER_SIZE(pFile->FileOffsetSize)) {
1605                  Chunk* ck;                  Chunk* ck;
1606                  uint32_t ckid;                  uint32_t ckid;
1607                  Read(&ckid, 4, 1);                  // return value check is required here to prevent a potential
1608                    // garbage data use of 'ckid' below in case Read() failed
1609                    if (Read(&ckid, 4, 1) != 4)
1610                        throw Exception("LoadSubChunks(): Failed reading RIFF chunk ID");
1611                  #if DEBUG_RIFF                  #if DEBUG_RIFF
1612                  std::cout << " ckid=" << convertToString(ckid) << std::endl;                  std::cout << " ckid=" << convertToString(ckid) << std::endl;
1613                  #endif // DEBUG_RIFF                  #endif // DEBUG_RIFF
1614                    const file_offset_t pos = GetPos();
1615                  if (ckid == CHUNK_ID_LIST) {                  if (ckid == CHUNK_ID_LIST) {
1616                      ck = new RIFF::List(pFile, ullStartPos + ullPos - 4, this);                      ck = new RIFF::List(pFile, ullStartPos + pos - 4, this);
1617                      SetPos(ck->GetSize() + LIST_HEADER_SIZE(pFile->FileOffsetSize) - 4, RIFF::stream_curpos);                      SetPos(ck->GetSize() + LIST_HEADER_SIZE(pFile->FileOffsetSize) - 4, RIFF::stream_curpos);
1618                  }                  }
1619                  else { // simple chunk                  else { // simple chunk
1620                      ck = new RIFF::Chunk(pFile, ullStartPos + ullPos - 4, this);                      ck = new RIFF::Chunk(pFile, ullStartPos + pos - 4, this);
1621                      SetPos(ck->GetSize() + CHUNK_HEADER_SIZE(pFile->FileOffsetSize) - 4, RIFF::stream_curpos);                      SetPos(ck->GetSize() + CHUNK_HEADER_SIZE(pFile->FileOffsetSize) - 4, RIFF::stream_curpos);
1622                  }                  }
1623                  pSubChunks->push_back(ck);                  pSubChunks->push_back(ck);
# Line 1513  namespace RIFF { Line 1626  namespace RIFF {
1626              }              }
1627              SetPos(ullOriginalPos); // restore position before this call              SetPos(ullOriginalPos); // restore position before this call
1628          }          }
1629          __notify_progress(pProgress, 1.0); // notify done          if (pProgress)
1630                __notify_progress(pProgress, 1.0); // notify done
1631      }      }
1632    
1633      void List::LoadSubChunksRecursively(progress_t* pProgress) {      void List::LoadSubChunksRecursively(progress_t* pProgress) {
1634          const int n = (int) CountSubLists();          const int n = (int) CountSubLists();
1635          int i = 0;          int i = 0;
1636          for (List* pList = GetFirstSubList(); pList; pList = GetNextSubList(), ++i) {          for (List* pList = GetFirstSubList(); pList; pList = GetNextSubList(), ++i) {
1637              // divide local progress into subprogress              if (pProgress) {
1638              progress_t subprogress;                  // divide local progress into subprogress
1639              __divide_progress(pProgress, &subprogress, n, i);                  progress_t subprogress;
1640              // do the actual work                  __divide_progress(pProgress, &subprogress, n, i);
1641              pList->LoadSubChunksRecursively(&subprogress);                  // do the actual work
1642                    pList->LoadSubChunksRecursively(&subprogress);
1643                } else
1644                    pList->LoadSubChunksRecursively(NULL);
1645          }          }
1646          __notify_progress(pProgress, 1.0); // notify done          if (pProgress)
1647                __notify_progress(pProgress, 1.0); // notify done
1648      }      }
1649    
1650      /** @brief Write list chunk persistently e.g. to disk.      /** @brief Write list chunk persistently e.g. to disk.
# Line 1548  namespace RIFF { Line 1666  namespace RIFF {
1666          const file_offset_t ullOriginalPos = ullWritePos;          const file_offset_t ullOriginalPos = ullWritePos;
1667          ullWritePos += LIST_HEADER_SIZE(pFile->FileOffsetSize);          ullWritePos += LIST_HEADER_SIZE(pFile->FileOffsetSize);
1668    
1669          if (pFile->Mode != stream_mode_read_write)          if (pFile->GetMode() != stream_mode_read_write)
1670              throw Exception("Cannot write list chunk, file has to be opened in read+write mode");              throw Exception("Cannot write list chunk, file has to be opened in read+write mode");
1671    
1672          // write all subchunks (including sub list chunks) recursively          // write all subchunks (including sub list chunks) recursively
# Line 1556  namespace RIFF { Line 1674  namespace RIFF {
1674              size_t i = 0;              size_t i = 0;
1675              const size_t n = pSubChunks->size();              const size_t n = pSubChunks->size();
1676              for (ChunkList::iterator iter = pSubChunks->begin(), end = pSubChunks->end(); iter != end; ++iter, ++i) {              for (ChunkList::iterator iter = pSubChunks->begin(), end = pSubChunks->end(); iter != end; ++iter, ++i) {
1677                  // divide local progress into subprogress for loading current Instrument                  if (pProgress) {
1678                  progress_t subprogress;                      // divide local progress into subprogress for loading current Instrument
1679                  __divide_progress(pProgress, &subprogress, n, i);                      progress_t subprogress;
1680                  // do the actual work                      __divide_progress(pProgress, &subprogress, n, i);
1681                  ullWritePos = (*iter)->WriteChunk(ullWritePos, ullCurrentDataOffset, &subprogress);                      // do the actual work
1682                        ullWritePos = (*iter)->WriteChunk(ullWritePos, ullCurrentDataOffset, &subprogress);
1683                    } else
1684                        ullWritePos = (*iter)->WriteChunk(ullWritePos, ullCurrentDataOffset, NULL);
1685              }              }
1686          }          }
1687    
# Line 1571  namespace RIFF { Line 1692  namespace RIFF {
1692          // offset of this list chunk in new written file may have changed          // offset of this list chunk in new written file may have changed
1693          ullStartPos = ullOriginalPos + LIST_HEADER_SIZE(pFile->FileOffsetSize);          ullStartPos = ullOriginalPos + LIST_HEADER_SIZE(pFile->FileOffsetSize);
1694    
1695           __notify_progress(pProgress, 1.0); // notify done          if (pProgress)
1696                __notify_progress(pProgress, 1.0); // notify done
1697    
1698          return ullWritePos;          return ullWritePos;
1699      }      }
# Line 1615  namespace RIFF { Line 1737  namespace RIFF {
1737          : List(this), bIsNewFile(true), Layout(layout_standard),          : List(this), bIsNewFile(true), Layout(layout_standard),
1738            FileOffsetPreference(offset_size_auto)            FileOffsetPreference(offset_size_auto)
1739      {      {
1740            io.isPerThread = false;
1741          #if defined(WIN32)          #if defined(WIN32)
1742          hFileRead = hFileWrite = INVALID_HANDLE_VALUE;          io.hRead = io.hWrite = INVALID_HANDLE_VALUE;
1743          #else          #else
1744          hFileRead = hFileWrite = 0;          io.hRead = io.hWrite = 0;
1745          #endif          #endif
1746          Mode = stream_mode_closed;          io.Mode = stream_mode_closed;
1747          bEndianNative = true;          bEndianNative = true;
1748          ListType = FileType;          ListType = FileType;
1749          FileOffsetSize = 4;          FileOffsetSize = 4;
# Line 1710  namespace RIFF { Line 1833  namespace RIFF {
1833       *                         given RIFF file or RIFF-alike file       *                         given RIFF file or RIFF-alike file
1834       */       */
1835      void File::__openExistingFile(const String& path, uint32_t* FileType) {      void File::__openExistingFile(const String& path, uint32_t* FileType) {
1836            io.isPerThread = false;
1837          #if POSIX          #if POSIX
1838          hFileRead = hFileWrite = open(path.c_str(), O_RDONLY | O_NONBLOCK);          io.hRead = io.hWrite = open(path.c_str(), O_RDONLY | O_NONBLOCK);
1839          if (hFileRead == -1) {          if (io.hRead == -1) {
1840              hFileRead = hFileWrite = 0;              io.hRead = io.hWrite = 0;
1841              String sError = strerror(errno);              String sError = strerror(errno);
1842              throw RIFF::Exception("Can't open \"" + path + "\": " + sError);              throw RIFF::Exception("Can't open \"" + path + "\": " + sError);
1843          }          }
1844          #elif defined(WIN32)          #elif defined(WIN32)
1845          hFileRead = hFileWrite = CreateFile(          io.hRead = io.hWrite = CreateFile(
1846                                       path.c_str(), GENERIC_READ,                                       path.c_str(), GENERIC_READ,
1847                                       FILE_SHARE_READ | FILE_SHARE_WRITE,                                       FILE_SHARE_READ | FILE_SHARE_WRITE,
1848                                       NULL, OPEN_EXISTING,                                       NULL, OPEN_EXISTING,
1849                                       FILE_ATTRIBUTE_NORMAL |                                       FILE_ATTRIBUTE_NORMAL |
1850                                       FILE_FLAG_RANDOM_ACCESS, NULL                                       FILE_FLAG_RANDOM_ACCESS, NULL
1851                                   );                                   );
1852          if (hFileRead == INVALID_HANDLE_VALUE) {          if (io.hRead == INVALID_HANDLE_VALUE) {
1853              hFileRead = hFileWrite = INVALID_HANDLE_VALUE;              io.hRead = io.hWrite = INVALID_HANDLE_VALUE;
1854              throw RIFF::Exception("Can't open \"" + path + "\"");              throw RIFF::Exception("Can't open \"" + path + "\"");
1855          }          }
1856          #else          #else
1857          hFileRead = hFileWrite = fopen(path.c_str(), "rb");          io.hRead = io.hWrite = fopen(path.c_str(), "rb");
1858          if (!hFileRead) throw RIFF::Exception("Can't open \"" + path + "\"");          if (!io.hRead) throw RIFF::Exception("Can't open \"" + path + "\"");
1859          #endif // POSIX          #endif // POSIX
1860          Mode = stream_mode_read;          io.Mode = stream_mode_read;
1861    
1862          // determine RIFF file offset size to be used (in RIFF chunk headers)          // determine RIFF file offset size to be used (in RIFF chunk headers)
1863          // according to the current file offset preference          // according to the current file offset preference
# Line 1772  namespace RIFF { Line 1896  namespace RIFF {
1896          Filename = path;          Filename = path;
1897      }      }
1898    
1899        /**
1900         * This is an internal-only method which must not be used by any application
1901         * and might change at any time.
1902         *
1903         * Resolves and returns a reference (memory location) of the RIFF file's
1904         * internal and OS dependent file I/O handles which are intended to be used
1905         * by the calling thread.
1906         */
1907        File::HandlePair& File::FileHandlePairUnsafeRef() {
1908            if (io.byThread.empty()) return io;
1909            const std::thread::id tid = std::this_thread::get_id();
1910            const auto it = io.byThread.find(tid);
1911            return (it != io.byThread.end()) ?
1912                it->second :
1913                io.byThread[tid] = {
1914                    #if defined(WIN32)
1915                    .hRead  = INVALID_HANDLE_VALUE,
1916                    .hWrite = INVALID_HANDLE_VALUE,
1917                    #else
1918                    .hRead  = 0,
1919                    .hWrite = 0,
1920                    #endif
1921                    .Mode = stream_mode_closed
1922                };
1923        }
1924    
1925        /**
1926         * Returns the OS dependent file I/O read and write handles intended to be
1927         * used by the calling thread.
1928         *
1929         * @see File::IsIOPerThread() for multi-threaded streaming
1930         */
1931        File::HandlePair File::FileHandlePair() const {
1932            std::lock_guard<std::mutex> lock(io.mutex);
1933            if (io.byThread.empty()) return io;
1934            const std::thread::id tid = std::this_thread::get_id();
1935            const auto it = io.byThread.find(tid);
1936            return (it != io.byThread.end()) ?
1937                it->second :
1938                io.byThread[tid] = {
1939                    #if defined(WIN32)
1940                    .hRead  = INVALID_HANDLE_VALUE,
1941                    .hWrite = INVALID_HANDLE_VALUE,
1942                    #else
1943                    .hRead  = 0,
1944                    .hWrite = 0,
1945                    #endif
1946                    .Mode = stream_mode_closed
1947                };
1948         }
1949    
1950        /**
1951         * Returns the OS dependent file I/O read handle intended to be used by the
1952         * calling thread.
1953         *
1954         * @see File::IsIOPerThread() for multi-threaded streaming
1955         */
1956        File::Handle File::FileHandle() const {
1957            return FileHandlePair().hRead;
1958        }
1959    
1960        /**
1961         * Returns the OS dependent file I/O write handle intended to be used by the
1962         * calling thread.
1963         *
1964         * @see File::IsIOPerThread() for multi-threaded streaming
1965         */
1966        File::Handle File::FileWriteHandle() const {
1967            return FileHandlePair().hWrite;
1968        }
1969    
1970        /**
1971         * Returns the file I/O mode currently being available for the calling
1972         * thread for this RIFF file (either ro, rw or closed).
1973         *
1974         * @see File::IsIOPerThread() for multi-threaded streaming
1975         */
1976      stream_mode_t File::GetMode() const {      stream_mode_t File::GetMode() const {
1977          return Mode;          return FileHandlePair().Mode;
1978      }      }
1979    
1980      layout_t File::GetLayout() const {      layout_t File::GetLayout() const {
# Line 1788  namespace RIFF { Line 1989  namespace RIFF {
1989       * @param NewMode - new file access mode       * @param NewMode - new file access mode
1990       * @returns true if mode was changed, false if current mode already       * @returns true if mode was changed, false if current mode already
1991       *          equals new mode       *          equals new mode
1992       * @throws RIFF::Exception if new file access mode is unknown       * @throws RIFF::Exception if file could not be opened in requested file
1993         *         access mode or if passed access mode is unknown
1994         * @see File::IsIOPerThread() for multi-threaded streaming
1995       */       */
1996      bool File::SetMode(stream_mode_t NewMode) {      bool File::SetMode(stream_mode_t NewMode) {
1997          if (NewMode != Mode) {          bool bResetPos = false;
1998            bool res = SetModeInternal(NewMode, &bResetPos);
1999            // resetting position must be handled outside above's call to avoid any
2000            // potential dead lock, as SetModeInternal() acquires a lock and
2001            // __resetPos() acquires a lock by itself (not a theoretical issue!)
2002            if (bResetPos)
2003                __resetPos(); // reset read/write position of ALL 'Chunk' objects
2004            return res;
2005        }
2006    
2007        bool File::SetModeInternal(stream_mode_t NewMode, bool* pResetPos) {
2008            std::lock_guard<std::mutex> lock(io.mutex);
2009            HandlePair& io = FileHandlePairUnsafeRef();
2010            if (NewMode != io.Mode) {
2011              switch (NewMode) {              switch (NewMode) {
2012                  case stream_mode_read:                  case stream_mode_read:
2013                        if (_isValidHandle(io.hRead)) _close(io.hRead);
2014                      #if POSIX                      #if POSIX
2015                      if (hFileRead) close(hFileRead);                      io.hRead = io.hWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);
2016                      hFileRead = hFileWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);                      if (io.hRead == -1) {
2017                      if (hFileRead == -1) {                          io.hRead = io.hWrite = 0;
                         hFileRead = hFileWrite = 0;  
2018                          String sError = strerror(errno);                          String sError = strerror(errno);
2019                          throw Exception("Could not (re)open file \"" + Filename + "\" in read mode: " + sError);                          throw Exception("Could not (re)open file \"" + Filename + "\" in read mode: " + sError);
2020                      }                      }
2021                      #elif defined(WIN32)                      #elif defined(WIN32)
2022                      if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);                      io.hRead = io.hWrite = CreateFile(
                     hFileRead = hFileWrite = CreateFile(  
2023                                                   Filename.c_str(), GENERIC_READ,                                                   Filename.c_str(), GENERIC_READ,
2024                                                   FILE_SHARE_READ | FILE_SHARE_WRITE,                                                   FILE_SHARE_READ | FILE_SHARE_WRITE,
2025                                                   NULL, OPEN_EXISTING,                                                   NULL, OPEN_EXISTING,
# Line 1812  namespace RIFF { Line 2027  namespace RIFF {
2027                                                   FILE_FLAG_RANDOM_ACCESS,                                                   FILE_FLAG_RANDOM_ACCESS,
2028                                                   NULL                                                   NULL
2029                                               );                                               );
2030                      if (hFileRead == INVALID_HANDLE_VALUE) {                      if (io.hRead == INVALID_HANDLE_VALUE) {
2031                          hFileRead = hFileWrite = INVALID_HANDLE_VALUE;                          io.hRead = io.hWrite = INVALID_HANDLE_VALUE;
2032                          throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");                          throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");
2033                      }                      }
2034                      #else                      #else
2035                      if (hFileRead) fclose(hFileRead);                      io.hRead = io.hWrite = fopen(Filename.c_str(), "rb");
2036                      hFileRead = hFileWrite = fopen(Filename.c_str(), "rb");                      if (!io.hRead) throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");
                     if (!hFileRead) throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");  
2037                      #endif                      #endif
2038                      __resetPos(); // reset read/write position of ALL 'Chunk' objects                      *pResetPos = true;
2039                      break;                      break;
2040                  case stream_mode_read_write:                  case stream_mode_read_write:
2041                        if (_isValidHandle(io.hRead)) _close(io.hRead);
2042                      #if POSIX                      #if POSIX
2043                      if (hFileRead) close(hFileRead);                      io.hRead = io.hWrite = open(Filename.c_str(), O_RDWR | O_NONBLOCK);
2044                      hFileRead = hFileWrite = open(Filename.c_str(), O_RDWR | O_NONBLOCK);                      if (io.hRead == -1) {
2045                      if (hFileRead == -1) {                          io.hRead = io.hWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);
                         hFileRead = hFileWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);  
2046                          String sError = strerror(errno);                          String sError = strerror(errno);
2047                          throw Exception("Could not open file \"" + Filename + "\" in read+write mode: " + sError);                          throw Exception("Could not open file \"" + Filename + "\" in read+write mode: " + sError);
2048                      }                      }
2049                      #elif defined(WIN32)                      #elif defined(WIN32)
2050                      if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);                      io.hRead = io.hWrite = CreateFile(
                     hFileRead = hFileWrite = CreateFile(  
2051                                                   Filename.c_str(),                                                   Filename.c_str(),
2052                                                   GENERIC_READ | GENERIC_WRITE,                                                   GENERIC_READ | GENERIC_WRITE,
2053                                                   FILE_SHARE_READ,                                                   FILE_SHARE_READ,
# Line 1843  namespace RIFF { Line 2056  namespace RIFF {
2056                                                   FILE_FLAG_RANDOM_ACCESS,                                                   FILE_FLAG_RANDOM_ACCESS,
2057                                                   NULL                                                   NULL
2058                                               );                                               );
2059                      if (hFileRead == INVALID_HANDLE_VALUE) {                      if (io.hRead == INVALID_HANDLE_VALUE) {
2060                          hFileRead = hFileWrite = CreateFile(                          io.hRead = io.hWrite = CreateFile(
2061                                                       Filename.c_str(), GENERIC_READ,                                                       Filename.c_str(), GENERIC_READ,
2062                                                       FILE_SHARE_READ | FILE_SHARE_WRITE,                                                       FILE_SHARE_READ | FILE_SHARE_WRITE,
2063                                                       NULL, OPEN_EXISTING,                                                       NULL, OPEN_EXISTING,
# Line 1855  namespace RIFF { Line 2068  namespace RIFF {
2068                          throw Exception("Could not (re)open file \"" + Filename + "\" in read+write mode");                          throw Exception("Could not (re)open file \"" + Filename + "\" in read+write mode");
2069                      }                      }
2070                      #else                      #else
2071                      if (hFileRead) fclose(hFileRead);                      io.hRead = io.hWrite = fopen(Filename.c_str(), "r+b");
2072                      hFileRead = hFileWrite = fopen(Filename.c_str(), "r+b");                      if (!io.hRead) {
2073                      if (!hFileRead) {                          io.hRead = io.hWrite = fopen(Filename.c_str(), "rb");
                         hFileRead = hFileWrite = fopen(Filename.c_str(), "rb");  
2074                          throw Exception("Could not open file \"" + Filename + "\" in read+write mode");                          throw Exception("Could not open file \"" + Filename + "\" in read+write mode");
2075                      }                      }
2076                      #endif                      #endif
2077                      __resetPos(); // reset read/write position of ALL 'Chunk' objects                      *pResetPos = true;
2078                      break;                      break;
2079                  case stream_mode_closed:                  case stream_mode_closed:
2080                        if (_isValidHandle(io.hRead)) _close(io.hRead);
2081                        if (_isValidHandle(io.hWrite)) _close(io.hWrite);
2082                      #if POSIX                      #if POSIX
2083                      if (hFileRead)  close(hFileRead);                      io.hRead = io.hWrite = 0;
                     if (hFileWrite) close(hFileWrite);  
                     hFileRead = hFileWrite = 0;  
2084                      #elif defined(WIN32)                      #elif defined(WIN32)
2085                      if (hFileRead  != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);                      io.hRead = io.hWrite = INVALID_HANDLE_VALUE;
                     if (hFileWrite != INVALID_HANDLE_VALUE) CloseHandle(hFileWrite);  
                     hFileRead = hFileWrite = INVALID_HANDLE_VALUE;  
2086                      #else                      #else
2087                      if (hFileRead)  fclose(hFileRead);                      io.hRead = io.hWrite = NULL;
                     if (hFileWrite) fclose(hFileWrite);  
                     hFileRead = hFileWrite = NULL;  
2088                      #endif                      #endif
2089                      break;                      break;
2090                  default:                  default:
2091                      throw Exception("Unknown file access mode");                      throw Exception("Unknown file access mode");
2092              }              }
2093              Mode = NewMode;              io.Mode = NewMode;
2094              return true;              return true;
2095          }          }
2096          return false;          return false;
# Line 1913  namespace RIFF { Line 2121  namespace RIFF {
2121       * @param pProgress - optional: callback function for progress notification       * @param pProgress - optional: callback function for progress notification
2122       * @throws RIFF::Exception if there is an empty chunk or empty list       * @throws RIFF::Exception if there is an empty chunk or empty list
2123       *                         chunk or any kind of IO error occurred       *                         chunk or any kind of IO error occurred
2124         * @see File::IsIOPerThread() for multi-threaded streaming
2125       */       */
2126      void File::Save(progress_t* pProgress) {      void File::Save(progress_t* pProgress) {
2127          //TODO: implementation for the case where first chunk is not a global container (List chunk) is not implemented yet (i.e. Korg files)          //TODO: implementation for the case where first chunk is not a global container (List chunk) is not implemented yet (i.e. Korg files)
# Line 1920  namespace RIFF { Line 2129  namespace RIFF {
2129              throw Exception("Saving a RIFF file with layout_flat is not implemented yet");              throw Exception("Saving a RIFF file with layout_flat is not implemented yet");
2130    
2131          // make sure the RIFF tree is built (from the original file)          // make sure the RIFF tree is built (from the original file)
2132          {          if (pProgress) {
2133              // divide progress into subprogress              // divide progress into subprogress
2134              progress_t subprogress;              progress_t subprogress;
2135              __divide_progress(pProgress, &subprogress, 3.f, 0.f); // arbitrarily subdivided into 1/3 of total progress              __divide_progress(pProgress, &subprogress, 3.f, 0.f); // arbitrarily subdivided into 1/3 of total progress
# Line 1928  namespace RIFF { Line 2137  namespace RIFF {
2137              LoadSubChunksRecursively(&subprogress);              LoadSubChunksRecursively(&subprogress);
2138              // notify subprogress done              // notify subprogress done
2139              __notify_progress(&subprogress, 1.f);              __notify_progress(&subprogress, 1.f);
2140          }          } else
2141                LoadSubChunksRecursively(NULL);
2142    
2143          // reopen file in write mode          // reopen file in write mode
2144          SetMode(stream_mode_read_write);          SetMode(stream_mode_read_write);
# Line 1943  namespace RIFF { Line 2153  namespace RIFF {
2153          // the RIFF file offset size to be used accordingly for all chunks          // the RIFF file offset size to be used accordingly for all chunks
2154          FileOffsetSize = FileOffsetSizeFor(newFileSize);          FileOffsetSize = FileOffsetSizeFor(newFileSize);
2155    
2156            const HandlePair io = FileHandlePair();
2157            const Handle hRead  = io.hRead;
2158            const Handle hWrite = io.hWrite;
2159    
2160          // to be able to save the whole file without loading everything into          // to be able to save the whole file without loading everything into
2161          // RAM and without having to store the data in a temporary file, we          // RAM and without having to store the data in a temporary file, we
2162          // enlarge the file with the overall positive file size change,          // enlarge the file with the overall positive file size change,
# Line 1958  namespace RIFF { Line 2172  namespace RIFF {
2172    
2173              // divide progress into subprogress              // divide progress into subprogress
2174              progress_t subprogress;              progress_t subprogress;
2175              __divide_progress(pProgress, &subprogress, 3.f, 1.f); // arbitrarily subdivided into 1/3 of total progress              if (pProgress)
2176                    __divide_progress(pProgress, &subprogress, 3.f, 1.f); // arbitrarily subdivided into 1/3 of total progress
2177    
2178              // ... we enlarge this file first ...              // ... we enlarge this file first ...
2179              ResizeFile(newFileSize);              ResizeFile(newFileSize);
# Line 1974  namespace RIFF { Line 2189  namespace RIFF {
2189                  iBytesMoved = (ullPos < 4096) ? ullPos : 4096;                  iBytesMoved = (ullPos < 4096) ? ullPos : 4096;
2190                  ullPos -= iBytesMoved;                  ullPos -= iBytesMoved;
2191                  #if POSIX                  #if POSIX
2192                  lseek(hFileRead, ullPos, SEEK_SET);                  lseek(hRead, ullPos, SEEK_SET);
2193                  iBytesMoved = read(hFileRead, pCopyBuffer, iBytesMoved);                  iBytesMoved = read(hRead, pCopyBuffer, iBytesMoved);
2194                  lseek(hFileWrite, ullPos + positiveSizeDiff, SEEK_SET);                  lseek(hWrite, ullPos + positiveSizeDiff, SEEK_SET);
2195                  iBytesMoved = write(hFileWrite, pCopyBuffer, iBytesMoved);                  iBytesMoved = write(hWrite, pCopyBuffer, iBytesMoved);
2196                  #elif defined(WIN32)                  #elif defined(WIN32)
2197                  LARGE_INTEGER liFilePos;                  LARGE_INTEGER liFilePos;
2198                  liFilePos.QuadPart = ullPos;                  liFilePos.QuadPart = ullPos;
2199                  SetFilePointerEx(hFileRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);                  SetFilePointerEx(hRead, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
2200                  ReadFile(hFileRead, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);                  ReadFile(hRead, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
2201                  liFilePos.QuadPart = ullPos + positiveSizeDiff;                  liFilePos.QuadPart = ullPos + positiveSizeDiff;
2202                  SetFilePointerEx(hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);                  SetFilePointerEx(hWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN);
2203                  WriteFile(hFileWrite, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);                  WriteFile(hWrite, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
2204                  #else                  #else
2205                  fseeko(hFileRead, ullPos, SEEK_SET);                  fseeko(hRead, ullPos, SEEK_SET);
2206                  iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, hFileRead);                  iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, hRead);
2207                  fseeko(hFileWrite, ullPos + positiveSizeDiff, SEEK_SET);                  fseeko(hWrite, ullPos + positiveSizeDiff, SEEK_SET);
2208                  iBytesMoved = fwrite(pCopyBuffer, 1, iBytesMoved, hFileWrite);                  iBytesMoved = fwrite(pCopyBuffer, 1, iBytesMoved, hWrite);
2209                  #endif                  #endif
2210                  if (!(iNotif % 8) && iBytesMoved > 0)                  if (pProgress && !(iNotif % 8) && iBytesMoved > 0)
2211                      __notify_progress(&subprogress, float(workingFileSize - ullPos) / float(workingFileSize));                      __notify_progress(&subprogress, float(workingFileSize - ullPos) / float(workingFileSize));
2212              }              }
2213              delete[] pCopyBuffer;              delete[] pCopyBuffer;
2214              if (iBytesMoved < 0) throw Exception("Could not modify file while trying to enlarge it");              if (iBytesMoved < 0) throw Exception("Could not modify file while trying to enlarge it");
2215    
2216              __notify_progress(&subprogress, 1.f); // notify subprogress done              if (pProgress)
2217                    __notify_progress(&subprogress, 1.f); // notify subprogress done
2218          }          }
2219    
2220          // rebuild / rewrite complete RIFF tree ...          // rebuild / rewrite complete RIFF tree ...
2221    
2222          // divide progress into subprogress          // divide progress into subprogress
2223          progress_t subprogress;          progress_t subprogress;
2224          __divide_progress(pProgress, &subprogress, 3.f, 2.f); // arbitrarily subdivided into 1/3 of total progress          if (pProgress)
2225                __divide_progress(pProgress, &subprogress, 3.f, 2.f); // arbitrarily subdivided into 1/3 of total progress
2226          // do the actual work          // do the actual work
2227          const file_offset_t finalSize = WriteChunk(0, positiveSizeDiff, &subprogress);          const file_offset_t finalSize = WriteChunk(0, positiveSizeDiff, pProgress ? &subprogress : NULL);
2228          const file_offset_t finalActualSize = __GetFileSize(hFileWrite);          const file_offset_t finalActualSize = __GetFileSize(hWrite);
2229          // notify subprogress done          // notify subprogress done
2230          __notify_progress(&subprogress, 1.f);          if (pProgress)
2231                __notify_progress(&subprogress, 1.f);
2232    
2233          // resize file to the final size          // resize file to the final size
2234          if (finalSize < finalActualSize) ResizeFile(finalSize);          if (finalSize < finalActualSize) ResizeFile(finalSize);
2235    
2236          __notify_progress(pProgress, 1.0); // notify done          if (pProgress)
2237                __notify_progress(pProgress, 1.0); // notify done
2238      }      }
2239    
2240      /** @brief Save changes to another file.      /** @brief Save changes to another file.
# Line 2031  namespace RIFF { Line 2250  namespace RIFF {
2250       *       *
2251       * @param path - path and file name where everything should be written to       * @param path - path and file name where everything should be written to
2252       * @param pProgress - optional: callback function for progress notification       * @param pProgress - optional: callback function for progress notification
2253         * @see File::IsIOPerThread() for multi-threaded streaming
2254       */       */
2255      void File::Save(const String& path, progress_t* pProgress) {      void File::Save(const String& path, progress_t* pProgress) {
2256          //TODO: we should make a check here if somebody tries to write to the same file and automatically call the other Save() method in that case          //TODO: we should make a check here if somebody tries to write to the same file and automatically call the other Save() method in that case
# Line 2040  namespace RIFF { Line 2260  namespace RIFF {
2260              throw Exception("Saving a RIFF file with layout_flat is not implemented yet");              throw Exception("Saving a RIFF file with layout_flat is not implemented yet");
2261    
2262          // make sure the RIFF tree is built (from the original file)          // make sure the RIFF tree is built (from the original file)
2263          {          if (pProgress) {
2264              // divide progress into subprogress              // divide progress into subprogress
2265              progress_t subprogress;              progress_t subprogress;
2266              __divide_progress(pProgress, &subprogress, 2.f, 0.f); // arbitrarily subdivided into 1/2 of total progress              __divide_progress(pProgress, &subprogress, 2.f, 0.f); // arbitrarily subdivided into 1/2 of total progress
# Line 2048  namespace RIFF { Line 2268  namespace RIFF {
2268              LoadSubChunksRecursively(&subprogress);              LoadSubChunksRecursively(&subprogress);
2269              // notify subprogress done              // notify subprogress done
2270              __notify_progress(&subprogress, 1.f);              __notify_progress(&subprogress, 1.f);
2271          }          } else
2272                LoadSubChunksRecursively(NULL);
2273    
2274          if (!bIsNewFile) SetMode(stream_mode_read);          if (!bIsNewFile) SetMode(stream_mode_read);
2275          // open the other (new) file for writing and truncate it to zero size  
2276          #if POSIX          {
2277          hFileWrite = open(path.c_str(), O_RDWR | O_CREAT, S_IRUSR | S_IWUSR | S_IRGRP);              std::lock_guard<std::mutex> lock(io.mutex);
2278          if (hFileWrite == -1) {              HandlePair& io = FileHandlePairUnsafeRef();
2279              hFileWrite = hFileRead;  
2280              String sError = strerror(errno);              // open the other (new) file for writing and truncate it to zero size
2281              throw Exception("Could not open file \"" + path + "\" for writing: " + sError);              #if POSIX
2282          }              io.hWrite = open(path.c_str(), O_RDWR | O_CREAT, S_IRUSR | S_IWUSR | S_IRGRP);
2283          #elif defined(WIN32)              if (io.hWrite == -1) {
2284          hFileWrite = CreateFile(                  io.hWrite = io.hRead;
2285                           path.c_str(), GENERIC_WRITE, FILE_SHARE_READ,                  String sError = strerror(errno);
2286                           NULL, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL |                  throw Exception("Could not open file \"" + path + "\" for writing: " + sError);
2287                           FILE_FLAG_RANDOM_ACCESS, NULL              }
2288                       );              #elif defined(WIN32)
2289          if (hFileWrite == INVALID_HANDLE_VALUE) {              io.hWrite = CreateFile(
2290              hFileWrite = hFileRead;                  path.c_str(), GENERIC_WRITE, FILE_SHARE_READ,
2291              throw Exception("Could not open file \"" + path + "\" for writing");                  NULL, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL |
2292          }                  FILE_FLAG_RANDOM_ACCESS, NULL
2293          #else              );
2294          hFileWrite = fopen(path.c_str(), "w+b");              if (io.hWrite == INVALID_HANDLE_VALUE) {
2295          if (!hFileWrite) {                  io.hWrite = io.hRead;
2296              hFileWrite = hFileRead;                  throw Exception("Could not open file \"" + path + "\" for writing");
2297              throw Exception("Could not open file \"" + path + "\" for writing");              }
2298                #else
2299                io.hWrite = fopen(path.c_str(), "w+b");
2300                if (!io.hWrite) {
2301                    io.hWrite = io.hRead;
2302                    throw Exception("Could not open file \"" + path + "\" for writing");
2303                }
2304                #endif // POSIX
2305                io.Mode = stream_mode_read_write;
2306          }          }
         #endif // POSIX  
         Mode = stream_mode_read_write;  
2307    
2308          // get the overall file size required to save this file          // get the overall file size required to save this file
2309          const file_offset_t newFileSize = GetRequiredFileSize(FileOffsetPreference);          const file_offset_t newFileSize = GetRequiredFileSize(FileOffsetPreference);
# Line 2087  namespace RIFF { Line 2314  namespace RIFF {
2314    
2315          // write complete RIFF tree to the other (new) file          // write complete RIFF tree to the other (new) file
2316          file_offset_t ullTotalSize;          file_offset_t ullTotalSize;
2317          {          if (pProgress) {
2318              // divide progress into subprogress              // divide progress into subprogress
2319              progress_t subprogress;              progress_t subprogress;
2320              __divide_progress(pProgress, &subprogress, 2.f, 1.f); // arbitrarily subdivided into 1/2 of total progress              __divide_progress(pProgress, &subprogress, 2.f, 1.f); // arbitrarily subdivided into 1/2 of total progress
# Line 2095  namespace RIFF { Line 2322  namespace RIFF {
2322              ullTotalSize = WriteChunk(0, 0, &subprogress);              ullTotalSize = WriteChunk(0, 0, &subprogress);
2323              // notify subprogress done              // notify subprogress done
2324              __notify_progress(&subprogress, 1.f);              __notify_progress(&subprogress, 1.f);
2325          }          } else
2326          file_offset_t ullActualSize = __GetFileSize(hFileWrite);              ullTotalSize = WriteChunk(0, 0, NULL);
2327    
2328            const file_offset_t ullActualSize = __GetFileSize(FileWriteHandle());
2329    
2330          // resize file to the final size (if the file was originally larger)          // resize file to the final size (if the file was originally larger)
2331          if (ullActualSize > ullTotalSize) ResizeFile(ullTotalSize);          if (ullActualSize > ullTotalSize) ResizeFile(ullTotalSize);
2332    
2333          #if POSIX          {
2334          if (hFileWrite) close(hFileWrite);              std::lock_guard<std::mutex> lock(io.mutex);
2335          #elif defined(WIN32)              HandlePair& io = FileHandlePairUnsafeRef();
         if (hFileWrite != INVALID_HANDLE_VALUE) CloseHandle(hFileWrite);  
         #else  
         if (hFileWrite) fclose(hFileWrite);  
         #endif  
         hFileWrite = hFileRead;  
2336    
2337          // associate new file with this File object from now on              if (_isValidHandle(io.hWrite)) _close(io.hWrite);
2338          Filename = path;              io.hWrite = io.hRead;
2339          bIsNewFile = false;  
2340          Mode = (stream_mode_t) -1;       // Just set it to an undefined mode ...              // associate new file with this File object from now on
2341                Filename = path;
2342                bIsNewFile = false;
2343                io.Mode = (stream_mode_t) -1; // Just set it to an undefined mode ...
2344            }
2345          SetMode(stream_mode_read_write); // ... so SetMode() has to reopen the file handles.          SetMode(stream_mode_read_write); // ... so SetMode() has to reopen the file handles.
2346    
2347          __notify_progress(pProgress, 1.0); // notify done          if (pProgress)
2348                __notify_progress(pProgress, 1.0); // notify done
2349      }      }
2350    
2351      void File::ResizeFile(file_offset_t ullNewSize) {      void File::ResizeFile(file_offset_t ullNewSize) {
2352            const Handle hWrite = FileWriteHandle();
2353          #if POSIX          #if POSIX
2354          if (ftruncate(hFileWrite, ullNewSize) < 0)          if (ftruncate(hWrite, ullNewSize) < 0)
2355              throw Exception("Could not resize file \"" + Filename + "\"");              throw Exception("Could not resize file \"" + Filename + "\"");
2356          #elif defined(WIN32)          #elif defined(WIN32)
2357          LARGE_INTEGER liFilePos;          LARGE_INTEGER liFilePos;
2358          liFilePos.QuadPart = ullNewSize;          liFilePos.QuadPart = ullNewSize;
2359          if (          if (
2360              !SetFilePointerEx(hFileWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN) ||              !SetFilePointerEx(hWrite, liFilePos, NULL/*new pos pointer*/, FILE_BEGIN) ||
2361              !SetEndOfFile(hFileWrite)              !SetEndOfFile(hWrite)
2362          ) throw Exception("Could not resize file \"" + Filename + "\"");          ) throw Exception("Could not resize file \"" + Filename + "\"");
2363          #else          #else
2364          # error Sorry, this version of libgig only supports POSIX and Windows systems yet.          # error Sorry, this version of libgig only supports POSIX and Windows systems yet.
# Line 2152  namespace RIFF { Line 2382  namespace RIFF {
2382      }      }
2383    
2384      void File::Cleanup() {      void File::Cleanup() {
2385          #if POSIX          if (IsIOPerThread()) {
2386          if (hFileRead) close(hFileRead);              for (auto it = io.byThread.begin(); it != io.byThread.end(); ++it) {
2387          #elif defined(WIN32)                  _close(it->second.hRead);
2388          if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);              }
2389          #else          } else {
2390          if (hFileRead) fclose(hFileRead);              _close(io.hRead);
2391          #endif // POSIX          }
2392          DeleteChunkList();          DeleteChunkList();
2393          pFile = NULL;          pFile = NULL;
2394      }      }
# Line 2171  namespace RIFF { Line 2401  namespace RIFF {
2401       */       */
2402      file_offset_t File::GetCurrentFileSize() const {      file_offset_t File::GetCurrentFileSize() const {
2403          file_offset_t size = 0;          file_offset_t size = 0;
2404            const Handle hRead = FileHandle();
2405          try {          try {
2406              size = __GetFileSize(hFileRead);              size = __GetFileSize(hRead);
2407          } catch (...) {          } catch (...) {
2408              size = 0;              size = 0;
2409          }          }
# Line 2280  namespace RIFF { Line 2511  namespace RIFF {
2511          return FileOffsetSizeFor(GetCurrentFileSize());          return FileOffsetSizeFor(GetCurrentFileSize());
2512      }      }
2513    
2514        /** @brief Whether file streams are independent for each thread.
2515         *
2516         * All file I/O operations like reading from a RIFF chunk body (e.g. by
2517         * calling Chunk::Read(), Chunk::ReadInt8()), writing to a RIFF chunk body
2518         * (e.g. by calling Chunk::Write(), Chunk::WriteInt8()) or saving the
2519         * current RIFF tree structure to some file (e.g. by calling Save())
2520         * operate on a file I/O stream state, i.e. there is a "current" file
2521         * read/write position and reading/writing by a certain amount of bytes
2522         * automatically advances that "current" file position.
2523         *
2524         * By default there is only one stream state for a RIFF::File object, which
2525         * is not an issue as long as only one thread is using the RIFF::File
2526         * object at a time (which might also be the case in a collaborative /
2527         * coroutine multi-threaded scenario).
2528         *
2529         * If however a RIFF::File object is read/written @b simultaniously by
2530         * multiple threads this can lead to undefined behaviour as the individual
2531         * threads would concurrently alter the file stream position. For such a
2532         * concurrent multithreaded file I/O scenario @c SetIOPerThread(true) might
2533         * be enabled which causes each thread to automatically use its own file
2534         * stream state.
2535         *
2536         * @returns true if each thread has its own file stream state
2537         *          (default: false)
2538         * @see SetIOPerThread()
2539         */
2540        bool File::IsIOPerThread() const {
2541            //NOTE: Not caring about atomicity here at all, for three reasons:
2542            // 1. SetIOPerThread() is assumed to be called only once for the entire
2543            //    life time of a RIFF::File, usually very early at its lifetime, and
2544            //    hence a change to isPerThread should already safely be propagated
2545            //    before any other thread would actually read this boolean flag.
2546            // 2. This method is called very frequently, and therefore any
2547            //    synchronization techique would hurt runtime efficiency.
2548            // 3. Using even a mutex lock here might easily cause a deadlock due to
2549            //    other locks been taken in this .cpp file, i.e. at a higher call
2550            //    stack level (and this is the main reason why I removed it here).
2551            return io.isPerThread;
2552        }
2553    
2554        /** @brief Enable/disable file streams being independent for each thread.
2555         *
2556         * By enabling this feature (default off) each thread will automatically use
2557         * its own file I/O stream state for allowing simultanious multi-threaded
2558         * file read/write operations.
2559         *
2560         * @b NOTE: After having enabled this feature, the individual threads must
2561         * at least once check GetState() and if their file I/O stream is yet closed
2562         * they must call SetMode() (i.e. once) respectively to open their own file
2563         * handles before being able to use any of the Read() or Write() methods.
2564         *
2565         * @param enable - @c true: one independent stream state per thread,
2566         *                 @c false: only one stream in total shared by @b all threads
2567         * @see IsIOPerThread() for more details about this feature
2568         */
2569        void File::SetIOPerThread(bool enable) {
2570            std::lock_guard<std::mutex> lock(io.mutex);
2571            if (!io.byThread.empty() == enable) return;
2572            io.isPerThread = enable;
2573            if (enable) {
2574                const std::thread::id tid = std::this_thread::get_id();
2575                io.byThread[tid] = io;
2576            } else {
2577                // retain an arbitrary handle pair, close all other handle pairs
2578                for (auto it = io.byThread.begin(); it != io.byThread.end(); ++it) {
2579                    if (it == io.byThread.begin()) {
2580                        io.hRead  = it->second.hRead;
2581                        io.hWrite = it->second.hWrite;
2582                    } else {
2583                        _close(it->second.hRead);
2584                        _close(it->second.hWrite);
2585                    }
2586                }
2587                io.byThread.clear();
2588            }
2589        }
2590    
2591      #if POSIX      #if POSIX
2592      file_offset_t File::__GetFileSize(int hFile) const {      file_offset_t File::__GetFileSize(int hFile) const {
2593          struct stat filestat;          struct stat filestat;

Legend:
Removed from v.3481  
changed lines
  Added in v.3919

  ViewVC Help
Powered by ViewVC