/[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 808 by schoenebeck, Tue Nov 22 09:11:17 2005 UTC revision 2703 by schoenebeck, Tue Jan 13 15:28:37 2015 UTC
# Line 1  Line 1 
1  /***************************************************************************  /***************************************************************************
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file loader library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2005 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2015 by Christian Schoenebeck                      *
6   *                              <cuse@users.sourceforge.net>               *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   This library is free software; you can redistribute it and/or modify  *
# Line 21  Line 21 
21   *   MA  02111-1307  USA                                                   *   *   MA  02111-1307  USA                                                   *
22   ***************************************************************************/   ***************************************************************************/
23    
24    #include <algorithm>
25    #include <set>
26  #include <string.h>  #include <string.h>
27    
28  #include "RIFF.h"  #include "RIFF.h"
29    
30  #include "helper.h"  #include "helper.h"
31    
32    #if POSIX
33    # include <errno.h>
34    #endif
35    
36  namespace RIFF {  namespace RIFF {
37    
38    // *************** Internal functions **************
39    // *
40    
41        /// Returns a human readable path of the given chunk.
42        static String __resolveChunkPath(Chunk* pCk) {
43            String sPath;
44            for (Chunk* pChunk = pCk; pChunk; pChunk = pChunk->GetParent()) {
45                if (pChunk->GetChunkID() == CHUNK_ID_LIST) {
46                    List* pList = (List*) pChunk;
47                    sPath = "->'" + pList->GetListTypeString() + "'" + sPath;
48                } else {
49                    sPath = "->'" + pChunk->GetChunkIDString() + "'" + sPath;
50                }
51            }
52            return sPath;
53        }
54    
55    
56    
57    // *************** progress_t ***************
58    // *
59    
60        progress_t::progress_t() {
61            callback    = NULL;
62            custom      = NULL;
63            __range_min = 0.0f;
64            __range_max = 1.0f;
65        }
66    
67    
68    
69  // *************** Chunk **************  // *************** Chunk **************
70  // *  // *
71    
# Line 39  namespace RIFF { Line 76  namespace RIFF {
76          ulPos      = 0;          ulPos      = 0;
77          pParent    = NULL;          pParent    = NULL;
78          pChunkData = NULL;          pChunkData = NULL;
79            CurrentChunkSize = 0;
80            NewChunkSize = 0;
81          ulChunkDataSize = 0;          ulChunkDataSize = 0;
82          ChunkID    = CHUNK_ID_RIFF;          ChunkID    = CHUNK_ID_RIFF;
83          this->pFile = pFile;          this->pFile = pFile;
# Line 53  namespace RIFF { Line 92  namespace RIFF {
92          pParent       = Parent;          pParent       = Parent;
93          ulPos         = 0;          ulPos         = 0;
94          pChunkData    = NULL;          pChunkData    = NULL;
95            CurrentChunkSize = 0;
96            NewChunkSize = 0;
97          ulChunkDataSize = 0;          ulChunkDataSize = 0;
98          ReadHeader(StartPos);          ReadHeader(StartPos);
99      }      }
# Line 63  namespace RIFF { Line 104  namespace RIFF {
104          this->pParent    = pParent;          this->pParent    = pParent;
105          ulPos            = 0;          ulPos            = 0;
106          pChunkData       = NULL;          pChunkData       = NULL;
         ulChunkDataSize  = 0;  
107          ChunkID          = uiChunkID;          ChunkID          = uiChunkID;
108            ulChunkDataSize  = 0;
109          CurrentChunkSize = 0;          CurrentChunkSize = 0;
110          NewChunkSize     = uiBodySize;          NewChunkSize     = uiBodySize;
111      }      }
112    
113      Chunk::~Chunk() {      Chunk::~Chunk() {
114            if (pFile) pFile->UnlogResized(this);
115          if (pChunkData) delete[] pChunkData;          if (pChunkData) delete[] pChunkData;
116      }      }
117    
# Line 77  namespace RIFF { Line 119  namespace RIFF {
119          #if DEBUG          #if DEBUG
120          std::cout << "Chunk::Readheader(" << fPos << ") ";          std::cout << "Chunk::Readheader(" << fPos << ") ";
121          #endif // DEBUG          #endif // DEBUG
122            ChunkID = 0;
123            NewChunkSize = CurrentChunkSize = 0;
124          #if POSIX          #if POSIX
125          if (lseek(pFile->hFileRead, fPos, SEEK_SET) != -1) {          if (lseek(pFile->hFileRead, fPos, SEEK_SET) != -1) {
126              read(pFile->hFileRead, &ChunkID, 4);              read(pFile->hFileRead, &ChunkID, 4);
127              read(pFile->hFileRead, &CurrentChunkSize, 4);              read(pFile->hFileRead, &CurrentChunkSize, 4);
128            #elif defined(WIN32)
129            if (SetFilePointer(pFile->hFileRead, fPos, NULL/*32 bit*/, FILE_BEGIN) != INVALID_SET_FILE_POINTER) {
130                DWORD dwBytesRead;
131                ReadFile(pFile->hFileRead, &ChunkID, 4, &dwBytesRead, NULL);
132                ReadFile(pFile->hFileRead, &CurrentChunkSize, 4, &dwBytesRead, NULL);
133          #else          #else
134          if (!fseek(pFile->hFileRead, fPos, SEEK_SET)) {          if (!fseek(pFile->hFileRead, fPos, SEEK_SET)) {
135              fread(&ChunkID, 4, 1, pFile->hFileRead);              fread(&ChunkID, 4, 1, pFile->hFileRead);
# Line 102  namespace RIFF { Line 151  namespace RIFF {
151              }              }
152              #if DEBUG              #if DEBUG
153              std::cout << "ckID=" << convertToString(ChunkID) << " ";              std::cout << "ckID=" << convertToString(ChunkID) << " ";
154              std::cout << "ckSize=" << ChunkSize << " ";              std::cout << "ckSize=" << CurrentChunkSize << " ";
155              std::cout << "bEndianNative=" << bEndianNative << std::endl;              std::cout << "bEndianNative=" << pFile->bEndianNative << std::endl;
156              #endif // DEBUG              #endif // DEBUG
157              NewChunkSize = CurrentChunkSize;              NewChunkSize = CurrentChunkSize;
158          }          }
# Line 129  namespace RIFF { Line 178  namespace RIFF {
178              write(pFile->hFileWrite, &uiNewChunkID, 4);              write(pFile->hFileWrite, &uiNewChunkID, 4);
179              write(pFile->hFileWrite, &uiNewChunkSize, 4);              write(pFile->hFileWrite, &uiNewChunkSize, 4);
180          }          }
181            #elif defined(WIN32)
182            if (SetFilePointer(pFile->hFileWrite, fPos, NULL/*32 bit*/, FILE_BEGIN) != INVALID_SET_FILE_POINTER) {
183                DWORD dwBytesWritten;
184                WriteFile(pFile->hFileWrite, &uiNewChunkID, 4, &dwBytesWritten, NULL);
185                WriteFile(pFile->hFileWrite, &uiNewChunkSize, 4, &dwBytesWritten, NULL);
186            }
187          #else          #else
188          if (!fseek(pFile->hFileWrite, fPos, SEEK_SET)) {          if (!fseek(pFile->hFileWrite, fPos, SEEK_SET)) {
189              fwrite(&uiNewChunkID, 4, 1, pFile->hFileWrite);              fwrite(&uiNewChunkID, 4, 1, pFile->hFileWrite);
# Line 193  namespace RIFF { Line 248  namespace RIFF {
248         #if DEBUG         #if DEBUG
249         std::cout << "Chunk::Remainingbytes()=" << CurrentChunkSize - ulPos << std::endl;         std::cout << "Chunk::Remainingbytes()=" << CurrentChunkSize - ulPos << std::endl;
250         #endif // DEBUG         #endif // DEBUG
251          return CurrentChunkSize - ulPos;          return (CurrentChunkSize > ulPos) ? CurrentChunkSize - ulPos : 0;
252      }      }
253    
254      /**      /**
# Line 204  namespace RIFF { Line 259  namespace RIFF {
259       *  - RIFF::stream_closed :       *  - RIFF::stream_closed :
260       *    the data stream was closed somehow, no more reading possible       *    the data stream was closed somehow, no more reading possible
261       *  - RIFF::stream_end_reached :       *  - RIFF::stream_end_reached :
262       *    alreaady reached the end of the chunk data, no more reading       *    already reached the end of the chunk data, no more reading
263       *    possible without SetPos()       *    possible without SetPos()
264       */       */
265      stream_state_t Chunk::GetState() {      stream_state_t Chunk::GetState() {
# Line 212  namespace RIFF { Line 267  namespace RIFF {
267        std::cout << "Chunk::GetState()" << std::endl;        std::cout << "Chunk::GetState()" << std::endl;
268        #endif // DEBUG        #endif // DEBUG
269          #if POSIX          #if POSIX
270          if (pFile->hFileRead == 0)    return stream_closed;          if (pFile->hFileRead == 0) return stream_closed;
271            #elif defined (WIN32)
272            if (pFile->hFileRead == INVALID_HANDLE_VALUE)
273                return stream_closed;
274          #else          #else
275          if (pFile->hFileRead == NULL) return stream_closed;          if (pFile->hFileRead == NULL) return stream_closed;
276          #endif // POSIX          #endif // POSIX
# Line 239  namespace RIFF { Line 297  namespace RIFF {
297         #if DEBUG         #if DEBUG
298         std::cout << "Chunk::Read(void*,ulong,ulong)" << std::endl;         std::cout << "Chunk::Read(void*,ulong,ulong)" << std::endl;
299         #endif // DEBUG         #endif // DEBUG
300            //if (ulStartPos == 0) return 0; // is only 0 if this is a new chunk, so nothing to read (yet)
301          if (ulPos >= CurrentChunkSize) return 0;          if (ulPos >= CurrentChunkSize) return 0;
302          if (ulPos + WordCount * WordSize >= CurrentChunkSize) WordCount = (CurrentChunkSize - ulPos) / WordSize;          if (ulPos + WordCount * WordSize >= CurrentChunkSize) WordCount = (CurrentChunkSize - ulPos) / WordSize;
303          #if POSIX          #if POSIX
304          if (lseek(pFile->hFileRead, ulStartPos + ulPos, SEEK_SET) < 0) return 0;          if (lseek(pFile->hFileRead, ulStartPos + ulPos, SEEK_SET) < 0) return 0;
305          unsigned long readWords = read(pFile->hFileRead, pData, WordCount * WordSize);          ssize_t readWords = read(pFile->hFileRead, pData, WordCount * WordSize);
306            if (readWords < 1) {
307                #if DEBUG
308                std::cerr << "POSIX read() failed: " << strerror(errno) << std::endl << std::flush;
309                #endif // DEBUG
310                return 0;
311            }
312            readWords /= WordSize;
313            #elif defined(WIN32)
314            if (SetFilePointer(pFile->hFileRead, ulStartPos + ulPos, NULL/*32 bit*/, FILE_BEGIN) == INVALID_SET_FILE_POINTER) return 0;
315            DWORD readWords;
316            ReadFile(pFile->hFileRead, pData, WordCount * WordSize, &readWords, NULL);
317          if (readWords < 1) return 0;          if (readWords < 1) return 0;
318          readWords /= WordSize;          readWords /= WordSize;
319          #else // standard C functions          #else // standard C functions
320          if (fseek(pFile->hFileRead, ulStartPos + ulPos, SEEK_SET)) return 0;          if (fseek(pFile->hFileRead, ulStartPos + ulPos, SEEK_SET)) return 0;
321          unsigned long readWords = fread(pData, WordSize, WordCount, pFile->hFileRead);          size_t readWords = fread(pData, WordSize, WordCount, pFile->hFileRead);
322          #endif // POSIX          #endif // POSIX
323          if (!pFile->bEndianNative && WordSize != 1) {          if (!pFile->bEndianNative && WordSize != 1) {
324              switch (WordSize) {              switch (WordSize) {
# Line 315  namespace RIFF { Line 385  namespace RIFF {
385          unsigned long writtenWords = write(pFile->hFileWrite, pData, WordCount * WordSize);          unsigned long writtenWords = write(pFile->hFileWrite, pData, WordCount * WordSize);
386          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");
387          writtenWords /= WordSize;          writtenWords /= WordSize;
388            #elif defined(WIN32)
389            if (SetFilePointer(pFile->hFileWrite, ulStartPos + ulPos, NULL/*32 bit*/, FILE_BEGIN) == INVALID_SET_FILE_POINTER) {
390                throw Exception("Could not seek to position " + ToString(ulPos) +
391                                " in chunk (" + ToString(ulStartPos + ulPos) + " in file)");
392            }
393            DWORD writtenWords;
394            WriteFile(pFile->hFileWrite, pData, WordCount * WordSize, &writtenWords, NULL);
395            if (writtenWords < 1) throw Exception("Windows IO Error while trying to write chunk data");
396            writtenWords /= WordSize;
397          #else // standard C functions          #else // standard C functions
398          if (fseek(pFile->hFileWrite, ulStartPos + ulPos, SEEK_SET)) {          if (fseek(pFile->hFileWrite, ulStartPos + ulPos, SEEK_SET)) {
399              throw Exception("Could not seek to position " + ToString(ulPos) +              throw Exception("Could not seek to position " + ToString(ulPos) +
# Line 537  namespace RIFF { Line 616  namespace RIFF {
616      }      }
617    
618      /**      /**
619         * Reads a null-padded string of size characters and copies it
620         * into the string \a s. The position within the chunk will
621         * automatically be incremented.
622         *
623         * @param s                 destination string
624         * @param size              number of characters to read
625         * @throws RIFF::Exception  if an error occured or less than
626         *                          \a size characters could be read!
627         */
628        void Chunk::ReadString(String& s, int size) {
629            char* buf = new char[size];
630            ReadSceptical(buf, 1, size);
631            s.assign(buf, std::find(buf, buf + size, '\0'));
632            delete[] buf;
633        }
634    
635        /**
636       * Writes \a WordCount number of 32 Bit unsigned integer words from the       * Writes \a WordCount number of 32 Bit unsigned integer words from the
637       * buffer pointed by \a pData to the chunk's body, directly to the       * buffer pointed by \a pData to the chunk's body, directly to the
638       * actual "physical" file. The position within the chunk will       * actual "physical" file. The position within the chunk will
# Line 676  namespace RIFF { Line 772  namespace RIFF {
772       * @see ReleaseChunkData()       * @see ReleaseChunkData()
773       */       */
774      void* Chunk::LoadChunkData() {      void* Chunk::LoadChunkData() {
775          if (!pChunkData && pFile->Filename != "") {          if (!pChunkData && pFile->Filename != "" /*&& ulStartPos != 0*/) {
776              #if POSIX              #if POSIX
777              if (lseek(pFile->hFileRead, ulStartPos, SEEK_SET) == -1) return NULL;              if (lseek(pFile->hFileRead, ulStartPos, SEEK_SET) == -1) return NULL;
778                #elif defined(WIN32)
779                if (SetFilePointer(pFile->hFileRead, ulStartPos, NULL/*32 bit*/, FILE_BEGIN) == INVALID_SET_FILE_POINTER) return NULL;
780              #else              #else
781              if (fseek(pFile->hFileRead, ulStartPos, SEEK_SET)) return NULL;              if (fseek(pFile->hFileRead, ulStartPos, SEEK_SET)) return NULL;
782              #endif // POSIX              #endif // POSIX
# Line 688  namespace RIFF { Line 786  namespace RIFF {
786              memset(pChunkData, 0, ulBufferSize);              memset(pChunkData, 0, ulBufferSize);
787              #if POSIX              #if POSIX
788              unsigned long readWords = read(pFile->hFileRead, pChunkData, GetSize());              unsigned long readWords = read(pFile->hFileRead, pChunkData, GetSize());
789                #elif defined(WIN32)
790                DWORD readWords;
791                ReadFile(pFile->hFileRead, pChunkData, GetSize(), &readWords, NULL);
792              #else              #else
793              unsigned long readWords = fread(pChunkData, 1, GetSize(), pFile->hFileRead);              unsigned long readWords = fread(pChunkData, 1, GetSize(), pFile->hFileRead);
794              #endif // POSIX              #endif // POSIX
# Line 740  namespace RIFF { Line 841  namespace RIFF {
841       * @see File::Save()       * @see File::Save()
842       */       */
843      void Chunk::Resize(int iNewSize) {      void Chunk::Resize(int iNewSize) {
844          if (iNewSize <= 0) throw Exception("Chunk size must be at least one byte");          if (iNewSize <= 0)
845                throw Exception("There is at least one empty chunk (zero size): " + __resolveChunkPath(this));
846          if (NewChunkSize == iNewSize) return;          if (NewChunkSize == iNewSize) return;
847          NewChunkSize = iNewSize;          NewChunkSize = iNewSize;
848          pFile->LogAsResized(this);          pFile->LogAsResized(this);
# Line 754  namespace RIFF { Line 856  namespace RIFF {
856       *                     chunk should be written to       *                     chunk should be written to
857       * @param ulCurrentDataOffset - offset of current (old) data within       * @param ulCurrentDataOffset - offset of current (old) data within
858       *                              the file       *                              the file
859         * @param pProgress - optional: callback function for progress notification
860       * @returns new write position in the "physical" file, that is       * @returns new write position in the "physical" file, that is
861       *          \a ulWritePos incremented by this chunk's new size       *          \a ulWritePos incremented by this chunk's new size
862       *          (including its header size of course)       *          (including its header size of course)
863       */       */
864      unsigned long Chunk::WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset) {      unsigned long Chunk::WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset, progress_t* pProgress) {
865          const unsigned long ulOriginalPos = ulWritePos;          const unsigned long ulOriginalPos = ulWritePos;
866          ulWritePos += CHUNK_HEADER_SIZE;          ulWritePos += CHUNK_HEADER_SIZE;
867    
# Line 775  namespace RIFF { Line 878  namespace RIFF {
878              if (write(pFile->hFileWrite, pChunkData, NewChunkSize) != NewChunkSize) {              if (write(pFile->hFileWrite, pChunkData, NewChunkSize) != NewChunkSize) {
879                  throw Exception("Writing Chunk data (from RAM) failed");                  throw Exception("Writing Chunk data (from RAM) failed");
880              }              }
881                #elif defined(WIN32)
882                SetFilePointer(pFile->hFileWrite, ulWritePos, NULL/*32 bit*/, FILE_BEGIN);
883                DWORD dwBytesWritten;
884                WriteFile(pFile->hFileWrite, pChunkData, NewChunkSize, &dwBytesWritten, NULL);
885                if (dwBytesWritten != NewChunkSize) {
886                    throw Exception("Writing Chunk data (from RAM) failed");
887                }
888              #else              #else
889              fseek(pFile->hFileWrite, ulWritePos, SEEK_SET);              fseek(pFile->hFileWrite, ulWritePos, SEEK_SET);
890              if (fwrite(pChunkData, 1, NewChunkSize, pFile->hFileWrite) != NewChunkSize) {              if (fwrite(pChunkData, 1, NewChunkSize, pFile->hFileWrite) != NewChunkSize) {
# Line 785  namespace RIFF { Line 895  namespace RIFF {
895              // move chunk data from the end of the file to the appropriate position              // move chunk data from the end of the file to the appropriate position
896              int8_t* pCopyBuffer = new int8_t[4096];              int8_t* pCopyBuffer = new int8_t[4096];
897              unsigned long ulToMove = (NewChunkSize < CurrentChunkSize) ? NewChunkSize : CurrentChunkSize;              unsigned long ulToMove = (NewChunkSize < CurrentChunkSize) ? NewChunkSize : CurrentChunkSize;
898                #if defined(WIN32)
899                DWORD iBytesMoved = 1; // we have to pass it via pointer to the Windows API, thus the correct size must be ensured
900                #else
901              int iBytesMoved = 1;              int iBytesMoved = 1;
902              for (unsigned long ulOffset = 0; iBytesMoved > 0; ulOffset += iBytesMoved, ulToMove -= iBytesMoved) {              #endif
903                for (unsigned long ulOffset = 0; ulToMove > 0 && iBytesMoved > 0; ulOffset += iBytesMoved, ulToMove -= iBytesMoved) {
904                  iBytesMoved = (ulToMove < 4096) ? ulToMove : 4096;                  iBytesMoved = (ulToMove < 4096) ? ulToMove : 4096;
905                  #if POSIX                  #if POSIX
906                  lseek(pFile->hFileRead, ulStartPos + ulCurrentDataOffset + ulOffset, SEEK_SET);                  lseek(pFile->hFileRead, ulStartPos + ulCurrentDataOffset + ulOffset, SEEK_SET);
907                  iBytesMoved = read(pFile->hFileRead, pCopyBuffer, iBytesMoved);                  iBytesMoved = read(pFile->hFileRead, pCopyBuffer, iBytesMoved);
908                  lseek(pFile->hFileWrite, ulWritePos + ulOffset, SEEK_SET);                  lseek(pFile->hFileWrite, ulWritePos + ulOffset, SEEK_SET);
909                  iBytesMoved = write(pFile->hFileWrite, pCopyBuffer, iBytesMoved);                  iBytesMoved = write(pFile->hFileWrite, pCopyBuffer, iBytesMoved);
910                    #elif defined(WIN32)
911                    SetFilePointer(pFile->hFileRead, ulStartPos + ulCurrentDataOffset + ulOffset, NULL/*32 bit*/, FILE_BEGIN);
912                    ReadFile(pFile->hFileRead, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
913                    SetFilePointer(pFile->hFileWrite, ulWritePos + ulOffset, NULL/*32 bit*/, FILE_BEGIN);
914                    WriteFile(pFile->hFileWrite, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
915                  #else                  #else
916                  fseek(pFile->hFileRead, ulStartPos + ulCurrentDataOffset + ulOffset, SEEK_SET);                  fseek(pFile->hFileRead, ulStartPos + ulCurrentDataOffset + ulOffset, SEEK_SET);
917                  iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, pFile->hFileRead);                  iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, pFile->hFileRead);
# Line 808  namespace RIFF { Line 927  namespace RIFF {
927          CurrentChunkSize = NewChunkSize;          CurrentChunkSize = NewChunkSize;
928          WriteHeader(ulOriginalPos);          WriteHeader(ulOriginalPos);
929    
930            __notify_progress(pProgress, 1.0); // notify done
931    
932          // update chunk's position pointers          // update chunk's position pointers
933          ulStartPos = ulOriginalPos + CHUNK_HEADER_SIZE;          ulStartPos = ulOriginalPos + CHUNK_HEADER_SIZE;
934          ulPos      = 0;          ulPos      = 0;
# Line 818  namespace RIFF { Line 939  namespace RIFF {
939              #if POSIX              #if POSIX
940              lseek(pFile->hFileWrite, ulStartPos + NewChunkSize, SEEK_SET);              lseek(pFile->hFileWrite, ulStartPos + NewChunkSize, SEEK_SET);
941              write(pFile->hFileWrite, &cPadByte, 1);              write(pFile->hFileWrite, &cPadByte, 1);
942                #elif defined(WIN32)
943                SetFilePointer(pFile->hFileWrite, ulStartPos + NewChunkSize, NULL/*32 bit*/, FILE_BEGIN);
944                DWORD dwBytesWritten;
945                WriteFile(pFile->hFileWrite, &cPadByte, 1, &dwBytesWritten, NULL);
946              #else              #else
947              fseek(pFile->hFileWrite, ulStartPos + NewChunkSize, SEEK_SET);              fseek(pFile->hFileWrite, ulStartPos + NewChunkSize, SEEK_SET);
948              fwrite(&cPadByte, 1, 1, pFile->hFileWrite);              fwrite(&cPadByte, 1, 1, pFile->hFileWrite);
# Line 867  namespace RIFF { Line 992  namespace RIFF {
992        #if DEBUG        #if DEBUG
993        std::cout << "List::~List()" << std::endl;        std::cout << "List::~List()" << std::endl;
994        #endif // DEBUG        #endif // DEBUG
995            DeleteChunkList();
996        }
997    
998        void List::DeleteChunkList() {
999          if (pSubChunks) {          if (pSubChunks) {
1000              ChunkList::iterator iter = pSubChunks->begin();              ChunkList::iterator iter = pSubChunks->begin();
1001              ChunkList::iterator end  = pSubChunks->end();              ChunkList::iterator end  = pSubChunks->end();
# Line 875  namespace RIFF { Line 1004  namespace RIFF {
1004                  iter++;                  iter++;
1005              }              }
1006              delete pSubChunks;              delete pSubChunks;
1007                pSubChunks = NULL;
1008            }
1009            if (pSubChunksMap) {
1010                delete pSubChunksMap;
1011                pSubChunksMap = NULL;
1012          }          }
         if (pSubChunksMap) delete pSubChunksMap;  
1013      }      }
1014    
1015      /**      /**
# Line 1077  namespace RIFF { Line 1210  namespace RIFF {
1210          pSubChunks->push_back(pNewChunk);          pSubChunks->push_back(pNewChunk);
1211          (*pSubChunksMap)[uiChunkID] = pNewChunk;          (*pSubChunksMap)[uiChunkID] = pNewChunk;
1212          pNewChunk->Resize(uiBodySize);          pNewChunk->Resize(uiBodySize);
1213            NewChunkSize += CHUNK_HEADER_SIZE;
1214            pFile->LogAsResized(this);
1215          return pNewChunk;          return pNewChunk;
1216      }      }
1217    
1218        /** @brief Moves a sub chunk witin this list.
1219         *
1220         * Moves a sub chunk from one position in this list to another
1221         * position in the same list. The pSrc chunk is placed before the
1222         * pDst chunk.
1223         *
1224         * @param pSrc - sub chunk to be moved
1225         * @param pDst - the position to move to. pSrc will be placed
1226         *               before pDst. If pDst is 0, pSrc will be placed
1227         *               last in list.
1228         */
1229        void List::MoveSubChunk(Chunk* pSrc, Chunk* pDst) {
1230            if (!pSubChunks) LoadSubChunks();
1231            pSubChunks->remove(pSrc);
1232            ChunkList::iterator iter = find(pSubChunks->begin(), pSubChunks->end(), pDst);
1233            pSubChunks->insert(iter, pSrc);
1234        }
1235    
1236        /** @brief Moves a sub chunk from this list to another list.
1237         *
1238         * Moves a sub chunk from this list list to the end of another
1239         * list.
1240         *
1241         * @param pSrc - sub chunk to be moved
1242         * @param pDst - destination list where the chunk shall be moved to
1243         */
1244        void List::MoveSubChunk(Chunk* pSrc, List* pNewParent) {
1245            if (pNewParent == this || !pNewParent) return;
1246            if (!pSubChunks) LoadSubChunks();
1247            if (!pNewParent->pSubChunks) pNewParent->LoadSubChunks();
1248            pSubChunks->remove(pSrc);
1249            pNewParent->pSubChunks->push_back(pSrc);
1250            // update chunk id map of this List
1251            if ((*pSubChunksMap)[pSrc->GetChunkID()] == pSrc) {
1252                pSubChunksMap->erase(pSrc->GetChunkID());
1253                // try to find another chunk of the same chunk ID
1254                ChunkList::iterator iter = pSubChunks->begin();
1255                ChunkList::iterator end  = pSubChunks->end();
1256                for (; iter != end; ++iter) {
1257                    if ((*iter)->GetChunkID() == pSrc->GetChunkID()) {
1258                        (*pSubChunksMap)[pSrc->GetChunkID()] = *iter;
1259                        break; // we're done, stop search
1260                    }
1261                }
1262            }
1263            // update chunk id map of other list
1264            if (!(*pNewParent->pSubChunksMap)[pSrc->GetChunkID()])
1265                (*pNewParent->pSubChunksMap)[pSrc->GetChunkID()] = pSrc;
1266        }
1267    
1268      /** @brief Creates a new list sub chunk.      /** @brief Creates a new list sub chunk.
1269       *       *
1270       * Creates and adds a new list sub chunk to this list chunk. Note that       * Creates and adds a new list sub chunk to this list chunk. Note that
# Line 1094  namespace RIFF { Line 1279  namespace RIFF {
1279          List* pNewListChunk = new List(pFile, this, uiListType);          List* pNewListChunk = new List(pFile, this, uiListType);
1280          pSubChunks->push_back(pNewListChunk);          pSubChunks->push_back(pNewListChunk);
1281          (*pSubChunksMap)[CHUNK_ID_LIST] = pNewListChunk;          (*pSubChunksMap)[CHUNK_ID_LIST] = pNewListChunk;
1282            NewChunkSize += LIST_HEADER_SIZE;
1283            pFile->LogAsResized(this);
1284          return pNewListChunk;          return pNewListChunk;
1285      }      }
1286    
# Line 1101  namespace RIFF { Line 1288  namespace RIFF {
1288       *       *
1289       * Removes the sub chunk given by \a pSubChunk from this list and frees       * Removes the sub chunk given by \a pSubChunk from this list and frees
1290       * it completely from RAM. The given chunk can either be a normal sub       * it completely from RAM. The given chunk can either be a normal sub
1291       * 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,
1292       * change persistent at any time.       * all its subchunks (if any) will be removed recursively as well. You
1293         * should call File::Save() to make this change persistent at any time.
1294       *       *
1295       * @param pSubChunk - sub chunk or sub list chunk to be removed       * @param pSubChunk - sub chunk or sub list chunk to be removed
1296       */       */
# Line 1129  namespace RIFF { Line 1317  namespace RIFF {
1317        std::cout << "List::Readheader(ulong) ";        std::cout << "List::Readheader(ulong) ";
1318        #endif // DEBUG        #endif // DEBUG
1319          Chunk::ReadHeader(fPos);          Chunk::ReadHeader(fPos);
1320            if (CurrentChunkSize < 4) return;
1321          NewChunkSize = CurrentChunkSize -= 4;          NewChunkSize = CurrentChunkSize -= 4;
1322          #if POSIX          #if POSIX
1323          lseek(pFile->hFileRead, fPos + CHUNK_HEADER_SIZE, SEEK_SET);          lseek(pFile->hFileRead, fPos + CHUNK_HEADER_SIZE, SEEK_SET);
1324          read(pFile->hFileRead, &ListType, 4);          read(pFile->hFileRead, &ListType, 4);
1325            #elif defined(WIN32)
1326            SetFilePointer(pFile->hFileRead, fPos + CHUNK_HEADER_SIZE, NULL/*32 bit*/, FILE_BEGIN);
1327            DWORD dwBytesRead;
1328            ReadFile(pFile->hFileRead, &ListType, 4, &dwBytesRead, NULL);
1329          #else          #else
1330          fseek(pFile->hFileRead, fPos + CHUNK_HEADER_SIZE, SEEK_SET);          fseek(pFile->hFileRead, fPos + CHUNK_HEADER_SIZE, SEEK_SET);
1331          fread(&ListType, 4, 1, pFile->hFileRead);          fread(&ListType, 4, 1, pFile->hFileRead);
# Line 1153  namespace RIFF { Line 1346  namespace RIFF {
1346          #if POSIX          #if POSIX
1347          lseek(pFile->hFileWrite, fPos + CHUNK_HEADER_SIZE, SEEK_SET);          lseek(pFile->hFileWrite, fPos + CHUNK_HEADER_SIZE, SEEK_SET);
1348          write(pFile->hFileWrite, &ListType, 4);          write(pFile->hFileWrite, &ListType, 4);
1349            #elif defined(WIN32)
1350            SetFilePointer(pFile->hFileWrite, fPos + CHUNK_HEADER_SIZE, NULL/*32 bit*/, FILE_BEGIN);
1351            DWORD dwBytesWritten;
1352            WriteFile(pFile->hFileWrite, &ListType, 4, &dwBytesWritten, NULL);
1353          #else          #else
1354          fseek(pFile->hFileWrite, fPos + CHUNK_HEADER_SIZE, SEEK_SET);          fseek(pFile->hFileWrite, fPos + CHUNK_HEADER_SIZE, SEEK_SET);
1355          fwrite(&ListType, 4, 1, pFile->hFileWrite);          fwrite(&ListType, 4, 1, pFile->hFileWrite);
1356          #endif // POSIX          #endif // POSIX
1357      }      }
1358    
1359      void List::LoadSubChunks() {      void List::LoadSubChunks(progress_t* pProgress) {
1360         #if DEBUG         #if DEBUG
1361         std::cout << "List::LoadSubChunks()";         std::cout << "List::LoadSubChunks()";
1362         #endif // DEBUG         #endif // DEBUG
1363          if (!pSubChunks) {          if (!pSubChunks) {
1364              pSubChunks    = new ChunkList();              pSubChunks    = new ChunkList();
1365              pSubChunksMap = new ChunkMap();              pSubChunksMap = new ChunkMap();
1366                #if defined(WIN32)
1367                if (pFile->hFileRead == INVALID_HANDLE_VALUE) return;
1368                #else
1369              if (!pFile->hFileRead) return;              if (!pFile->hFileRead) return;
1370                #endif
1371              unsigned long uiOriginalPos = GetPos();              unsigned long uiOriginalPos = GetPos();
1372              SetPos(0); // jump to beginning of list chunk body              SetPos(0); // jump to beginning of list chunk body
1373              while (RemainingBytes() >= CHUNK_HEADER_SIZE) {              while (RemainingBytes() >= CHUNK_HEADER_SIZE) {
# Line 1190  namespace RIFF { Line 1391  namespace RIFF {
1391              }              }
1392              SetPos(uiOriginalPos); // restore position before this call              SetPos(uiOriginalPos); // restore position before this call
1393          }          }
1394            __notify_progress(pProgress, 1.0); // notify done
1395        }
1396    
1397        void List::LoadSubChunksRecursively(progress_t* pProgress) {
1398            const int n = CountSubLists();
1399            int i = 0;
1400            for (List* pList = GetFirstSubList(); pList; pList = GetNextSubList(), ++i) {
1401                // divide local progress into subprogress
1402                progress_t subprogress;
1403                __divide_progress(pProgress, &subprogress, n, i);
1404                // do the actual work
1405                pList->LoadSubChunksRecursively(&subprogress);
1406            }
1407            __notify_progress(pProgress, 1.0); // notify done
1408      }      }
1409    
1410      /** @brief Write list chunk persistently e.g. to disk.      /** @brief Write list chunk persistently e.g. to disk.
# Line 1202  namespace RIFF { Line 1417  namespace RIFF {
1417       *                     list chunk should be written to       *                     list chunk should be written to
1418       * @param ulCurrentDataOffset - offset of current (old) data within       * @param ulCurrentDataOffset - offset of current (old) data within
1419       *                              the file       *                              the file
1420         * @param pProgress - optional: callback function for progress notification
1421       * @returns new write position in the "physical" file, that is       * @returns new write position in the "physical" file, that is
1422       *          \a ulWritePos incremented by this list chunk's new size       *          \a ulWritePos incremented by this list chunk's new size
1423       *          (including its header size of course)       *          (including its header size of course)
1424       */       */
1425      unsigned long List::WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset) {      unsigned long List::WriteChunk(unsigned long ulWritePos, unsigned long ulCurrentDataOffset, progress_t* pProgress) {
1426          const unsigned long ulOriginalPos = ulWritePos;          const unsigned long ulOriginalPos = ulWritePos;
1427          ulWritePos += LIST_HEADER_SIZE;          ulWritePos += LIST_HEADER_SIZE;
1428    
# Line 1215  namespace RIFF { Line 1431  namespace RIFF {
1431    
1432          // write all subchunks (including sub list chunks) recursively          // write all subchunks (including sub list chunks) recursively
1433          if (pSubChunks) {          if (pSubChunks) {
1434              for (ChunkList::iterator iter = pSubChunks->begin(), end = pSubChunks->end(); iter != end; ++iter) {              int i = 0;
1435                  ulWritePos = (*iter)->WriteChunk(ulWritePos, ulCurrentDataOffset);              const int n = pSubChunks->size();
1436                for (ChunkList::iterator iter = pSubChunks->begin(), end = pSubChunks->end(); iter != end; ++iter, ++i) {
1437                    // divide local progress into subprogress for loading current Instrument
1438                    progress_t subprogress;
1439                    __divide_progress(pProgress, &subprogress, n, i);
1440                    // do the actual work
1441                    ulWritePos = (*iter)->WriteChunk(ulWritePos, ulCurrentDataOffset, &subprogress);
1442              }              }
1443          }          }
1444    
# Line 1227  namespace RIFF { Line 1449  namespace RIFF {
1449          // offset of this list chunk in new written file may have changed          // offset of this list chunk in new written file may have changed
1450          ulStartPos = ulOriginalPos + LIST_HEADER_SIZE;          ulStartPos = ulOriginalPos + LIST_HEADER_SIZE;
1451    
1452             __notify_progress(pProgress, 1.0); // notify done
1453    
1454          return ulWritePos;          return ulWritePos;
1455      }      }
1456    
# Line 1257  namespace RIFF { Line 1481  namespace RIFF {
1481       * "from scratch". Note: there must be no empty chunks or empty list       * "from scratch". Note: there must be no empty chunks or empty list
1482       * chunks when trying to make the new RIFF file persistent with Save()!       * chunks when trying to make the new RIFF file persistent with Save()!
1483       *       *
1484         * Note: by default, the RIFF file will be saved in native endian
1485         * format; that is, as a RIFF file on little-endian machines and
1486         * as a RIFX file on big-endian. To change this behaviour, call
1487         * SetByteOrder() before calling Save().
1488         *
1489       * @param FileType - four-byte identifier of the RIFF file type       * @param FileType - four-byte identifier of the RIFF file type
1490       * @see AddSubChunk(), AddSubList()       * @see AddSubChunk(), AddSubList(), SetByteOrder()
1491       */       */
1492      File::File(uint32_t FileType) : List(this) {      File::File(uint32_t FileType)
1493            : List(this), bIsNewFile(true), Layout(layout_standard)
1494        {
1495            #if defined(WIN32)
1496            hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
1497            #else
1498          hFileRead = hFileWrite = 0;          hFileRead = hFileWrite = 0;
1499            #endif
1500          Mode = stream_mode_closed;          Mode = stream_mode_closed;
1501          bEndianNative = true;          bEndianNative = true;
1502          ulStartPos = RIFF_HEADER_SIZE;          ulStartPos = RIFF_HEADER_SIZE;
# Line 1276  namespace RIFF { Line 1511  namespace RIFF {
1511       * @throws RIFF::Exception if error occured while trying to load the       * @throws RIFF::Exception if error occured while trying to load the
1512       *                         given RIFF file       *                         given RIFF file
1513       */       */
1514      File::File(const String& path) : List(this), Filename(path) {      File::File(const String& path)
1515        #if DEBUG          : List(this), Filename(path), bIsNewFile(false), Layout(layout_standard)
1516        std::cout << "File::File("<<path<<")" << std::endl;      {
1517        #endif // DEBUG         #if DEBUG
1518           std::cout << "File::File("<<path<<")" << std::endl;
1519           #endif // DEBUG
1520          bEndianNative = true;          bEndianNative = true;
1521            try {
1522                __openExistingFile(path);
1523                if (ChunkID != CHUNK_ID_RIFF && ChunkID != CHUNK_ID_RIFX) {
1524                    throw RIFF::Exception("Not a RIFF file");
1525                }
1526            }
1527            catch (...) {
1528                Cleanup();
1529                throw;
1530            }
1531        }
1532    
1533        /** @brief Load existing RIFF-like file.
1534         *
1535         * Loads an existing file, which is not a "real" RIFF file, but similar to
1536         * an ordinary RIFF file.
1537         *
1538         * A "real" RIFF file contains at top level a List chunk either with chunk
1539         * ID "RIFF" or "RIFX". The simple constructor above expects this to be
1540         * case, and if it finds the toplevel List chunk to have another chunk ID
1541         * than one of those two expected ones, it would throw an Exception and
1542         * would refuse to load the file accordingly.
1543         *
1544         * Since there are however a lot of file formats which use the same simple
1545         * principles of the RIFF format, with another toplevel List chunk ID
1546         * though, you can use this alternative constructor here to be able to load
1547         * and handle those files in the same way as you would do with "real" RIFF
1548         * files.
1549         *
1550         * @param path - path and file name of the RIFF-alike file to be opened
1551         * @param FileType - expected toplevel List chunk ID (this is the very
1552         *                   first chunk found in the file)
1553         * @param Endian - whether the file uses little endian or big endian layout
1554         * @param layout - general file structure type
1555         * @throws RIFF::Exception if error occured while trying to load the
1556         *                         given RIFF-alike file
1557         */
1558        File::File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout)
1559            : List(this), Filename(path), bIsNewFile(false), Layout(layout)
1560        {
1561            SetByteOrder(Endian);
1562            try {
1563                __openExistingFile(path, &FileType);
1564            }
1565            catch (...) {
1566                Cleanup();
1567                throw;
1568            }
1569        }
1570    
1571        /**
1572         * Opens an already existing RIFF file or RIFF-alike file. This method
1573         * shall only be called once (in a File class constructor).
1574         *
1575         * @param path - path and file name of the RIFF file or RIFF-alike file to
1576         *               be opened
1577         * @param FileType - (optional) expected chunk ID of first chunk in file
1578         * @throws RIFF::Exception if error occured while trying to load the
1579         *                         given RIFF file or RIFF-alike file
1580         */
1581        void File::__openExistingFile(const String& path, uint32_t* FileType) {
1582            ResizedChunks.clear();
1583          #if POSIX          #if POSIX
1584          hFileRead = hFileWrite = open(path.c_str(), O_RDONLY | O_NONBLOCK);          hFileRead = hFileWrite = open(path.c_str(), O_RDONLY | O_NONBLOCK);
1585          if (hFileRead <= 0) {          if (hFileRead == -1) {
1586              hFileRead = hFileWrite = 0;              hFileRead = hFileWrite = 0;
1587                String sError = strerror(errno);
1588                throw RIFF::Exception("Can't open \"" + path + "\": " + sError);
1589            }
1590            #elif defined(WIN32)
1591            hFileRead = hFileWrite = CreateFile(
1592                                         path.c_str(), GENERIC_READ,
1593                                         FILE_SHARE_READ | FILE_SHARE_WRITE,
1594                                         NULL, OPEN_EXISTING,
1595                                         FILE_ATTRIBUTE_NORMAL |
1596                                         FILE_FLAG_RANDOM_ACCESS, NULL
1597                                     );
1598            if (hFileRead == INVALID_HANDLE_VALUE) {
1599                hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
1600              throw RIFF::Exception("Can't open \"" + path + "\"");              throw RIFF::Exception("Can't open \"" + path + "\"");
1601          }          }
1602          #else          #else
1603          hFileRead = hFileWrite = fopen(path.c_str(), "rb");          hFileRead = hFileWrite = fopen(path.c_str(), "rb");
1604          if (!hFile) throw RIFF::Exception("Can't open \"" + path + "\"");          if (!hFileRead) throw RIFF::Exception("Can't open \"" + path + "\"");
1605          #endif // POSIX          #endif // POSIX
1606          Mode = stream_mode_read;          Mode = stream_mode_read;
1607          ulStartPos = RIFF_HEADER_SIZE;          switch (Layout) {
1608          ReadHeader(0);              case layout_standard: // this is a normal RIFF file
1609          if (ChunkID != CHUNK_ID_RIFF) {                  ulStartPos = RIFF_HEADER_SIZE;
1610              throw RIFF::Exception("Not a RIFF file");                  ReadHeader(0);
1611                    if (FileType && ChunkID != *FileType)
1612                        throw RIFF::Exception("Invalid file container ID");
1613                    break;
1614                case layout_flat: // non-standard RIFF-alike file
1615                    ulStartPos = 0;
1616                    NewChunkSize = CurrentChunkSize = GetFileSize();
1617                    if (FileType) {
1618                        uint32_t ckid;
1619                        if (Read(&ckid, 4, 1) != 4) {
1620                            throw RIFF::Exception("Invalid file header ID (premature end of header)");
1621                        } else if (ckid != *FileType) {
1622                            String s = " (expected '" + convertToString(*FileType) + "' but got '" + convertToString(ckid) + "')";
1623                            throw RIFF::Exception("Invalid file header ID" + s);
1624                        }
1625                        SetPos(0); // reset to first byte of file
1626                    }
1627                    LoadSubChunks();
1628                    break;
1629          }          }
1630      }      }
1631    
1632      String File::GetFileName() {      String File::GetFileName() {
1633          return Filename;          return Filename;
1634      }      }
1635        
1636        void File::SetFileName(const String& path) {
1637            Filename = path;
1638        }
1639    
1640      stream_mode_t File::GetMode() {      stream_mode_t File::GetMode() {
1641          return Mode;          return Mode;
1642      }      }
1643    
1644        layout_t File::GetLayout() const {
1645            return Layout;
1646        }
1647    
1648      /** @brief Change file access mode.      /** @brief Change file access mode.
1649       *       *
1650       * Changes files access mode either to read-only mode or to read/write       * Changes files access mode either to read-only mode or to read/write
# Line 1324  namespace RIFF { Line 1662  namespace RIFF {
1662                      #if POSIX                      #if POSIX
1663                      if (hFileRead) close(hFileRead);                      if (hFileRead) close(hFileRead);
1664                      hFileRead = hFileWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);                      hFileRead = hFileWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);
1665                      if (hFileRead < 0) {                      if (hFileRead == -1) {
1666                          hFileRead = hFileWrite = 0;                          hFileRead = hFileWrite = 0;
1667                            String sError = strerror(errno);
1668                            throw Exception("Could not (re)open file \"" + Filename + "\" in read mode: " + sError);
1669                        }
1670                        #elif defined(WIN32)
1671                        if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
1672                        hFileRead = hFileWrite = CreateFile(
1673                                                     Filename.c_str(), GENERIC_READ,
1674                                                     FILE_SHARE_READ | FILE_SHARE_WRITE,
1675                                                     NULL, OPEN_EXISTING,
1676                                                     FILE_ATTRIBUTE_NORMAL |
1677                                                     FILE_FLAG_RANDOM_ACCESS,
1678                                                     NULL
1679                                                 );
1680                        if (hFileRead == INVALID_HANDLE_VALUE) {
1681                            hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
1682                          throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");                          throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");
1683                      }                      }
1684                      #else                      #else
1685                      if (hFileRead) fclose(hFileRead);                      if (hFileRead) fclose(hFileRead);
1686                      hFileRead = hFileWrite = fopen(path.c_str(), "rb");                      hFileRead = hFileWrite = fopen(Filename.c_str(), "rb");
1687                      if (!hFileRead) throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");                      if (!hFileRead) throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");
1688                      #endif                      #endif
1689                      __resetPos(); // reset read/write position of ALL 'Chunk' objects                      __resetPos(); // reset read/write position of ALL 'Chunk' objects
# Line 1339  namespace RIFF { Line 1692  namespace RIFF {
1692                      #if POSIX                      #if POSIX
1693                      if (hFileRead) close(hFileRead);                      if (hFileRead) close(hFileRead);
1694                      hFileRead = hFileWrite = open(Filename.c_str(), O_RDWR | O_NONBLOCK);                      hFileRead = hFileWrite = open(Filename.c_str(), O_RDWR | O_NONBLOCK);
1695                      if (hFileRead < 0) {                      if (hFileRead == -1) {
1696                          hFileRead = hFileWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);                          hFileRead = hFileWrite = open(Filename.c_str(), O_RDONLY | O_NONBLOCK);
1697                          throw Exception("Could not open file \"" + Filename + "\" in read+write mode");                          String sError = strerror(errno);
1698                            throw Exception("Could not open file \"" + Filename + "\" in read+write mode: " + sError);
1699                        }
1700                        #elif defined(WIN32)
1701                        if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
1702                        hFileRead = hFileWrite = CreateFile(
1703                                                     Filename.c_str(),
1704                                                     GENERIC_READ | GENERIC_WRITE,
1705                                                     FILE_SHARE_READ,
1706                                                     NULL, OPEN_ALWAYS,
1707                                                     FILE_ATTRIBUTE_NORMAL |
1708                                                     FILE_FLAG_RANDOM_ACCESS,
1709                                                     NULL
1710                                                 );
1711                        if (hFileRead == INVALID_HANDLE_VALUE) {
1712                            hFileRead = hFileWrite = CreateFile(
1713                                                         Filename.c_str(), GENERIC_READ,
1714                                                         FILE_SHARE_READ | FILE_SHARE_WRITE,
1715                                                         NULL, OPEN_EXISTING,
1716                                                         FILE_ATTRIBUTE_NORMAL |
1717                                                         FILE_FLAG_RANDOM_ACCESS,
1718                                                         NULL
1719                                                     );
1720                            throw Exception("Could not (re)open file \"" + Filename + "\" in read+write mode");
1721                      }                      }
1722                      #else                      #else
1723                      if (hFileRead) fclose(hFileRead);                      if (hFileRead) fclose(hFileRead);
1724                      hFileRead = hFileWrite = fopen(path.c_str(), "r+b");                      hFileRead = hFileWrite = fopen(Filename.c_str(), "r+b");
1725                      if (!hFileRead) {                      if (!hFileRead) {
1726                          hFileRead = hFileWrite = fopen(path.c_str(), "rb");                          hFileRead = hFileWrite = fopen(Filename.c_str(), "rb");
1727                          throw Exception("Could not open file \"" + Filename + "\" in read+write mode");                          throw Exception("Could not open file \"" + Filename + "\" in read+write mode");
1728                      }                      }
1729                      #endif                      #endif
# Line 1357  namespace RIFF { Line 1733  namespace RIFF {
1733                      #if POSIX                      #if POSIX
1734                      if (hFileRead)  close(hFileRead);                      if (hFileRead)  close(hFileRead);
1735                      if (hFileWrite) close(hFileWrite);                      if (hFileWrite) close(hFileWrite);
1736                        #elif defined(WIN32)
1737                        if (hFileRead  != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
1738                        if (hFileWrite != INVALID_HANDLE_VALUE) CloseHandle(hFileWrite);
1739                      #else                      #else
1740                      if (hFileRead)  fclose(hFileRead);                      if (hFileRead)  fclose(hFileRead);
1741                      if (hFileWrite) fclose(hFileWrite);                      if (hFileWrite) fclose(hFileWrite);
# Line 1372  namespace RIFF { Line 1751  namespace RIFF {
1751          return false;          return false;
1752      }      }
1753    
1754        /** @brief Set the byte order to be used when saving.
1755         *
1756         * Set the byte order to be used in the file. A value of
1757         * endian_little will create a RIFF file, endian_big a RIFX file
1758         * and endian_native will create a RIFF file on little-endian
1759         * machines and RIFX on big-endian machines.
1760         *
1761         * @param Endian - endianess to use when file is saved.
1762         */
1763        void File::SetByteOrder(endian_t Endian) {
1764            #if WORDS_BIGENDIAN
1765            bEndianNative = Endian != endian_little;
1766            #else
1767            bEndianNative = Endian != endian_big;
1768            #endif
1769        }
1770    
1771      /** @brief Save changes to same file.      /** @brief Save changes to same file.
1772       *       *
1773       * Make all changes of all chunks persistent by writing them to the       * Make all changes of all chunks persistent by writing them to the
# Line 1379  namespace RIFF { Line 1775  namespace RIFF {
1775       * than it will have at the end of the saving process, in case chunks       * than it will have at the end of the saving process, in case chunks
1776       * were grown.       * were grown.
1777       *       *
1778         * @param pProgress - optional: callback function for progress notification
1779       * @throws RIFF::Exception if there is an empty chunk or empty list       * @throws RIFF::Exception if there is an empty chunk or empty list
1780       *                         chunk or any kind of IO error occured       *                         chunk or any kind of IO error occured
1781       */       */
1782      void File::Save() {      void File::Save(progress_t* pProgress) {
1783            //TODO: implementation for the case where first chunk is not a global container (List chunk) is not implemented yet (i.e. Korg files)
1784            if (Layout == layout_flat)
1785                throw Exception("Saving a RIFF file with layout_flat is not implemented yet");
1786    
1787            // make sure the RIFF tree is built (from the original file)
1788            {
1789                // divide progress into subprogress
1790                progress_t subprogress;
1791                __divide_progress(pProgress, &subprogress, 3.f, 0.f); // arbitrarily subdivided into 1/3 of total progress
1792                // do the actual work
1793                LoadSubChunksRecursively(&subprogress);
1794                // notify subprogress done
1795                __notify_progress(&subprogress, 1.f);
1796            }
1797    
1798          // reopen file in write mode          // reopen file in write mode
1799          SetMode(stream_mode_read_write);          SetMode(stream_mode_read_write);
1800    
# Line 1395  namespace RIFF { Line 1807  namespace RIFF {
1807    
1808          // first we sum up all positive chunk size changes (and skip all negative ones)          // first we sum up all positive chunk size changes (and skip all negative ones)
1809          unsigned long ulPositiveSizeDiff = 0;          unsigned long ulPositiveSizeDiff = 0;
1810          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) {
1811              if ((*iter)->GetNewSize() == 0) throw Exception("There is at least one empty chunk (zero size)");              if ((*iter)->GetNewSize() == 0) {
1812              if ((*iter)->GetNewSize() + 1L > (*iter)->GetSize()) {                  throw Exception("There is at least one empty chunk (zero size): " + __resolveChunkPath(*iter));
                 unsigned long ulDiff = (*iter)->GetNewSize() - (*iter)->GetSize() + 1L; // +1 in case we have to add a pad byte  
                 ulPositiveSizeDiff += ulDiff;  
1813              }              }
1814                unsigned long newSizePadded = (*iter)->GetNewSize() + (*iter)->GetNewSize() % 2;
1815                unsigned long oldSizePadded = (*iter)->GetSize() + (*iter)->GetSize() % 2;
1816                if (newSizePadded > oldSizePadded) ulPositiveSizeDiff += newSizePadded - oldSizePadded;
1817          }          }
1818    
1819          unsigned long ulWorkingFileSize = GetFileSize();          unsigned long ulWorkingFileSize = GetFileSize();
1820    
1821          // if there are positive size changes...          // if there are positive size changes...
1822          if (ulPositiveSizeDiff > 0) {          if (ulPositiveSizeDiff > 0) {
1823                // divide progress into subprogress
1824                progress_t subprogress;
1825                __divide_progress(pProgress, &subprogress, 3.f, 1.f); // arbitrarily subdivided into 1/3 of total progress
1826    
1827              // ... we enlarge this file first ...              // ... we enlarge this file first ...
1828              ulWorkingFileSize += ulPositiveSizeDiff;              ulWorkingFileSize += ulPositiveSizeDiff;
1829              ResizeFile(ulWorkingFileSize);              ResizeFile(ulWorkingFileSize);
1830              // ... and move current data by the same amount towards end of file.              // ... and move current data by the same amount towards end of file.
1831              int8_t* pCopyBuffer = new int8_t[4096];              int8_t* pCopyBuffer = new int8_t[4096];
1832              const unsigned long ulFileSize = GetSize() + RIFF_HEADER_SIZE;              const unsigned long ulFileSize = GetSize() + RIFF_HEADER_SIZE;
1833                #if defined(WIN32)
1834                DWORD iBytesMoved = 1; // we have to pass it via pointer to the Windows API, thus the correct size must be ensured
1835                #else
1836              int iBytesMoved = 1;              int iBytesMoved = 1;
1837              for (unsigned long ulPos = 0; iBytesMoved > 0; ulPos += iBytesMoved) {              #endif
1838                  const unsigned long ulToMove = ulFileSize - ulPos;              for (unsigned long ulPos = ulFileSize, iNotif = 0; iBytesMoved > 0; ++iNotif) {
1839                  iBytesMoved = (ulToMove < 4096) ? ulToMove : 4096;                  iBytesMoved = (ulPos < 4096) ? ulPos : 4096;
1840                    ulPos -= iBytesMoved;
1841                  #if POSIX                  #if POSIX
1842                  lseek(hFileRead, ulPos, SEEK_SET);                  lseek(hFileRead, ulPos, SEEK_SET);
1843                  iBytesMoved = read(hFileRead, pCopyBuffer, iBytesMoved);                  iBytesMoved = read(hFileRead, pCopyBuffer, iBytesMoved);
1844                  lseek(hFileWrite, ulPos + ulPositiveSizeDiff, SEEK_SET);                  lseek(hFileWrite, ulPos + ulPositiveSizeDiff, SEEK_SET);
1845                  iBytesMoved = write(hFileWrite, pCopyBuffer, iBytesMoved);                  iBytesMoved = write(hFileWrite, pCopyBuffer, iBytesMoved);
1846                    #elif defined(WIN32)
1847                    SetFilePointer(hFileRead, ulPos, NULL/*32 bit*/, FILE_BEGIN);
1848                    ReadFile(hFileRead, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
1849                    SetFilePointer(hFileWrite, ulPos + ulPositiveSizeDiff, NULL/*32 bit*/, FILE_BEGIN);
1850                    WriteFile(hFileWrite, pCopyBuffer, iBytesMoved, &iBytesMoved, NULL);
1851                  #else                  #else
1852                  fseek(hFileRead, ulPos, SEEK_SET);                  fseek(hFileRead, ulPos, SEEK_SET);
1853                  iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, hFileRead);                  iBytesMoved = fread(pCopyBuffer, 1, iBytesMoved, hFileRead);
1854                  fseek(hFileWrite, ulPos + ulPositiveSizeDiff, SEEK_SET);                  fseek(hFileWrite, ulPos + ulPositiveSizeDiff, SEEK_SET);
1855                  iBytesMoved = fwrite(pCopyBuffer, 1, iBytesMoved, hFileWrite);                  iBytesMoved = fwrite(pCopyBuffer, 1, iBytesMoved, hFileWrite);
1856                  #endif                  #endif
1857                    if (!(iNotif % 8) && iBytesMoved > 0)
1858                        __notify_progress(&subprogress, float(ulFileSize - ulPos) / float(ulFileSize));
1859              }              }
1860              delete[] pCopyBuffer;              delete[] pCopyBuffer;
1861              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");
1862    
1863                __notify_progress(&subprogress, 1.f); // notify subprogress done
1864          }          }
1865    
1866          // rebuild / rewrite complete RIFF tree          // rebuild / rewrite complete RIFF tree ...
1867          unsigned long ulTotalSize  = WriteChunk(0, ulPositiveSizeDiff);  
1868            // divide progress into subprogress
1869            progress_t subprogress;
1870            __divide_progress(pProgress, &subprogress, 3.f, 2.f); // arbitrarily subdivided into 1/3 of total progress
1871            // do the actual work
1872            unsigned long ulTotalSize  = WriteChunk(0, ulPositiveSizeDiff, &subprogress);
1873          unsigned long ulActualSize = __GetFileSize(hFileWrite);          unsigned long ulActualSize = __GetFileSize(hFileWrite);
1874            // notify subprogress done
1875            __notify_progress(&subprogress, 1.f);
1876    
1877          // resize file to the final size          // resize file to the final size
1878          if (ulTotalSize < ulActualSize) ResizeFile(ulTotalSize);          if (ulTotalSize < ulActualSize) ResizeFile(ulTotalSize);
1879    
1880          // forget all resized chunks          // forget all resized chunks
1881          ResizedChunks.clear();          ResizedChunks.clear();
1882    
1883            __notify_progress(pProgress, 1.0); // notify done
1884      }      }
1885    
1886      /** @brief Save changes to another file.      /** @brief Save changes to another file.
# Line 1456  namespace RIFF { Line 1895  namespace RIFF {
1895       * the new file (given by \a path) afterwards.       * the new file (given by \a path) afterwards.
1896       *       *
1897       * @param path - path and file name where everything should be written to       * @param path - path and file name where everything should be written to
1898         * @param pProgress - optional: callback function for progress notification
1899       */       */
1900      void File::Save(const String& path) {      void File::Save(const String& path, progress_t* pProgress) {
1901          //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
1902    
1903          if (Filename.length() > 0) SetMode(stream_mode_read);          //TODO: implementation for the case where first chunk is not a global container (List chunk) is not implemented yet (i.e. Korg files)
1904            if (Layout == layout_flat)
1905                throw Exception("Saving a RIFF file with layout_flat is not implemented yet");
1906    
1907            // make sure the RIFF tree is built (from the original file)
1908            {
1909                // divide progress into subprogress
1910                progress_t subprogress;
1911                __divide_progress(pProgress, &subprogress, 2.f, 0.f); // arbitrarily subdivided into 1/2 of total progress
1912                // do the actual work
1913                LoadSubChunksRecursively(&subprogress);
1914                // notify subprogress done
1915                __notify_progress(&subprogress, 1.f);
1916            }
1917    
1918            if (!bIsNewFile) SetMode(stream_mode_read);
1919          // open the other (new) file for writing and truncate it to zero size          // open the other (new) file for writing and truncate it to zero size
1920          #if POSIX          #if POSIX
1921          hFileWrite = open(path.c_str(), O_RDWR | O_CREAT, S_IRUSR | S_IWUSR | S_IRGRP);          hFileWrite = open(path.c_str(), O_RDWR | O_CREAT, S_IRUSR | S_IWUSR | S_IRGRP);
1922          if (hFileWrite < 0) {          if (hFileWrite == -1) {
1923                hFileWrite = hFileRead;
1924                String sError = strerror(errno);
1925                throw Exception("Could not open file \"" + path + "\" for writing: " + sError);
1926            }
1927            #elif defined(WIN32)
1928            hFileWrite = CreateFile(
1929                             path.c_str(), GENERIC_WRITE, FILE_SHARE_READ,
1930                             NULL, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL |
1931                             FILE_FLAG_RANDOM_ACCESS, NULL
1932                         );
1933            if (hFileWrite == INVALID_HANDLE_VALUE) {
1934              hFileWrite = hFileRead;              hFileWrite = hFileRead;
1935              throw Exception("Could not open file \"" + path + "\" for writing");              throw Exception("Could not open file \"" + path + "\" for writing");
1936          }          }
# Line 1478  namespace RIFF { Line 1944  namespace RIFF {
1944          Mode = stream_mode_read_write;          Mode = stream_mode_read_write;
1945    
1946          // write complete RIFF tree to the other (new) file          // write complete RIFF tree to the other (new) file
1947          unsigned long ulTotalSize  = WriteChunk(0, 0);          unsigned long ulTotalSize;
1948            {
1949                // divide progress into subprogress
1950                progress_t subprogress;
1951                __divide_progress(pProgress, &subprogress, 2.f, 1.f); // arbitrarily subdivided into 1/2 of total progress
1952                // do the actual work
1953                ulTotalSize = WriteChunk(0, 0, &subprogress);
1954                // notify subprogress done
1955                __notify_progress(&subprogress, 1.f);
1956            }
1957          unsigned long ulActualSize = __GetFileSize(hFileWrite);          unsigned long ulActualSize = __GetFileSize(hFileWrite);
1958    
1959          // resize file to the final size (if the file was originally larger)          // resize file to the final size (if the file was originally larger)
# Line 1487  namespace RIFF { Line 1962  namespace RIFF {
1962          // forget all resized chunks          // forget all resized chunks
1963          ResizedChunks.clear();          ResizedChunks.clear();
1964    
1965          if (Filename.length() > 0) {          #if POSIX
1966              #if POSIX          if (hFileWrite) close(hFileWrite);
1967              close(hFileWrite);          #elif defined(WIN32)
1968              #else          if (hFileWrite != INVALID_HANDLE_VALUE) CloseHandle(hFileWrite);
1969              fclose(hFileWrite);          #else
1970              #endif          if (hFileWrite) fclose(hFileWrite);
1971              hFileWrite = hFileRead;          #endif
1972          }          hFileWrite = hFileRead;
1973    
1974          // associate new file with this File object from now on          // associate new file with this File object from now on
1975          Filename = path;          Filename = path;
1976            bIsNewFile = false;
1977          Mode = (stream_mode_t) -1;       // Just set it to an undefined mode ...          Mode = (stream_mode_t) -1;       // Just set it to an undefined mode ...
1978          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.
1979    
1980            __notify_progress(pProgress, 1.0); // notify done
1981      }      }
1982    
1983      void File::ResizeFile(unsigned long ulNewSize) {      void File::ResizeFile(unsigned long ulNewSize) {
1984          #if POSIX          #if POSIX
1985          if (ftruncate(hFileWrite, ulNewSize) < 0)          if (ftruncate(hFileWrite, ulNewSize) < 0)
1986              throw Exception("Could not resize file \"" + Filename + "\"");              throw Exception("Could not resize file \"" + Filename + "\"");
1987            #elif defined(WIN32)
1988            if (
1989                SetFilePointer(hFileWrite, ulNewSize, NULL/*32 bit*/, FILE_BEGIN) == INVALID_SET_FILE_POINTER ||
1990                !SetEndOfFile(hFileWrite)
1991            ) throw Exception("Could not resize file \"" + Filename + "\"");
1992          #else          #else
1993          # error Sorry, this version of libgig only supports POSIX systems yet.          # error Sorry, this version of libgig only supports POSIX and Windows systems yet.
1994          # error Reason: portable implementation of RIFF::File::ResizeFile() is missing (yet)!          # error Reason: portable implementation of RIFF::File::ResizeFile() is missing (yet)!
1995          #endif          #endif
1996      }      }
# Line 1516  namespace RIFF { Line 1999  namespace RIFF {
1999         #if DEBUG         #if DEBUG
2000         std::cout << "File::~File()" << std::endl;         std::cout << "File::~File()" << std::endl;
2001         #endif // DEBUG         #endif // DEBUG
2002            Cleanup();
2003        }
2004        
2005        /**
2006         * Returns @c true if this file has been created new from scratch and
2007         * has not been stored to disk yet.
2008         */
2009        bool File::IsNew() const {
2010            return bIsNewFile;
2011        }
2012    
2013        void File::Cleanup() {
2014          #if POSIX          #if POSIX
2015          if (hFileRead) close(hFileRead);          if (hFileRead) close(hFileRead);
2016            #elif defined(WIN32)
2017            if (hFileRead != INVALID_HANDLE_VALUE) CloseHandle(hFileRead);
2018          #else          #else
2019          if (hFileRead) fclose(hFileRead);          if (hFileRead) fclose(hFileRead);
2020          #endif // POSIX          #endif // POSIX
2021            DeleteChunkList();
2022            pFile = NULL;
2023            ResizedChunks.clear();
2024      }      }
2025    
2026      void File::LogAsResized(Chunk* pResizedChunk) {      void File::LogAsResized(Chunk* pResizedChunk) {
2027          ResizedChunks.push_back(pResizedChunk);          ResizedChunks.insert(pResizedChunk);
2028        }
2029    
2030        void File::UnlogResized(Chunk* pResizedChunk) {
2031            ResizedChunks.erase(pResizedChunk);
2032      }      }
2033    
2034      unsigned long File::GetFileSize() {      unsigned long File::GetFileSize() {
# Line 1538  namespace RIFF { Line 2042  namespace RIFF {
2042          long size = filestat.st_size;          long size = filestat.st_size;
2043          return size;          return size;
2044      }      }
2045        #elif defined(WIN32)
2046        unsigned long File::__GetFileSize(HANDLE hFile) {
2047            DWORD dwSize = ::GetFileSize(hFile, NULL /*32bit*/);
2048            if (dwSize == INVALID_FILE_SIZE)
2049                throw Exception("Windows FS error: could not determine file size");
2050            return dwSize;
2051        }
2052      #else // standard C functions      #else // standard C functions
2053      unsigned long File::__GetFileSize(FILE* hFile) {      unsigned long File::__GetFileSize(FILE* hFile) {
2054          long curpos = ftell(hFile);          long curpos = ftell(hFile);

Legend:
Removed from v.808  
changed lines
  Added in v.2703

  ViewVC Help
Powered by ViewVC