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

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

Parent Directory | Revision Log | View Patch Patch

-revision 2599 by schoenebeck,
Sat Jun  7 00:00:10 2014 UTC
+revision 2912 by schoenebeck,
Tue May 17 14:30:10 2016 UTC
 Line 2
   *                                                                         *
   *   libgig - C++ cross-platform Gigasampler format file access library    *
   *                                                                         *
-  *   Copyright (C) 2003-2014 by Christian Schoenebeck                      *
+  *   Copyright (C) 2003-2016 by Christian Schoenebeck                      *
   *                              <cuse@users.sourceforge.net>               *
   *                                                                         *
   *   This library is free software; you can redistribute it and/or modify  *
 Line 30
  #include <iostream>
  #include <assert.h>
+ /// libgig's current file format version (for extending the original Giga file
+ /// format with libgig's own custom data / custom features).
+ #define GIG_FILE_EXT_VERSION    2
  /// Initial size of the sample buffer which is used for decompression of
  /// compressed sample wave streams - this value should always be bigger than
  /// the biggest sample piece expected to be read by the sampler engine,
-Line 53
+Line 57
  namespace gig {
- // *************** progress_t ***************
- // *
-     progress_t::progress_t() {
-         callback    = NULL;
-         custom      = NULL;
-         __range_min = 0.0f;
-         __range_max = 1.0f;
-     }
-     // private helper function to convert progress of a subprocess into the global progress
-     static void __notify_progress(progress_t* pProgress, float subprogress) {
-         if (pProgress && pProgress->callback) {
-             const float totalrange    = pProgress->__range_max - pProgress->__range_min;
-             const float totalprogress = pProgress->__range_min + subprogress * totalrange;
-             pProgress->factor         = totalprogress;
-             pProgress->callback(pProgress); // now actually notify about the progress
-         }
-     }
-     // private helper function to divide a progress into subprogresses
-     static void __divide_progress(progress_t* pParentProgress, progress_t* pSubProgress, float totalTasks, float currentTask) {
-         if (pParentProgress && pParentProgress->callback) {
-             const float totalrange    = pParentProgress->__range_max - pParentProgress->__range_min;
-             pSubProgress->callback    = pParentProgress->callback;
-             pSubProgress->custom      = pParentProgress->custom;
-             pSubProgress->__range_min = pParentProgress->__range_min + totalrange * currentTask / totalTasks;
-             pSubProgress->__range_max = pSubProgress->__range_min + totalrange / totalTasks;
-         }
-     }
  // *************** Internal functions for sample decompression ***************
  // *
-Line 123 
 namespace {
+Line 95 
 namespace {
      void Decompress16(int compressionmode, const unsigned char* params,
                        int srcStep, int dstStep,
                        const unsigned char* pSrc, int16_t* pDst,
-                       unsigned long currentframeoffset,
+                       file_offset_t currentframeoffset,
-                       unsigned long copysamples)
+                       file_offset_t copysamples)
      {
          switch (compressionmode) {
              case 0: // 16 bit uncompressed
-Line 160 
 namespace {
+Line 132 
 namespace {
      void Decompress24(int compressionmode, const unsigned char* params,
                        int dstStep, const unsigned char* pSrc, uint8_t* pDst,
-                       unsigned long currentframeoffset,
+                       file_offset_t currentframeoffset,
-                       unsigned long copysamples, int truncatedBits)
+                       file_offset_t copysamples, int truncatedBits)
      {
          int y, dy, ddy, dddy;
-Line 367 
 namespace {
+Line 339 
 namespace {
       * @param fileNo         - number of an extension file where this sample
       *                         is located, 0 otherwise
       */
-     Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {
+     Sample::Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {
          static const DLS::Info::string_length_t fixedStringLengths[] = {
              { CHUNK_ID_INAM, 64 },
              { 0, 0 }
-Line 509 
 namespace {
+Line 481 
 namespace {
          const int iReadAtOnce = 32*1024;
          char* buf = new char[iReadAtOnce * orig->FrameSize];
          Sample* pOrig = (Sample*) orig; //HACK: remove constness for now
-         unsigned long restorePos = pOrig->GetPos();
+         file_offset_t restorePos = pOrig->GetPos();
          pOrig->SetPos(0);
          SetPos(0);
-         for (unsigned long n = pOrig->Read(buf, iReadAtOnce); n;
+         for (file_offset_t n = pOrig->Read(buf, iReadAtOnce); n;
                             n = pOrig->Read(buf, iReadAtOnce))
          {
              Write(buf, n);
-Line 528 
 namespace {
+Line 500 
 namespace {
       * Usually there is absolutely no need to call this method explicitly.
       * It will be called automatically when File::Save() was called.
       *
+      * @param pProgress - callback function for progress notification
       * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data
       *                        was provided yet
       * @throws gig::Exception if there is any invalid sample setting
       */
-     void Sample::UpdateChunks() {
+     void Sample::UpdateChunks(progress_t* pProgress) {
          // first update base class's chunks
-         DLS::Sample::UpdateChunks();
+         DLS::Sample::UpdateChunks(pProgress);
          // make sure 'smpl' chunk exists
          pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);
-Line 596 
 namespace {
+Line 569 
 namespace {
      void Sample::ScanCompressedSample() {
          //TODO: we have to add some more scans here (e.g. determine compression rate)
          this->SamplesTotal = 0;
-         std::list<unsigned long> frameOffsets;
+         std::list<file_offset_t> frameOffsets;
          SamplesPerFrame = BitDepth == 24 ? 256 : 2048;
          WorstCaseFrameSize = SamplesPerFrame * FrameSize + Channels; // +Channels for compression flag
-Line 612 
 namespace {
+Line 585 
 namespace {
                  const int mode_l = pCkData->ReadUint8();
                  const int mode_r = pCkData->ReadUint8();
                  if (mode_l > 5 || mode_r > 5) throw gig::Exception("Unknown compression mode");
-                 const unsigned long frameSize = bytesPerFrame[mode_l] + bytesPerFrame[mode_r];
+                 const file_offset_t frameSize = bytesPerFrame[mode_l] + bytesPerFrame[mode_r];
                  if (pCkData->RemainingBytes() <= frameSize) {
                      SamplesInLastFrame =
-Line 631 
 namespace {
+Line 604 
 namespace {
                  const int mode = pCkData->ReadUint8();
                  if (mode > 5) throw gig::Exception("Unknown compression mode");
-                 const unsigned long frameSize = bytesPerFrame[mode];
+                 const file_offset_t frameSize = bytesPerFrame[mode];
                  if (pCkData->RemainingBytes() <= frameSize) {
                      SamplesInLastFrame =
-Line 647 
 namespace {
+Line 620 
 namespace {
          // Build the frames table (which is used for fast resolving of a frame's chunk offset)
          if (FrameTable) delete[] FrameTable;
-         FrameTable = new unsigned long[frameOffsets.size()];
+         FrameTable = new file_offset_t[frameOffsets.size()];
-         std::list<unsigned long>::iterator end  = frameOffsets.end();
+         std::list<file_offset_t>::iterator end  = frameOffsets.end();
-         std::list<unsigned long>::iterator iter = frameOffsets.begin();
+         std::list<file_offset_t>::iterator iter = frameOffsets.begin();
          for (int i = 0; iter != end; i++, iter++) {
              FrameTable[i] = *iter;
          }
-Line 690 
 namespace {
+Line 663 
 namespace {
       *                      the cached sample data in bytes
       * @see                 ReleaseSampleData(), Read(), SetPos()
       */
-     buffer_t Sample::LoadSampleData(unsigned long SampleCount) {
+     buffer_t Sample::LoadSampleData(file_offset_t SampleCount) {
          return LoadSampleDataWithNullSamplesExtension(SampleCount, 0); // 0 amount of NullSamples
      }
-Line 749 
 namespace {
+Line 722 
 namespace {
       *                           size of the cached sample data in bytes
       * @see                      ReleaseSampleData(), Read(), SetPos()
       */
-     buffer_t Sample::LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount) {
+     buffer_t Sample::LoadSampleDataWithNullSamplesExtension(file_offset_t SampleCount, uint NullSamplesCount) {
          if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;
          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
-         unsigned long allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;
+         file_offset_t allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;
          SetPos(0); // reset read position to begin of sample
          RAMCache.pStart            = new int8_t[allocationsize];
          RAMCache.Size              = Read(RAMCache.pStart, SampleCount) * this->FrameSize;
-Line 850 
 namespace {
+Line 823 
 namespace {
       * @returns            the new sample position
       * @see                Read()
       */
-     unsigned long Sample::SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence) {
+     file_offset_t Sample::SetPos(file_offset_t SampleCount, RIFF::stream_whence_t Whence) {
          if (Compressed) {
              switch (Whence) {
                  case RIFF::stream_curpos:
-Line 868 
 namespace {
+Line 841 
 namespace {
              }
              if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;
-             unsigned long frame = this->SamplePos / 2048; // to which frame to jump
+             file_offset_t frame = this->SamplePos / 2048; // to which frame to jump
              this->FrameOffset   = this->SamplePos % 2048; // offset (in sample points) within that frame
              pCkData->SetPos(FrameTable[frame]);           // set chunk pointer to the start of sought frame
              return this->SamplePos;
          }
          else { // not compressed
-             unsigned long orderedBytes = SampleCount * this->FrameSize;
+             file_offset_t orderedBytes = SampleCount * this->FrameSize;
-             unsigned long result = pCkData->SetPos(orderedBytes, Whence);
+             file_offset_t result = pCkData->SetPos(orderedBytes, Whence);
              return (result == orderedBytes) ? SampleCount
                                              : result / this->FrameSize;
          }
-Line 884 
 namespace {
+Line 857 
 namespace {
      /**
       * Returns the current position in the sample (in sample points).
       */
-     unsigned long Sample::GetPos() const {
+     file_offset_t Sample::GetPos() const {
          if (Compressed) return SamplePos;
          else            return pCkData->GetPos() / FrameSize;
      }
-Line 923 
 namespace {
+Line 896 
 namespace {
       * @returns                number of successfully read sample points
       * @see                    CreateDecompressionBuffer()
       */
-     unsigned long Sample::ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState,
+     file_offset_t Sample::ReadAndLoop(void* pBuffer, file_offset_t SampleCount, playback_state_t* pPlaybackState,
                                        DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {
-         unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;
+         file_offset_t samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;
          uint8_t* pDst = (uint8_t*) pBuffer;
          SetPos(pPlaybackState->position); // recover position from the last time
-Line 963 
 namespace {
+Line 936 
 namespace {
                                  // reading, swap all sample frames so it reflects
                                  // backward playback
-                                 unsigned long swapareastart       = totalreadsamples;
+                                 file_offset_t swapareastart       = totalreadsamples;
-                                 unsigned long loopoffset          = GetPos() - loop.LoopStart;
+                                 file_offset_t loopoffset          = GetPos() - loop.LoopStart;
-                                 unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);
+                                 file_offset_t samplestoreadinloop = Min(samplestoread, loopoffset);
-                                 unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;
+                                 file_offset_t reverseplaybackend  = GetPos() - samplestoreadinloop;
                                  SetPos(reverseplaybackend);
-Line 1014 
 namespace {
+Line 987 
 namespace {
                          // reading, swap all sample frames so it reflects
                          // backward playback
-                         unsigned long swapareastart       = totalreadsamples;
+                         file_offset_t swapareastart       = totalreadsamples;
-                         unsigned long loopoffset          = GetPos() - loop.LoopStart;
+                         file_offset_t loopoffset          = GetPos() - loop.LoopStart;
-                         unsigned long samplestoreadinloop = (this->LoopPlayCount) ? Min(samplestoread, pPlaybackState->loop_cycles_left * loop.LoopLength - loopoffset)
+                         file_offset_t samplestoreadinloop = (this->LoopPlayCount) ? Min(samplestoread, pPlaybackState->loop_cycles_left * loop.LoopLength - loopoffset)
                                                                                    : samplestoread;
-                         unsigned long reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);
+                         file_offset_t reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);
                          SetPos(reverseplaybackend);
-Line 1098 
 namespace {
+Line 1071 
 namespace {
       * @returns            number of successfully read sample points
       * @see                SetPos(), CreateDecompressionBuffer()
       */
-     unsigned long Sample::Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer) {
+     file_offset_t Sample::Read(void* pBuffer, file_offset_t SampleCount, buffer_t* pExternalDecompressionBuffer) {
          if (SampleCount == 0) return 0;
          if (!Compressed) {
              if (BitDepth == 24) {
-Line 1113 
 namespace {
+Line 1086 
 namespace {
          else {
              if (this->SamplePos >= this->SamplesTotal) return 0;
              //TODO: efficiency: maybe we should test for an average compression rate
-             unsigned long assumedsize      = GuessSize(SampleCount),
+             file_offset_t assumedsize      = GuessSize(SampleCount),
                            remainingbytes   = 0,           // remaining bytes in the local buffer
                            remainingsamples = SampleCount,
                            copysamples, skipsamples,
-Line 1136 
 namespace {
+Line 1109 
 namespace {
              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);
              while (remainingsamples && remainingbytes) {
-                 unsigned long framesamples = SamplesPerFrame;
+                 file_offset_t framesamples = SamplesPerFrame;
-                 unsigned long framebytes, rightChannelOffset = 0, nextFrameOffset;
+                 file_offset_t framebytes, rightChannelOffset = 0, nextFrameOffset;
                  int mode_l = *pSrc++, mode_r = 0;
-Line 1287 
 namespace {
+Line 1260 
 namespace {
       * @throws gig::Exception if sample is compressed
       * @see DLS::LoadSampleData()
       */
-     unsigned long Sample::Write(void* pBuffer, unsigned long SampleCount) {
+     file_offset_t Sample::Write(void* pBuffer, file_offset_t SampleCount) {
          if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");
          // if this is the first write in this sample, reset the
-Line 1296 
 namespace {
+Line 1269 
 namespace {
              __resetCRC(crc);
          }
          if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");
-         unsigned long res;
+         file_offset_t res;
          if (BitDepth == 24) {
              res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
          } else { // 16 bit
-Line 1330 
 namespace {
+Line 1303 
 namespace {
       * @returns allocated decompression buffer
       * @see DestroyDecompressionBuffer()
       */
-     buffer_t Sample::CreateDecompressionBuffer(unsigned long MaxReadSize) {
+     buffer_t Sample::CreateDecompressionBuffer(file_offset_t MaxReadSize) {
          buffer_t result;
          const double worstCaseHeaderOverhead =
                  (256.0 /*frame size*/ + 12.0 /*header*/ + 2.0 /*compression type flag (stereo)*/) / 256.0;
-         result.Size              = (unsigned long) (double(MaxReadSize) * 3.0 /*(24 Bit)*/ * 2.0 /*stereo*/ * worstCaseHeaderOverhead);
+         result.Size              = (file_offset_t) (double(MaxReadSize) * 3.0 /*(24 Bit)*/ * 2.0 /*stereo*/ * worstCaseHeaderOverhead);
          result.pStart            = new int8_t[result.Size];
          result.NullExtensionSize = 0;
          return result;
-Line 1752 
 namespace {
+Line 1725 
 namespace {
       *
       * Usually there is absolutely no need to call this method explicitly.
       * It will be called automatically when File::Save() was called.
+      *
+      * @param pProgress - callback function for progress notification
       */
-     void DimensionRegion::UpdateChunks() {
+     void DimensionRegion::UpdateChunks(progress_t* pProgress) {
          // first update base class's chunk
-         DLS::Sampler::UpdateChunks();
+         DLS::Sampler::UpdateChunks(pProgress);
          RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);
          uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();
-Line 3026 
 namespace {
+Line 3001 
 namespace {
       * Usually there is absolutely no need to call this method explicitly.
       * It will be called automatically when File::Save() was called.
       *
+      * @param pProgress - callback function for progress notification
       * @throws gig::Exception if samples cannot be dereferenced
       */
-     void Region::UpdateChunks() {
+     void Region::UpdateChunks(progress_t* pProgress) {
          // in the gig format we don't care about the Region's sample reference
          // but we still have to provide some existing one to not corrupt the
          // file, so to avoid the latter we simply always assign the sample of
-Line 3036 
 namespace {
+Line 3012 
 namespace {
          pSample = pDimensionRegions[0]->pSample;
          // first update base class's chunks
-         DLS::Region::UpdateChunks();
+         DLS::Region::UpdateChunks(pProgress);
          // update dimension region's chunks
          for (int i = 0; i < DimensionRegions; i++) {
-             pDimensionRegions[i]->UpdateChunks();
+             pDimensionRegions[i]->UpdateChunks(pProgress);
          }
          File* pFile = (File*) GetParent()->GetParent();
-Line 3652 
 namespace {
+Line 3628 
 namespace {
          UpdateVelocityTable();
      }
+     /** @brief Change type of an existing dimension.
+      *
+      * Alters the dimension type of a dimension already existing on this
+      * region. If there is currently no dimension on this Region with type
+      * @a oldType, then this call with throw an Exception. Likewise there are
+      * cases where the requested dimension type cannot be performed. For example
+      * if the new dimension type shall be gig::dimension_samplechannel, and the
+      * current dimension has more than 2 zones. In such cases an Exception is
+      * thrown as well.
+      *
+      * @param oldType - identifies the existing dimension to be changed
+      * @param newType - to which dimension type it should be changed to
+      * @throws gig::Exception if requested change cannot be performed
+      */
+     void Region::SetDimensionType(dimension_t oldType, dimension_t newType) {
+         if (oldType == newType) return;
+         dimension_def_t* def = GetDimensionDefinition(oldType);
+         if (!def)
+             throw gig::Exception("No dimension with provided old dimension type exists on this region");
+         if (newType == dimension_samplechannel && def->zones != 2)
+             throw gig::Exception("Cannot change to dimension type 'sample channel', because existing dimension does not have 2 zones");
+         if (GetDimensionDefinition(newType))
+             throw gig::Exception("There is already a dimension with requested new dimension type on this region");
+         def->dimension  = newType;
+         def->split_type = __resolveSplitType(newType);
+     }
      DimensionRegion* Region::GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase) {
          uint8_t bits[8] = {};
          for (std::map<dimension_t,int>::const_iterator it = DimCase.begin();
-Line 3847 
 namespace {
+Line 3850 
 namespace {
          if ((int32_t)WavePoolTableIndex == -1) return NULL;
          File* file = (File*) GetParent()->GetParent();
          if (!file->pWavePoolTable) return NULL;
-         unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
+         if (file->HasMonolithicLargeFilePolicy()) {
-         unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
+             uint64_t soughtoffset =
-         Sample* sample = file->GetFirstSample(pProgress);
+                 uint64_t(file->pWavePoolTable[WavePoolTableIndex]) |
-         while (sample) {
+                 uint64_t(file->pWavePoolTableHi[WavePoolTableIndex]) << 32;
-             if (sample->ulWavePoolOffset == soughtoffset &&
+             Sample* sample = file->GetFirstSample(pProgress);
-                 sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
+             while (sample) {
-             sample = file->GetNextSample();
+                 if (sample->ullWavePoolOffset == soughtoffset)
+                     return static_cast<gig::Sample*>(sample);
+                 sample = file->GetNextSample();
+             }
+         } else {
+             file_offset_t soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
+             file_offset_t soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
+             Sample* sample = file->GetFirstSample(pProgress);
+             while (sample) {
+                 if (sample->ullWavePoolOffset == soughtoffset &&
+                     sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
+                 sample = file->GetNextSample();
+             }
          }
          return NULL;
      }
-Line 4094 
 namespace {
+Line 4109 
 namespace {
              for (int i = 0; i < nameSize; ++i)
                  Name[i] = ckScri->ReadUint8();
              // to handle potential future extensions of the header
-             ckScri->SetPos(headerSize - 6*sizeof(int32_t) + nameSize, RIFF::stream_curpos);
+             ckScri->SetPos(sizeof(int32_t) + headerSize);
              // read actual script data
              uint32_t scriptSize = ckScri->GetSize() - ckScri->GetPos();
              data.resize(scriptSize);
-Line 4134 
 namespace {
+Line 4149 
 namespace {
          memcpy(&data[0], &text[0], text.size());
      }
-     void Script::UpdateChunks() {
+     /**
+      * Apply this script to the respective RIFF chunks. You have to call
+      * File::Save() to make changes persistent.
+      *
+      * Usually there is absolutely no need to call this method explicitly.
+      * It will be called automatically when File::Save() was called.
+      *
+      * @param pProgress - callback function for progress notification
+      */
+     void Script::UpdateChunks(progress_t* pProgress) {
          // recalculate CRC32 check sum
          __resetCRC(crc);
          __calculateCRC(&data[0], data.size(), crc);
-Line 4173 
 namespace {
+Line 4197 
 namespace {
       * @param pGroup - script's new group
       */
      void Script::SetGroup(ScriptGroup* pGroup) {
-         if (this->pGroup = pGroup) return;
+         if (this->pGroup == pGroup) return;
          if (pChunk)
              pChunk->GetParent()->MoveSubChunk(pChunk, pGroup->pList);
          this->pGroup = pGroup;
      }
+     /**
+      * Returns the script group this script currently belongs to. Each script
+      * is a member of exactly one ScriptGroup.
+      *
+      * @returns current script group
+      */
+     ScriptGroup* Script::GetGroup() const {
+         return pGroup;
+     }
      void Script::RemoveAllScriptReferences() {
          File* pFile = pGroup->pFile;
          for (int i = 0; pFile->GetInstrument(i); ++i) {
-Line 4214 
 namespace {
+Line 4248 
 namespace {
          }
      }
-     void ScriptGroup::UpdateChunks() {
+     /**
+      * Apply this script group to the respective RIFF chunks. You have to call
+      * File::Save() to make changes persistent.
+      *
+      * Usually there is absolutely no need to call this method explicitly.
+      * It will be called automatically when File::Save() was called.
+      *
+      * @param pProgress - callback function for progress notification
+      */
+     void ScriptGroup::UpdateChunks(progress_t* pProgress) {
          if (pScripts) {
              if (!pList)
                  pList = pFile->pRIFF->GetSubList(LIST_TYPE_3LS)->AddSubList(LIST_TYPE_RTIS);
-Line 4225 
 namespace {
+Line 4268 
 namespace {
              for (std::list<Script*>::iterator it = pScripts->begin();
                   it != pScripts->end(); ++it)
              {
-                 (*it)->UpdateChunks();
+                 (*it)->UpdateChunks(pProgress);
              }
          }
      }
-Line 4388 
 namespace {
+Line 4431 
 namespace {
          if (lst3LS) {
              RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
              if (ckSCSL) {
-                 int slotCount = ckSCSL->ReadUint32();
+                 int headerSize = ckSCSL->ReadUint32();
-                 int slotSize  = ckSCSL->ReadUint32();
+                 int slotCount  = ckSCSL->ReadUint32();
-                 int unknownSpace = slotSize - 2*sizeof(uint32_t); // in case of future extensions
+                 if (slotCount) {
-                 for (int i = 0; i < slotCount; ++i) {
+                     int slotSize  = ckSCSL->ReadUint32();
-                     _ScriptPooolEntry e;
+                     ckSCSL->SetPos(headerSize); // in case of future header extensions
-                     e.fileOffset = ckSCSL->ReadUint32();
+                     int unknownSpace = slotSize - 2*sizeof(uint32_t); // in case of future slot extensions
-                     e.bypass     = ckSCSL->ReadUint32() & 1;
+                     for (int i = 0; i < slotCount; ++i) {
-                     if (unknownSpace) ckSCSL->SetPos(unknownSpace, RIFF::stream_curpos); // in case of future extensions
+                         _ScriptPooolEntry e;
-                     scriptPoolFileOffsets.push_back(e);
+                         e.fileOffset = ckSCSL->ReadUint32();
+                         e.bypass     = ckSCSL->ReadUint32() & 1;
+                         if (unknownSpace) ckSCSL->SetPos(unknownSpace, RIFF::stream_curpos); // in case of future extensions
+                         scriptPoolFileOffsets.push_back(e);
+                     }
                  }
              }
          }
-Line 4431 
 namespace {
+Line 4478 
 namespace {
       * Usually there is absolutely no need to call this method explicitly.
       * It will be called automatically when File::Save() was called.
       *
+      * @param pProgress - callback function for progress notification
       * @throws gig::Exception if samples cannot be dereferenced
       */
-     void Instrument::UpdateChunks() {
+     void Instrument::UpdateChunks(progress_t* pProgress) {
          // first update base classes' chunks
-         DLS::Instrument::UpdateChunks();
+         DLS::Instrument::UpdateChunks(pProgress);
          // update Regions' chunks
          {
              RegionList::iterator iter = pRegions->begin();
              RegionList::iterator end  = pRegions->end();
              for (; iter != end; ++iter)
-                 (*iter)->UpdateChunks();
+                 (*iter)->UpdateChunks(pProgress);
          }
          // make sure 'lart' RIFF list chunk exists
-Line 4479 
 namespace {
+Line 4527 
 namespace {
          }
          // own gig format extensions
-        if (pScriptRefs) {
+        if (ScriptSlotCount()) {
+            // make sure we have converted the original loaded script file
+            // offsets into valid Script object pointers
+            LoadScripts();
             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
             if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);
-            const int totalSize = pScriptRefs->size() * 2*sizeof(uint32_t);
+            const int slotCount = pScriptRefs->size();
+            const int headerSize = 3 * sizeof(uint32_t);
+            const int slotSize  = 2 * sizeof(uint32_t);
+            const int totalChunkSize = headerSize + slotCount * slotSize;
             RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
-            if (!ckSCSL) ckSCSL = lst3LS->AddSubChunk(CHUNK_ID_SCSL, totalSize);
+            if (!ckSCSL) ckSCSL = lst3LS->AddSubChunk(CHUNK_ID_SCSL, totalChunkSize);
-            else ckSCSL->Resize(totalSize);
+            else ckSCSL->Resize(totalChunkSize);
             uint8_t* pData = (uint8_t*) ckSCSL->LoadChunkData();
-            for (int i = 0, pos = 0; i < pScriptRefs->size(); ++i) {
+            int pos = 0;
-                int fileOffset =
+            store32(&pData[pos], headerSize);
-                     (*pScriptRefs)[i].script->pChunk->GetFilePos() -
+            pos += sizeof(uint32_t);
-                     (*pScriptRefs)[i].script->pChunk->GetPos() -
+            store32(&pData[pos], slotCount);
-                     CHUNK_HEADER_SIZE;
+            pos += sizeof(uint32_t);
-                store32(&pData[pos], fileOffset);
+            store32(&pData[pos], slotSize);
+            pos += sizeof(uint32_t);
+            for (int i = 0; i < slotCount; ++i) {
+                // arbitrary value, the actual file offset will be updated in
+                // UpdateScriptFileOffsets() after the file has been resized
+                int bogusFileOffset = 0;
+                store32(&pData[pos], bogusFileOffset);
                 pos += sizeof(uint32_t);
                 store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0);
                 pos += sizeof(uint32_t);
             }
+        } else {
+            // no script slots, so get rid of any LS custom RIFF chunks (if any)
+            RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
+            if (lst3LS) pCkInstrument->DeleteSubChunk(lst3LS);
         }
      }
+     void Instrument::UpdateScriptFileOffsets() {
+        // own gig format extensions
+        if (pScriptRefs && pScriptRefs->size() > 0) {
+            RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
+            RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
+            const int slotCount = pScriptRefs->size();
+            const int headerSize = 3 * sizeof(uint32_t);
+            ckSCSL->SetPos(headerSize);
+            for (int i = 0; i < slotCount; ++i) {
+                uint32_t fileOffset =
+                     (*pScriptRefs)[i].script->pChunk->GetFilePos() -
+                     (*pScriptRefs)[i].script->pChunk->GetPos() -
+                     CHUNK_HEADER_SIZE(ckSCSL->GetFile()->GetFileOffsetSize());
+                ckSCSL->WriteUint32(&fileOffset);
+                // jump over flags entry (containing the bypass flag)
+                ckSCSL->SetPos(sizeof(uint32_t), RIFF::stream_curpos);
+            }
+        }
+     }
      /**
       * Returns the appropriate Region for a triggered note.
       *
-Line 4567 
 namespace {
+Line 4652 
 namespace {
      }
      /**
+      * Move this instrument at the position before @arg dst.
+      *
+      * This method can be used to reorder the sequence of instruments in a
+      * .gig file. This might be helpful especially on large .gig files which
+      * contain a large number of instruments within the same .gig file. So
+      * grouping such instruments to similar ones, can help to keep track of them
+      * when working with such complex .gig files.
+      *
+      * When calling this method, this instrument will be removed from in its
+      * current position in the instruments list and moved to the requested
+      * target position provided by @param dst. You may also pass NULL as
+      * argument to this method, in that case this intrument will be moved to the
+      * very end of the .gig file's instrument list.
+      *
+      * You have to call Save() to make the order change persistent to the .gig
+      * file.
+      *
+      * Currently this method is limited to moving the instrument within the same
+      * .gig file. Trying to move it to another .gig file by calling this method
+      * will throw an exception.
+      *
+      * @param dst - destination instrument at which this instrument will be
+      *              moved to, or pass NULL for moving to end of list
+      * @throw gig::Exception if this instrument and target instrument are not
+      *                       part of the same file
+      */
+     void Instrument::MoveTo(Instrument* dst) {
+         if (dst && GetParent() != dst->GetParent())
+             throw Exception(
+                 "gig::Instrument::MoveTo() can only be used for moving within "
+                 "the same gig file."
+             );
+         File* pFile = (File*) GetParent();
+         // move this instrument within the instrument list
+         {
+             File::InstrumentList& list = *pFile->pInstruments;
+             File::InstrumentList::iterator itFrom =
+                 std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(this));
+             File::InstrumentList::iterator itTo =
+                 std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(dst));
+             list.splice(itTo, list, itFrom);
+         }
+         // move the instrument's actual list RIFF chunk appropriately
+         RIFF::List* lstCkInstruments = pFile->pRIFF->GetSubList(LIST_TYPE_LINS);
+         lstCkInstruments->MoveSubChunk(
+             this->pCkInstrument,
+             (RIFF::Chunk*) ((dst) ? dst->pCkInstrument : NULL)
+         );
+     }
+     /**
       * Returns a MIDI rule of the instrument.
       *
       * The list of MIDI rules, at least in gig v3, always contains at
-Line 4635 
 namespace {
+Line 4777 
 namespace {
          if (scriptPoolFileOffsets.empty()) return;
          File* pFile = (File*) GetParent();
          for (uint k = 0; k < scriptPoolFileOffsets.size(); ++k) {
-             uint32_t offset = scriptPoolFileOffsets[k].fileOffset;
+             uint32_t soughtOffset = scriptPoolFileOffsets[k].fileOffset;
              for (uint i = 0; pFile->GetScriptGroup(i); ++i) {
                  ScriptGroup* group = pFile->GetScriptGroup(i);
                  for (uint s = 0; group->GetScript(s); ++s) {
                      Script* script = group->GetScript(s);
                      if (script->pChunk) {
-                         script->pChunk->SetPos(0);
+                         uint32_t offset = script->pChunk->GetFilePos() -
-                         if (script->pChunk->GetFilePos() -
+                                           script->pChunk->GetPos() -
-                             script->pChunk->GetPos() -
+                                           CHUNK_HEADER_SIZE(script->pChunk->GetFile()->GetFileOffsetSize());
-                             CHUNK_HEADER_SIZE == offset)
+                         if (offset == soughtOffset)
                          {
                              _ScriptPooolRef ref;
                              ref.script = script;
-Line 4926 
 namespace {
+Line 5068 
 namespace {
       *
       * Usually there is absolutely no need to call this method explicitly.
       * It will be called automatically when File::Save() was called.
+      *
+      * @param pProgress - callback function for progress notification
       */
-     void Group::UpdateChunks() {
+     void Group::UpdateChunks(progress_t* pProgress) {
          // make sure <3gri> and <3gnl> list chunks exist
          RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);
          if (!_3gri) {
-Line 5205 
 namespace {
+Line 5349 
 namespace {
          // check if samples should be loaded from extension files
          int lastFileNo = 0;
-         for (int i = 0 ; i < WavePoolCount ; i++) {
+         if (!HasMonolithicLargeFilePolicy()) {
-             if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];
+             for (int i = 0 ; i < WavePoolCount ; i++) {
+                 if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];
+             }
          }
          String name(pRIFF->GetFileName());
          int nameLen = name.length();
-Line 5216 
 namespace {
+Line 5362 
 namespace {
          for (int fileNo = 0 ; ; ) {
              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
              if (wvpl) {
-                 unsigned long wvplFileOffset = wvpl->GetFilePos();
+                 file_offset_t wvplFileOffset = wvpl->GetFilePos();
                  RIFF::List* wave = wvpl->GetFirstSubList();
                  while (wave) {
                      if (wave->GetListType() == LIST_TYPE_WAVE) {
-Line 5224 
 namespace {
+Line 5370 
 namespace {
                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
                          __notify_progress(pProgress, subprogress);
-                         unsigned long waveFileOffset = wave->GetFilePos();
+                         file_offset_t waveFileOffset = wave->GetFilePos();
                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));
                          iSampleIndex++;
-Line 5695 
 namespace {
+Line 5841 
 namespace {
          }
      }
+     /** @brief Returns the version number of libgig's Giga file format extension.
+      *
+      * libgig added several new features which were not available with the
+      * original GigaStudio software. For those purposes libgig's own custom RIFF
+      * chunks were added to the Giga file format.
+      *
+      * This method returns the version number of the Giga file format extension
+      * used in this Giga file. Currently there are 3 possible values that might
+      * be returned by this method:
+      *
+      * - @c 0: This gig file is not using any libgig specific file format
+      *         extension at all.
+      * - @c 1: This gig file uses the RT instrument script format extension.
+      * - @c 2: This gig file additionally provides support for monolithic
+      *         large gig files (larger than 2 GB).
+      *
+      * @note This method is currently protected and shall not be used as public
+      * API method, since its method signature might change in future.
+      */
+     uint File::GetFormatExtensionVersion() const {
+         RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);
+         if (!lst3LS) return 0; // is not using custom Giga format extensions at all
+         RIFF::Chunk* ckFFmt = lst3LS->GetSubChunk(CHUNK_ID_FFMT);
+         if (!ckFFmt) return 1; // uses custom Giga format extension(s) but had no format version saved
+         uint8_t* pData = (uint8_t*) ckFFmt->LoadChunkData();
+         return load32(pData);
+     }
+     /** @brief Returns true in case this file is stored as one, single monolithic gig file.
+      *
+      * To avoid issues with operating systems which did not support large files
+      * (larger than 2 GB) the original Giga file format avoided to ever save gig
+      * files larger than 2 GB, instead such large Giga files were splitted into
+      * several files, each one not being larger than 2 GB. It used a predefined
+      * file name scheme for them like this:
+      * @code
+      * foo.gig
+      * foo.gx01
+      * foo.gx02
+      * foo.gx03
+      * ...
+      * @endcode
+      * So when like in this example foo.gig was loaded, all other files
+      * (foo.gx01, ...) were automatically loaded as well to make up the overall
+      * large gig file (provided they were located at the same directory). Such
+      * additional .gxYY files were called "extension files".
+      *
+      * Since nowadays all modern systems support large files, libgig always
+      * saves large gig files as one single monolithic gig file instead, that
+      * is libgig won't split such a large gig file into separate files like the
+      * original GigaStudio software did. It uses a custom Giga file format
+      * extension for this feature.
+      *
+      * For still being able though to load old splitted gig files and the new
+      * large monolithic ones, this method is used to determine which loading
+      * policy must be used for this gig file.
+      *
+      * @note This method is currently protected and shall not be used as public
+      * API method, since its method signature might change in future and since
+      * this method should not be directly relevant for applications based on
+      * libgig.
+      */
+     bool File::HasMonolithicLargeFilePolicy() const {
+         RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);
+         if (!lst3LS) return false;
+         RIFF::Chunk* ckFFmt = lst3LS->GetSubChunk(CHUNK_ID_FFMT);
+         if (!ckFFmt) return false;
+         uint8_t* pData = (uint8_t*) ckFFmt->LoadChunkData();
+         uint32_t formatBitField = load32(&pData[4]);
+         return formatBitField & 1;
+     }
      /**
       * Apply all the gig file's current instruments, samples, groups and settings
       * to the respective RIFF chunks. You have to call Save() to make changes
-Line 5703 
 namespace {
+Line 5921 
 namespace {
       * Usually there is absolutely no need to call this method explicitly.
       * It will be called automatically when File::Save() was called.
       *
+      * @param pProgress - callback function for progress notification
       * @throws Exception - on errors
       */
-     void File::UpdateChunks() {
+     void File::UpdateChunks(progress_t* pProgress) {
          bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;
          b64BitWavePoolOffsets = pVersion && pVersion->major == 3;
          // update own gig format extension chunks
          // (not part of the GigaStudio 4 format)
+         RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);
+         if (!lst3LS) {
+             lst3LS = pRIFF->AddSubList(LIST_TYPE_3LS);
+         }
+         // Make sure <3LS > chunk is placed before <ptbl> chunk. The precise
+         // location of <3LS > is irrelevant, however it MUST BE located BEFORE
+         // the actual wave data, otherwise the <3LS > chunk becomes
+         // inaccessible on gig files larger than 4GB !
+         RIFF::Chunk* ckPTBL = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
+         pRIFF->MoveSubChunk(lst3LS, ckPTBL);
+         // Update <FFmt> chunk with informations about our file format
+         // extensions. Currently this <FFmt> chunk has the following
+         // layout:
          //
+         // <uint32> -> (libgig's) File Format Extension version
+         // <uint32> -> Format bit field:
+         //             bit 0: If flag is not set use separate .gx01
+         //                    extension files if file is larger than 2 GB
+         //                    like with the original Giga format, if flag
+         //                    is set use 64 bit sample references and keep
+         //                    everything as one single monolithic gig file.
+         RIFF::Chunk* ckFFmt = lst3LS->GetSubChunk(CHUNK_ID_FFMT);
+         if (!ckFFmt) {
+             const int iChunkSize = 2 * sizeof(uint32_t);
+             ckFFmt = lst3LS->AddSubChunk(CHUNK_ID_FFMT, iChunkSize);
+         }
+         {
+             uint8_t* pData = (uint8_t*) ckFFmt->LoadChunkData();
+             store32(&pData[0], GIG_FILE_EXT_VERSION);
+             // for now we always save gig files larger than 2 GB as one
+             // single monolithic file (saving those with extension files is
+             // currently not supported and probably also not desired anymore
+             // nowadays).
+             uint32_t formatBitfield = 1;
+             store32(&pData[4], formatBitfield);
+         }
          // This must be performed before writing the chunks for instruments,
          // because the instruments' script slots will write the file offsets
          // of the respective instrument script chunk as reference.
          if (pScriptGroups) {
-             RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);
+             // Update instrument script (group) chunks.
-             if (pScriptGroups->empty()) {
+             for (std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
-                 if (lst3LS) pRIFF->DeleteSubChunk(lst3LS);
+                  it != pScriptGroups->end(); ++it)
-             } else {
+             {
-                 if (!lst3LS) lst3LS = pRIFF->AddSubList(LIST_TYPE_3LS);
+                 (*it)->UpdateChunks(pProgress);
-                 // Update instrument script (group) chunks.
-                 for (std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
-                      it != pScriptGroups->end(); ++it)
-                 {
-                     (*it)->UpdateChunks();
-                 }
              }
          }
          // first update base class's chunks
-         DLS::File::UpdateChunks();
+         DLS::File::UpdateChunks(pProgress);
          if (newFile) {
              // INFO was added by Resource::UpdateChunks - make sure it
-Line 5771 
 namespace {
+Line 6018 
 namespace {
              std::list<Group*>::iterator iter = pGroups->begin();
              std::list<Group*>::iterator end  = pGroups->end();
              for (; iter != end; ++iter) {
-                 (*iter)->UpdateChunks();
+                 (*iter)->UpdateChunks(pProgress);
              }
          }
-Line 5903 
 namespace {
+Line 6150 
 namespace {
              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
          }
      }
+     void File::UpdateFileOffsets() {
+         DLS::File::UpdateFileOffsets();
+         for (Instrument* instrument = GetFirstInstrument(); instrument;
+              instrument = GetNextInstrument())
+         {
+             instrument->UpdateScriptFileOffsets();
+         }
+     }
      /**
       * Enable / disable automatic loading. By default this properyt is

 Legend:



Removed from v.2599
 


changed lines


 
Added in v.2912
 Legend:



Removed from v.2599
 


changed lines


 
Added in v.2912
-Removed from v.2599
+Added in v.2912

	ViewVC Help
Powered by ViewVC