/[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 1063 by schoenebeck, Sat Mar 3 21:45:25 2007 UTC revision 1859 by persson, Sun Mar 8 12:24:56 2009 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file access library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2007 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2009 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 <string.h>  #include <string.h>
26    
27  #include "RIFF.h"  #include "RIFF.h"
# Line 29  Line 30 
30    
31  namespace RIFF {  namespace RIFF {
32    
33    // *************** Internal functions **************
34    // *
35    
36        /// Returns a human readable path of the given chunk.
37        static String __resolveChunkPath(Chunk* pCk) {
38            String sPath;
39            for (Chunk* pChunk = pCk; pChunk; pChunk = pChunk->GetParent()) {
40                if (pChunk->GetChunkID() == CHUNK_ID_LIST) {
41                    List* pList = (List*) pChunk;
42                    sPath = "->'" + pList->GetListTypeString() + "'" + sPath;
43                } else {
44                    sPath = "->'" + pChunk->GetChunkIDString() + "'" + sPath;
45                }
46            }
47            return sPath;
48        }
49    
50    
51    
52  // *************** Chunk **************  // *************** Chunk **************
53  // *  // *
54    
# Line 70  namespace RIFF { Line 90  namespace RIFF {
90      }      }
91    
92      Chunk::~Chunk() {      Chunk::~Chunk() {
93            pFile->UnlogResized(this);
94          if (pChunkData) delete[] pChunkData;          if (pChunkData) delete[] pChunkData;
95      }      }
96    
# Line 215  namespace RIFF { Line 236  namespace RIFF {
236       *  - RIFF::stream_closed :       *  - RIFF::stream_closed :
237       *    the data stream was closed somehow, no more reading possible       *    the data stream was closed somehow, no more reading possible
238       *  - RIFF::stream_end_reached :       *  - RIFF::stream_end_reached :
239       *    alreaady reached the end of the chunk data, no more reading       *    already reached the end of the chunk data, no more reading
240       *    possible without SetPos()       *    possible without SetPos()
241       */       */
242      stream_state_t Chunk::GetState() {      stream_state_t Chunk::GetState() {
# Line 253  namespace RIFF { Line 274  namespace RIFF {
274         #if DEBUG         #if DEBUG
275         std::cout << "Chunk::Read(void*,ulong,ulong)" << std::endl;         std::cout << "Chunk::Read(void*,ulong,ulong)" << std::endl;
276         #endif // DEBUG         #endif // DEBUG
277            if (ulStartPos == 0) return 0; // is only 0 if this is a new chunk, so nothing to read (yet)
278          if (ulPos >= CurrentChunkSize) return 0;          if (ulPos >= CurrentChunkSize) return 0;
279          if (ulPos + WordCount * WordSize >= CurrentChunkSize) WordCount = (CurrentChunkSize - ulPos) / WordSize;          if (ulPos + WordCount * WordSize >= CurrentChunkSize) WordCount = (CurrentChunkSize - ulPos) / WordSize;
280          #if POSIX          #if POSIX
# Line 338  namespace RIFF { Line 360  namespace RIFF {
360          #elif defined(WIN32)          #elif defined(WIN32)
361          if (SetFilePointer(pFile->hFileWrite, ulStartPos + ulPos, NULL/*32 bit*/, FILE_BEGIN) == INVALID_SET_FILE_POINTER) {          if (SetFilePointer(pFile->hFileWrite, ulStartPos + ulPos, NULL/*32 bit*/, FILE_BEGIN) == INVALID_SET_FILE_POINTER) {
362              throw Exception("Could not seek to position " + ToString(ulPos) +              throw Exception("Could not seek to position " + ToString(ulPos) +
363                              " in chunk (" + ToString(ulStartPos + ulPos) + " in file)");                                          " in chunk (" + ToString(ulStartPos + ulPos) + " in file)");
364          }          }
365          DWORD writtenWords;          DWORD writtenWords;
366          WriteFile(pFile->hFileWrite, pData, WordCount * WordSize, &writtenWords, NULL);          WriteFile(pFile->hFileWrite, pData, WordCount * WordSize, &writtenWords, NULL);
# Line 705  namespace RIFF { Line 727  namespace RIFF {
727       * @see ReleaseChunkData()       * @see ReleaseChunkData()
728       */       */
729      void* Chunk::LoadChunkData() {      void* Chunk::LoadChunkData() {
730          if (!pChunkData && pFile->Filename != "") {          if (!pChunkData && pFile->Filename != "" && ulStartPos != 0) {
731              #if POSIX              #if POSIX
732              if (lseek(pFile->hFileRead, ulStartPos, SEEK_SET) == -1) return NULL;              if (lseek(pFile->hFileRead, ulStartPos, SEEK_SET) == -1) return NULL;
733              #elif defined(WIN32)              #elif defined(WIN32)
# Line 774  namespace RIFF { Line 796  namespace RIFF {
796       * @see File::Save()       * @see File::Save()
797       */       */
798      void Chunk::Resize(int iNewSize) {      void Chunk::Resize(int iNewSize) {
799          if (iNewSize <= 0) throw Exception("Chunk size must be at least one byte");          if (iNewSize <= 0)
800                throw Exception("There is at least one empty chunk (zero size): " + __resolveChunkPath(this));
801          if (NewChunkSize == iNewSize) return;          if (NewChunkSize == iNewSize) return;
802          NewChunkSize = iNewSize;          NewChunkSize = iNewSize;
803          pFile->LogAsResized(this);          pFile->LogAsResized(this);
# Line 1131  namespace RIFF { Line 1154  namespace RIFF {
1154          pSubChunks->push_back(pNewChunk);          pSubChunks->push_back(pNewChunk);
1155          (*pSubChunksMap)[uiChunkID] = pNewChunk;          (*pSubChunksMap)[uiChunkID] = pNewChunk;
1156          pNewChunk->Resize(uiBodySize);          pNewChunk->Resize(uiBodySize);
1157            NewChunkSize += CHUNK_HEADER_SIZE;
1158            pFile->LogAsResized(this);
1159          return pNewChunk;          return pNewChunk;
1160      }      }
1161    
1162        /** @brief Moves a sub chunk.
1163         *
1164         * Moves a sub chunk from one position in a list to another
1165         * position in the same list. The pSrc chunk is placed before the
1166         * pDst chunk.
1167         *
1168         * @param pSrc - sub chunk to be moved
1169         * @param pDst - the position to move to. pSrc will be placed
1170         *               before pDst. If pDst is 0, pSrc will be placed
1171         *               last in list.
1172         */
1173        void List::MoveSubChunk(Chunk* pSrc, Chunk* pDst) {
1174            if (!pSubChunks) LoadSubChunks();
1175            pSubChunks->remove(pSrc);
1176            ChunkList::iterator iter = find(pSubChunks->begin(), pSubChunks->end(), pDst);
1177            pSubChunks->insert(iter, pSrc);
1178        }
1179    
1180      /** @brief Creates a new list sub chunk.      /** @brief Creates a new list sub chunk.
1181       *       *
1182       * 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 1148  namespace RIFF { Line 1191  namespace RIFF {
1191          List* pNewListChunk = new List(pFile, this, uiListType);          List* pNewListChunk = new List(pFile, this, uiListType);
1192          pSubChunks->push_back(pNewListChunk);          pSubChunks->push_back(pNewListChunk);
1193          (*pSubChunksMap)[CHUNK_ID_LIST] = pNewListChunk;          (*pSubChunksMap)[CHUNK_ID_LIST] = pNewListChunk;
1194            NewChunkSize += LIST_HEADER_SIZE;
1195            pFile->LogAsResized(this);
1196          return pNewListChunk;          return pNewListChunk;
1197      }      }
1198    
# Line 1155  namespace RIFF { Line 1200  namespace RIFF {
1200       *       *
1201       * 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
1202       * 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
1203       * 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,
1204       * change persistent at any time.       * all its subchunks (if any) will be removed recursively as well. You
1205         * should call File::Save() to make this change persistent at any time.
1206       *       *
1207       * @param pSubChunk - sub chunk or sub list chunk to be removed       * @param pSubChunk - sub chunk or sub list chunk to be removed
1208       */       */
# Line 1228  namespace RIFF { Line 1274  namespace RIFF {
1274          if (!pSubChunks) {          if (!pSubChunks) {
1275              pSubChunks    = new ChunkList();              pSubChunks    = new ChunkList();
1276              pSubChunksMap = new ChunkMap();              pSubChunksMap = new ChunkMap();
1277                #if defined(WIN32)
1278                if (pFile->hFileRead == INVALID_HANDLE_VALUE) return;
1279                #else
1280              if (!pFile->hFileRead) return;              if (!pFile->hFileRead) return;
1281                #endif
1282              unsigned long uiOriginalPos = GetPos();              unsigned long uiOriginalPos = GetPos();
1283              SetPos(0); // jump to beginning of list chunk body              SetPos(0); // jump to beginning of list chunk body
1284              while (RemainingBytes() >= CHUNK_HEADER_SIZE) {              while (RemainingBytes() >= CHUNK_HEADER_SIZE) {
# Line 1324  namespace RIFF { Line 1374  namespace RIFF {
1374       * "from scratch". Note: there must be no empty chunks or empty list       * "from scratch". Note: there must be no empty chunks or empty list
1375       * chunks when trying to make the new RIFF file persistent with Save()!       * chunks when trying to make the new RIFF file persistent with Save()!
1376       *       *
1377         * Note: by default, the RIFF file will be saved in native endian
1378         * format; that is, as a RIFF file on little-endian machines and
1379         * as a RIFX file on big-endian. To change this behaviour, call
1380         * SetByteOrder() before calling Save().
1381         *
1382       * @param FileType - four-byte identifier of the RIFF file type       * @param FileType - four-byte identifier of the RIFF file type
1383       * @see AddSubChunk(), AddSubList()       * @see AddSubChunk(), AddSubList(), SetByteOrder()
1384       */       */
1385      File::File(uint32_t FileType) : List(this) {      File::File(uint32_t FileType) : List(this) {
1386          #if defined(WIN32)          #if defined(WIN32)
# Line 1363  namespace RIFF { Line 1418  namespace RIFF {
1418                                       path.c_str(), GENERIC_READ,                                       path.c_str(), GENERIC_READ,
1419                                       FILE_SHARE_READ | FILE_SHARE_WRITE,                                       FILE_SHARE_READ | FILE_SHARE_WRITE,
1420                                       NULL, OPEN_EXISTING,                                       NULL, OPEN_EXISTING,
1421                                       FILE_ATTRIBUTE_NORMAL, NULL                                       FILE_ATTRIBUTE_NORMAL |
1422                                         FILE_FLAG_RANDOM_ACCESS, NULL
1423                                   );                                   );
1424          if (hFileRead == INVALID_HANDLE_VALUE) {          if (hFileRead == INVALID_HANDLE_VALUE) {
1425              hFileRead = hFileWrite = INVALID_HANDLE_VALUE;              hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
# Line 1416  namespace RIFF { Line 1472  namespace RIFF {
1472                                                   Filename.c_str(), GENERIC_READ,                                                   Filename.c_str(), GENERIC_READ,
1473                                                   FILE_SHARE_READ | FILE_SHARE_WRITE,                                                   FILE_SHARE_READ | FILE_SHARE_WRITE,
1474                                                   NULL, OPEN_EXISTING,                                                   NULL, OPEN_EXISTING,
1475                                                   FILE_ATTRIBUTE_NORMAL, NULL                                                   FILE_ATTRIBUTE_NORMAL |
1476                                                     FILE_FLAG_RANDOM_ACCESS,
1477                                                     NULL
1478                                               );                                               );
1479                      if (hFileRead == INVALID_HANDLE_VALUE) {                      if (hFileRead == INVALID_HANDLE_VALUE) {
1480                          hFileRead = hFileWrite = INVALID_HANDLE_VALUE;                          hFileRead = hFileWrite = INVALID_HANDLE_VALUE;
# Line 1444  namespace RIFF { Line 1502  namespace RIFF {
1502                                                   GENERIC_READ | GENERIC_WRITE,                                                   GENERIC_READ | GENERIC_WRITE,
1503                                                   FILE_SHARE_READ,                                                   FILE_SHARE_READ,
1504                                                   NULL, OPEN_ALWAYS,                                                   NULL, OPEN_ALWAYS,
1505                                                   FILE_ATTRIBUTE_NORMAL, NULL                                                   FILE_ATTRIBUTE_NORMAL |
1506                                                     FILE_FLAG_RANDOM_ACCESS,
1507                                                     NULL
1508                                               );                                               );
1509                      if (hFileRead == INVALID_HANDLE_VALUE) {                      if (hFileRead == INVALID_HANDLE_VALUE) {
1510                          hFileRead = hFileWrite = CreateFile(                          hFileRead = hFileWrite = CreateFile(
1511                                                       Filename.c_str(), GENERIC_READ,                                                       Filename.c_str(), GENERIC_READ,
1512                                                       FILE_SHARE_READ | FILE_SHARE_WRITE,                                                       FILE_SHARE_READ | FILE_SHARE_WRITE,
1513                                                       NULL, OPEN_EXISTING,                                                       NULL, OPEN_EXISTING,
1514                                                       FILE_ATTRIBUTE_NORMAL, NULL                                                       FILE_ATTRIBUTE_NORMAL |
1515                                                         FILE_FLAG_RANDOM_ACCESS,
1516                                                         NULL
1517                                                   );                                                   );
1518                          throw Exception("Could not (re)open file \"" + Filename + "\" in read mode");                          throw Exception("Could not (re)open file \"" + Filename + "\" in read+write mode");
1519                      }                      }
1520                      #else                      #else
1521                      if (hFileRead) fclose(hFileRead);                      if (hFileRead) fclose(hFileRead);
# Line 1487  namespace RIFF { Line 1549  namespace RIFF {
1549          return false;          return false;
1550      }      }
1551    
1552        /** @brief Set the byte order to be used when saving.
1553         *
1554         * Set the byte order to be used in the file. A value of
1555         * endian_little will create a RIFF file, endian_big a RIFX file
1556         * and endian_native will create a RIFF file on little-endian
1557         * machines and RIFX on big-endian machines.
1558         *
1559         * @param Endian - endianess to use when file is saved.
1560         */
1561        void File::SetByteOrder(endian_t Endian) {
1562            #if WORDS_BIGENDIAN
1563            bEndianNative = Endian != endian_little;
1564            #else
1565            bEndianNative = Endian != endian_big;
1566            #endif
1567        }
1568    
1569      /** @brief Save changes to same file.      /** @brief Save changes to same file.
1570       *       *
1571       * 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 1513  namespace RIFF { Line 1592  namespace RIFF {
1592    
1593          // 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)
1594          unsigned long ulPositiveSizeDiff = 0;          unsigned long ulPositiveSizeDiff = 0;
1595          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) {
1596              if ((*iter)->GetNewSize() == 0) throw Exception("There is at least one empty chunk (zero size)");              if ((*iter)->GetNewSize() == 0) {
1597              if ((*iter)->GetNewSize() + 1L > (*iter)->GetSize()) {                  throw Exception("There is at least one empty chunk (zero size): " + __resolveChunkPath(*iter));
1598                  unsigned long ulDiff = (*iter)->GetNewSize() - (*iter)->GetSize() + 1L; // +1 in case we have to add a pad byte              }
1599                  ulPositiveSizeDiff += ulDiff;              unsigned long newSizePadded = (*iter)->GetNewSize() + (*iter)->GetNewSize() % 2;
1600              }              unsigned long oldSizePadded = (*iter)->GetSize() + (*iter)->GetSize() % 2;
1601                if (newSizePadded > oldSizePadded) ulPositiveSizeDiff += newSizePadded - oldSizePadded;
1602          }          }
1603    
1604          unsigned long ulWorkingFileSize = GetFileSize();          unsigned long ulWorkingFileSize = GetFileSize();
# Line 1534  namespace RIFF { Line 1614  namespace RIFF {
1614              #if defined(WIN32)              #if defined(WIN32)
1615              DWORD iBytesMoved = 1; // we have to pass it via pointer to the Windows API, thus the correct size must be ensured              DWORD iBytesMoved = 1; // we have to pass it via pointer to the Windows API, thus the correct size must be ensured
1616              #else              #else
1617              int iBytesMoved = 1;              int iBytesMoved = 1;
1618              #endif              #endif
1619              for (unsigned long ulPos = 0; iBytesMoved > 0; ulPos += iBytesMoved) {              for (unsigned long ulPos = ulFileSize; iBytesMoved > 0; ) {
1620                  const unsigned long ulToMove = ulFileSize - ulPos;                  iBytesMoved = (ulPos < 4096) ? ulPos : 4096;
1621                  iBytesMoved = (ulToMove < 4096) ? ulToMove : 4096;                  ulPos -= iBytesMoved;
1622                  #if POSIX                  #if POSIX
1623                  lseek(hFileRead, ulPos, SEEK_SET);                  lseek(hFileRead, ulPos, SEEK_SET);
1624                  iBytesMoved = read(hFileRead, pCopyBuffer, iBytesMoved);                  iBytesMoved = read(hFileRead, pCopyBuffer, iBytesMoved);
# Line 1601  namespace RIFF { Line 1681  namespace RIFF {
1681          #elif defined(WIN32)          #elif defined(WIN32)
1682          hFileWrite = CreateFile(          hFileWrite = CreateFile(
1683                           path.c_str(), GENERIC_WRITE, FILE_SHARE_READ,                           path.c_str(), GENERIC_WRITE, FILE_SHARE_READ,
1684                           NULL, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL                           NULL, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL |
1685                             FILE_FLAG_RANDOM_ACCESS, NULL
1686                       );                       );
1687          if (hFileWrite == INVALID_HANDLE_VALUE) {          if (hFileWrite == INVALID_HANDLE_VALUE) {
1688              hFileWrite = hFileRead;              hFileWrite = hFileRead;
# Line 1626  namespace RIFF { Line 1707  namespace RIFF {
1707          // forget all resized chunks          // forget all resized chunks
1708          ResizedChunks.clear();          ResizedChunks.clear();
1709    
1710          if (Filename.length() > 0) {          #if POSIX
1711              #if POSIX          if (hFileWrite) close(hFileWrite);
1712              close(hFileWrite);          #elif defined(WIN32)
1713              #elif defined(WIN32)          if (hFileWrite != INVALID_HANDLE_VALUE) CloseHandle(hFileWrite);
1714              CloseHandle(hFileWrite);          #else
1715              #else          if (hFileWrite) fclose(hFileWrite);
1716              fclose(hFileWrite);          #endif
1717              #endif          hFileWrite = hFileRead;
             hFileWrite = hFileRead;  
         }  
1718    
1719          // associate new file with this File object from now on          // associate new file with this File object from now on
1720          Filename = path;          Filename = path;
# Line 1672  namespace RIFF { Line 1751  namespace RIFF {
1751      }      }
1752    
1753      void File::LogAsResized(Chunk* pResizedChunk) {      void File::LogAsResized(Chunk* pResizedChunk) {
1754          ResizedChunks.push_back(pResizedChunk);          ResizedChunks.insert(pResizedChunk);
1755        }
1756    
1757        void File::UnlogResized(Chunk* pResizedChunk) {
1758            ResizedChunks.erase(pResizedChunk);
1759      }      }
1760    
1761      unsigned long File::GetFileSize() {      unsigned long File::GetFileSize() {
Legend:
Removed from v.1063  
changed lines
  Added in v.1859
  ViewVC Help
Powered by ViewVC