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

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

Parent Directory | Revision Log | View Patch Patch

-revision 780 by schoenebeck,
Sun Sep 25 13:40:37 2005 UTC
+revision 1859 by persson,
Sun Mar  8 12:24:56 2009 UTC
 Line 1
  /***************************************************************************
   *                                                                         *
-  *   libgig - C++ cross-platform Gigasampler format file loader library    *
+  *   libgig - C++ cross-platform Gigasampler format file access library    *
   *                                                                         *
-  *   Copyright (C) 2003-2005 by Christian Schoenebeck                      *
+  *   Copyright (C) 2003-2009 by Christian Schoenebeck                      *
   *                              <cuse@users.sourceforge.net>               *
   *                                                                         *
   *   This library is free software; you can redistribute it and/or modify  *
 Line 21
   *   MA  02111-1307  USA                                                   *
   ***************************************************************************/
+ #include <algorithm>
  #include <string.h>
- #include <sstream>
  #include "RIFF.h"
+ #include "helper.h"
  namespace RIFF {
- // *************** Helper Functions **************
+ // *************** Internal functions **************
  // *
-     template<class T> inline String ToString(T o) {
+     /// Returns a human readable path of the given chunk.
-         std::stringstream ss;
+     static String __resolveChunkPath(Chunk* pCk) {
-         ss << o;
+         String sPath;
-         return ss.str();
+         for (Chunk* pChunk = pCk; pChunk; pChunk = pChunk->GetParent()) {
+             if (pChunk->GetChunkID() == CHUNK_ID_LIST) {
+                 List* pList = (List*) pChunk;
+                 sPath = "->'" + pList->GetListTypeString() + "'" + sPath;
+             } else {
+                 sPath = "->'" + pChunk->GetChunkIDString() + "'" + sPath;
+             }
+         }
+         return sPath;
      }
-Line 49 
 namespace RIFF {
+Line 59 
 namespace RIFF {
          ulPos      = 0;
          pParent    = NULL;
          pChunkData = NULL;
+         ulChunkDataSize = 0;
+         ChunkID    = CHUNK_ID_RIFF;
          this->pFile = pFile;
      }
-Line 61 
 namespace RIFF {
+Line 73 
 namespace RIFF {
          pParent       = Parent;
          ulPos         = 0;
          pChunkData    = NULL;
+         ulChunkDataSize = 0;
          ReadHeader(StartPos);
      }
-Line 70 
 namespace RIFF {
+Line 83 
 namespace RIFF {
          this->pParent    = pParent;
          ulPos            = 0;
          pChunkData       = NULL;
+         ulChunkDataSize  = 0;
          ChunkID          = uiChunkID;
          CurrentChunkSize = 0;
          NewChunkSize     = uiBodySize;
      }
      Chunk::~Chunk() {
+         pFile->UnlogResized(this);
          if (pChunkData) delete[] pChunkData;
      }
-Line 87 
 namespace RIFF {
+Line 102 
 namespace RIFF {
          if (lseek(pFile->hFileRead, fPos, SEEK_SET) != -1) {
              read(pFile->hFileRead, &ChunkID, 4);
              read(pFile->hFileRead, &CurrentChunkSize, 4);
+         #elif defined(WIN32)
+         if (SetFilePointer(pFile->hFileRead, fPos, NULL/*32 bit*/, FILE_BEGIN) != INVALID_SET_FILE_POINTER) {
+             DWORD dwBytesRead;
+             ReadFile(pFile->hFileRead, &ChunkID, 4, &dwBytesRead, NULL);
+             ReadFile(pFile->hFileRead, &CurrentChunkSize, 4, &dwBytesRead, NULL);
          #else
          if (!fseek(pFile->hFileRead, fPos, SEEK_SET)) {
              fread(&ChunkID, 4, 1, pFile->hFileRead);
-Line 94 
 namespace RIFF {
+Line 114 
 namespace RIFF {
          #endif // POSIX
              #if WORDS_BIGENDIAN
              if (ChunkID == CHUNK_ID_RIFF) {
-                 bEndianNative = false;
+                 pFile->bEndianNative = false;
              }
              #else // little endian
              if (ChunkID == CHUNK_ID_RIFX) {
-Line 135 
 namespace RIFF {
+Line 155 
 namespace RIFF {
              write(pFile->hFileWrite, &uiNewChunkID, 4);
              write(pFile->hFileWrite, &uiNewChunkSize, 4);
          }
+         #elif defined(WIN32)
+         if (SetFilePointer(pFile->hFileWrite, fPos, NULL/*32 bit*/, FILE_BEGIN) != INVALID_SET_FILE_POINTER) {
+             DWORD dwBytesWritten;
+             WriteFile(pFile->hFileWrite, &uiNewChunkID, 4, &dwBytesWritten, NULL);
+             WriteFile(pFile->hFileWrite, &uiNewChunkSize, 4, &dwBytesWritten, NULL);
+         }
          #else
          if (!fseek(pFile->hFileWrite, fPos, SEEK_SET)) {
              fwrite(&uiNewChunkID, 4, 1, pFile->hFileWrite);
-Line 210 
 namespace RIFF {
+Line 236 
 namespace RIFF {
       *  - RIFF::stream_closed :
       *    the data stream was closed somehow, no more reading possible
       *  - RIFF::stream_end_reached :
-      *    alreaady reached the end of the chunk data, no more reading
+      *    already reached the end of the chunk data, no more reading
       *    possible without SetPos()
       */
      stream_state_t Chunk::GetState() {
-Line 218 
 namespace RIFF {
+Line 244 
 namespace RIFF {
        std::cout << "Chunk::GetState()" << std::endl;
        #endif // DEBUG
          #if POSIX
-         if (pFile->hFileRead == 0)    return stream_closed;
+         if (pFile->hFileRead == 0) return stream_closed;
+         #elif defined (WIN32)
+         if (pFile->hFileRead == INVALID_HANDLE_VALUE)
+             return stream_closed;
          #else
          if (pFile->hFileRead == NULL) return stream_closed;
          #endif // POSIX
-Line 245 
 namespace RIFF {
+Line 274 
 namespace RIFF {
         #if DEBUG
         std::cout << "Chunk::Read(void*,ulong,ulong)" << std::endl;
         #endif // DEBUG
+         if (ulStartPos == 0) return 0; // is only 0 if this is a new chunk, so nothing to read (yet)
          if (ulPos >= CurrentChunkSize) return 0;
          if (ulPos + WordCount * WordSize >= CurrentChunkSize) WordCount = (CurrentChunkSize - ulPos) / WordSize;
          #if POSIX
-Line 252 
 namespace RIFF {
+Line 282 
 namespace RIFF {
          unsigned long readWords = read(pFile->hFileRead, pData, WordCount * WordSize);
          if (readWords < 1) return 0;
          readWords /= WordSize;
+         #elif defined(WIN32)
+         if (SetFilePointer(pFile->hFileRead, ulStartPos + ulPos, NULL/*32 bit*/, FILE_BEGIN) == INVALID_SET_FILE_POINTER) return 0;
+         DWORD readWords;
+         ReadFile(pFile->hFileRead, pData, WordCount * WordSize, &readWords, NULL);
+         if (readWords < 1) return 0;
+         readWords /= WordSize;
          #else // standard C functions
          if (fseek(pFile->hFileRead, ulStartPos + ulPos, SEEK_SET)) return 0;
          unsigned long readWords = fread(pData, WordSize, WordCount, pFile->hFileRead);
-Line 293 
 namespace RIFF {
+Line 329 
 namespace RIFF {
       *  @see Resize()
       */
      unsigned long Chunk::Write(void* pData, unsigned long WordCount, unsigned long WordSize) {
-         if (pFile->Mode == stream_mode_read)
+         if (pFile->Mode != stream_mode_read_write)
-             throw Exception("Writing chunk data in read-only file access mode was attempted");
+             throw Exception("Cannot write data to chunk, file has to be opened in read+write mode first");
-         if (ulPos >= CurrentChunkSize || ulPos + WordCount * WordSize >= CurrentChunkSize)
+         if (ulPos >= CurrentChunkSize || ulPos + WordCount * WordSize > CurrentChunkSize)
              throw Exception("End of chunk reached while trying to write data");
          if (!pFile->bEndianNative && WordSize != 1) {
              switch (WordSize) {
-Line 321 
 namespace RIFF {
+Line 357 
 namespace RIFF {
          unsigned long writtenWords = write(pFile->hFileWrite, pData, WordCount * WordSize);
          if (writtenWords < 1) throw Exception("POSIX IO Error while trying to write chunk data");
          writtenWords /= WordSize;
+         #elif defined(WIN32)
+         if (SetFilePointer(pFile->hFileWrite, ulStartPos + ulPos, NULL/*32 bit*/, FILE_BEGIN) == INVALID_SET_FILE_POINTER) {
+             throw Exception("Could not seek to position " + ToString(ulPos) +
+                             " in chunk (" + ToString(ulStartPos + ulPos) + " in file)");
+         }
+         DWORD writtenWords;
+         WriteFile(pFile->hFileWrite, pData, WordCount * WordSize, &writtenWords, NULL);
+         if (writtenWords < 1) throw Exception("Windows IO Error while trying to write chunk data");
+         writtenWords /= WordSize;
          #else // standard C functions
          if (fseek(pFile->hFileWrite, ulStartPos + ulPos, SEEK_SET)) {
              throw Exception("Could not seek to position " + ToString(ulPos) +
-Line 667 
 namespace RIFF {
+Line 712 
 namespace RIFF {
       *
       * <b>Caution:</b> the buffer pointer will be invalidated once
       * File::Save() was called. You have to call LoadChunkData() again to
-      * get a new pointer whenever File::Save() was called.
+      * get a new, valid pointer whenever File::Save() was called.
+      *
+      * You can call LoadChunkData() again if you previously scheduled to
+      * enlarge this chunk with a Resize() call. In that case the buffer will
+      * be enlarged to the new, scheduled chunk size and you can already
+      * place the new chunk data to the buffer and finally call File::Save()
+      * to enlarge the chunk physically and write the new data in one rush.
+      * This approach is definitely recommended if you have to enlarge and
+      * write new data to a lot of chunks.
       *
       * @returns a pointer to the data in RAM on success, NULL otherwise
+      * @throws Exception if data buffer could not be enlarged
       * @see ReleaseChunkData()
       */
      void* Chunk::LoadChunkData() {
-         if (!pChunkData) {
+         if (!pChunkData && pFile->Filename != "" && ulStartPos != 0) {
              #if POSIX
              if (lseek(pFile->hFileRead, ulStartPos, SEEK_SET) == -1) return NULL;
-             pChunkData = new uint8_t[GetSize()];
+             #elif defined(WIN32)
-             if (!pChunkData) return NULL;
+             if (SetFilePointer(pFile->hFileRead, ulStartPos, NULL/*32 bit*/, FILE_BEGIN) == INVALID_SET_FILE_POINTER) return NULL;
-             unsigned long readWords = read(pFile->hFileRead, pChunkData, GetSize());
              #else
              if (fseek(pFile->hFileRead, ulStartPos, SEEK_SET)) return NULL;
-             pChunkData = new uint8_t[GetSize()];
+             #endif // POSIX
+             unsigned long ulBufferSize = (CurrentChunkSize > NewChunkSize) ? CurrentChunkSize : NewChunkSize;
+             pChunkData = new uint8_t[ulBufferSize];
              if (!pChunkData) return NULL;
+             memset(pChunkData, 0, ulBufferSize);
+             #if POSIX
+             unsigned long readWords = read(pFile->hFileRead, pChunkData, GetSize());
+             #elif defined(WIN32)
+             DWORD readWords;
+             ReadFile(pFile->hFileRead, pChunkData, GetSize(), &readWords, NULL);
+             #else
              unsigned long readWords = fread(pChunkData, 1, GetSize(), pFile->hFileRead);
              #endif // POSIX
              if (readWords != GetSize()) {
                  delete[] pChunkData;
                  return (pChunkData = NULL);
              }
+             ulChunkDataSize = ulBufferSize;
+         } else if (NewChunkSize > ulChunkDataSize) {
+             uint8_t* pNewBuffer = new uint8_t[NewChunkSize];
+             if (!pNewBuffer) throw Exception("Could not enlarge chunk data buffer to " + ToString(NewChunkSize) + " bytes");
+             memset(pNewBuffer, 0 , NewChunkSize);
+             memcpy(pNewBuffer, pChunkData, ulChunkDataSize);
+             delete[] pChunkData;
+             pChunkData      = pNewBuffer;
+             ulChunkDataSize = NewChunkSize;
          }
          return pChunkData;
      }
-Line 718 
 namespace RIFF {
+Line 789 
 namespace RIFF {
       *
       * <b>Caution:</b> You cannot directly write to enlarged chunks before
       * calling File::Save() as this might exceed the current chunk's body
-      * boundary.
+      * boundary!
       *
       * @param iNewSize - new chunk body size in bytes (must be greater than zero)
       * @throws RIFF::Exception  if \a iNewSize is less than 1
       * @see File::Save()
       */
      void Chunk::Resize(int iNewSize) {
-         if (iNewSize <= 0) throw Exception("Chunk size must be at least one byte");
+         if (iNewSize <= 0)
+             throw Exception("There is at least one empty chunk (zero size): " + __resolveChunkPath(this));
+         if (NewChunkSize == iNewSize) return;
          NewChunkSize = iNewSize;
          pFile->LogAsResized(this);
      }
-Line 743 
 namespace RIFF {
+Line 816 
 namespace RIFF {
       *          (including its header size of course)
       */
      unsigned long Chunk::WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset) {
-         unsigned long ulOriginalPos = ulWritePos;
+         const unsigned long ulOriginalPos = ulWritePos;
          ulWritePos += CHUNK_HEADER_SIZE;
+         if (pFile->Mode != stream_mode_read_write)
+             throw Exception("Cannot write list chunk, file has to be opened in read+write mode");
          // if the whole chunk body was loaded into RAM
          if (pChunkData) {
-             // in case the chunk size was changed, reallocate the data in RAM with the chunk's new size
+             // make sure chunk data buffer in RAM is at least as large as the new chunk size
-             if (NewChunkSize != CurrentChunkSize) {
+             LoadChunkData();
-                 uint8_t* pNewBuffer = new uint8_t[NewChunkSize];
-                 if (NewChunkSize > CurrentChunkSize) {
-                     memcpy(pNewBuffer, pChunkData, CurrentChunkSize);
-                     memset(pNewBuffer + CurrentChunkSize, 0, NewChunkSize - CurrentChunkSize);
-                 } else {
-                     memcpy(pNewBuffer, pChunkData, NewChunkSize);
-                 }
-                 delete[] pChunkData;
-                 pChunkData = pNewBuffer;
-             }
              // write chunk data from RAM persistently to the file
              #if POSIX
              lseek(pFile->hFileWrite, ulWritePos, SEEK_SET);
              if (write(pFile->hFileWrite, pChunkData, NewChunkSize) != NewChunkSize) {
                  throw Exception("Writing Chunk data (from RAM) failed");
              }
+             #elif defined(WIN32)
+             SetFilePointer(pFile->hFileWrite, ulWritePos, NULL/*32 bit*/, FILE_BEGIN);
+             DWORD dwBytesWritten;
+             WriteFile(pFile->hFileWrite, pChunkData, NewChunkSize, &dwBytesWritten, NULL);
+             if (dwBytesWritten != NewChunkSize) {
+                 throw Exception("Writing Chunk data (from RAM) failed");
+             }
              #else
              fseek(pFile->hFileWrite, ulWritePos, SEEK_SET);
              if (fwrite(pChunkData, 1, NewChunkSize, pFile->hFileWrite) != NewChunkSize) {
-Line 777 
 namespace RIFF {
+Line 849 
 namespace RIFF {
              // move chunk data from the end of the file to the appropriate position
              int8_t* pCopyBuffer = new int8_t[4096];
              unsigned long ulToMove = (NewChunkSize < CurrentChunkSize) ? NewChunkSize : CurrentChunkSize;
+             #if defined(WIN32)
+             DWORD iBytesMoved = 1; // we have to pass it via pointer to the Windows API, thus the correct size must be ensured
+             #else
              int iBytesMoved = 1;
+             #endif
              for (unsigned long ulOffset = 0; iBytesMoved > 0; ulOffset += iBytesMoved, ulToMove -= iBytesMoved) {
                  iBytesMoved = (ulToMove < 4096) ? ulToMove : 4096;
                  #if POSIX
-Line 785 
 namespace RIFF {
+Line 861 
 namespace RIFF {
                  iBytesMoved = read(pFile->hFileRead, pCopyBuffer, iBytesMoved);
                  lseek(pFile->hFileWrite, ulWritePos + ulOffset, SEEK_SET);
                  iBytesMoved = write(pFile->hFileWrite, pCopyBuffer, iBytesMoved);
+                 #elif defined(WIN32)
+                 SetFilePointer(pFile->hFileRead, ulStartPos + ulCurrentDataOffset + ulOffset, NULL/*32 bit*/, FILE_BEGIN);
+                 ReadFile(pFile->hFileRead, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
+                 SetFilePointer(pFile->hFileWrite, ulWritePos + ulOffset, NULL/*32 bit*/, FILE_BEGIN);
+                 WriteFile(pFile->hFileWrite, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
                  #else
                  fseek(pFile->hFileRead, ulStartPos + ulCurrentDataOffset + ulOffset, SEEK_SET);
                  iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, pFile->hFileRead);
-Line 806 
 namespace RIFF {
+Line 887 
 namespace RIFF {
          // add pad byte if needed
          if ((ulStartPos + NewChunkSize) % 2 != 0) {
-             char cPadByte = 0;
+             const char cPadByte = 0;
              #if POSIX
+             lseek(pFile->hFileWrite, ulStartPos + NewChunkSize, SEEK_SET);
              write(pFile->hFileWrite, &cPadByte, 1);
+             #elif defined(WIN32)
+             SetFilePointer(pFile->hFileWrite, ulStartPos + NewChunkSize, NULL/*32 bit*/, FILE_BEGIN);
+             DWORD dwBytesWritten;
+             WriteFile(pFile->hFileWrite, &cPadByte, 1, &dwBytesWritten, NULL);
              #else
+             fseek(pFile->hFileWrite, ulStartPos + NewChunkSize, SEEK_SET);
              fwrite(&cPadByte, 1, 1, pFile->hFileWrite);
              #endif
              return ulStartPos + NewChunkSize + 1;
-Line 1063 
 namespace RIFF {
+Line 1150 
 namespace RIFF {
      Chunk* List::AddSubChunk(uint32_t uiChunkID, uint uiBodySize) {
          if (uiBodySize == 0) throw Exception("Chunk body size must be at least 1 byte");
          if (!pSubChunks) LoadSubChunks();
-         Chunk* pNewChunk = new Chunk(pFile, this, uiChunkID, uiBodySize);
+         Chunk* pNewChunk = new Chunk(pFile, this, uiChunkID, 0);
          pSubChunks->push_back(pNewChunk);
          (*pSubChunksMap)[uiChunkID] = pNewChunk;
-         pFile->ResizedChunks.push_back(pNewChunk);
+         pNewChunk->Resize(uiBodySize);
+         NewChunkSize += CHUNK_HEADER_SIZE;
+         pFile->LogAsResized(this);
          return pNewChunk;
      }
+     /** @brief Moves a sub chunk.
+      *
+      * Moves a sub chunk from one position in a list to another
+      * position in the same list. The pSrc chunk is placed before the
+      * pDst chunk.
+      *
+      * @param pSrc - sub chunk to be moved
+      * @param pDst - the position to move to. pSrc will be placed
+      *               before pDst. If pDst is 0, pSrc will be placed
+      *               last in list.
+      */
+     void List::MoveSubChunk(Chunk* pSrc, Chunk* pDst) {
+         if (!pSubChunks) LoadSubChunks();
+         pSubChunks->remove(pSrc);
+         ChunkList::iterator iter = find(pSubChunks->begin(), pSubChunks->end(), pDst);
+         pSubChunks->insert(iter, pSrc);
+     }
      /** @brief Creates a new list sub chunk.
       *
       * Creates and adds a new list sub chunk to this list chunk. Note that
-Line 1084 
 namespace RIFF {
+Line 1191 
 namespace RIFF {
          List* pNewListChunk = new List(pFile, this, uiListType);
          pSubChunks->push_back(pNewListChunk);
          (*pSubChunksMap)[CHUNK_ID_LIST] = pNewListChunk;
+         NewChunkSize += LIST_HEADER_SIZE;
+         pFile->LogAsResized(this);
          return pNewListChunk;
      }
-Line 1091 
 namespace RIFF {
+Line 1200 
 namespace RIFF {
       *
       * Removes the sub chunk given by \a pSubChunk from this list and frees
       * it completely from RAM. The given chunk can either be a normal sub
-      * chunk or a list sub chunk. You should call File::Save() to make this
+      * chunk or a list sub chunk. In case the given chunk is a list chunk,
-      * change persistent at any time.
+      * all its subchunks (if any) will be removed recursively as well. You
+      * should call File::Save() to make this change persistent at any time.
       *
       * @param pSubChunk - sub chunk or sub list chunk to be removed
       */
-Line 1123 
 namespace RIFF {
+Line 1233 
 namespace RIFF {
          #if POSIX
          lseek(pFile->hFileRead, fPos + CHUNK_HEADER_SIZE, SEEK_SET);
          read(pFile->hFileRead, &ListType, 4);
+         #elif defined(WIN32)
+         SetFilePointer(pFile->hFileRead, fPos + CHUNK_HEADER_SIZE, NULL/*32 bit*/, FILE_BEGIN);
+         DWORD dwBytesRead;
+         ReadFile(pFile->hFileRead, &ListType, 4, &dwBytesRead, NULL);
          #else
          fseek(pFile->hFileRead, fPos + CHUNK_HEADER_SIZE, SEEK_SET);
          fread(&ListType, 4, 1, pFile->hFileRead);
-Line 1143 
 namespace RIFF {
+Line 1257 
 namespace RIFF {
          #if POSIX
          lseek(pFile->hFileWrite, fPos + CHUNK_HEADER_SIZE, SEEK_SET);
          write(pFile->hFileWrite, &ListType, 4);
+         #elif defined(WIN32)
+         SetFilePointer(pFile->hFileWrite, fPos + CHUNK_HEADER_SIZE, NULL/*32 bit*/, FILE_BEGIN);
+         DWORD dwBytesWritten;
+         WriteFile(pFile->hFileWrite, &ListType, 4, &dwBytesWritten, NULL);
          #else
          fseek(pFile->hFileWrite, fPos + CHUNK_HEADER_SIZE, SEEK_SET);
          fwrite(&ListType, 4, 1, pFile->hFileWrite);
-Line 1156 
 namespace RIFF {
+Line 1274 
 namespace RIFF {
          if (!pSubChunks) {
              pSubChunks    = new ChunkList();
              pSubChunksMap = new ChunkMap();
+             #if defined(WIN32)
+             if (pFile->hFileRead == INVALID_HANDLE_VALUE) return;
+             #else
              if (!pFile->hFileRead) return;
+             #endif
              unsigned long uiOriginalPos = GetPos();
              SetPos(0); // jump to beginning of list chunk body
              while (RemainingBytes() >= CHUNK_HEADER_SIZE) {
-Line 1182 
 namespace RIFF {
+Line 1304 
 namespace RIFF {
          }
      }
+     void List::LoadSubChunksRecursively() {
+         for (List* pList = GetFirstSubList(); pList; pList = GetNextSubList())
+             pList->LoadSubChunksRecursively();
+     }
      /** @brief Write list chunk persistently e.g. to disk.
       *
       * Stores the list chunk persistently to its actual "physical" file. All
-Line 1197 
 namespace RIFF {
+Line 1324 
 namespace RIFF {
       *          (including its header size of course)
       */
      unsigned long List::WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset) {
-         unsigned long ulOriginalPos = ulWritePos;
+         const unsigned long ulOriginalPos = ulWritePos;
          ulWritePos += LIST_HEADER_SIZE;
+         if (pFile->Mode != stream_mode_read_write)
+             throw Exception("Cannot write list chunk, file has to be opened in read+write mode");
          // write all subchunks (including sub list chunks) recursively
          if (pSubChunks) {
              for (ChunkList::iterator iter = pSubChunks->begin(), end = pSubChunks->end(); iter != end; ++iter) {
-Line 1211 
 namespace RIFF {
+Line 1341 
 namespace RIFF {
          CurrentChunkSize = NewChunkSize = ulWritePos - ulOriginalPos - LIST_HEADER_SIZE;
          WriteHeader(ulOriginalPos);
+         // offset of this list chunk in new written file may have changed
+         ulStartPos = ulOriginalPos + LIST_HEADER_SIZE;
          return ulWritePos;
      }
-Line 1241 
 namespace RIFF {
+Line 1374 
 namespace RIFF {
       * "from scratch". Note: there must be no empty chunks or empty list
       * chunks when trying to make the new RIFF file persistent with Save()!
       *
-      * @see AddSubChunk(), AddSubList()
+      * Note: by default, the RIFF file will be saved in native endian
-      */
+      * format; that is, as a RIFF file on little-endian machines and
-     File::File() : List(this) {
+      * as a RIFX file on big-endian. To change this behaviour, call
+      * SetByteOrder() before calling Save().
+      *
+      * @param FileType - four-byte identifier of the RIFF file type
+      * @see AddSubChunk(), AddSubList(), SetByteOrder()
+      */
+     File::File(uint32_t FileType) : List(this) {
+         #if defined(WIN32)
+         hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
+         #else
          hFileRead = hFileWrite = 0;
+         #endif
+         Mode = stream_mode_closed;
          bEndianNative = true;
          ulStartPos = RIFF_HEADER_SIZE;
+         ListType = FileType;
      }
      /** @brief Load existing RIFF file.
-Line 1268 
 namespace RIFF {
+Line 1413 
 namespace RIFF {
              hFileRead = hFileWrite = 0;
              throw RIFF::Exception("Can't open \"" + path + "\"");
          }
+         #elif defined(WIN32)
+         hFileRead = hFileWrite = CreateFile(
+                                      path.c_str(), GENERIC_READ,
+                                      FILE_SHARE_READ | FILE_SHARE_WRITE,
+                                      NULL, OPEN_EXISTING,
+                                      FILE_ATTRIBUTE_NORMAL |
+                                      FILE_FLAG_RANDOM_ACCESS, NULL
+                                  );
+         if (hFileRead == INVALID_HANDLE_VALUE) {
+             hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
+             throw RIFF::Exception("Can't open \"" + path + "\"");
+         }
          #else
          hFileRead = hFileWrite = fopen(path.c_str(), "rb");
-         if (!hFile) throw RIFF::Exception("Can't open \"" + path + "\"");
+         if (!hFileRead) throw RIFF::Exception("Can't open \"" + path + "\"");
          #endif // POSIX
+         Mode = stream_mode_read;
          ulStartPos = RIFF_HEADER_SIZE;
          ReadHeader(0);
          if (ChunkID != CHUNK_ID_RIFF) {
-Line 1308 
 namespace RIFF {
+Line 1466 
 namespace RIFF {
                          hFileRead = hFileWrite = 0;
                          throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");
                      }
+                     #elif defined(WIN32)
+                     if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
+                     hFileRead = hFileWrite = CreateFile(
+                                                  Filename.c_str(), GENERIC_READ,
+                                                  FILE_SHARE_READ | FILE_SHARE_WRITE,
+                                                  NULL, OPEN_EXISTING,
+                                                  FILE_ATTRIBUTE_NORMAL |
+                                                  FILE_FLAG_RANDOM_ACCESS,
+                                                  NULL
+                                              );
+                     if (hFileRead == INVALID_HANDLE_VALUE) {
+                         hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
+                         throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");
+                     }
                      #else
                      if (hFileRead) fclose(hFileRead);
-                     hFileRead = hFileWrite = fopen(path.c_str(), "rb");
+                     hFileRead = hFileWrite = fopen(Filename.c_str(), "rb");
                      if (!hFileRead) throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");
                      #endif
                      __resetPos(); // reset read/write position of ALL 'Chunk' objects
-                     return true;
+                     break;
                  case stream_mode_read_write:
                      #if POSIX
                      if (hFileRead) close(hFileRead);
-Line 1323 
 namespace RIFF {
+Line 1495 
 namespace RIFF {
                          hFileRead = hFileWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);
                          throw Exception("Could not open file \"" + Filename + "\" in read+write mode");
                      }
+                     #elif defined(WIN32)
+                     if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
+                     hFileRead = hFileWrite = CreateFile(
+                                                  Filename.c_str(),
+                                                  GENERIC_READ | GENERIC_WRITE,
+                                                  FILE_SHARE_READ,
+                                                  NULL, OPEN_ALWAYS,
+                                                  FILE_ATTRIBUTE_NORMAL |
+                                                  FILE_FLAG_RANDOM_ACCESS,
+                                                  NULL
+                                              );
+                     if (hFileRead == INVALID_HANDLE_VALUE) {
+                         hFileRead = hFileWrite = CreateFile(
+                                                      Filename.c_str(), GENERIC_READ,
+                                                      FILE_SHARE_READ | FILE_SHARE_WRITE,
+                                                      NULL, OPEN_EXISTING,
+                                                      FILE_ATTRIBUTE_NORMAL |
+                                                      FILE_FLAG_RANDOM_ACCESS,
+                                                      NULL
+                                                  );
+                         throw Exception("Could not (re)open file \"" + Filename + "\" in read+write mode");
+                     }
                      #else
                      if (hFileRead) fclose(hFileRead);
-                     hFileRead = hFileWrite = fopen(path.c_str(), "r+b");
+                     hFileRead = hFileWrite = fopen(Filename.c_str(), "r+b");
                      if (!hFileRead) {
-                         hFileRead = hFileWrite = fopen(path.c_str(), "rb");
+                         hFileRead = hFileWrite = fopen(Filename.c_str(), "rb");
                          throw Exception("Could not open file \"" + Filename + "\" in read+write mode");
                      }
                      #endif
                      __resetPos(); // reset read/write position of ALL 'Chunk' objects
-                     return true;
+                     break;
+                 case stream_mode_closed:
+                     #if POSIX
+                     if (hFileRead)  close(hFileRead);
+                     if (hFileWrite) close(hFileWrite);
+                     #elif defined(WIN32)
+                     if (hFileRead  != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
+                     if (hFileWrite != INVALID_HANDLE_VALUE) CloseHandle(hFileWrite);
+                     #else
+                     if (hFileRead)  fclose(hFileRead);
+                     if (hFileWrite) fclose(hFileWrite);
+                     #endif
+                     hFileRead = hFileWrite = 0;
+                     break;
                  default:
                      throw Exception("Unknown file access mode");
              }
+             Mode = NewMode;
+             return true;
          }
          return false;
      }
+     /** @brief Set the byte order to be used when saving.
+      *
+      * Set the byte order to be used in the file. A value of
+      * endian_little will create a RIFF file, endian_big a RIFX file
+      * and endian_native will create a RIFF file on little-endian
+      * machines and RIFX on big-endian machines.
+      *
+      * @param Endian - endianess to use when file is saved.
+      */
+     void File::SetByteOrder(endian_t Endian) {
+         #if WORDS_BIGENDIAN
+         bEndianNative = Endian != endian_little;
+         #else
+         bEndianNative = Endian != endian_big;
+         #endif
+     }
      /** @brief Save changes to same file.
       *
       * Make all changes of all chunks persistent by writing them to the
-Line 1351 
 namespace RIFF {
+Line 1577 
 namespace RIFF {
       *                         chunk or any kind of IO error occured
       */
      void File::Save() {
+         // make sure the RIFF tree is built (from the original file)
+         LoadSubChunksRecursively();
          // reopen file in write mode
-         bool bModeWasChanged = SetMode(stream_mode_read_write);
+         SetMode(stream_mode_read_write);
          // to be able to save the whole file without loading everything into
          // RAM and without having to store the data in a temporary file, we
-Line 1363 
 namespace RIFF {
+Line 1592 
 namespace RIFF {
          // first we sum up all positive chunk size changes (and skip all negative ones)
          unsigned long ulPositiveSizeDiff = 0;
-         for (ChunkList::iterator iter = ResizedChunks.begin(), end = ResizedChunks.end(); iter != end; ++iter) {
+         for (std::set<Chunk*>::const_iterator iter = ResizedChunks.begin(), end = ResizedChunks.end(); iter != end; ++iter) {
-             if ((*iter)->GetNewSize() == 0) throw Exception("There is at least one empty chunk (zero size)");
+             if ((*iter)->GetNewSize() == 0) {
-             unsigned long ulDiff = (*iter)->GetNewSize() - (*iter)->GetSize() + 1L; // +1 in case we have to add a pad byte
+                 throw Exception("There is at least one empty chunk (zero size): " + __resolveChunkPath(*iter));
-             if (ulDiff > 0) ulPositiveSizeDiff += ulDiff;
+             }
+             unsigned long newSizePadded = (*iter)->GetNewSize() + (*iter)->GetNewSize() % 2;
+             unsigned long oldSizePadded = (*iter)->GetSize() + (*iter)->GetSize() % 2;
+             if (newSizePadded > oldSizePadded) ulPositiveSizeDiff += newSizePadded - oldSizePadded;
          }
          unsigned long ulWorkingFileSize = GetFileSize();
-Line 1379 
 namespace RIFF {
+Line 1611 
 namespace RIFF {
              // ... and move current data by the same amount towards end of file.
              int8_t* pCopyBuffer = new int8_t[4096];
              const unsigned long ulFileSize = GetSize() + RIFF_HEADER_SIZE;
+             #if defined(WIN32)
+             DWORD iBytesMoved = 1; // we have to pass it via pointer to the Windows API, thus the correct size must be ensured
+             #else
              int iBytesMoved = 1;
-             for (unsigned long ulPos = 0; iBytesMoved > 0; ulPos += iBytesMoved) {
+             #endif
-                 const unsigned long ulToMove = ulFileSize - ulPos;
+             for (unsigned long ulPos = ulFileSize; iBytesMoved > 0; ) {
-                 iBytesMoved = (ulToMove < 4096) ? ulToMove : 4096;
+                 iBytesMoved = (ulPos < 4096) ? ulPos : 4096;
+                 ulPos -= iBytesMoved;
                  #if POSIX
                  lseek(hFileRead, ulPos, SEEK_SET);
                  iBytesMoved = read(hFileRead, pCopyBuffer, iBytesMoved);
                  lseek(hFileWrite, ulPos + ulPositiveSizeDiff, SEEK_SET);
                  iBytesMoved = write(hFileWrite, pCopyBuffer, iBytesMoved);
+                 #elif defined(WIN32)
+                 SetFilePointer(hFileRead, ulPos, NULL/*32 bit*/, FILE_BEGIN);
+                 ReadFile(hFileRead, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
+                 SetFilePointer(hFileWrite, ulPos + ulPositiveSizeDiff, NULL/*32 bit*/, FILE_BEGIN);
+                 WriteFile(hFileWrite, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
                  #else
                  fseek(hFileRead, ulPos, SEEK_SET);
                  iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, hFileRead);
-Line 1400 
 namespace RIFF {
+Line 1641 
 namespace RIFF {
          }
          // rebuild / rewrite complete RIFF tree
-         unsigned long ulTotalSize = WriteChunk(0, ulPositiveSizeDiff);
+         unsigned long ulTotalSize  = WriteChunk(0, ulPositiveSizeDiff);
+         unsigned long ulActualSize = __GetFileSize(hFileWrite);
          // resize file to the final size
-         if (ulTotalSize < ulWorkingFileSize) ResizeFile(ulTotalSize);
+         if (ulTotalSize < ulActualSize) ResizeFile(ulTotalSize);
          // forget all resized chunks
          ResizedChunks.clear();
-         // reopen file in read mode
-         if (bModeWasChanged) SetMode(stream_mode_read);
      }
      /** @brief Save changes to another file.
-Line 1417 
 namespace RIFF {
+Line 1656 
 namespace RIFF {
       * Make all changes of all chunks persistent by writing them to another
       * file. <b>Caution:</b> this method is optimized for writing to
       * <b>another</b> file, do not use it to save the changes to the same
-      * file! Use File::Save() in that case instead!
+      * file! Use File::Save() in that case instead! Ignoring this might
+      * result in a corrupted file, especially in case chunks were resized!
       *
       * After calling this method, this File object will be associated with
       * the new file (given by \a path) afterwards.
-Line 1425 
 namespace RIFF {
+Line 1665 
 namespace RIFF {
       * @param path - path and file name where everything should be written to
       */
      void File::Save(const String& path) {
+         //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
+         // make sure the RIFF tree is built (from the original file)
+         LoadSubChunksRecursively();
+         if (Filename.length() > 0) SetMode(stream_mode_read);
          // open the other (new) file for writing and truncate it to zero size
          #if POSIX
-         hFileWrite = open(path.c_str(), O_RDWR | O_CREAT | O_TRUNC);
+         hFileWrite = open(path.c_str(), O_RDWR | O_CREAT, S_IRUSR | S_IWUSR | S_IRGRP);
          if (hFileWrite < 0) {
              hFileWrite = hFileRead;
              throw Exception("Could not open file \"" + path + "\" for writing");
          }
+         #elif defined(WIN32)
+         hFileWrite = CreateFile(
+                          path.c_str(), GENERIC_WRITE, FILE_SHARE_READ,
+                          NULL, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL |
+                          FILE_FLAG_RANDOM_ACCESS, NULL
+                      );
+         if (hFileWrite == INVALID_HANDLE_VALUE) {
+             hFileWrite = hFileRead;
+             throw Exception("Could not open file \"" + path + "\" for writing");
+         }
          #else
          hFileWrite = fopen(path.c_str(), "w+b");
          if (!hFileWrite) {
-Line 1439 
 namespace RIFF {
+Line 1695 
 namespace RIFF {
              throw Exception("Could not open file \"" + path + "\" for writing");
          }
          #endif // POSIX
+         Mode = stream_mode_read_write;
          // write complete RIFF tree to the other (new) file
-         WriteChunk(0, 0);
+         unsigned long ulTotalSize  = WriteChunk(0, 0);
+         unsigned long ulActualSize = __GetFileSize(hFileWrite);
+         // resize file to the final size (if the file was originally larger)
+         if (ulTotalSize < ulActualSize) ResizeFile(ulTotalSize);
          // forget all resized chunks
          ResizedChunks.clear();
+         #if POSIX
+         if (hFileWrite) close(hFileWrite);
+         #elif defined(WIN32)
+         if (hFileWrite != INVALID_HANDLE_VALUE) CloseHandle(hFileWrite);
+         #else
+         if (hFileWrite) fclose(hFileWrite);
+         #endif
+         hFileWrite = hFileRead;
          // associate new file with this File object from now on
          Filename = path;
-         stream_mode_t oldMode = Mode;
+         Mode = (stream_mode_t) -1;       // Just set it to an undefined mode ...
-         Mode = (stream_mode_t) -1; // Just set it to an undefined mode ...
+         SetMode(stream_mode_read_write); // ... so SetMode() has to reopen the file handles.
-         SetMode(oldMode);          // ... so SetMode() has to reopen the file handles.
      }
      void File::ResizeFile(unsigned long ulNewSize) {
          #if POSIX
          if (ftruncate(hFileWrite, ulNewSize) < 0)
              throw Exception("Could not resize file \"" + Filename + "\"");
+         #elif defined(WIN32)
+         if (
+             SetFilePointer(hFileWrite, ulNewSize, NULL/*32 bit*/, FILE_BEGIN) == INVALID_SET_FILE_POINTER ||
+             !SetEndOfFile(hFileWrite)
+         ) throw Exception("Could not resize file \"" + Filename + "\"");
          #else
-         # error Sorry, this version of libgig only supports POSIX systems yet.
+         # error Sorry, this version of libgig only supports POSIX and Windows systems yet.
-         # error Reason: portable implementation of RIFF::File::ResizeFile() is missing!
+         # error Reason: portable implementation of RIFF::File::ResizeFile() is missing (yet)!
          #endif
      }
-Line 1469 
 namespace RIFF {
+Line 1743 
 namespace RIFF {
         #endif // DEBUG
          #if POSIX
          if (hFileRead) close(hFileRead);
+         #elif defined(WIN32)
+         if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
          #else
          if (hFileRead) fclose(hFileRead);
          #endif // POSIX
      }
      void File::LogAsResized(Chunk* pResizedChunk) {
-         ResizedChunks.push_back(pResizedChunk);
+         ResizedChunks.insert(pResizedChunk);
+     }
+     void File::UnlogResized(Chunk* pResizedChunk) {
+         ResizedChunks.erase(pResizedChunk);
      }
      unsigned long File::GetFileSize() {
-         #if POSIX
+         return __GetFileSize(hFileRead);
+     }
+     #if POSIX
+     unsigned long File::__GetFileSize(int hFile) {
          struct stat filestat;
-         fstat(hFileRead, &filestat);
+         fstat(hFile, &filestat);
          long size = filestat.st_size;
-         #else // standard C functions
-         long curpos = ftell(hFileRead);
-         fseek(hFileRead, 0, SEEK_END);
-         long size = ftell(hFileRead);
-         fseek(hFileRead, curpos, SEEK_SET);
-         #endif // POSIX
          return size;
      }
+     #elif defined(WIN32)
+     unsigned long File::__GetFileSize(HANDLE hFile) {
+         DWORD dwSize = ::GetFileSize(hFile, NULL /*32bit*/);
+         if (dwSize == INVALID_FILE_SIZE)
+             throw Exception("Windows FS error: could not determine file size");
+         return dwSize;
+     }
+     #else // standard C functions
+     unsigned long File::__GetFileSize(FILE* hFile) {
+         long curpos = ftell(hFile);
+         fseek(hFile, 0, SEEK_END);
+         long size = ftell(hFile);
+         fseek(hFile, curpos, SEEK_SET);
+         return size;
+     }
+     #endif
  // *************** Exception ***************

 Legend:



Removed from v.780
 


changed lines


 
Added in v.1859
 Legend:



Removed from v.780
 


changed lines


 
Added in v.1859
-Removed from v.780
+Added in v.1859

	ViewVC Help
Powered by ViewVC