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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2593 by schoenebeck, Wed Jun 4 01:59:56 2014 UTC revision 3623 by schoenebeck, Wed Oct 2 16:30:29 2019 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-2014 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2019 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 24  Line 24 
24  #include "gig.h"  #include "gig.h"
25    
26  #include "helper.h"  #include "helper.h"
27    #include "Serialization.h"
28    
29  #include <algorithm>  #include <algorithm>
30  #include <math.h>  #include <math.h>
31  #include <iostream>  #include <iostream>
32  #include <assert.h>  #include <assert.h>
33    
34    /// libgig's current file format version (for extending the original Giga file
35    /// format with libgig's own custom data / custom features).
36    #define GIG_FILE_EXT_VERSION    2
37    
38  /// Initial size of the sample buffer which is used for decompression of  /// Initial size of the sample buffer which is used for decompression of
39  /// compressed sample wave streams - this value should always be bigger than  /// compressed sample wave streams - this value should always be bigger than
40  /// the biggest sample piece expected to be read by the sampler engine,  /// the biggest sample piece expected to be read by the sampler engine,
# Line 51  Line 56 
56  #define GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(x)    ((x & 0x03) << 3)  #define GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(x)    ((x & 0x03) << 3)
57  #define GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(x)  ((x & 0x03) << 5)  #define GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(x)  ((x & 0x03) << 5)
58    
59  namespace gig {  #define SRLZ(member) \
60        archive->serializeMember(*this, member, #member);
 // *************** 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;  
         }  
     }  
