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

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

Parent Directory | Revision Log | View Patch Patch

-revision 933 by schoenebeck,
Fri Nov 24 12:50:05 2006 UTC
+revision 2675 by schoenebeck,
Sun Sep 14 16:07:34 2014 UTC
 Line 2
   *                                                                         *
   *   libgig - C++ cross-platform Gigasampler format file access library    *
   *                                                                         *
-  *   Copyright (C) 2003-2006 by Christian Schoenebeck                      *
+  *   Copyright (C) 2003-2014 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 <set>
  #include <string.h>
  #include "RIFF.h"
  #include "helper.h"
+ #if POSIX
+ # include <errno.h>
+ #endif
  namespace RIFF {
+ // *************** Internal functions **************
+ // *
+     /// Returns a human readable path of the given chunk.
+     static String __resolveChunkPath(Chunk* pCk) {
+         String sPath;
+         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;
+     }
  // *************** Chunk **************
  // *
-Line 39 
 namespace RIFF {
+Line 64 
 namespace RIFF {
          ulPos      = 0;
          pParent    = NULL;
          pChunkData = NULL;
+         CurrentChunkSize = 0;
+         NewChunkSize = 0;
          ulChunkDataSize = 0;
          ChunkID    = CHUNK_ID_RIFF;
          this->pFile = pFile;
-Line 53 
 namespace RIFF {
+Line 80 
 namespace RIFF {
          pParent       = Parent;
          ulPos         = 0;
          pChunkData    = NULL;
+         CurrentChunkSize = 0;
+         NewChunkSize = 0;
          ulChunkDataSize = 0;
          ReadHeader(StartPos);
      }
-Line 63 
 namespace RIFF {
+Line 92 
 namespace RIFF {
          this->pParent    = pParent;
          ulPos            = 0;
          pChunkData       = NULL;
-         ulChunkDataSize  = 0;
          ChunkID          = uiChunkID;
+         ulChunkDataSize  = 0;
          CurrentChunkSize = 0;
          NewChunkSize     = uiBodySize;
      }
      Chunk::~Chunk() {
+         if (pFile) pFile->UnlogResized(this);
          if (pChunkData) delete[] pChunkData;
      }
-Line 77 
 namespace RIFF {
+Line 107 
 namespace RIFF {
          #if DEBUG
          std::cout << "Chunk::Readheader(" << fPos << ") ";
          #endif // DEBUG
+         ChunkID = 0;
+         NewChunkSize = CurrentChunkSize = 0;
          #if POSIX
          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 102 
 namespace RIFF {
+Line 139 
 namespace RIFF {
              }
              #if DEBUG
              std::cout << "ckID=" << convertToString(ChunkID) << " ";
-             std::cout << "ckSize=" << ChunkSize << " ";
+             std::cout << "ckSize=" << CurrentChunkSize << " ";
-             std::cout << "bEndianNative=" << bEndianNative << std::endl;
+             std::cout << "bEndianNative=" << pFile->bEndianNative << std::endl;
              #endif // DEBUG
              NewChunkSize = CurrentChunkSize;
          }
-Line 129 
 namespace RIFF {
+Line 166 
 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 193 
 namespace RIFF {
+Line 236 
 namespace RIFF {
         #if DEBUG
         std::cout << "Chunk::Remainingbytes()=" << CurrentChunkSize - ulPos << std::endl;
         #endif // DEBUG
-         return CurrentChunkSize - ulPos;
+         return (CurrentChunkSize > ulPos) ? CurrentChunkSize - ulPos : 0;
      }
      /**
-Line 204 
 namespace RIFF {
+Line 247 
 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 212 
 namespace RIFF {
+Line 255 
 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 239 
 namespace RIFF {
+Line 285 
 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 246 
 namespace RIFF {
+Line 293 
 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 315 
 namespace RIFF {
+Line 368 
 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 537 
 namespace RIFF {
+Line 599 
 namespace RIFF {
      }
      /**
+      * Reads a null-padded string of size characters and copies it
+      * into the string \a s. The position within the chunk will
+      * automatically be incremented.
+      *
+      * @param s                 destination string
+      * @param size              number of characters to read
+      * @throws RIFF::Exception  if an error occured or less than
+      *                          \a size characters could be read!
+      */
+     void Chunk::ReadString(String& s, int size) {
+         char* buf = new char[size];
+         ReadSceptical(buf, 1, size);
+         s.assign(buf, std::find(buf, buf + size, '\0'));
+         delete[] buf;
+     }
+     /**
       * Writes \a WordCount number of 32 Bit unsigned integer words from the
       * buffer pointed by \a pData to the chunk's body, directly to the
       * actual "physical" file. The position within the chunk will
-Line 676 
 namespace RIFF {
+Line 755 
 namespace RIFF {
       * @see ReleaseChunkData()
       */
      void* Chunk::LoadChunkData() {
-         if (!pChunkData && pFile->Filename != "") {
+         if (!pChunkData && pFile->Filename != "" /*&& ulStartPos != 0*/) {
              #if POSIX
              if (lseek(pFile->hFileRead, ulStartPos, SEEK_SET) == -1) return NULL;
+             #elif defined(WIN32)
+             if (SetFilePointer(pFile->hFileRead, ulStartPos, NULL/*32 bit*/, FILE_BEGIN) == INVALID_SET_FILE_POINTER) return NULL;
              #else
              if (fseek(pFile->hFileRead, ulStartPos, SEEK_SET)) return NULL;
              #endif // POSIX
-Line 688 
 namespace RIFF {
+Line 769 
 namespace RIFF {
              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
-Line 740 
 namespace RIFF {
+Line 824 
 namespace RIFF {
       * @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 775 
 namespace RIFF {
+Line 860 
 namespace RIFF {
              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 785 
 namespace RIFF {
+Line 877 
 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;
-             for (unsigned long ulOffset = 0; iBytesMoved > 0; ulOffset += iBytesMoved, ulToMove -= iBytesMoved) {
+             #endif
+             for (unsigned long ulOffset = 0; ulToMove > 0 && iBytesMoved > 0; ulOffset += iBytesMoved, ulToMove -= iBytesMoved) {
                  iBytesMoved = (ulToMove < 4096) ? ulToMove : 4096;
                  #if POSIX
                  lseek(pFile->hFileRead, ulStartPos + ulCurrentDataOffset + ulOffset, SEEK_SET);
                  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 818 
 namespace RIFF {
+Line 919 
 namespace RIFF {
              #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);
-Line 867 
 namespace RIFF {
+Line 972 
 namespace RIFF {
        #if DEBUG
        std::cout << "List::~List()" << std::endl;
        #endif // DEBUG
+         DeleteChunkList();
+     }
+     void List::DeleteChunkList() {
          if (pSubChunks) {
              ChunkList::iterator iter = pSubChunks->begin();
              ChunkList::iterator end  = pSubChunks->end();
-Line 875 
 namespace RIFF {
+Line 984 
 namespace RIFF {
                  iter++;
              }
              delete pSubChunks;
+             pSubChunks = NULL;
+         }
+         if (pSubChunksMap) {
+             delete pSubChunksMap;
+             pSubChunksMap = NULL;
          }
-         if (pSubChunksMap) delete pSubChunksMap;
      }
      /**
-Line 1077 
 namespace RIFF {
+Line 1190 
 namespace RIFF {
          pSubChunks->push_back(pNewChunk);
          (*pSubChunksMap)[uiChunkID] = pNewChunk;
          pNewChunk->Resize(uiBodySize);
+         NewChunkSize += CHUNK_HEADER_SIZE;
+         pFile->LogAsResized(this);
          return pNewChunk;
      }
+     /** @brief Moves a sub chunk witin this list.
+      *
+      * Moves a sub chunk from one position in this 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 Moves a sub chunk from this list to another list.
+      *
+      * Moves a sub chunk from this list list to the end of another
+      * list.
+      *
+      * @param pSrc - sub chunk to be moved
+      * @param pDst - destination list where the chunk shall be moved to
+      */
+     void List::MoveSubChunk(Chunk* pSrc, List* pNewParent) {
+         if (pNewParent == this || !pNewParent) return;
+         if (!pSubChunks) LoadSubChunks();
+         if (!pNewParent->pSubChunks) pNewParent->LoadSubChunks();
+         pSubChunks->remove(pSrc);
+         pNewParent->pSubChunks->push_back(pSrc);
+         // update chunk id map of this List
+         if ((*pSubChunksMap)[pSrc->GetChunkID()] == pSrc) {
+             pSubChunksMap->erase(pSrc->GetChunkID());
+             // try to find another chunk of the same chunk ID
+             ChunkList::iterator iter = pSubChunks->begin();
+             ChunkList::iterator end  = pSubChunks->end();
+             for (; iter != end; ++iter) {
+                 if ((*iter)->GetChunkID() == pSrc->GetChunkID()) {
+                     (*pSubChunksMap)[pSrc->GetChunkID()] = *iter;
+                     break; // we're done, stop search
+                 }
+             }
+         }
+         // update chunk id map of other list
+         if (!(*pNewParent->pSubChunksMap)[pSrc->GetChunkID()])
+             (*pNewParent->pSubChunksMap)[pSrc->GetChunkID()] = pSrc;
+     }
      /** @brief Creates a new list sub chunk.
       *
       * Creates and adds a new list sub chunk to this list chunk. Note that
-Line 1094 
 namespace RIFF {
+Line 1259 
 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 1101 
 namespace RIFF {
+Line 1268 
 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 1129 
 namespace RIFF {
+Line 1297 
 namespace RIFF {
        std::cout << "List::Readheader(ulong) ";
        #endif // DEBUG
          Chunk::ReadHeader(fPos);
+         if (CurrentChunkSize < 4) return;
          NewChunkSize = CurrentChunkSize -= 4;
          #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 1153 
 namespace RIFF {
+Line 1326 
 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 1166 
 namespace RIFF {
+Line 1343 
 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 1256 
 namespace RIFF {
+Line 1437 
 namespace RIFF {
  // *************** File ***************
  // *
+ //HACK: to avoid breaking DLL compatibility to older versions of libgig we roll the new std::set<Chunk*> into the old std::list<Chunk*> container, should be replaced on member variable level soon though
+ #define _GET_RESIZED_CHUNKS() \
+         (reinterpret_cast<std::set<Chunk*>*>(ResizedChunks.front()))
      /** @brief Create new RIFF file.
       *
       * Use this constructor if you want to create a new RIFF file completely
       * "from scratch". Note: there must be no empty chunks or empty list
       * chunks when trying to make the new RIFF file persistent with Save()!
       *
+      * Note: by default, the RIFF file will be saved in native endian
+      * format; that is, as a RIFF file on little-endian machines and
+      * 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()
+      * @see AddSubChunk(), AddSubList(), SetByteOrder()
       */
-     File::File(uint32_t FileType) : List(this) {
+     File::File(uint32_t FileType)
+         : List(this), bIsNewFile(true), Layout(layout_standard)
+     {
+         //HACK: see _GET_RESIZED_CHUNKS() comment
+         ResizedChunks.push_back(reinterpret_cast<Chunk*>(new std::set<Chunk*>));
+         #if defined(WIN32)
+         hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
+         #else
          hFileRead = hFileWrite = 0;
+         #endif
          Mode = stream_mode_closed;
          bEndianNative = true;
          ulStartPos = RIFF_HEADER_SIZE;
-Line 1281 
 namespace RIFF {
+Line 1479 
 namespace RIFF {
       * @throws RIFF::Exception if error occured while trying to load the
       *                         given RIFF file
       */
-     File::File(const String& path) : List(this), Filename(path) {
+     File::File(const String& path)
-       #if DEBUG
+         : List(this), Filename(path), bIsNewFile(false), Layout(layout_standard)
-       std::cout << "File::File("<<path<<")" << std::endl;
+     {
-       #endif // DEBUG
+        #if DEBUG
+        std::cout << "File::File("<<path<<")" << std::endl;
+        #endif // DEBUG
          bEndianNative = true;
+         try {
+             __openExistingFile(path);
+             if (ChunkID != CHUNK_ID_RIFF && ChunkID != CHUNK_ID_RIFX) {
+                 throw RIFF::Exception("Not a RIFF file");
+             }
+         }
+         catch (...) {
+             Cleanup();
+             throw;
+         }
+     }
+     /** @brief Load existing RIFF-like file.
+      *
+      * Loads an existing file, which is not a "real" RIFF file, but similar to
+      * an ordinary RIFF file.
+      *
+      * A "real" RIFF file contains at top level a List chunk either with chunk
+      * ID "RIFF" or "RIFX". The simple constructor above expects this to be
+      * case, and if it finds the toplevel List chunk to have another chunk ID
+      * than one of those two expected ones, it would throw an Exception and
+      * would refuse to load the file accordingly.
+      *
+      * Since there are however a lot of file formats which use the same simple
+      * principles of the RIFF format, with another toplevel List chunk ID
+      * though, you can use this alternative constructor here to be able to load
+      * and handle those files in the same way as you would do with "real" RIFF
+      * files.
+      *
+      * @param path - path and file name of the RIFF-alike file to be opened
+      * @param FileType - expected toplevel List chunk ID (this is the very
+      *                   first chunk found in the file)
+      * @param Endian - whether the file uses little endian or big endian layout
+      * @param layout - general file structure type
+      * @throws RIFF::Exception if error occured while trying to load the
+      *                         given RIFF-alike file
+      */
+     File::File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout)
+         : List(this), Filename(path), bIsNewFile(false), Layout(layout)
+     {
+         SetByteOrder(Endian);
+         try {
+             __openExistingFile(path, &FileType);
+         }
+         catch (...) {
+             Cleanup();
+             throw;
+         }
+     }
+     /**
+      * Opens an already existing RIFF file or RIFF-alike file. This method
+      * shall only be called once (in a File class constructor).
+      *
+      * @param path - path and file name of the RIFF file or RIFF-alike file to
+      *               be opened
+      * @param FileType - (optional) expected chunk ID of first chunk in file
+      * @throws RIFF::Exception if error occured while trying to load the
+      *                         given RIFF file or RIFF-alike file
+      */
+     void File::__openExistingFile(const String& path, uint32_t* FileType) {
+         //HACK: see _GET_RESIZED_CHUNKS() comment
+         ResizedChunks.push_back(reinterpret_cast<Chunk*>(new std::set<Chunk*>));
          #if POSIX
          hFileRead = hFileWrite = open(path.c_str(), O_RDONLY | O_NONBLOCK);
-         if (hFileRead <= 0) {
+         if (hFileRead == -1) {
              hFileRead = hFileWrite = 0;
+             String sError = strerror(errno);
+             throw RIFF::Exception("Can't open \"" + path + "\": " + sError);
+         }
+         #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;
+         switch (Layout) {
-         ReadHeader(0);
+             case layout_standard: // this is a normal RIFF file
-         if (ChunkID != CHUNK_ID_RIFF) {
+                 ulStartPos = RIFF_HEADER_SIZE;
-             throw RIFF::Exception("Not a RIFF file");
+                 ReadHeader(0);
+                 if (FileType && ChunkID != *FileType)
+                     throw RIFF::Exception("Invalid file container ID");
+                 break;
+             case layout_flat: // non-standard RIFF-alike file
+                 ulStartPos = 0;
+                 NewChunkSize = CurrentChunkSize = GetFileSize();
+                 if (FileType) {
+                     uint32_t ckid;
+                     if (Read(&ckid, 4, 1) != 4) {
+                         throw RIFF::Exception("Invalid file header ID (premature end of header)");
+                     } else if (ckid != *FileType) {
+                         String s = " (expected '" + convertToString(*FileType) + "' but got '" + convertToString(ckid) + "')";
+                         throw RIFF::Exception("Invalid file header ID" + s);
+                     }
+                     SetPos(0); // reset to first byte of file
+                 }
+                 LoadSubChunks();
+                 break;
          }
      }
      String File::GetFileName() {
          return Filename;
      }
+     void File::SetFileName(const String& path) {
+         Filename = path;
+     }
      stream_mode_t File::GetMode() {
          return Mode;
      }
+     layout_t File::GetLayout() const {
+         return Layout;
+     }
      /** @brief Change file access mode.
       *
       * Changes files access mode either to read-only mode or to read/write
-Line 1329 
 namespace RIFF {
+Line 1631 
 namespace RIFF {
                      #if POSIX
                      if (hFileRead) close(hFileRead);
                      hFileRead = hFileWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);
-                     if (hFileRead < 0) {
+                     if (hFileRead == -1) {
                          hFileRead = hFileWrite = 0;
+                         String sError = strerror(errno);
+                         throw Exception("Could not (re)open file \"" + Filename + "\" in read mode: " + sError);
+                     }
+                     #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
-Line 1344 
 namespace RIFF {
+Line 1661 
 namespace RIFF {
                      #if POSIX
                      if (hFileRead) close(hFileRead);
                      hFileRead = hFileWrite = open(Filename.c_str(), O_RDWR | O_NONBLOCK);
-                     if (hFileRead < 0) {
+                     if (hFileRead == -1) {
                          hFileRead = hFileWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);
-                         throw Exception("Could not open file \"" + Filename + "\" in read+write mode");
+                         String sError = strerror(errno);
+                         throw Exception("Could not open file \"" + Filename + "\" in read+write mode: " + sError);
+                     }
+                     #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
-Line 1362 
 namespace RIFF {
+Line 1702 
 namespace RIFF {
                      #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);
-Line 1377 
 namespace RIFF {
+Line 1720 
 namespace RIFF {
          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 1388 
 namespace RIFF {
+Line 1748 
 namespace RIFF {
       *                         chunk or any kind of IO error occured
       */
      void File::Save() {
+         //TODO: implementation for the case where first chunk is not a global container (List chunk) is not implemented yet (i.e. Korg files)
+         if (Layout == layout_flat)
+             throw Exception("Saving a RIFF file with layout_flat is not implemented yet");
          // make sure the RIFF tree is built (from the original file)
          LoadSubChunksRecursively();
-Line 1403 
 namespace RIFF {
+Line 1767 
 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) {
+         std::set<Chunk*>* resizedChunks = _GET_RESIZED_CHUNKS();
-             if ((*iter)->GetNewSize() == 0) throw Exception("There is at least one empty chunk (zero size)");
+         for (std::set<Chunk*>::const_iterator iter = resizedChunks->begin(), end = resizedChunks->end(); iter != end; ++iter) {
-             if ((*iter)->GetNewSize() + 1L > (*iter)->GetSize()) {
+             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));
-                 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 1421 
 namespace RIFF {
+Line 1787 
 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 1449 
 namespace RIFF {
+Line 1824 
 namespace RIFF {
          if (ulTotalSize < ulActualSize) ResizeFile(ulTotalSize);
          // forget all resized chunks
-         ResizedChunks.clear();
+         resizedChunks->clear();
      }
      /** @brief Save changes to another file.
-Line 1468 
 namespace RIFF {
+Line 1843 
 namespace RIFF {
      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
+         //TODO: implementation for the case where first chunk is not a global container (List chunk) is not implemented yet (i.e. Korg files)
+         if (Layout == layout_flat)
+             throw Exception("Saving a RIFF file with layout_flat is not implemented yet");
          // make sure the RIFF tree is built (from the original file)
          LoadSubChunksRecursively();
-         if (Filename.length() > 0) SetMode(stream_mode_read);
+         if (!bIsNewFile) 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, S_IRUSR | S_IWUSR | S_IRGRP);
-         if (hFileWrite < 0) {
+         if (hFileWrite == -1) {
+             hFileWrite = hFileRead;
+             String sError = strerror(errno);
+             throw Exception("Could not open file \"" + path + "\" for writing: " + sError);
+         }
+         #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");
          }
-Line 1496 
 namespace RIFF {
+Line 1886 
 namespace RIFF {
          if (ulTotalSize < ulActualSize) ResizeFile(ulTotalSize);
          // forget all resized chunks
-         ResizedChunks.clear();
+         _GET_RESIZED_CHUNKS()->clear();
-         if (Filename.length() > 0) {
+         #if POSIX
-             #if POSIX
+         if (hFileWrite) close(hFileWrite);
-             close(hFileWrite);
+         #elif defined(WIN32)
-             #else
+         if (hFileWrite != INVALID_HANDLE_VALUE) CloseHandle(hFileWrite);
-             fclose(hFileWrite);
+         #else
-             #endif
+         if (hFileWrite) fclose(hFileWrite);
-             hFileWrite = hFileRead;
+         #endif
-         }
+         hFileWrite = hFileRead;
          // associate new file with this File object from now on
          Filename = path;
+         bIsNewFile = false;
          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.
      }
-Line 1517 
 namespace RIFF {
+Line 1908 
 namespace RIFF {
          #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 (yet)!
          #endif
      }
-Line 1527 
 namespace RIFF {
+Line 1923 
 namespace RIFF {
         #if DEBUG
         std::cout << "File::~File()" << std::endl;
         #endif // DEBUG
+         Cleanup();
+     }
+     /**
+      * Returns @c true if this file has been created new from scratch and
+      * has not been stored to disk yet.
+      */
+     bool File::IsNew() const {
+         return bIsNewFile;
+     }
+     void File::Cleanup() {
          #if POSIX
          if (hFileRead) close(hFileRead);
+         #elif defined(WIN32)
+         if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
          #else
          if (hFileRead) fclose(hFileRead);
          #endif // POSIX
+         DeleteChunkList();
+         pFile = NULL;
+         //HACK: see _GET_RESIZED_CHUNKS() comment
+         delete _GET_RESIZED_CHUNKS();
      }
      void File::LogAsResized(Chunk* pResizedChunk) {
-         ResizedChunks.push_back(pResizedChunk);
+         _GET_RESIZED_CHUNKS()->insert(pResizedChunk);
+     }
+     void File::UnlogResized(Chunk* pResizedChunk) {
+         _GET_RESIZED_CHUNKS()->erase(pResizedChunk);
      }
      unsigned long File::GetFileSize() {
-Line 1549 
 namespace RIFF {
+Line 1967 
 namespace RIFF {
          long size = filestat.st_size;
          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);

 Legend:



Removed from v.933
 


changed lines


 
Added in v.2675
 Legend:



Removed from v.933
 


changed lines


 
Added in v.2675
-Removed from v.933
+Added in v.2675

	ViewVC Help
Powered by ViewVC