61    
62    namespace gig {
63    
64  // *************** Internal functions for sample decompression ***************  // *************** Internal functions for sample decompression ***************
65  // *  // *
# Line 123  namespace { Line 99  namespace {
99      void Decompress16(int compressionmode, const unsigned char* params,      void Decompress16(int compressionmode, const unsigned char* params,
100                        int srcStep, int dstStep,                        int srcStep, int dstStep,
101                        const unsigned char* pSrc, int16_t* pDst,                        const unsigned char* pSrc, int16_t* pDst,
102                        unsigned long currentframeoffset,                        file_offset_t currentframeoffset,
103                        unsigned long copysamples)                        file_offset_t copysamples)
104      {      {
105          switch (compressionmode) {          switch (compressionmode) {
106              case 0: // 16 bit uncompressed              case 0: // 16 bit uncompressed
# Line 160  namespace { Line 136  namespace {
136    
137      void Decompress24(int compressionmode, const unsigned char* params,      void Decompress24(int compressionmode, const unsigned char* params,
138                        int dstStep, const unsigned char* pSrc, uint8_t* pDst,                        int dstStep, const unsigned char* pSrc, uint8_t* pDst,
139                        unsigned long currentframeoffset,                        file_offset_t currentframeoffset,
140                        unsigned long copysamples, int truncatedBits)                        file_offset_t copysamples, int truncatedBits)
141      {      {
142          int y, dy, ddy, dddy;          int y, dy, ddy, dddy;
143    
# Line 297  namespace { Line 273  namespace {
273       * steps.       * steps.
274       *       *
275       * Once the whole data was processed by __calculateCRC(), one should       * Once the whole data was processed by __calculateCRC(), one should
276       * call __encodeCRC() to get the final CRC result.       * call __finalizeCRC() to get the final CRC result.
277       *       *
278       * @param buf     - pointer to data the CRC shall be calculated of       * @param buf     - pointer to data the CRC shall be calculated of
279       * @param bufSize - size of the data to be processed       * @param bufSize - size of the data to be processed
280       * @param crc     - variable the CRC sum shall be stored to       * @param crc     - variable the CRC sum shall be stored to
281       */       */
282      static void __calculateCRC(unsigned char* buf, int bufSize, uint32_t& crc) {      static void __calculateCRC(unsigned char* buf, size_t bufSize, uint32_t& crc) {
283          for (int i = 0 ; i < bufSize ; i++) {          for (size_t i = 0 ; i < bufSize ; i++) {
284              crc = __CRCTable[(crc ^ buf[i]) & 0xff] ^ (crc >> 8);              crc = __CRCTable[(crc ^ buf[i]) & 0xff] ^ (crc >> 8);
285          }          }
286      }      }
# Line 314  namespace { Line 290  namespace {
290       *       *
291       * @param crc - variable previously passed to __calculateCRC()       * @param crc - variable previously passed to __calculateCRC()
292       */       */
293      inline static uint32_t __encodeCRC(const uint32_t& crc) {      inline static void __finalizeCRC(uint32_t& crc) {
294          return crc ^ 0xffffffff;          crc ^= 0xffffffff;
295      }      }
296    
297    
# Line 343  namespace { Line 319  namespace {
319    
320    
321    
322    // *************** leverage_ctrl_t ***************
323    // *
324    
325        void leverage_ctrl_t::serialize(Serialization::Archive* archive) {
326            SRLZ(type);
327            SRLZ(controller_number);
328        }
329    
330    
331    
332    // *************** crossfade_t ***************
333    // *
334    
335        void crossfade_t::serialize(Serialization::Archive* archive) {
336            SRLZ(in_start);
337            SRLZ(in_end);
338            SRLZ(out_start);
339            SRLZ(out_end);
340        }
341    
342    
343    
344    // *************** eg_opt_t ***************
345    // *
346    
347        eg_opt_t::eg_opt_t() {
348            AttackCancel     = true;
349            AttackHoldCancel = true;
350            Decay1Cancel     = true;
351            Decay2Cancel     = true;
352            ReleaseCancel    = true;
353        }
354    
355        void eg_opt_t::serialize(Serialization::Archive* archive) {
356            SRLZ(AttackCancel);
357            SRLZ(AttackHoldCancel);
358            SRLZ(Decay1Cancel);
359            SRLZ(Decay2Cancel);
360            SRLZ(ReleaseCancel);
361        }
362    
363    
364    
365  // *************** Sample ***************  // *************** Sample ***************
366  // *  // *
367    
368      unsigned int Sample::Instances = 0;      size_t       Sample::Instances = 0;
369      buffer_t     Sample::InternalDecompressionBuffer;      buffer_t     Sample::InternalDecompressionBuffer;
370    
371      /** @brief Constructor.      /** @brief Constructor.
# Line 366  namespace { Line 385  namespace {
385       *                         ('wvpl') list chunk       *                         ('wvpl') list chunk
386       * @param fileNo         - number of an extension file where this sample       * @param fileNo         - number of an extension file where this sample
387       *                         is located, 0 otherwise       *                         is located, 0 otherwise
388         * @param index          - wave pool index of sample (may be -1 on new sample)
389       */       */
390      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, int index)
391            : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset)
392        {
393          static const DLS::Info::string_length_t fixedStringLengths[] = {          static const DLS::Info::string_length_t fixedStringLengths[] = {
394              { CHUNK_ID_INAM, 64 },              { CHUNK_ID_INAM, 64 },
395              { 0, 0 }              { 0, 0 }
# Line 377  namespace { Line 399  namespace {
399          FileNo = fileNo;          FileNo = fileNo;
400    
401          __resetCRC(crc);          __resetCRC(crc);
402            // if this is not a new sample, try to get the sample's already existing
403            // CRC32 checksum from disk, this checksum will reflect the sample's CRC32
404            // checksum of the time when the sample was consciously modified by the
405            // user for the last time (by calling Sample::Write() that is).
406            if (index >= 0) { // not a new file ...
407                try {
408                    uint32_t crc = pFile->GetSampleChecksumByIndex(index);
409                    this->crc = crc;
410                } catch (...) {}
411            }
412    
413          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
414          if (pCk3gix) {          if (pCk3gix) {
415                pCk3gix->SetPos(0);
416    
417              uint16_t iSampleGroup = pCk3gix->ReadInt16();              uint16_t iSampleGroup = pCk3gix->ReadInt16();
418              pGroup = pFile->GetGroup(iSampleGroup);              pGroup = pFile->GetGroup(iSampleGroup);
419          } else { // '3gix' chunk missing          } else { // '3gix' chunk missing
# Line 389  namespace { Line 423  namespace {
423    
424          pCkSmpl = waveList->GetSubChunk(CHUNK_ID_SMPL);          pCkSmpl = waveList->GetSubChunk(CHUNK_ID_SMPL);
425          if (pCkSmpl) {          if (pCkSmpl) {
426                pCkSmpl->SetPos(0);
427    
428              Manufacturer  = pCkSmpl->ReadInt32();              Manufacturer  = pCkSmpl->ReadInt32();
429              Product       = pCkSmpl->ReadInt32();              Product       = pCkSmpl->ReadInt32();
430              SamplePeriod  = pCkSmpl->ReadInt32();              SamplePeriod  = pCkSmpl->ReadInt32();
# Line 435  namespace { Line 471  namespace {
471          Dithered          = false;          Dithered          = false;
472          TruncatedBits     = 0;          TruncatedBits     = 0;
473          if (Compressed) {          if (Compressed) {
474                ewav->SetPos(0);
475    
476              uint32_t version = ewav->ReadInt32();              uint32_t version = ewav->ReadInt32();
477              if (version == 3 && BitDepth == 24) {              if (version > 2 && BitDepth == 24) {
478                  Dithered = ewav->ReadInt32();                  Dithered = ewav->ReadInt32();
479                  ewav->SetPos(Channels == 2 ? 84 : 64);                  ewav->SetPos(Channels == 2 ? 84 : 64);
480                  TruncatedBits = ewav->ReadInt32();                  TruncatedBits = ewav->ReadInt32();
# Line 509  namespace { Line 547  namespace {
547          const int iReadAtOnce = 32*1024;          const int iReadAtOnce = 32*1024;
548          char* buf = new char[iReadAtOnce * orig->FrameSize];          char* buf = new char[iReadAtOnce * orig->FrameSize];
549          Sample* pOrig = (Sample*) orig; //HACK: remove constness for now          Sample* pOrig = (Sample*) orig; //HACK: remove constness for now
550          unsigned long restorePos = pOrig->GetPos();          file_offset_t restorePos = pOrig->GetPos();
551          pOrig->SetPos(0);          pOrig->SetPos(0);
552          SetPos(0);          SetPos(0);
553          for (unsigned long n = pOrig->Read(buf, iReadAtOnce); n;          for (file_offset_t n = pOrig->Read(buf, iReadAtOnce); n;
554                             n = pOrig->Read(buf, iReadAtOnce))                             n = pOrig->Read(buf, iReadAtOnce))
555          {          {
556              Write(buf, n);              Write(buf, n);
# Line 528  namespace { Line 566  namespace {
566       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
567       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
568       *       *
569         * @param pProgress - callback function for progress notification
570       * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data       * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data
571       *                        was provided yet       *                        was provided yet
572       * @throws gig::Exception if there is any invalid sample setting       * @throws gig::Exception if there is any invalid sample setting
573       */       */
574      void Sample::UpdateChunks() {      void Sample::UpdateChunks(progress_t* pProgress) {
575          // first update base class's chunks          // first update base class's chunks
576          DLS::Sample::UpdateChunks();          DLS::Sample::UpdateChunks(pProgress);
577    
578          // make sure 'smpl' chunk exists          // make sure 'smpl' chunk exists
579          pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);          pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);
# Line 596  namespace { Line 635  namespace {
635      void Sample::ScanCompressedSample() {      void Sample::ScanCompressedSample() {
636          //TODO: we have to add some more scans here (e.g. determine compression rate)          //TODO: we have to add some more scans here (e.g. determine compression rate)
637          this->SamplesTotal = 0;          this->SamplesTotal = 0;
638          std::list<unsigned long> frameOffsets;          std::list<file_offset_t> frameOffsets;
639    
640          SamplesPerFrame = BitDepth == 24 ? 256 : 2048;          SamplesPerFrame = BitDepth == 24 ? 256 : 2048;
641          WorstCaseFrameSize = SamplesPerFrame * FrameSize + Channels; // +Channels for compression flag          WorstCaseFrameSize = SamplesPerFrame * FrameSize + Channels; // +Channels for compression flag
# Line 612  namespace { Line 651  namespace {
651                  const int mode_l = pCkData->ReadUint8();                  const int mode_l = pCkData->ReadUint8();
652                  const int mode_r = pCkData->ReadUint8();                  const int mode_r = pCkData->ReadUint8();
653                  if (mode_l > 5 || mode_r > 5) throw gig::Exception("Unknown compression mode");                  if (mode_l > 5 || mode_r > 5) throw gig::Exception("Unknown compression mode");
654                  const unsigned long frameSize = bytesPerFrame[mode_l] + bytesPerFrame[mode_r];                  const file_offset_t frameSize = bytesPerFrame[mode_l] + bytesPerFrame[mode_r];
655    
656                  if (pCkData->RemainingBytes() <= frameSize) {                  if (pCkData->RemainingBytes() <= frameSize) {
657                      SamplesInLastFrame =                      SamplesInLastFrame =
# Line 631  namespace { Line 670  namespace {
670    
671                  const int mode = pCkData->ReadUint8();                  const int mode = pCkData->ReadUint8();
672                  if (mode > 5) throw gig::Exception("Unknown compression mode");                  if (mode > 5) throw gig::Exception("Unknown compression mode");
673                  const unsigned long frameSize = bytesPerFrame[mode];                  const file_offset_t frameSize = bytesPerFrame[mode];
674    
675                  if (pCkData->RemainingBytes() <= frameSize) {                  if (pCkData->RemainingBytes() <= frameSize) {
676                      SamplesInLastFrame =                      SamplesInLastFrame =
# Line 647  namespace { Line 686  namespace {
686    
687          // Build the frames table (which is used for fast resolving of a frame's chunk offset)          // Build the frames table (which is used for fast resolving of a frame's chunk offset)
688          if (FrameTable) delete[] FrameTable;          if (FrameTable) delete[] FrameTable;
689          FrameTable = new unsigned long[frameOffsets.size()];          FrameTable = new file_offset_t[frameOffsets.size()];
690          std::list<unsigned long>::iterator end  = frameOffsets.end();          std::list<file_offset_t>::iterator end  = frameOffsets.end();
691          std::list<unsigned long>::iterator iter = frameOffsets.begin();          std::list<file_offset_t>::iterator iter = frameOffsets.begin();
692          for (int i = 0; iter != end; i++, iter++) {          for (int i = 0; iter != end; i++, iter++) {
693              FrameTable[i] = *iter;              FrameTable[i] = *iter;
694          }          }
# Line 690  namespace { Line 729  namespace {
729       *                      the cached sample data in bytes       *                      the cached sample data in bytes
730       * @see                 ReleaseSampleData(), Read(), SetPos()       * @see                 ReleaseSampleData(), Read(), SetPos()
731       */       */
732      buffer_t Sample::LoadSampleData(unsigned long SampleCount) {      buffer_t Sample::LoadSampleData(file_offset_t SampleCount) {
733          return LoadSampleDataWithNullSamplesExtension(SampleCount, 0); // 0 amount of NullSamples          return LoadSampleDataWithNullSamplesExtension(SampleCount, 0); // 0 amount of NullSamples
734      }      }
735    
# Line 749  namespace { Line 788  namespace {
788       *                           size of the cached sample data in bytes       *                           size of the cached sample data in bytes
789       * @see                      ReleaseSampleData(), Read(), SetPos()       * @see                      ReleaseSampleData(), Read(), SetPos()
790       */       */
791      buffer_t Sample::LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount) {      buffer_t Sample::LoadSampleDataWithNullSamplesExtension(file_offset_t SampleCount, uint NullSamplesCount) {
792          if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;          if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;
793          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
794          unsigned long allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;          file_offset_t allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;
795          SetPos(0); // reset read position to begin of sample          SetPos(0); // reset read position to begin of sample
796          RAMCache.pStart            = new int8_t[allocationsize];          RAMCache.pStart            = new int8_t[allocationsize];
797          RAMCache.Size              = Read(RAMCache.pStart, SampleCount) * this->FrameSize;          RAMCache.Size              = Read(RAMCache.pStart, SampleCount) * this->FrameSize;
# Line 816  namespace { Line 855  namespace {
855       * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with       * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with
856       * other formats will fail!       * other formats will fail!
857       *       *
858       * @param iNewSize - new sample wave data size in sample points (must be       * @param NewSize - new sample wave data size in sample points (must be
859       *                   greater than zero)       *                  greater than zero)
860       * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM       * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM
861       *                         or if \a iNewSize is less than 1       * @throws DLS::Exception if \a NewSize is less than 1 or unrealistic large
862       * @throws gig::Exception if existing sample is compressed       * @throws gig::Exception if existing sample is compressed
863       * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,       * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,
864       *      DLS::Sample::FormatTag, File::Save()       *      DLS::Sample::FormatTag, File::Save()
865       */       */
866      void Sample::Resize(int iNewSize) {      void Sample::Resize(file_offset_t NewSize) {
867          if (Compressed) throw gig::Exception("There is no support for modifying compressed samples (yet)");          if (Compressed) throw gig::Exception("There is no support for modifying compressed samples (yet)");
868          DLS::Sample::Resize(iNewSize);          DLS::Sample::Resize(NewSize);
869      }      }
870    
871      /**      /**
# Line 850  namespace { Line 889  namespace {
889       * @returns            the new sample position       * @returns            the new sample position
890       * @see                Read()       * @see                Read()
891       */       */
892      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) {
893          if (Compressed) {          if (Compressed) {
894              switch (Whence) {              switch (Whence) {
895                  case RIFF::stream_curpos:                  case RIFF::stream_curpos:
# Line 868  namespace { Line 907  namespace {
907              }              }
908              if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;              if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;
909    
910              unsigned long frame = this->SamplePos / 2048; // to which frame to jump              file_offset_t frame = this->SamplePos / 2048; // to which frame to jump
911              this->FrameOffset   = this->SamplePos % 2048; // offset (in sample points) within that frame              this->FrameOffset   = this->SamplePos % 2048; // offset (in sample points) within that frame
912              pCkData->SetPos(FrameTable[frame]);           // set chunk pointer to the start of sought frame              pCkData->SetPos(FrameTable[frame]);           // set chunk pointer to the start of sought frame
913              return this->SamplePos;              return this->SamplePos;
914          }          }
915          else { // not compressed          else { // not compressed
916              unsigned long orderedBytes = SampleCount * this->FrameSize;              file_offset_t orderedBytes = SampleCount * this->FrameSize;
917              unsigned long result = pCkData->SetPos(orderedBytes, Whence);              file_offset_t result = pCkData->SetPos(orderedBytes, Whence);
918              return (result == orderedBytes) ? SampleCount              return (result == orderedBytes) ? SampleCount
919                                              : result / this->FrameSize;                                              : result / this->FrameSize;
920          }          }
# Line 884  namespace { Line 923  namespace {
923      /**      /**
924       * Returns the current position in the sample (in sample points).       * Returns the current position in the sample (in sample points).
925       */       */
926      unsigned long Sample::GetPos() const {      file_offset_t Sample::GetPos() const {
927          if (Compressed) return SamplePos;          if (Compressed) return SamplePos;
928          else            return pCkData->GetPos() / FrameSize;          else            return pCkData->GetPos() / FrameSize;
929      }      }
# Line 923  namespace { Line 962  namespace {
962       * @returns                number of successfully read sample points       * @returns                number of successfully read sample points
963       * @see                    CreateDecompressionBuffer()       * @see                    CreateDecompressionBuffer()
964       */       */
965      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,
966                                        DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {                                        DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {
967          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;          file_offset_t samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;
968          uint8_t* pDst = (uint8_t*) pBuffer;          uint8_t* pDst = (uint8_t*) pBuffer;
969    
970          SetPos(pPlaybackState->position); // recover position from the last time          SetPos(pPlaybackState->position); // recover position from the last time
# Line 963  namespace { Line 1002  namespace {
1002                                  // reading, swap all sample frames so it reflects                                  // reading, swap all sample frames so it reflects
1003                                  // backward playback                                  // backward playback
1004    
1005                                  unsigned long swapareastart       = totalreadsamples;                                  file_offset_t swapareastart       = totalreadsamples;
1006                                  unsigned long loopoffset          = GetPos() - loop.LoopStart;                                  file_offset_t loopoffset          = GetPos() - loop.LoopStart;
1007                                  unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);                                  file_offset_t samplestoreadinloop = Min(samplestoread, loopoffset);
1008                                  unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;                                  file_offset_t reverseplaybackend  = GetPos() - samplestoreadinloop;
1009    
1010                                  SetPos(reverseplaybackend);                                  SetPos(reverseplaybackend);
1011    
# Line 1014  namespace { Line 1053  namespace {
1053                          // reading, swap all sample frames so it reflects                          // reading, swap all sample frames so it reflects
1054                          // backward playback                          // backward playback
1055    
1056                          unsigned long swapareastart       = totalreadsamples;                          file_offset_t swapareastart       = totalreadsamples;
1057                          unsigned long loopoffset          = GetPos() - loop.LoopStart;                          file_offset_t loopoffset          = GetPos() - loop.LoopStart;
1058                          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)
1059                                                                                    : samplestoread;                                                                                    : samplestoread;
1060                          unsigned long reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);                          file_offset_t reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);
1061    
1062                          SetPos(reverseplaybackend);                          SetPos(reverseplaybackend);
1063    
# Line 1098  namespace { Line 1137  namespace {
1137       * @returns            number of successfully read sample points       * @returns            number of successfully read sample points
1138       * @see                SetPos(), CreateDecompressionBuffer()       * @see                SetPos(), CreateDecompressionBuffer()
1139       */       */
1140      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) {
1141          if (SampleCount == 0) return 0;          if (SampleCount == 0) return 0;
1142          if (!Compressed) {          if (!Compressed) {
1143              if (BitDepth == 24) {              if (BitDepth == 24) {
# Line 1113  namespace { Line 1152  namespace {
1152          else {          else {
1153              if (this->SamplePos >= this->SamplesTotal) return 0;              if (this->SamplePos >= this->SamplesTotal) return 0;
1154              //TODO: efficiency: maybe we should test for an average compression rate              //TODO: efficiency: maybe we should test for an average compression rate
1155              unsigned long assumedsize      = GuessSize(SampleCount),              file_offset_t assumedsize      = GuessSize(SampleCount),
1156                            remainingbytes   = 0,           // remaining bytes in the local buffer                            remainingbytes   = 0,           // remaining bytes in the local buffer
1157                            remainingsamples = SampleCount,                            remainingsamples = SampleCount,
1158                            copysamples, skipsamples,                            copysamples, skipsamples,
# Line 1136  namespace { Line 1175  namespace {
1175              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);
1176    
1177              while (remainingsamples && remainingbytes) {              while (remainingsamples && remainingbytes) {
1178                  unsigned long framesamples = SamplesPerFrame;                  file_offset_t framesamples = SamplesPerFrame;
1179                  unsigned long framebytes, rightChannelOffset = 0, nextFrameOffset;                  file_offset_t framebytes, rightChannelOffset = 0, nextFrameOffset;
1180    
1181                  int mode_l = *pSrc++, mode_r = 0;                  int mode_l = *pSrc++, mode_r = 0;
1182    
# Line 1287  namespace { Line 1326  namespace {
1326       * @throws gig::Exception if sample is compressed       * @throws gig::Exception if sample is compressed
1327       * @see DLS::LoadSampleData()       * @see DLS::LoadSampleData()
1328       */       */
1329      unsigned long Sample::Write(void* pBuffer, unsigned long SampleCount) {      file_offset_t Sample::Write(void* pBuffer, file_offset_t SampleCount) {
1330          if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");          if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");
1331    
1332          // if this is the first write in this sample, reset the          // if this is the first write in this sample, reset the
# Line 1296  namespace { Line 1335  namespace {
1335              __resetCRC(crc);              __resetCRC(crc);
1336          }          }
1337          if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");          if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");
1338          unsigned long res;          file_offset_t res;
1339          if (BitDepth == 24) {          if (BitDepth == 24) {
1340              res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;              res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
1341          } else { // 16 bit          } else { // 16 bit
# Line 1308  namespace { Line 1347  namespace {
1347          // if this is the last write, update the checksum chunk in the          // if this is the last write, update the checksum chunk in the
1348          // file          // file
1349          if (pCkData->GetPos() == pCkData->GetSize()) {          if (pCkData->GetPos() == pCkData->GetSize()) {
1350                __finalizeCRC(crc);
1351              File* pFile = static_cast<File*>(GetParent());              File* pFile = static_cast<File*>(GetParent());
1352              pFile->SetSampleChecksum(this, __encodeCRC(crc));              pFile->SetSampleChecksum(this, crc);
1353          }          }
1354          return res;          return res;
1355      }      }
# Line 1330  namespace { Line 1370  namespace {
1370       * @returns allocated decompression buffer       * @returns allocated decompression buffer
1371       * @see DestroyDecompressionBuffer()       * @see DestroyDecompressionBuffer()
1372       */       */
1373      buffer_t Sample::CreateDecompressionBuffer(unsigned long MaxReadSize) {      buffer_t Sample::CreateDecompressionBuffer(file_offset_t MaxReadSize) {
1374          buffer_t result;          buffer_t result;
1375          const double worstCaseHeaderOverhead =          const double worstCaseHeaderOverhead =
1376                  (256.0 /*frame size*/ + 12.0 /*header*/ + 2.0 /*compression type flag (stereo)*/) / 256.0;                  (256.0 /*frame size*/ + 12.0 /*header*/ + 2.0 /*compression type flag (stereo)*/) / 256.0;
1377          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);
1378          result.pStart            = new int8_t[result.Size];          result.pStart            = new int8_t[result.Size];
1379          result.NullExtensionSize = 0;          result.NullExtensionSize = 0;
1380          return result;          return result;
# Line 1368  namespace { Line 1408  namespace {
1408          return pGroup;          return pGroup;
1409      }      }
1410    
1411        /**
1412         * Returns the CRC-32 checksum of the sample's raw wave form data at the
1413         * time when this sample's wave form data was modified for the last time
1414         * by calling Write(). This checksum only covers the raw wave form data,
1415         * not any meta informations like i.e. bit depth or loop points. Since
1416         * this method just returns the checksum stored for this sample i.e. when
1417         * the gig file was loaded, this method returns immediately. So it does no
1418         * recalcuation of the checksum with the currently available sample wave
1419         * form data.
1420         *
1421         * @see VerifyWaveData()
1422         */
1423        uint32_t Sample::GetWaveDataCRC32Checksum() {
1424            return crc;
1425        }
1426    
1427        /**
1428         * Checks the integrity of this sample's raw audio wave data. Whenever a
1429         * Sample's raw wave data is intentionally modified (i.e. by calling
1430         * Write() and supplying the new raw audio wave form data) a CRC32 checksum
1431         * is calculated and stored/updated for this sample, along to the sample's
1432         * meta informations.
1433         *
1434         * Now by calling this method the current raw audio wave data is checked
1435         * against the already stored CRC32 check sum in order to check whether the
1436         * sample data had been damaged unintentionally for some reason. Since by
1437         * calling this method always the entire raw audio wave data has to be
1438         * read, verifying all samples this way may take a long time accordingly.
1439         * And that's also the reason why the sample integrity is not checked by
1440         * default whenever a gig file is loaded. So this method must be called
1441         * explicitly to fulfill this task.
1442         *
1443         * @param pActually - (optional) if provided, will be set to the actually
1444         *                    calculated checksum of the current raw wave form data,
1445         *                    you can get the expected checksum instead by calling
1446         *                    GetWaveDataCRC32Checksum()
1447         * @returns true if sample is OK or false if the sample is damaged
1448         * @throws Exception if no checksum had been stored to disk for this
1449         *         sample yet, or on I/O issues
1450         * @see GetWaveDataCRC32Checksum()
1451         */
1452        bool Sample::VerifyWaveData(uint32_t* pActually) {
1453            //File* pFile = static_cast<File*>(GetParent());
1454            uint32_t crc = CalculateWaveDataChecksum();
1455            if (pActually) *pActually = crc;
1456            return crc == this->crc;
1457        }
1458    
1459        uint32_t Sample::CalculateWaveDataChecksum() {
1460            const size_t sz = 20*1024; // 20kB buffer size
1461            std::vector<uint8_t> buffer(sz);
1462            buffer.resize(sz);
1463    
1464            const size_t n = sz / FrameSize;
1465            SetPos(0);
1466            uint32_t crc = 0;
1467            __resetCRC(crc);
1468            while (true) {
1469                file_offset_t nRead = Read(&buffer[0], n);
1470                if (nRead <= 0) break;
1471                __calculateCRC(&buffer[0], nRead * FrameSize, crc);
1472            }
1473            __finalizeCRC(crc);
1474            return crc;
1475        }
1476    
1477      Sample::~Sample() {      Sample::~Sample() {
1478          Instances--;          Instances--;
1479          if (!Instances && InternalDecompressionBuffer.Size) {          if (!Instances && InternalDecompressionBuffer.Size) {
# Line 1384  namespace { Line 1490  namespace {
1490  // *************** DimensionRegion ***************  // *************** DimensionRegion ***************
1491  // *  // *
1492    
1493      uint                               DimensionRegion::Instances       = 0;      size_t                             DimensionRegion::Instances       = 0;
1494      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;
1495    
1496      DimensionRegion::DimensionRegion(Region* pParent, RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(Region* pParent, RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
# Line 1400  namespace { Line 1506  namespace {
1506    
1507          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);
1508          if (_3ewa) { // if '3ewa' chunk exists          if (_3ewa) { // if '3ewa' chunk exists
1509                _3ewa->SetPos(0);
1510    
1511              _3ewa->ReadInt32(); // unknown, always == chunk size ?              _3ewa->ReadInt32(); // unknown, always == chunk size ?
1512              LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1513              EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
# Line 1578  namespace { Line 1686  namespace {
1686              EG2Attack                       = 0.0;              EG2Attack                       = 0.0;
1687              EG2Decay1                       = 0.005;              EG2Decay1                       = 0.005;
1688              EG2Sustain                      = 1000;              EG2Sustain                      = 1000;
1689              EG2Release                      = 0.3;              EG2Release                      = 60;
1690              LFO2ControlDepth                = 0;              LFO2ControlDepth                = 0;
1691              LFO2Frequency                   = 1.0;              LFO2Frequency                   = 1.0;
1692              LFO2InternalDepth               = 0;              LFO2InternalDepth               = 0;
# Line 1633  namespace { Line 1741  namespace {
1741              memset(DimensionUpperLimits, 127, 8);              memset(DimensionUpperLimits, 127, 8);
1742          }          }
1743    
1744            // chunk for own format extensions, these will *NOT* work with Gigasampler/GigaStudio !
1745            RIFF::Chunk* lsde = _3ewl->GetSubChunk(CHUNK_ID_LSDE);
1746            if (lsde) { // format extension for EG behavior options
1747                lsde->SetPos(0);
1748    
1749                eg_opt_t* pEGOpts[2] = { &EG1Options, &EG2Options };
1750                for (int i = 0; i < 2; ++i) { // NOTE: we reserved a 3rd byte for a potential future EG3 option
1751                    unsigned char byte = lsde->ReadUint8();
1752                    pEGOpts[i]->AttackCancel     = byte & 1;
1753                    pEGOpts[i]->AttackHoldCancel = byte & (1 << 1);
1754                    pEGOpts[i]->Decay1Cancel     = byte & (1 << 2);
1755                    pEGOpts[i]->Decay2Cancel     = byte & (1 << 3);
1756                    pEGOpts[i]->ReleaseCancel    = byte & (1 << 4);
1757                }
1758            }
1759            // format extension for sustain pedal up effect on release trigger samples
1760            if (lsde && lsde->GetSize() > 3) { // NOTE: we reserved the 3rd byte for a potential future EG3 option
1761                lsde->SetPos(3);
1762                uint8_t byte = lsde->ReadUint8();
1763                SustainReleaseTrigger   = static_cast<sust_rel_trg_t>(byte & 0x03);
1764                NoNoteOffReleaseTrigger = byte >> 7;
1765            } else {
1766                SustainReleaseTrigger   = sust_rel_trg_none;
1767                NoNoteOffReleaseTrigger = false;
1768            }
1769            // format extension for LFOs' wave form, phase displacement and for
1770            // LFO3's flip phase
1771            if (lsde && lsde->GetSize() > 4) {
1772                lsde->SetPos(4);
1773                LFO1WaveForm = static_cast<lfo_wave_t>( lsde->ReadUint16() );
1774                LFO2WaveForm = static_cast<lfo_wave_t>( lsde->ReadUint16() );
1775                LFO3WaveForm = static_cast<lfo_wave_t>( lsde->ReadUint16() );
1776                lsde->ReadUint16(); // unused 16 bits, reserved for potential future use
1777                LFO1Phase = (double) GIG_EXP_DECODE( lsde->ReadInt32() );
1778                LFO2Phase = (double) GIG_EXP_DECODE( lsde->ReadInt32() );
1779                LFO3Phase = (double) GIG_EXP_DECODE( lsde->ReadInt32() );
1780                const uint32_t flags = lsde->ReadInt32();
1781                LFO3FlipPhase = flags & 1;
1782            } else {
1783                LFO1WaveForm = lfo_wave_sine;
1784                LFO2WaveForm = lfo_wave_sine;
1785                LFO3WaveForm = lfo_wave_sine;
1786                LFO1Phase = 0.0;
1787                LFO2Phase = 0.0;
1788                LFO3Phase = 0.0;
1789                LFO3FlipPhase = false;
1790            }
1791    
1792          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
1793                                                       VelocityResponseDepth,                                                       VelocityResponseDepth,
1794                                                       VelocityResponseCurveScaling);                                                       VelocityResponseCurveScaling);
# Line 1737  namespace { Line 1893  namespace {
1893          }          }
1894      }      }
1895    
1896        void DimensionRegion::serialize(Serialization::Archive* archive) {
1897            // in case this class will become backward incompatible one day,
1898            // then set a version and minimum version for this class like:
1899            //archive->setVersion(*this, 2);
1900            //archive->setMinVersion(*this, 1);
1901    
1902            SRLZ(VelocityUpperLimit);
1903            SRLZ(EG1PreAttack);
1904            SRLZ(EG1Attack);
1905            SRLZ(EG1Decay1);
1906            SRLZ(EG1Decay2);
1907            SRLZ(EG1InfiniteSustain);
1908            SRLZ(EG1Sustain);
1909            SRLZ(EG1Release);
1910            SRLZ(EG1Hold);
1911            SRLZ(EG1Controller);
1912            SRLZ(EG1ControllerInvert);
1913            SRLZ(EG1ControllerAttackInfluence);
1914            SRLZ(EG1ControllerDecayInfluence);
1915            SRLZ(EG1ControllerReleaseInfluence);
1916            SRLZ(LFO1WaveForm);
1917            SRLZ(LFO1Frequency);
1918            SRLZ(LFO1Phase);
1919            SRLZ(LFO1InternalDepth);
1920            SRLZ(LFO1ControlDepth);
1921            SRLZ(LFO1Controller);
1922            SRLZ(LFO1FlipPhase);
1923            SRLZ(LFO1Sync);
1924            SRLZ(EG2PreAttack);
1925            SRLZ(EG2Attack);
1926            SRLZ(EG2Decay1);
1927            SRLZ(EG2Decay2);
1928            SRLZ(EG2InfiniteSustain);
1929            SRLZ(EG2Sustain);
1930            SRLZ(EG2Release);
1931            SRLZ(EG2Controller);
1932            SRLZ(EG2ControllerInvert);
1933            SRLZ(EG2ControllerAttackInfluence);
1934            SRLZ(EG2ControllerDecayInfluence);
1935            SRLZ(EG2ControllerReleaseInfluence);
1936            SRLZ(LFO2WaveForm);
1937            SRLZ(LFO2Frequency);
1938            SRLZ(LFO2Phase);
1939            SRLZ(LFO2InternalDepth);
1940            SRLZ(LFO2ControlDepth);
1941            SRLZ(LFO2Controller);
1942            SRLZ(LFO2FlipPhase);
1943            SRLZ(LFO2Sync);
1944            SRLZ(EG3Attack);
1945            SRLZ(EG3Depth);
1946            SRLZ(LFO3WaveForm);
1947            SRLZ(LFO3Frequency);
1948            SRLZ(LFO3Phase);
1949            SRLZ(LFO3InternalDepth);
1950            SRLZ(LFO3ControlDepth);
1951            SRLZ(LFO3Controller);
1952            SRLZ(LFO3FlipPhase);
1953            SRLZ(LFO3Sync);
1954            SRLZ(VCFEnabled);
1955            SRLZ(VCFType);
1956            SRLZ(VCFCutoffController);
1957            SRLZ(VCFCutoffControllerInvert);
1958            SRLZ(VCFCutoff);
1959            SRLZ(VCFVelocityCurve);
1960            SRLZ(VCFVelocityScale);
1961            SRLZ(VCFVelocityDynamicRange);
1962            SRLZ(VCFResonance);
1963            SRLZ(VCFResonanceDynamic);
1964            SRLZ(VCFResonanceController);
1965            SRLZ(VCFKeyboardTracking);
1966            SRLZ(VCFKeyboardTrackingBreakpoint);
1967            SRLZ(VelocityResponseCurve);
1968            SRLZ(VelocityResponseDepth);
1969            SRLZ(VelocityResponseCurveScaling);
1970            SRLZ(ReleaseVelocityResponseCurve);
1971            SRLZ(ReleaseVelocityResponseDepth);
1972            SRLZ(ReleaseTriggerDecay);
1973            SRLZ(Crossfade);
1974            SRLZ(PitchTrack);
1975            SRLZ(DimensionBypass);
1976            SRLZ(Pan);
1977            SRLZ(SelfMask);
1978            SRLZ(AttenuationController);
1979            SRLZ(InvertAttenuationController);
1980            SRLZ(AttenuationControllerThreshold);
1981            SRLZ(ChannelOffset);
1982            SRLZ(SustainDefeat);
1983            SRLZ(MSDecode);
1984            //SRLZ(SampleStartOffset);
1985            SRLZ(SampleAttenuation);
1986            SRLZ(EG1Options);
1987            SRLZ(EG2Options);
1988            SRLZ(SustainReleaseTrigger);
1989            SRLZ(NoNoteOffReleaseTrigger);
1990    
1991            // derived attributes from DLS::Sampler
1992            SRLZ(FineTune);
1993            SRLZ(Gain);
1994        }
1995    
1996      /**      /**
1997       * Updates the respective member variable and updates @c SampleAttenuation       * Updates the respective member variable and updates @c SampleAttenuation
1998       * which depends on this value.       * which depends on this value.
# Line 1752  namespace { Line 2008  namespace {
2008       *       *
2009       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
2010       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
2011         *
2012         * @param pProgress - callback function for progress notification
2013       */       */
2014      void DimensionRegion::UpdateChunks() {      void DimensionRegion::UpdateChunks(progress_t* pProgress) {
2015          // first update base class's chunk          // first update base class's chunk
2016          DLS::Sampler::UpdateChunks();          DLS::Sampler::UpdateChunks(pProgress);
2017    
2018          RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);          RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);
2019          uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();          uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();
# Line 1768  namespace { Line 2026  namespace {
2026          RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);
2027          if (!_3ewa) {          if (!_3ewa) {
2028              File* pFile = (File*) GetParent()->GetParent()->GetParent();              File* pFile = (File*) GetParent()->GetParent()->GetParent();
2029              bool version3 = pFile->pVersion && pFile->pVersion->major == 3;              bool versiongt2 = pFile->pVersion && pFile->pVersion->major > 2;
2030              _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, version3 ? 148 : 140);              _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, versiongt2 ? 148 : 140);
2031          }          }
2032          pData = (uint8_t*) _3ewa->LoadChunkData();          pData = (uint8_t*) _3ewa->LoadChunkData();
2033    
2034          // update '3ewa' chunk with DimensionRegion's current settings          // update '3ewa' chunk with DimensionRegion's current settings
2035    
2036          const uint32_t chunksize = _3ewa->GetNewSize();          const uint32_t chunksize = (uint32_t) _3ewa->GetNewSize();
2037          store32(&pData[0], chunksize); // unknown, always chunk size?          store32(&pData[0], chunksize); // unknown, always chunk size?
2038    
2039          const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);          const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);
# Line 2035  namespace { Line 2293  namespace {
2293          if (chunksize >= 148) {          if (chunksize >= 148) {
2294              memcpy(&pData[140], DimensionUpperLimits, 8);              memcpy(&pData[140], DimensionUpperLimits, 8);
2295          }          }
2296    
2297            // chunk for own format extensions, these will *NOT* work with
2298            // Gigasampler/GigaStudio !
2299            RIFF::Chunk* lsde = pParentList->GetSubChunk(CHUNK_ID_LSDE);
2300            const int lsdeSize =
2301                3 /* EG cancel options */ +
2302                1 /* sustain pedal up on release trigger option */ +
2303                8 /* LFOs' wave forms */ + 12 /* LFOs' phase */ + 4 /* flags (LFO3FlipPhase) */;
2304            if (!lsde && UsesAnyGigFormatExtension()) {
2305                // only add this "LSDE" chunk if there is some (format extension)
2306                // setting effective that would require our "LSDE" format extension
2307                // chunk to be stored
2308                lsde = pParentList->AddSubChunk(CHUNK_ID_LSDE, lsdeSize);
2309                // move LSDE chunk to the end of parent list
2310                pParentList->MoveSubChunk(lsde, (RIFF::Chunk*)NULL);
2311            }
2312            if (lsde) {
2313                if (lsde->GetNewSize() < lsdeSize)
2314                    lsde->Resize(lsdeSize);
2315                // format extension for EG behavior options
2316                unsigned char* pData = (unsigned char*) lsde->LoadChunkData();
2317                eg_opt_t* pEGOpts[2] = { &EG1Options, &EG2Options };
2318                for (int i = 0; i < 2; ++i) { // NOTE: we reserved the 3rd byte for a potential future EG3 option
2319                    pData[i] =
2320                        (pEGOpts[i]->AttackCancel     ? 1 : 0) |
2321                        (pEGOpts[i]->AttackHoldCancel ? (1<<1) : 0) |
2322                        (pEGOpts[i]->Decay1Cancel     ? (1<<2) : 0) |
2323                        (pEGOpts[i]->Decay2Cancel     ? (1<<3) : 0) |
2324                        (pEGOpts[i]->ReleaseCancel    ? (1<<4) : 0);
2325                }
2326                // format extension for release trigger options
2327                pData[3] = static_cast<uint8_t>(SustainReleaseTrigger) | (NoNoteOffReleaseTrigger ? (1<<7) : 0);
2328                // format extension for LFOs' wave form, phase displacement and for
2329                // LFO3's flip phase
2330                store16(&pData[4], LFO1WaveForm);
2331                store16(&pData[6], LFO2WaveForm);
2332                store16(&pData[8], LFO3WaveForm);
2333                //NOTE: 16 bits reserved here for potential future use !
2334                const int32_t lfo1Phase = (int32_t) GIG_EXP_ENCODE(LFO1Phase);
2335                const int32_t lfo2Phase = (int32_t) GIG_EXP_ENCODE(LFO2Phase);
2336                const int32_t lfo3Phase = (int32_t) GIG_EXP_ENCODE(LFO3Phase);
2337                store32(&pData[12], lfo1Phase);
2338                store32(&pData[16], lfo2Phase);
2339                store32(&pData[20], lfo3Phase);
2340                const int32_t flags = LFO3FlipPhase ? 1 : 0;
2341                store32(&pData[24], flags);
2342    
2343                // compile time sanity check: is our last store access here
2344                // consistent with the initial lsdeSize value assignment?
2345                static_assert(lsdeSize == 28, "Inconsistency in assumed 'LSDE' RIFF chunk size");
2346            }
2347        }
2348    
2349        /**
2350         * Returns @c true in case this DimensionRegion object uses any gig format
2351         * extension, that is whether this DimensionRegion object currently has any
2352         * setting effective that would require our "LSDE" RIFF chunk to be stored
2353         * to the gig file.
2354         *
2355         * Right now this is a private method. It is considerable though this method
2356         * to become (in slightly modified form) a public API method in future, i.e.
2357         * to allow instrument editors to visualize and/or warn the user of any
2358         * format extension being used. Right now this method really just serves to
2359         * answer the question whether an LSDE chunk is required, for the public API
2360         * purpose this method would also need to check whether any other setting
2361         * stored to the regular value '3ewa' chunk, is actually a format extension
2362         * as well.
2363         */
2364        bool DimensionRegion::UsesAnyGigFormatExtension() const {
2365            eg_opt_t defaultOpt;
2366            return memcmp(&EG1Options, &defaultOpt, sizeof(eg_opt_t)) ||
2367                   memcmp(&EG2Options, &defaultOpt, sizeof(eg_opt_t)) ||
2368                   SustainReleaseTrigger || NoNoteOffReleaseTrigger ||
2369                   LFO1WaveForm || LFO2WaveForm || LFO3WaveForm ||
2370                   LFO1Phase || LFO2Phase || LFO3Phase ||
2371                   LFO3FlipPhase;
2372      }      }
2373    
2374      double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {      double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {
# Line 2074  namespace { Line 2408  namespace {
2408      // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet      // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet
2409      double* DimensionRegion::GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling)      double* DimensionRegion::GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling)
2410      {      {
2411            // sanity check input parameters
2412            // (fallback to some default parameters on ill input)
2413            switch (curveType) {
2414                case curve_type_nonlinear:
2415                case curve_type_linear:
2416                    if (depth > 4) {
2417                        printf("Warning: Invalid depth (0x%x) for velocity curve type (0x%x).\n", depth, curveType);
2418                        depth   = 0;
2419                        scaling = 0;
2420                    }
2421                    break;
2422                case curve_type_special:
2423                    if (depth > 5) {
2424                        printf("Warning: Invalid depth (0x%x) for velocity curve type 'special'.\n", depth);
2425                        depth   = 0;
2426                        scaling = 0;
2427                    }
2428                    break;
2429                case curve_type_unknown:
2430                default:
2431                    printf("Warning: Unknown velocity curve type (0x%x).\n", curveType);
2432                    curveType = curve_type_linear;
2433                    depth     = 0;
2434                    scaling   = 0;
2435                    break;
2436            }
2437    
2438          double* table;          double* table;
2439          uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;          uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;
2440          if (pVelocityTables->count(tableKey)) { // if key exists          if (pVelocityTables->count(tableKey)) { // if key exists
# Line 2449  namespace { Line 2810  namespace {
2810    
2811              // unknown controller type              // unknown controller type
2812              default:              default:
2813                  throw gig::Exception("Unknown leverage controller type.");                  decodedcontroller.type = leverage_ctrl_t::type_none;
2814                    decodedcontroller.controller_number = 0;
2815                    printf("Warning: Unknown leverage controller type (0x%x).\n", EncodedController);
2816                    break;
2817          }          }
2818          return decodedcontroller;          return decodedcontroller;
2819      }      }
# Line 2943  namespace { Line 3307  namespace {
3307          }          }
3308          Layers = 1;          Layers = 1;
3309          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
3310          int dimensionBits = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;          int dimensionBits = (file->pVersion && file->pVersion->major > 2) ? 8 : 5;
3311    
3312          // Actual Loading          // Actual Loading
3313    
# Line 2953  namespace { Line 3317  namespace {
3317    
3318          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);
3319          if (_3lnk) {          if (_3lnk) {
3320                _3lnk->SetPos(0);
3321    
3322              DimensionRegions = _3lnk->ReadUint32();              DimensionRegions = _3lnk->ReadUint32();
3323              for (int i = 0; i < dimensionBits; i++) {              for (int i = 0; i < dimensionBits; i++) {
3324                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());
# Line 2987  namespace { Line 3353  namespace {
3353              UpdateVelocityTable();              UpdateVelocityTable();
3354    
3355              // jump to start of the wave pool indices (if not already there)              // jump to start of the wave pool indices (if not already there)
3356              if (file->pVersion && file->pVersion->major == 3)              if (file->pVersion && file->pVersion->major > 2)
3357                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure
3358              else              else
3359                  _3lnk->SetPos(44);                  _3lnk->SetPos(44);
# Line 2996  namespace { Line 3362  namespace {
3362              if (file->GetAutoLoad()) {              if (file->GetAutoLoad()) {
3363                  for (uint i = 0; i < DimensionRegions; i++) {                  for (uint i = 0; i < DimensionRegions; i++) {
3364                      uint32_t wavepoolindex = _3lnk->ReadUint32();                      uint32_t wavepoolindex = _3lnk->ReadUint32();
3365                      if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);                      if (file->pWavePoolTable && pDimensionRegions[i])
3366                            pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
3367                  }                  }
3368                  GetSample(); // load global region sample reference                  GetSample(); // load global region sample reference
3369              }              }
# Line 3026  namespace { Line 3393  namespace {
3393       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
3394       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
3395       *       *
3396         * @param pProgress - callback function for progress notification
3397       * @throws gig::Exception if samples cannot be dereferenced       * @throws gig::Exception if samples cannot be dereferenced
3398       */       */
3399      void Region::UpdateChunks() {      void Region::UpdateChunks(progress_t* pProgress) {
3400          // in the gig format we don't care about the Region's sample reference          // in the gig format we don't care about the Region's sample reference
3401          // but we still have to provide some existing one to not corrupt the          // but we still have to provide some existing one to not corrupt the
3402          // file, so to avoid the latter we simply always assign the sample of          // file, so to avoid the latter we simply always assign the sample of
# Line 3036  namespace { Line 3404  namespace {
3404          pSample = pDimensionRegions[0]->pSample;          pSample = pDimensionRegions[0]->pSample;
3405    
3406          // first update base class's chunks          // first update base class's chunks
3407          DLS::Region::UpdateChunks();          DLS::Region::UpdateChunks(pProgress);
3408    
3409          // update dimension region's chunks          // update dimension region's chunks
3410          for (int i = 0; i < DimensionRegions; i++) {          for (int i = 0; i < DimensionRegions; i++) {
3411              pDimensionRegions[i]->UpdateChunks();              pDimensionRegions[i]->UpdateChunks(pProgress);
3412          }          }
3413    
3414          File* pFile = (File*) GetParent()->GetParent();          File* pFile = (File*) GetParent()->GetParent();
3415          bool version3 = pFile->pVersion && pFile->pVersion->major == 3;          bool versiongt2 = pFile->pVersion && pFile->pVersion->major > 2;
3416          const int iMaxDimensions =  version3 ? 8 : 5;          const int iMaxDimensions =  versiongt2 ? 8 : 5;
3417          const int iMaxDimensionRegions = version3 ? 256 : 32;          const int iMaxDimensionRegions = versiongt2 ? 256 : 32;
3418    
3419          // make sure '3lnk' chunk exists          // make sure '3lnk' chunk exists
3420          RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);          RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);
3421          if (!_3lnk) {          if (!_3lnk) {
3422              const int _3lnkChunkSize = version3 ? 1092 : 172;              const int _3lnkChunkSize = versiongt2 ? 1092 : 172;
3423              _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);              _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);
3424              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
3425    
# Line 3075  namespace { Line 3443  namespace {
3443          }          }
3444    
3445          // update wave pool table in '3lnk' chunk          // update wave pool table in '3lnk' chunk
3446          const int iWavePoolOffset = version3 ? 68 : 44;          const int iWavePoolOffset = versiongt2 ? 68 : 44;
3447          for (uint i = 0; i < iMaxDimensionRegions; i++) {          for (uint i = 0; i < iMaxDimensionRegions; i++) {
3448              int iWaveIndex = -1;              int iWaveIndex = -1;
3449              if (i < DimensionRegions) {              if (i < DimensionRegions) {
# Line 3130  namespace { Line 3498  namespace {
3498          int step = 1;          int step = 1;
3499          for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;          for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
3500          int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;          int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
         int end = step * pDimensionDefinitions[veldim].zones;  
3501    
3502          // loop through all dimension regions for all dimensions except the velocity dimension          // loop through all dimension regions for all dimensions except the velocity dimension
3503          int dim[8] = { 0 };          int dim[8] = { 0 };
3504          for (int i = 0 ; i < DimensionRegions ; i++) {          for (int i = 0 ; i < DimensionRegions ; i++) {
3505                const int end = i + step * pDimensionDefinitions[veldim].zones;
3506    
3507                // create a velocity table for all cases where the velocity zone is zero
3508              if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||              if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||
3509                  pDimensionRegions[i]->VelocityUpperLimit) {                  pDimensionRegions[i]->VelocityUpperLimit) {
3510                  // create the velocity table                  // create the velocity table
# Line 3166  namespace { Line 3535  namespace {
3535                  }                  }
3536              }              }
3537    
3538                // jump to the next case where the velocity zone is zero
3539              int j;              int j;
3540              int shift = 0;              int shift = 0;
3541              for (j = 0 ; j < Dimensions ; j++) {              for (j = 0 ; j < Dimensions ; j++) {
# Line 3216  namespace { Line 3586  namespace {
3586    
3587          // check if max. amount of dimensions reached          // check if max. amount of dimensions reached
3588          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
3589          const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;          const int iMaxDimensions = (file->pVersion && file->pVersion->major > 2) ? 8 : 5;
3590          if (Dimensions >= iMaxDimensions)          if (Dimensions >= iMaxDimensions)
3591              throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimensions already reached");              throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimensions already reached");
3592          // check if max. amount of dimension bits reached          // check if max. amount of dimension bits reached
# Line 3508  namespace { Line 3878  namespace {
3878          }          }
3879    
3880          // delete temporary region          // delete temporary region
3881            tempRgn->DeleteChunks();
3882          delete tempRgn;          delete tempRgn;
3883    
3884          UpdateVelocityTable();          UpdateVelocityTable();
# Line 3647  namespace { Line 4018  namespace {
4018          }          }
4019    
4020          // delete temporary region          // delete temporary region
4021            tempRgn->DeleteChunks();
4022          delete tempRgn;          delete tempRgn;
4023    
4024          UpdateVelocityTable();          UpdateVelocityTable();
4025      }      }
4026    
4027        /** @brief Change type of an existing dimension.
4028         *
4029         * Alters the dimension type of a dimension already existing on this
4030         * region. If there is currently no dimension on this Region with type
4031         * @a oldType, then this call with throw an Exception. Likewise there are
4032         * cases where the requested dimension type cannot be performed. For example
4033         * if the new dimension type shall be gig::dimension_samplechannel, and the
4034         * current dimension has more than 2 zones. In such cases an Exception is
4035         * thrown as well.
4036         *
4037         * @param oldType - identifies the existing dimension to be changed
4038         * @param newType - to which dimension type it should be changed to
4039         * @throws gig::Exception if requested change cannot be performed
4040         */
4041        void Region::SetDimensionType(dimension_t oldType, dimension_t newType) {
4042            if (oldType == newType) return;
4043            dimension_def_t* def = GetDimensionDefinition(oldType);
4044            if (!def)
4045                throw gig::Exception("No dimension with provided old dimension type exists on this region");
4046            if (newType == dimension_samplechannel && def->zones != 2)
4047                throw gig::Exception("Cannot change to dimension type 'sample channel', because existing dimension does not have 2 zones");
4048            if (GetDimensionDefinition(newType))
4049                throw gig::Exception("There is already a dimension with requested new dimension type on this region");
4050            def->dimension  = newType;
4051            def->split_type = __resolveSplitType(newType);
4052        }
4053    
4054      DimensionRegion* Region::GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase) {      DimensionRegion* Region::GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase) {
4055          uint8_t bits[8] = {};          uint8_t bits[8] = {};
4056          for (std::map<dimension_t,int>::const_iterator it = DimCase.begin();          for (std::map<dimension_t,int>::const_iterator it = DimCase.begin();
# Line 3713  namespace { Line 4112  namespace {
4112      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
4113          uint8_t bits;          uint8_t bits;
4114          int veldim = -1;          int veldim = -1;
4115          int velbitpos;          int velbitpos = 0;
4116          int bitpos = 0;          int bitpos = 0;
4117          int dimregidx = 0;          int dimregidx = 0;
4118          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
# Line 3759  namespace { Line 4158  namespace {
4158          return dimreg;          return dimreg;
4159      }      }
4160    
4161        int Region::GetDimensionRegionIndexByValue(const uint DimValues[8]) {
4162            uint8_t bits;
4163            int veldim = -1;
4164            int velbitpos = 0;
4165            int bitpos = 0;
4166            int dimregidx = 0;
4167            for (uint i = 0; i < Dimensions; i++) {
4168                if (pDimensionDefinitions[i].dimension == dimension_velocity) {
4169                    // the velocity dimension must be handled after the other dimensions
4170                    veldim = i;
4171                    velbitpos = bitpos;
4172                } else {
4173                    switch (pDimensionDefinitions[i].split_type) {
4174                        case split_type_normal:
4175                            if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
4176                                // gig3: all normal dimensions (not just the velocity dimension) have custom zone ranges
4177                                for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
4178                                    if (DimValues[i] <= pDimensionRegions[bits << bitpos]->DimensionUpperLimits[i]) break;
4179                                }
4180                            } else {
4181                                // gig2: evenly sized zones
4182                                bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
4183                            }
4184                            break;
4185                        case split_type_bit: // the value is already the sought dimension bit number
4186                            const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
4187                            bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
4188                            break;
4189                    }
4190                    dimregidx |= bits << bitpos;
4191                }
4192                bitpos += pDimensionDefinitions[i].bits;
4193            }
4194            dimregidx &= 255;
4195            DimensionRegion* dimreg = pDimensionRegions[dimregidx];
4196            if (!dimreg) return -1;
4197            if (veldim != -1) {
4198                // (dimreg is now the dimension region for the lowest velocity)
4199                if (dimreg->VelocityTable) // custom defined zone ranges
4200                    bits = dimreg->VelocityTable[DimValues[veldim] & 127];
4201                else // normal split type
4202                    bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
4203    
4204                const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
4205                dimregidx |= (bits & limiter_mask) << velbitpos;
4206                dimregidx &= 255;
4207            }
4208            return dimregidx;
4209        }
4210    
4211      /**      /**
4212       * Returns the appropriate DimensionRegion for the given dimension bit       * Returns the appropriate DimensionRegion for the given dimension bit
4213       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>
# Line 3797  namespace { Line 4246  namespace {
4246          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
4247          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
4248          if (!file->pWavePoolTable) return NULL;          if (!file->pWavePoolTable) return NULL;
4249          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          if (WavePoolTableIndex + 1 > file->WavePoolCount) return NULL;
4250          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];          // for new files or files >= 2 GB use 64 bit wave pool offsets
4251          Sample* sample = file->GetFirstSample(pProgress);          if (file->pRIFF->IsNew() || (file->pRIFF->GetCurrentFileSize() >> 31)) {
4252          while (sample) {              // use 64 bit wave pool offsets (treating this as large file)
4253              if (sample->ulWavePoolOffset == soughtoffset &&              uint64_t soughtoffset =
4254                  sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);                  uint64_t(file->pWavePoolTable[WavePoolTableIndex]) |
4255              sample = file->GetNextSample();                  uint64_t(file->pWavePoolTableHi[WavePoolTableIndex]) << 32;
4256                Sample* sample = file->GetFirstSample(pProgress);
4257                while (sample) {
4258                    if (sample->ullWavePoolOffset == soughtoffset)
4259                        return static_cast<gig::Sample*>(sample);
4260                    sample = file->GetNextSample();
4261                }
4262            } else {
4263                // use extension files and 32 bit wave pool offsets
4264                file_offset_t soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
4265                file_offset_t soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
4266                Sample* sample = file->GetFirstSample(pProgress);
4267                while (sample) {
4268                    if (sample->ullWavePoolOffset == soughtoffset &&
4269                        sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
4270                    sample = file->GetNextSample();
4271                }
4272          }          }
4273          return NULL;          return NULL;
4274      }      }
# Line 4032  namespace { Line 4497  namespace {
4497          pGroup = group;          pGroup = group;
4498          pChunk = ckScri;          pChunk = ckScri;
4499          if (ckScri) { // object is loaded from file ...          if (ckScri) { // object is loaded from file ...
4500                ckScri->SetPos(0);
4501    
4502              // read header              // read header
4503              uint32_t headerSize = ckScri->ReadUint32();              uint32_t headerSize = ckScri->ReadUint32();
4504              Compression = (Compression_t) ckScri->ReadUint32();              Compression = (Compression_t) ckScri->ReadUint32();
# Line 4044  namespace { Line 4511  namespace {
4511              for (int i = 0; i < nameSize; ++i)              for (int i = 0; i < nameSize; ++i)
4512                  Name[i] = ckScri->ReadUint8();                  Name[i] = ckScri->ReadUint8();
4513              // to handle potential future extensions of the header              // to handle potential future extensions of the header
4514              ckScri->SetPos(headerSize - 6*sizeof(int32_t) + nameSize, RIFF::stream_curpos);              ckScri->SetPos(sizeof(int32_t) + headerSize);
4515              // read actual script data              // read actual script data
4516              uint32_t scriptSize = ckScri->GetSize() - ckScri->GetPos();              uint32_t scriptSize = uint32_t(ckScri->GetSize() - ckScri->GetPos());
4517              data.resize(scriptSize);              data.resize(scriptSize);
4518              for (int i = 0; i < scriptSize; ++i)              for (int i = 0; i < scriptSize; ++i)
4519                  data[i] = ckScri->ReadUint8();                  data[i] = ckScri->ReadUint8();
# Line 4084  namespace { Line 4551  namespace {
4551          memcpy(&data[0], &text[0], text.size());          memcpy(&data[0], &text[0], text.size());
4552      }      }
4553    
4554      void Script::UpdateChunks() {      /** @brief Remove all RIFF chunks associated with this Script object.
4555         *
4556         * At the moment Script::DeleteChunks() does nothing. It is
4557         * recommended to call this method explicitly though from deriving classes's
4558         * own overridden implementation of this method to avoid potential future
4559         * compatiblity issues.
4560         *
4561         * See DLS::Storage::DeleteChunks() for details.
4562         */
4563        void Script::DeleteChunks() {
4564        }
4565    
4566        /**
4567         * Apply this script to the respective RIFF chunks. You have to call
4568         * File::Save() to make changes persistent.
4569         *
4570         * Usually there is absolutely no need to call this method explicitly.
4571         * It will be called automatically when File::Save() was called.
4572         *
4573         * @param pProgress - callback function for progress notification
4574         */
4575        void Script::UpdateChunks(progress_t* pProgress) {
4576          // recalculate CRC32 check sum          // recalculate CRC32 check sum
4577          __resetCRC(crc);          __resetCRC(crc);
4578          __calculateCRC(&data[0], data.size(), crc);          __calculateCRC(&data[0], data.size(), crc);
4579          __encodeCRC(crc);          __finalizeCRC(crc);
4580          // make sure chunk exists and has the required size          // make sure chunk exists and has the required size
4581          const int chunkSize = 7*sizeof(int32_t) + Name.size() + data.size();          const file_offset_t chunkSize = (file_offset_t) 7*sizeof(int32_t) + Name.size() + data.size();
4582          if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);          if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);
4583          else pChunk->Resize(chunkSize);          else pChunk->Resize(chunkSize);
4584          // fill the chunk data to be written to disk          // fill the chunk data to be written to disk
4585          uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();          uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();
4586          int pos = 0;          int pos = 0;
4587          store32(&pData[pos], 6*sizeof(int32_t) + Name.size()); // total header size          store32(&pData[pos], uint32_t(6*sizeof(int32_t) + Name.size())); // total header size
4588          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4589          store32(&pData[pos], Compression);          store32(&pData[pos], Compression);
4590          pos += sizeof(int32_t);          pos += sizeof(int32_t);
# Line 4108  namespace { Line 4596  namespace {
4596          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4597          store32(&pData[pos], crc);          store32(&pData[pos], crc);
4598          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4599          store32(&pData[pos], Name.size());          store32(&pData[pos], (uint32_t) Name.size());
4600          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4601          for (int i = 0; i < Name.size(); ++i, ++pos)          for (int i = 0; i < Name.size(); ++i, ++pos)
4602              pData[pos] = Name[i];              pData[pos] = Name[i];
# Line 4123  namespace { Line 4611  namespace {
4611       * @param pGroup - script's new group       * @param pGroup - script's new group
4612       */       */
4613      void Script::SetGroup(ScriptGroup* pGroup) {      void Script::SetGroup(ScriptGroup* pGroup) {
4614          if (this->pGroup = pGroup) return;          if (this->pGroup == pGroup) return;
4615          if (pChunk)          if (pChunk)
4616              pChunk->GetParent()->MoveSubChunk(pChunk, pGroup->pList);              pChunk->GetParent()->MoveSubChunk(pChunk, pGroup->pList);
4617          this->pGroup = pGroup;          this->pGroup = pGroup;
4618      }      }
4619    
4620        /**
4621         * Returns the script group this script currently belongs to. Each script
4622         * is a member of exactly one ScriptGroup.
4623         *
4624         * @returns current script group
4625         */
4626        ScriptGroup* Script::GetGroup() const {
4627            return pGroup;
4628        }
4629    
4630        /**
4631         * Make a (semi) deep copy of the Script object given by @a orig
4632         * and assign it to this object. Note: the ScriptGroup this Script
4633         * object belongs to remains untouched by this call.
4634         *
4635         * @param orig - original Script object to be copied from
4636         */
4637        void Script::CopyAssign(const Script* orig) {
4638            Name        = orig->Name;
4639            Compression = orig->Compression;
4640            Encoding    = orig->Encoding;
4641            Language    = orig->Language;
4642            Bypass      = orig->Bypass;
4643            data        = orig->data;
4644        }
4645    
4646      void Script::RemoveAllScriptReferences() {      void Script::RemoveAllScriptReferences() {
4647          File* pFile = pGroup->pFile;          File* pFile = pGroup->pFile;
4648          for (int i = 0; pFile->GetInstrument(i); ++i) {          for (int i = 0; pFile->GetInstrument(i); ++i) {
# Line 4164  namespace { Line 4678  namespace {
4678          }          }
4679      }      }
4680    
4681      void ScriptGroup::UpdateChunks() {      /** @brief Remove all RIFF chunks associated with this ScriptGroup object.
4682         *
4683         * At the moment ScriptGroup::DeleteChunks() does nothing. It is
4684         * recommended to call this method explicitly though from deriving classes's
4685         * own overridden implementation of this method to avoid potential future
4686         * compatiblity issues.
4687         *
4688         * See DLS::Storage::DeleteChunks() for details.
4689         */
4690        void ScriptGroup::DeleteChunks() {
4691        }
4692    
4693        /**
4694         * Apply this script group to the respective RIFF chunks. You have to call
4695         * File::Save() to make changes persistent.
4696         *
4697         * Usually there is absolutely no need to call this method explicitly.
4698         * It will be called automatically when File::Save() was called.
4699         *
4700         * @param pProgress - callback function for progress notification
4701         */
4702        void ScriptGroup::UpdateChunks(progress_t* pProgress) {
4703          if (pScripts) {          if (pScripts) {
4704              if (!pList)              if (!pList)
4705                  pList = pFile->pRIFF->GetSubList(LIST_TYPE_3LS)->AddSubList(LIST_TYPE_RTIS);                  pList = pFile->pRIFF->GetSubList(LIST_TYPE_3LS)->AddSubList(LIST_TYPE_RTIS);
# Line 4175  namespace { Line 4710  namespace {
4710              for (std::list<Script*>::iterator it = pScripts->begin();              for (std::list<Script*>::iterator it = pScripts->begin();
4711                   it != pScripts->end(); ++it)                   it != pScripts->end(); ++it)
4712              {              {
4713                  (*it)->UpdateChunks();                  (*it)->UpdateChunks(pProgress);
4714              }              }
4715          }          }
4716      }      }
# Line 4266  namespace { Line 4801  namespace {
4801          EffectSend = 0;          EffectSend = 0;
4802          Attenuation = 0;          Attenuation = 0;
4803          FineTune = 0;          FineTune = 0;
4804          PitchbendRange = 0;          PitchbendRange = 2;
4805          PianoReleaseMode = false;          PianoReleaseMode = false;
4806          DimensionKeyRange.low = 0;          DimensionKeyRange.low = 0;
4807          DimensionKeyRange.high = 0;          DimensionKeyRange.high = 0;
# Line 4279  namespace { Line 4814  namespace {
4814          if (lart) {          if (lart) {
4815              RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);              RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
4816              if (_3ewg) {              if (_3ewg) {
4817                    _3ewg->SetPos(0);
4818    
4819                  EffectSend             = _3ewg->ReadUint16();                  EffectSend             = _3ewg->ReadUint16();
4820                  Attenuation            = _3ewg->ReadInt32();                  Attenuation            = _3ewg->ReadInt32();
4821                  FineTune               = _3ewg->ReadInt16();                  FineTune               = _3ewg->ReadInt16();
# Line 4323  namespace { Line 4860  namespace {
4860                  RIFF::List* rgn = lrgn->GetFirstSubList();                  RIFF::List* rgn = lrgn->GetFirstSubList();
4861                  while (rgn) {                  while (rgn) {
4862                      if (rgn->GetListType() == LIST_TYPE_RGN) {                      if (rgn->GetListType() == LIST_TYPE_RGN) {
4863                          __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);                          if (pProgress)
4864                                __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
4865                          pRegions->push_back(new Region(this, rgn));                          pRegions->push_back(new Region(this, rgn));
4866                      }                      }
4867                      rgn = lrgn->GetNextSubList();                      rgn = lrgn->GetNextSubList();
# Line 4338  namespace { Line 4876  namespace {
4876          if (lst3LS) {          if (lst3LS) {
4877              RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);              RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4878              if (ckSCSL) {              if (ckSCSL) {
4879                  int slotCount = ckSCSL->ReadUint32();                  ckSCSL->SetPos(0);
4880                  int slotSize  = ckSCSL->ReadUint32();  
4881                  int unknownSpace = slotSize - 2*sizeof(uint32_t); // in case of future extensions                  int headerSize = ckSCSL->ReadUint32();
4882                  for (int i = 0; i < slotCount; ++i) {                  int slotCount  = ckSCSL->ReadUint32();
4883                      _ScriptPooolEntry e;                  if (slotCount) {
4884                      e.fileOffset = ckSCSL->ReadUint32();                      int slotSize  = ckSCSL->ReadUint32();
4885                      e.bypass     = ckSCSL->ReadUint32() & 1;                      ckSCSL->SetPos(headerSize); // in case of future header extensions
4886                      if (unknownSpace) ckSCSL->SetPos(unknownSpace, RIFF::stream_curpos); // in case of future extensions                      int unknownSpace = slotSize - 2*sizeof(uint32_t); // in case of future slot extensions
4887                      scriptPoolFileOffsets.push_back(e);                      for (int i = 0; i < slotCount; ++i) {
4888                            _ScriptPooolEntry e;
4889                            e.fileOffset = ckSCSL->ReadUint32();
4890                            e.bypass     = ckSCSL->ReadUint32() & 1;
4891                            if (unknownSpace) ckSCSL->SetPos(unknownSpace, RIFF::stream_curpos); // in case of future extensions
4892                            scriptPoolFileOffsets.push_back(e);
4893                        }
4894                  }                  }
4895              }              }
4896          }          }
4897    
4898          __notify_progress(pProgress, 1.0f); // notify done          if (pProgress)
4899                __notify_progress(pProgress, 1.0f); // notify done
4900      }      }
4901    
4902      void Instrument::UpdateRegionKeyTable() {      void Instrument::UpdateRegionKeyTable() {
# Line 4360  namespace { Line 4905  namespace {
4905          RegionList::iterator end  = pRegions->end();          RegionList::iterator end  = pRegions->end();
4906          for (; iter != end; ++iter) {          for (; iter != end; ++iter) {
4907              gig::Region* pRegion = static_cast<gig::Region*>(*iter);              gig::Region* pRegion = static_cast<gig::Region*>(*iter);
4908              for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {              const int low  = std::max(int(pRegion->KeyRange.low), 0);
4909                const int high = std::min(int(pRegion->KeyRange.high), 127);
4910                for (int iKey = low; iKey <= high; iKey++) {
4911                  RegionKeyTable[iKey] = pRegion;                  RegionKeyTable[iKey] = pRegion;
4912              }              }
4913          }          }
# Line 4381  namespace { Line 4928  namespace {
4928       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
4929       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
4930       *       *
4931         * @param pProgress - callback function for progress notification
4932       * @throws gig::Exception if samples cannot be dereferenced       * @throws gig::Exception if samples cannot be dereferenced
4933       */       */
4934      void Instrument::UpdateChunks() {      void Instrument::UpdateChunks(progress_t* pProgress) {
4935          // first update base classes' chunks          // first update base classes' chunks
4936          DLS::Instrument::UpdateChunks();          DLS::Instrument::UpdateChunks(pProgress);
4937    
4938          // update Regions' chunks          // update Regions' chunks
4939          {          {
4940              RegionList::iterator iter = pRegions->begin();              RegionList::iterator iter = pRegions->begin();
4941              RegionList::iterator end  = pRegions->end();              RegionList::iterator end  = pRegions->end();
4942              for (; iter != end; ++iter)              for (; iter != end; ++iter)
4943                  (*iter)->UpdateChunks();                  (*iter)->UpdateChunks(pProgress);
4944          }          }
4945    
4946          // make sure 'lart' RIFF list chunk exists          // make sure 'lart' RIFF list chunk exists
# Line 4404  namespace { Line 4952  namespace {
4952              File* pFile = (File*) GetParent();              File* pFile = (File*) GetParent();
4953    
4954              // 3ewg is bigger in gig3, as it includes the iMIDI rules              // 3ewg is bigger in gig3, as it includes the iMIDI rules
4955              int size = (pFile->pVersion && pFile->pVersion->major == 3) ? 16416 : 12;              int size = (pFile->pVersion && pFile->pVersion->major > 2) ? 16416 : 12;
4956              _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);              _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);
4957              memset(_3ewg->LoadChunkData(), 0, size);              memset(_3ewg->LoadChunkData(), 0, size);
4958          }          }
# Line 4429  namespace { Line 4977  namespace {
4977          }          }
4978    
4979          // own gig format extensions          // own gig format extensions
4980         if (pScriptRefs) {         if (ScriptSlotCount()) {
4981               // make sure we have converted the original loaded script file
4982               // offsets into valid Script object pointers
4983               LoadScripts();
4984    
4985             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4986             if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);             if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);
4987             const int totalSize = pScriptRefs->size() * 2*sizeof(uint32_t);             const int slotCount = (int) pScriptRefs->size();
4988               const int headerSize = 3 * sizeof(uint32_t);
4989               const int slotSize  = 2 * sizeof(uint32_t);
4990               const int totalChunkSize = headerSize + slotCount * slotSize;
4991             RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);             RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4992             if (!ckSCSL) ckSCSL = lst3LS->AddSubChunk(CHUNK_ID_SCSL, totalSize);             if (!ckSCSL) ckSCSL = lst3LS->AddSubChunk(CHUNK_ID_SCSL, totalChunkSize);
4993             else ckSCSL->Resize(totalSize);             else ckSCSL->Resize(totalChunkSize);
4994             uint8_t* pData = (uint8_t*) ckSCSL->LoadChunkData();             uint8_t* pData = (uint8_t*) ckSCSL->LoadChunkData();
4995             for (int i = 0, pos = 0; i < pScriptRefs->size(); ++i) {             int pos = 0;
4996                 int fileOffset =             store32(&pData[pos], headerSize);
4997                      (*pScriptRefs)[i].script->pChunk->GetFilePos() -             pos += sizeof(uint32_t);
4998                      (*pScriptRefs)[i].script->pChunk->GetPos() -             store32(&pData[pos], slotCount);
4999                      CHUNK_HEADER_SIZE;             pos += sizeof(uint32_t);
5000                 store32(&pData[pos], fileOffset);             store32(&pData[pos], slotSize);
5001               pos += sizeof(uint32_t);
5002               for (int i = 0; i < slotCount; ++i) {
5003                   // arbitrary value, the actual file offset will be updated in
5004                   // UpdateScriptFileOffsets() after the file has been resized
5005                   int bogusFileOffset = 0;
5006                   store32(&pData[pos], bogusFileOffset);
5007                 pos += sizeof(uint32_t);                 pos += sizeof(uint32_t);
5008                 store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0);                 store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0);
5009                 pos += sizeof(uint32_t);                 pos += sizeof(uint32_t);
5010             }             }
5011           } else {
5012               // no script slots, so get rid of any LS custom RIFF chunks (if any)
5013               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
5014               if (lst3LS) pCkInstrument->DeleteSubChunk(lst3LS);
5015         }         }
5016      }      }
5017    
5018        void Instrument::UpdateScriptFileOffsets() {
5019           // own gig format extensions
5020           if (pScriptRefs && pScriptRefs->size() > 0) {
5021               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
5022               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
5023               const int slotCount = (int) pScriptRefs->size();
5024               const int headerSize = 3 * sizeof(uint32_t);
5025               ckSCSL->SetPos(headerSize);
5026               for (int i = 0; i < slotCount; ++i) {
5027                   uint32_t fileOffset = uint32_t(
5028                        (*pScriptRefs)[i].script->pChunk->GetFilePos() -
5029                        (*pScriptRefs)[i].script->pChunk->GetPos() -
5030                        CHUNK_HEADER_SIZE(ckSCSL->GetFile()->GetFileOffsetSize())
5031                   );
5032                   ckSCSL->WriteUint32(&fileOffset);
5033                   // jump over flags entry (containing the bypass flag)
5034                   ckSCSL->SetPos(sizeof(uint32_t), RIFF::stream_curpos);
5035               }
5036           }        
5037        }
5038    
5039      /**      /**
5040       * Returns the appropriate Region for a triggered note.       * Returns the appropriate Region for a triggered note.
5041       *       *
# Line 4502  namespace { Line 5088  namespace {
5088          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
5089          Region* pNewRegion = new Region(this, rgn);          Region* pNewRegion = new Region(this, rgn);
5090          pRegions->push_back(pNewRegion);          pRegions->push_back(pNewRegion);
5091          Regions = pRegions->size();          Regions = (uint32_t) pRegions->size();
5092          // update Region key table for fast lookup          // update Region key table for fast lookup
5093          UpdateRegionKeyTable();          UpdateRegionKeyTable();
5094          // done          // done
# Line 4517  namespace { Line 5103  namespace {
5103      }      }
5104    
5105      /**      /**
5106         * Move this instrument at the position before @arg dst.
5107         *
5108         * This method can be used to reorder the sequence of instruments in a
5109         * .gig file. This might be helpful especially on large .gig files which
5110         * contain a large number of instruments within the same .gig file. So
5111         * grouping such instruments to similar ones, can help to keep track of them
5112         * when working with such complex .gig files.
5113         *
5114         * When calling this method, this instrument will be removed from in its
5115         * current position in the instruments list and moved to the requested
5116         * target position provided by @param dst. You may also pass NULL as
5117         * argument to this method, in that case this intrument will be moved to the
5118         * very end of the .gig file's instrument list.
5119         *
5120         * You have to call Save() to make the order change persistent to the .gig
5121         * file.
5122         *
5123         * Currently this method is limited to moving the instrument within the same
5124         * .gig file. Trying to move it to another .gig file by calling this method
5125         * will throw an exception.
5126         *
5127         * @param dst - destination instrument at which this instrument will be
5128         *              moved to, or pass NULL for moving to end of list
5129         * @throw gig::Exception if this instrument and target instrument are not
5130         *                       part of the same file
5131         */
5132        void Instrument::MoveTo(Instrument* dst) {
5133            if (dst && GetParent() != dst->GetParent())
5134                throw Exception(
5135                    "gig::Instrument::MoveTo() can only be used for moving within "
5136                    "the same gig file."
5137                );
5138    
5139            File* pFile = (File*) GetParent();
5140    
5141            // move this instrument within the instrument list
5142            {
5143                File::InstrumentList& list = *pFile->pInstruments;
5144    
5145                File::InstrumentList::iterator itFrom =
5146                    std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(this));
5147    
5148                File::InstrumentList::iterator itTo =
5149                    std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(dst));
5150    
5151                list.splice(itTo, list, itFrom);
5152            }
5153    
5154            // move the instrument's actual list RIFF chunk appropriately
5155            RIFF::List* lstCkInstruments = pFile->pRIFF->GetSubList(LIST_TYPE_LINS);
5156            lstCkInstruments->MoveSubChunk(
5157                this->pCkInstrument,
5158                (RIFF::Chunk*) ((dst) ? dst->pCkInstrument : NULL)
5159            );
5160        }
5161    
5162        /**
5163       * Returns a MIDI rule of the instrument.       * Returns a MIDI rule of the instrument.
5164       *       *
5165       * The list of MIDI rules, at least in gig v3, always contains at       * The list of MIDI rules, at least in gig v3, always contains at
# Line 4585  namespace { Line 5228  namespace {
5228          if (scriptPoolFileOffsets.empty()) return;          if (scriptPoolFileOffsets.empty()) return;
5229          File* pFile = (File*) GetParent();          File* pFile = (File*) GetParent();
5230          for (uint k = 0; k < scriptPoolFileOffsets.size(); ++k) {          for (uint k = 0; k < scriptPoolFileOffsets.size(); ++k) {
5231              uint32_t offset = scriptPoolFileOffsets[k].fileOffset;              uint32_t soughtOffset = scriptPoolFileOffsets[k].fileOffset;
5232              for (uint i = 0; pFile->GetScriptGroup(i); ++i) {              for (uint i = 0; pFile->GetScriptGroup(i); ++i) {
5233                  ScriptGroup* group = pFile->GetScriptGroup(i);                  ScriptGroup* group = pFile->GetScriptGroup(i);
5234                  for (uint s = 0; group->GetScript(s); ++s) {                  for (uint s = 0; group->GetScript(s); ++s) {
5235                      Script* script = group->GetScript(s);                      Script* script = group->GetScript(s);
5236                      if (script->pChunk) {                      if (script->pChunk) {
5237                          script->pChunk->SetPos(0);                          uint32_t offset = uint32_t(
5238                          if (script->pChunk->GetFilePos() -                              script->pChunk->GetFilePos() -
5239                              script->pChunk->GetPos() -                              script->pChunk->GetPos() -
5240                              CHUNK_HEADER_SIZE == offset)                              CHUNK_HEADER_SIZE(script->pChunk->GetFile()->GetFileOffsetSize())
5241                            );
5242                            if (offset == soughtOffset)
5243                          {                          {
5244                              _ScriptPooolRef ref;                              _ScriptPooolRef ref;
5245                              ref.script = script;                              ref.script = script;
# Line 4718  namespace { Line 5363  namespace {
5363       */       */
5364      void Instrument::RemoveScript(Script* pScript) {      void Instrument::RemoveScript(Script* pScript) {
5365          LoadScripts();          LoadScripts();
5366          for (int i = pScriptRefs->size() - 1; i >= 0; --i) {          for (ssize_t i = pScriptRefs->size() - 1; i >= 0; --i) {
5367              if ((*pScriptRefs)[i].script == pScript) {              if ((*pScriptRefs)[i].script == pScript) {
5368                  pScriptRefs->erase( pScriptRefs->begin() + i );                  pScriptRefs->erase( pScriptRefs->begin() + i );
5369              }              }
# Line 4740  namespace { Line 5385  namespace {
5385       * gigedit.       * gigedit.
5386       */       */
5387      uint Instrument::ScriptSlotCount() const {      uint Instrument::ScriptSlotCount() const {
5388          return pScriptRefs ? pScriptRefs->size() : scriptPoolFileOffsets.size();          return uint(pScriptRefs ? pScriptRefs->size() : scriptPoolFileOffsets.size());
5389      }      }
5390    
5391      /** @brief Whether script execution shall be skipped.      /** @brief Whether script execution shall be skipped.
# Line 4864  namespace { Line 5509  namespace {
5509          ::LoadString(pNameChunk, Name);          ::LoadString(pNameChunk, Name);
5510      }      }
5511    
5512        /** @brief Destructor.
5513         *
5514         * Currently this destructor implementation does nothing.
5515         */
5516      Group::~Group() {      Group::~Group() {
5517          // remove the chunk associated with this group (if any)      }
5518          if (pNameChunk) pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);  
5519        /** @brief Remove all RIFF chunks associated with this Group object.
5520         *
5521         * See DLS::Storage::DeleteChunks() for details.
5522         */
5523        void Group::DeleteChunks() {
5524            // handle own RIFF chunks
5525            if (pNameChunk) {
5526                pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
5527                pNameChunk = NULL;
5528            }
5529      }      }
5530    
5531      /** @brief Update chunks with current group settings.      /** @brief Update chunks with current group settings.
# Line 4876  namespace { Line 5535  namespace {
5535       *       *
5536       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
5537       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
5538         *
5539         * @param pProgress - callback function for progress notification
5540       */       */
5541      void Group::UpdateChunks() {      void Group::UpdateChunks(progress_t* pProgress) {
5542          // make sure <3gri> and <3gnl> list chunks exist          // make sure <3gri> and <3gnl> list chunks exist
5543          RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);          RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);
5544          if (!_3gri) {          if (!_3gri) {
# Line 4887  namespace { Line 5548  namespace {
5548          RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);          RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
5549          if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);          if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
5550    
5551          if (!pNameChunk && pFile->pVersion && pFile->pVersion->major == 3) {          if (!pNameChunk && pFile->pVersion && pFile->pVersion->major > 2) {
5552              // v3 has a fixed list of 128 strings, find a free one              // v3 has a fixed list of 128 strings, find a free one
5553              for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {              for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {
5554                  if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {                  if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {
# Line 4982  namespace { Line 5643  namespace {
5643          0, 3, 20030331 & 0xffff, 20030331 >> 16          0, 3, 20030331 & 0xffff, 20030331 >> 16
5644      };      };
5645    
5646        /// Reflects Gigasampler file format version 4.0 (2007-10-12).
5647        const DLS::version_t File::VERSION_4 = {
5648            0, 4, 20071012 & 0xffff, 20071012 >> 16
5649        };
5650    
5651      static const DLS::Info::string_length_t _FileFixedStringLengths[] = {      static const DLS::Info::string_length_t _FileFixedStringLengths[] = {
5652          { CHUNK_ID_IARL, 256 },          { CHUNK_ID_IARL, 256 },
5653          { CHUNK_ID_IART, 128 },          { CHUNK_ID_IART, 128 },
# Line 5078  namespace { Line 5744  namespace {
5744          return static_cast<gig::Sample*>( *it );          return static_cast<gig::Sample*>( *it );
5745      }      }
5746    
5747        /**
5748         * Returns the total amount of samples of this gig file.
5749         *
5750         * Note that this method might block for a long time in case it is required
5751         * to load the sample info for the first time.
5752         *
5753         * @returns total amount of samples
5754         */
5755        size_t File::CountSamples() {
5756            if (!pSamples) LoadSamples();
5757            if (!pSamples) return 0;
5758            return pSamples->size();
5759        }
5760    
5761      /** @brief Add a new sample.      /** @brief Add a new sample.
5762       *       *
5763       * This will create a new Sample object for the gig file. You have to       * This will create a new Sample object for the gig file. You have to
# Line 5116  namespace { Line 5796  namespace {
5796          if (iter == pSamples->end()) throw gig::Exception("Could not delete sample, could not find given sample");          if (iter == pSamples->end()) throw gig::Exception("Could not delete sample, could not find given sample");
5797          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
5798          pSamples->erase(iter);          pSamples->erase(iter);
5799            pSample->DeleteChunks();
5800          delete pSample;          delete pSample;
5801    
5802          SampleList::iterator tmp = SamplesIterator;          SampleList::iterator tmp = SamplesIterator;
# Line 5153  namespace { Line 5834  namespace {
5834          int iSampleIndex  = 0;          int iSampleIndex  = 0;
5835          int iTotalSamples = WavePoolCount;          int iTotalSamples = WavePoolCount;
5836    
5837          // check if samples should be loaded from extension files          // just for assembling path of optional extension files to be read
5838          int lastFileNo = 0;          const std::string folder = parentPath(pRIFF->GetFileName());
5839          for (int i = 0 ; i < WavePoolCount ; i++) {          const std::string baseName = pathWithoutExtension(pRIFF->GetFileName());
5840              if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];  
5841          }          // the main gig file and the extension files (.gx01, ... , .gx98) may
5842          String name(pRIFF->GetFileName());          // contain wave data (wave pool)
5843          int nameLen = name.length();          std::vector<RIFF::File*> poolFiles;
5844          char suffix[6];          poolFiles.push_back(pRIFF);
5845          if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;  
5846            // get info about all extension files
5847          for (int fileNo = 0 ; ; ) {          RIFF::Chunk* ckXfil = pRIFF->GetSubChunk(CHUNK_ID_XFIL);
5848            if (ckXfil) { // there are extension files (.gx01, ... , .gx98) ...
5849                const uint32_t n = ckXfil->ReadInt32();
5850                for (int i = 0; i < n; i++) {
5851                    // read the filename and load the extension file
5852                    std::string name;
5853                    ckXfil->ReadString(name, 128);
5854                    std::string path = concatPath(folder, name);
5855                    RIFF::File* pExtFile = new RIFF::File(path);
5856                    // check that the dlsids match
5857                    RIFF::Chunk* ckDLSID = pExtFile->GetSubChunk(CHUNK_ID_DLID);
5858                    if (ckDLSID) {
5859                        ::DLS::dlsid_t idExpected;
5860                        idExpected.ulData1 = ckXfil->ReadInt32();
5861                        idExpected.usData2 = ckXfil->ReadInt16();
5862                        idExpected.usData3 = ckXfil->ReadInt16();
5863                        ckXfil->Read(idExpected.abData, 8, 1);
5864                        ::DLS::dlsid_t idFound;
5865                        ckDLSID->Read(&idFound.ulData1, 1, 4);
5866                        ckDLSID->Read(&idFound.usData2, 1, 2);
5867                        ckDLSID->Read(&idFound.usData3, 1, 2);
5868                        ckDLSID->Read(idFound.abData, 8, 1);
5869                        if (memcmp(&idExpected, &idFound, 16) != 0)
5870                            throw gig::Exception("dlsid mismatch for extension file: %s", path.c_str());
5871                    }
5872                    poolFiles.push_back(pExtFile);
5873                    ExtensionFiles.push_back(pExtFile);
5874                }
5875            }
5876    
5877            // check if a .gx99 (GigaPulse) file exists
5878            RIFF::Chunk* ckDoxf = pRIFF->GetSubChunk(CHUNK_ID_DOXF);
5879            if (ckDoxf) { // there is a .gx99 (GigaPulse) file ...
5880                std::string path = baseName + ".gx99";
5881                RIFF::File* pExtFile = new RIFF::File(path);
5882    
5883                // skip unused int and filename
5884                ckDoxf->SetPos(132, RIFF::stream_curpos);
5885    
5886                // check that the dlsids match
5887                RIFF::Chunk* ckDLSID = pExtFile->GetSubChunk(CHUNK_ID_DLID);
5888                if (ckDLSID) {
5889                    ::DLS::dlsid_t idExpected;
5890                    idExpected.ulData1 = ckDoxf->ReadInt32();
5891                    idExpected.usData2 = ckDoxf->ReadInt16();
5892                    idExpected.usData3 = ckDoxf->ReadInt16();
5893                    ckDoxf->Read(idExpected.abData, 8, 1);
5894                    ::DLS::dlsid_t idFound;
5895                    ckDLSID->Read(&idFound.ulData1, 1, 4);
5896                    ckDLSID->Read(&idFound.usData2, 1, 2);
5897                    ckDLSID->Read(&idFound.usData3, 1, 2);
5898                    ckDLSID->Read(idFound.abData, 8, 1);
5899                    if (memcmp(&idExpected, &idFound, 16) != 0)
5900                        throw gig::Exception("dlsid mismatch for GigaPulse file: %s", path.c_str());
5901                }
5902                poolFiles.push_back(pExtFile);
5903                ExtensionFiles.push_back(pExtFile);
5904            }
5905    
5906            // load samples from extension files (if required)
5907            for (int i = 0; i < poolFiles.size(); i++) {
5908                RIFF::File* file = poolFiles[i];
5909              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
5910              if (wvpl) {              if (wvpl) {
5911                  unsigned long wvplFileOffset = wvpl->GetFilePos();                  file_offset_t wvplFileOffset = wvpl->GetFilePos() -
5912                                                   wvpl->GetPos(); // should be zero, but just to be sure
5913                  RIFF::List* wave = wvpl->GetFirstSubList();                  RIFF::List* wave = wvpl->GetFirstSubList();
5914                  while (wave) {                  while (wave) {
5915                      if (wave->GetListType() == LIST_TYPE_WAVE) {                      if (wave->GetListType() == LIST_TYPE_WAVE) {
5916                          // notify current progress                          // notify current progress
5917                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;                          if (pProgress) {
5918                          __notify_progress(pProgress, subprogress);                              const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
5919                                __notify_progress(pProgress, subprogress);
5920                            }
5921    
5922                          unsigned long waveFileOffset = wave->GetFilePos();                          file_offset_t waveFileOffset = wave->GetFilePos();
5923                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, i, iSampleIndex));
5924    
5925                          iSampleIndex++;                          iSampleIndex++;
5926                      }                      }
5927                      wave = wvpl->GetNextSubList();                      wave = wvpl->GetNextSubList();
5928                  }                  }
5929                }
                 if (fileNo == lastFileNo) break;  
   
                 // open extension file (*.gx01, *.gx02, ...)  
                 fileNo++;  
                 sprintf(suffix, ".gx%02d", fileNo);  
                 name.replace(nameLen, 5, suffix);  
                 file = new RIFF::File(name);  
                 ExtensionFiles.push_back(file);  
             } else break;  
5930          }          }
5931    
5932          __notify_progress(pProgress, 1.0); // notify done          if (pProgress)
5933                __notify_progress(pProgress, 1.0); // notify done
5934      }      }
5935    
5936      Instrument* File::GetFirstInstrument() {      Instrument* File::GetFirstInstrument() {
# Line 5210  namespace { Line 5947  namespace {
5947      }      }
5948    
5949      /**      /**
5950         * Returns the total amount of instruments of this gig file.
5951         *
5952         * Note that this method might block for a long time in case it is required
5953         * to load the instruments info for the first time.
5954         *
5955         * @returns total amount of instruments
5956         */
5957        size_t File::CountInstruments() {
5958            if (!pInstruments) LoadInstruments();
5959            if (!pInstruments) return 0;
5960            return pInstruments->size();
5961        }
5962    
5963        /**
5964       * Returns the instrument with the given index.       * Returns the instrument with the given index.
5965       *       *
5966       * @param index     - number of the sought instrument (0..n)       * @param index     - number of the sought instrument (0..n)
# Line 5220  namespace { Line 5971  namespace {
5971          if (!pInstruments) {          if (!pInstruments) {
5972              // TODO: hack - we simply load ALL samples here, it would have been done in the Region constructor anyway (ATM)              // TODO: hack - we simply load ALL samples here, it would have been done in the Region constructor anyway (ATM)
5973    
5974              // sample loading subtask              if (pProgress) {
5975              progress_t subprogress;                  // sample loading subtask
5976              __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask                  progress_t subprogress;
5977              __notify_progress(&subprogress, 0.0f);                  __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
5978              if (GetAutoLoad())                  __notify_progress(&subprogress, 0.0f);
5979                  GetFirstSample(&subprogress); // now force all samples to be loaded                  if (GetAutoLoad())
5980              __notify_progress(&subprogress, 1.0f);                      GetFirstSample(&subprogress); // now force all samples to be loaded
5981                    __notify_progress(&subprogress, 1.0f);
5982              // instrument loading subtask  
5983              if (pProgress && pProgress->callback) {                  // instrument loading subtask
5984                  subprogress.__range_min = subprogress.__range_max;                  if (pProgress->callback) {
5985                  subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask                      subprogress.__range_min = subprogress.__range_max;
5986              }                      subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask
5987              __notify_progress(&subprogress, 0.0f);                  }
5988              LoadInstruments(&subprogress);                  __notify_progress(&subprogress, 0.0f);
5989              __notify_progress(&subprogress, 1.0f);                  LoadInstruments(&subprogress);
5990                    __notify_progress(&subprogress, 1.0f);
5991                } else {
5992                    // sample loading subtask
5993                    if (GetAutoLoad())
5994                        GetFirstSample(); // now force all samples to be loaded
5995    
5996                    // instrument loading subtask
5997                    LoadInstruments();
5998                }
5999          }          }
6000          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
6001          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
# Line 5328  namespace { Line 6088  namespace {
6088              mGroups[pFile->GetSample(i)->GetGroup()]->AddSample(s);              mGroups[pFile->GetSample(i)->GetGroup()]->AddSample(s);
6089              mSamples[pFile->GetSample(i)] = s;              mSamples[pFile->GetSample(i)] = s;
6090          }          }
6091            
6092            // clone script groups and their scripts
6093            for (int iGroup = 0; pFile->GetScriptGroup(iGroup); ++iGroup) {
6094                ScriptGroup* sg = pFile->GetScriptGroup(iGroup);
6095                ScriptGroup* dg = AddScriptGroup();
6096                dg->Name = "COPY" + ToString(iCallCount) + "_" + sg->Name;
6097                for (int iScript = 0; sg->GetScript(iScript); ++iScript) {
6098                    Script* ss = sg->GetScript(iScript);
6099                    Script* ds = dg->AddScript();
6100                    ds->CopyAssign(ss);
6101                }
6102            }
6103    
6104          //BUG: For some reason this method only works with this additional          //BUG: For some reason this method only works with this additional
6105          //     Save() call in between here.          //     Save() call in between here.
6106          //          //
# Line 5372  namespace { Line 6144  namespace {
6144          InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);          InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);
6145          if (iter == pInstruments->end()) throw gig::Exception("Could not delete instrument, could not find given instrument");          if (iter == pInstruments->end()) throw gig::Exception("Could not delete instrument, could not find given instrument");
6146          pInstruments->erase(iter);          pInstruments->erase(iter);
6147            pInstrument->DeleteChunks();
6148          delete pInstrument;          delete pInstrument;
6149      }      }
6150    
# Line 5387  namespace { Line 6160  namespace {
6160              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();
6161              while (lstInstr) {              while (lstInstr) {
6162                  if (lstInstr->GetListType() == LIST_TYPE_INS) {                  if (lstInstr->GetListType() == LIST_TYPE_INS) {
6163                      // notify current progress                      if (pProgress) {
6164                      const float localProgress = (float) iInstrumentIndex / (float) Instruments;                          // notify current progress
6165                      __notify_progress(pProgress, localProgress);                          const float localProgress = (float) iInstrumentIndex / (float) Instruments;
6166                            __notify_progress(pProgress, localProgress);
                     // divide local progress into subprogress for loading current Instrument  
                     progress_t subprogress;  
                     __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);  
6167    
6168                      pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));                          // divide local progress into subprogress for loading current Instrument
6169                            progress_t subprogress;
6170                            __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
6171    
6172                            pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
6173                        } else {
6174                            pInstruments->push_back(new Instrument(this, lstInstr));
6175                        }
6176    
6177                      iInstrumentIndex++;                      iInstrumentIndex++;
6178                  }                  }
6179                  lstInstr = lstInstruments->GetNextSubList();                  lstInstr = lstInstruments->GetNextSubList();
6180              }              }
6181              __notify_progress(pProgress, 1.0); // notify done              if (pProgress)
6182                    __notify_progress(pProgress, 1.0); // notify done
6183          }          }
6184      }      }
6185    
# Line 5413  namespace { Line 6191  namespace {
6191          if (!_3crc) return;          if (!_3crc) return;
6192    
6193          // get the index of the sample          // get the index of the sample
6194          int iWaveIndex = -1;          int iWaveIndex = GetWaveTableIndexOf(pSample);
         File::SampleList::iterator iter = pSamples->begin();  
         File::SampleList::iterator end  = pSamples->end();  
         for (int index = 0; iter != end; ++iter, ++index) {  
             if (*iter == pSample) {  
                 iWaveIndex = index;  
                 break;  
             }  
         }  
6195          if (iWaveIndex < 0) throw gig::Exception("Could not update crc, could not find sample");          if (iWaveIndex < 0) throw gig::Exception("Could not update crc, could not find sample");
6196    
6197          // write the CRC-32 checksum to disk          // write the CRC-32 checksum to disk
6198          _3crc->SetPos(iWaveIndex * 8);          _3crc->SetPos(iWaveIndex * 8);
6199          uint32_t tmp = 1;          uint32_t one = 1;
6200          _3crc->WriteUint32(&tmp); // unknown, always 1?          _3crc->WriteUint32(&one); // always 1
6201          _3crc->WriteUint32(&crc);          _3crc->WriteUint32(&crc);
6202      }      }
6203    
6204        uint32_t File::GetSampleChecksum(Sample* pSample) {
6205            // get the index of the sample
6206            int iWaveIndex = GetWaveTableIndexOf(pSample);
6207            if (iWaveIndex < 0) throw gig::Exception("Could not retrieve reference crc of sample, could not resolve sample's wave table index");
6208    
6209            return GetSampleChecksumByIndex(iWaveIndex);
6210        }
6211    
6212        uint32_t File::GetSampleChecksumByIndex(int index) {
6213            if (index < 0) throw gig::Exception("Could not retrieve reference crc of sample, invalid wave pool index of sample");
6214    
6215            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6216            if (!_3crc) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
6217            uint8_t* pData = (uint8_t*) _3crc->LoadChunkData();
6218            if (!pData) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
6219    
6220            // read the CRC-32 checksum directly from disk
6221            size_t pos = index * 8;
6222            if (pos + 8 > _3crc->GetNewSize())
6223                throw gig::Exception("Could not retrieve reference crc of sample, could not seek to required position in crc chunk");
6224    
6225            uint32_t one = load32(&pData[pos]); // always 1
6226            if (one != 1)
6227                throw gig::Exception("Could not retrieve reference crc of sample, because reference checksum table is damaged");
6228    
6229            return load32(&pData[pos+4]);
6230        }
6231    
6232        int File::GetWaveTableIndexOf(gig::Sample* pSample) {
6233            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
6234            File::SampleList::iterator iter = pSamples->begin();
6235            File::SampleList::iterator end  = pSamples->end();
6236            for (int index = 0; iter != end; ++iter, ++index)
6237                if (*iter == pSample)
6238                    return index;
6239            return -1;
6240        }
6241    
6242        /**
6243         * Checks whether the file's "3CRC" chunk was damaged. This chunk contains
6244         * the CRC32 check sums of all samples' raw wave data.
6245         *
6246         * @return true if 3CRC chunk is OK, or false if 3CRC chunk is damaged
6247         */
6248        bool File::VerifySampleChecksumTable() {
6249            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6250            if (!_3crc) return false;
6251            if (_3crc->GetNewSize() <= 0) return false;
6252            if (_3crc->GetNewSize() % 8) return false;
6253            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
6254            if (_3crc->GetNewSize() != pSamples->size() * 8) return false;
6255    
6256            const file_offset_t n = _3crc->GetNewSize() / 8;
6257    
6258            uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6259            if (!pData) return false;
6260    
6261            for (file_offset_t i = 0; i < n; ++i) {
6262                uint32_t one = pData[i*2];
6263                if (one != 1) return false;
6264            }
6265    
6266            return true;
6267        }
6268    
6269        /**
6270         * Recalculates CRC32 checksums for all samples and rebuilds this gig
6271         * file's checksum table with those new checksums. This might usually
6272         * just be necessary if the checksum table was damaged.
6273         *
6274         * @e IMPORTANT: The current implementation of this method only works
6275         * with files that have not been modified since it was loaded, because
6276         * it expects that no externally caused file structure changes are
6277         * required!
6278         *
6279         * Due to the expectation above, this method is currently protected
6280         * and actually only used by the command line tool "gigdump" yet.
6281         *
6282         * @returns true if Save() is required to be called after this call,
6283         *          false if no further action is required
6284         */
6285        bool File::RebuildSampleChecksumTable() {
6286            // make sure sample chunks were scanned
6287            if (!pSamples) GetFirstSample();
6288    
6289            bool bRequiresSave = false;
6290    
6291            // make sure "3CRC" chunk exists with required size
6292            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6293            if (!_3crc) {
6294                _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
6295                // the order of einf and 3crc is not the same in v2 and v3
6296                RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
6297                if (einf && pVersion && pVersion->major > 2) pRIFF->MoveSubChunk(_3crc, einf);
6298                bRequiresSave = true;
6299            } else if (_3crc->GetNewSize() != pSamples->size() * 8) {
6300                _3crc->Resize(pSamples->size() * 8);
6301                bRequiresSave = true;
6302            }
6303    
6304            if (bRequiresSave) { // refill CRC table for all samples in RAM ...
6305                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6306                {
6307                    File::SampleList::iterator iter = pSamples->begin();
6308                    File::SampleList::iterator end  = pSamples->end();
6309                    for (; iter != end; ++iter) {
6310                        gig::Sample* pSample = (gig::Sample*) *iter;
6311                        int index = GetWaveTableIndexOf(pSample);
6312                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6313                        pData[index*2]   = 1; // always 1
6314                        pData[index*2+1] = pSample->CalculateWaveDataChecksum();
6315                    }
6316                }
6317            } else { // no file structure changes necessary, so directly write to disk and we are done ...
6318                // make sure file is in write mode
6319                pRIFF->SetMode(RIFF::stream_mode_read_write);
6320                {
6321                    File::SampleList::iterator iter = pSamples->begin();
6322                    File::SampleList::iterator end  = pSamples->end();
6323                    for (; iter != end; ++iter) {
6324                        gig::Sample* pSample = (gig::Sample*) *iter;
6325                        int index = GetWaveTableIndexOf(pSample);
6326                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6327                        pSample->crc  = pSample->CalculateWaveDataChecksum();
6328                        SetSampleChecksum(pSample, pSample->crc);
6329                    }
6330                }
6331            }
6332    
6333            return bRequiresSave;
6334        }
6335    
6336      Group* File::GetFirstGroup() {      Group* File::GetFirstGroup() {
6337          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6338          // there must always be at least one group          // there must always be at least one group
# Line 5507  namespace { Line 6409  namespace {
6409          }          }
6410          // now delete this group object          // now delete this group object
6411          pGroups->erase(iter);          pGroups->erase(iter);
6412            pGroup->DeleteChunks();
6413          delete pGroup;          delete pGroup;
6414      }      }
6415    
# Line 5528  namespace { Line 6431  namespace {
6431          // move all members of this group to another group          // move all members of this group to another group
6432          pGroup->MoveAll();          pGroup->MoveAll();
6433          pGroups->erase(iter);          pGroups->erase(iter);
6434            pGroup->DeleteChunks();
6435          delete pGroup;          delete pGroup;
6436      }      }
6437    
# Line 5541  namespace { Line 6445  namespace {
6445                  RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();                  RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();
6446                  while (ck) {                  while (ck) {
6447                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {
6448                          if (pVersion && pVersion->major == 3 &&                          if (pVersion && pVersion->major > 2 &&
6449                              strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;                              strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;
6450    
6451                          pGroups->push_back(new Group(this, ck));                          pGroups->push_back(new Group(this, ck));
# Line 5627  namespace { Line 6531  namespace {
6531              pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));              pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));
6532          if (pScriptGroup->pList)          if (pScriptGroup->pList)
6533              pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);              pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);
6534            pScriptGroup->DeleteChunks();
6535          delete pScriptGroup;          delete pScriptGroup;
6536      }      }
6537    
# Line 5653  namespace { Line 6558  namespace {
6558       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
6559       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
6560       *       *
6561         * @param pProgress - callback function for progress notification
6562       * @throws Exception - on errors       * @throws Exception - on errors
6563       */       */
6564      void File::UpdateChunks() {      void File::UpdateChunks(progress_t* pProgress) {
6565          bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;          bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;
6566    
         b64BitWavePoolOffsets = pVersion && pVersion->major == 3;  
   
6567          // update own gig format extension chunks          // update own gig format extension chunks
6568          // (not part of the GigaStudio 4 format)          // (not part of the GigaStudio 4 format)
6569          //          RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);
6570            if (!lst3LS) {
6571                lst3LS = pRIFF->AddSubList(LIST_TYPE_3LS);
6572            }
6573            // Make sure <3LS > chunk is placed before <ptbl> chunk. The precise
6574            // location of <3LS > is irrelevant, however it should be located
6575            // before  the actual wave data
6576            RIFF::Chunk* ckPTBL = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
6577            pRIFF->MoveSubChunk(lst3LS, ckPTBL);
6578    
6579          // This must be performed before writing the chunks for instruments,          // This must be performed before writing the chunks for instruments,
6580          // because the instruments' script slots will write the file offsets          // because the instruments' script slots will write the file offsets
6581          // of the respective instrument script chunk as reference.          // of the respective instrument script chunk as reference.
6582          if (pScriptGroups) {          if (pScriptGroups) {
6583              RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);              // Update instrument script (group) chunks.
6584              if (pScriptGroups->empty()) {              for (std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
6585                  if (lst3LS) pRIFF->DeleteSubChunk(lst3LS);                   it != pScriptGroups->end(); ++it)
6586              } else {              {
6587                  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();  
                 }  
6588              }              }
6589          }          }
6590    
6591            // in case no libgig custom format data was added, then remove the
6592            // custom "3LS " chunk again
6593            if (!lst3LS->CountSubChunks()) {
6594                pRIFF->DeleteSubChunk(lst3LS);
6595                lst3LS = NULL;
6596            }
6597    
6598          // first update base class's chunks          // first update base class's chunks
6599          DLS::File::UpdateChunks();          DLS::File::UpdateChunks(pProgress);
6600    
6601          if (newFile) {          if (newFile) {
6602              // INFO was added by Resource::UpdateChunks - make sure it              // INFO was added by Resource::UpdateChunks - make sure it
# Line 5710  namespace { Line 6622  namespace {
6622    
6623              // v3: make sure the file has 128 3gnm chunks              // v3: make sure the file has 128 3gnm chunks
6624              // (before updating the Group chunks)              // (before updating the Group chunks)
6625              if (pVersion && pVersion->major == 3) {              if (pVersion && pVersion->major > 2) {
6626                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
6627                  for (int i = 0 ; i < 128 ; i++) {                  for (int i = 0 ; i < 128 ; i++) {
6628                      if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);                      if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
# Line 5721  namespace { Line 6633  namespace {
6633              std::list<Group*>::iterator iter = pGroups->begin();              std::list<Group*>::iterator iter = pGroups->begin();
6634              std::list<Group*>::iterator end  = pGroups->end();              std::list<Group*>::iterator end  = pGroups->end();
6635              for (; iter != end; ++iter) {              for (; iter != end; ++iter) {
6636                  (*iter)->UpdateChunks();                  (*iter)->UpdateChunks(pProgress);
6637              }              }
6638          }          }
6639    
# Line 5741  namespace { Line 6653  namespace {
6653          // Note that there are several fields with unknown use. These          // Note that there are several fields with unknown use. These
6654          // are set to zero.          // are set to zero.
6655    
6656          int sublen = pSamples->size() / 8 + 49;          int sublen = int(pSamples->size() / 8 + 49);
6657          int einfSize = (Instruments + 1) * sublen;          int einfSize = (Instruments + 1) * sublen;
6658    
6659          RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);          RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
# Line 5814  namespace { Line 6726  namespace {
6726                  store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);                  store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);
6727                  // next 8 bytes unknown                  // next 8 bytes unknown
6728                  store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);                  store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);
6729                  store32(&pData[(instrumentIdx + 1) * sublen + 40], pSamples->size());                  store32(&pData[(instrumentIdx + 1) * sublen + 40], (uint32_t) pSamples->size());
6730                  // next 4 bytes unknown                  // next 4 bytes unknown
6731    
6732                  totnbregions += instrument->Regions;                  totnbregions += instrument->Regions;
# Line 5832  namespace { Line 6744  namespace {
6744              store32(&pData[24], totnbloops);              store32(&pData[24], totnbloops);
6745              // next 8 bytes unknown              // next 8 bytes unknown
6746              // next 4 bytes unknown, not always 0              // next 4 bytes unknown, not always 0
6747              store32(&pData[40], pSamples->size());              store32(&pData[40], (uint32_t) pSamples->size());
6748              // next 4 bytes unknown              // next 4 bytes unknown
6749          }          }
6750    
6751          // update 3crc chunk          // update 3crc chunk
6752    
6753          // The 3crc chunk contains CRC-32 checksums for the          // The 3crc chunk contains CRC-32 checksums for the
6754          // samples. The actual checksum values will be filled in          // samples. When saving a gig file to disk, we first update the 3CRC
6755          // later, by Sample::Write.          // chunk here (in RAM) with the old crc values which we read from the
6756            // 3CRC chunk when we opened the file (available with gig::Sample::crc
6757            // member variable). This step is required, because samples might have
6758            // been deleted by the user since the file was opened, which in turn
6759            // changes the order of the (i.e. old) checksums within the 3crc chunk.
6760            // If a sample was conciously modified by the user (that is if
6761            // Sample::Write() was called later on) then Sample::Write() will just
6762            // update the respective individual checksum(s) directly on disk and
6763            // leaves all other sample checksums untouched.
6764    
6765          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6766          if (_3crc) {          if (_3crc) {
6767              _3crc->Resize(pSamples->size() * 8);              _3crc->Resize(pSamples->size() * 8);
6768          } else if (newFile) {          } else /*if (newFile)*/ {
6769              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
             _3crc->LoadChunkData();  
   
6770              // the order of einf and 3crc is not the same in v2 and v3              // the order of einf and 3crc is not the same in v2 and v3
6771              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);              if (einf && pVersion && pVersion->major > 2) pRIFF->MoveSubChunk(_3crc, einf);
6772            }
6773            { // must be performed in RAM here ...
6774                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6775                if (pData) {
6776                    File::SampleList::iterator iter = pSamples->begin();
6777                    File::SampleList::iterator end  = pSamples->end();
6778                    for (int index = 0; iter != end; ++iter, ++index) {
6779                        gig::Sample* pSample = (gig::Sample*) *iter;
6780                        pData[index*2]   = 1; // always 1
6781                        pData[index*2+1] = pSample->crc;
6782                    }
6783                }
6784            }
6785        }
6786        
6787        void File::UpdateFileOffsets() {
6788            DLS::File::UpdateFileOffsets();
6789    
6790            for (Instrument* instrument = GetFirstInstrument(); instrument;
6791                 instrument = GetNextInstrument())
6792            {
6793                instrument->UpdateScriptFileOffsets();
6794          }          }
6795      }      }
6796    
6797      /**      /**
6798       * Enable / disable automatic loading. By default this properyt is       * Enable / disable automatic loading. By default this property is
6799       * enabled and all informations are loaded automatically. However       * enabled and every information is loaded automatically. However
6800       * loading all Regions, DimensionRegions and especially samples might       * loading all Regions, DimensionRegions and especially samples might
6801       * take a long time for large .gig files, and sometimes one might only       * take a long time for large .gig files, and sometimes one might only
6802       * be interested in retrieving very superficial informations like the       * be interested in retrieving very superficial informations like the
# Line 5864  namespace { Line 6804  namespace {
6804       * automatic loading to avoid very slow response times.       * automatic loading to avoid very slow response times.
6805       *       *
6806       * @e CAUTION: by disabling this property many pointers (i.e. sample       * @e CAUTION: by disabling this property many pointers (i.e. sample
6807       * references) and informations will have invalid or even undefined       * references) and attributes will have invalid or even undefined
6808       * data! This feature is currently only intended for retrieving very       * data! This feature is currently only intended for retrieving very
6809       * superficial informations in a very fast way. Don't use it to retrieve       * superficial information in a very fast way. Don't use it to retrieve
6810       * details like synthesis informations or even to modify .gig files!       * details like synthesis information or even to modify .gig files!
6811       */       */
6812      void File::SetAutoLoad(bool b) {      void File::SetAutoLoad(bool b) {
6813          bAutoLoad = b;          bAutoLoad = b;
# Line 5886  namespace { Line 6826  namespace {
6826  // *************** Exception ***************  // *************** Exception ***************
6827  // *  // *
6828    
6829      Exception::Exception(String Message) : DLS::Exception(Message) {      Exception::Exception() : DLS::Exception() {
6830        }
6831    
6832        Exception::Exception(String format, ...) : DLS::Exception() {
6833            va_list arg;
6834            va_start(arg, format);
6835            Message = assemble(format, arg);
6836            va_end(arg);
6837        }
6838    
6839        Exception::Exception(String format, va_list arg) : DLS::Exception() {
6840            Message = assemble(format, arg);
6841      }      }
6842    
6843      void Exception::PrintMessage() {      void Exception::PrintMessage() {

Legend:
Removed from v.2593  
changed lines
  Added in v.3623

  ViewVC Help
Powered by ViewVC