/[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 2702 by schoenebeck, Tue Jan 13 00:32:30 2015 UTC revision 3924 by schoenebeck, Mon Jun 14 12:07:47 2021 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-2015 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2021 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    #define SRLZ(member) \
60        archive->serializeMember(*this, member, #member);
61    
62  namespace gig {  namespace gig {
63    
64  // *************** Internal functions for sample decompression ***************  // *************** Internal functions for sample decompression ***************
# Line 91  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 128  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 265  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 282  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 311  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 334  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 345  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 357  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 403  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 412  namespace { Line 482  namespace {
482              ScanCompressedSample();              ScanCompressedSample();
483          }          }
484    
485          // we use a buffer for decompression and for truncating 24 bit samples to 16 bit          // we use a buffer for decompression only
486          if ((Compressed || BitDepth == 24) && !InternalDecompressionBuffer.Size) {          if (Compressed && !InternalDecompressionBuffer.Size) {
487              InternalDecompressionBuffer.pStart = new unsigned char[INITIAL_SAMPLE_BUFFER_SIZE];              InternalDecompressionBuffer.pStart = new unsigned char[INITIAL_SAMPLE_BUFFER_SIZE];
488              InternalDecompressionBuffer.Size   = INITIAL_SAMPLE_BUFFER_SIZE;              InternalDecompressionBuffer.Size   = INITIAL_SAMPLE_BUFFER_SIZE;
489          }          }
# Line 477  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 565  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 581  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 600  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 616  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 659  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 718  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 785  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 819  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 837  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 853  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 892  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 932  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 983  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 1067  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 1082  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 1105  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 1256  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 1265  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 1277  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 1299  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 1337  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 1353  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 1369  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 1547  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 1602  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 1706  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 1739  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 2006  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 2045  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 2420  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 2914  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 2924  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 2958  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 2967  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 3016  namespace { Line 3412  namespace {
3412          }          }
3413    
3414          File* pFile = (File*) GetParent()->GetParent();          File* pFile = (File*) GetParent()->GetParent();
3415          bool version3 = pFile->pVersion && pFile->pVersion->major == 3;          const 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 3047  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 3063  namespace { Line 3459  namespace {
3459              }              }
3460              store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);              store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);
3461          }          }
3462    
3463            // The following chunks are just added for compatibility with the
3464            // GigaStudio software, which would show a warning if these were
3465            // missing. However currently these chunks don't cover any useful
3466            // data. So if this gig file uses any of our own gig format
3467            // extensions which would cause this gig file to be unloadable
3468            // with GSt software anyway, then just skip these GSt compatibility
3469            // chunks here as well.
3470            if (versiongt2 && !UsesAnyGigFormatExtension()) {
3471                // add 3dnm list which always seems to be empty
3472                RIFF::List* _3dnm = pCkRegion->GetSubList(LIST_TYPE_3DNM);
3473                if (!_3dnm) _3dnm = pCkRegion->AddSubList(LIST_TYPE_3DNM);
3474    
3475                // add 3ddp chunk which always seems to have 16 bytes of 0xFF
3476                RIFF::Chunk* _3ddp = pCkRegion->GetSubChunk(CHUNK_ID_3DDP);
3477                if (!_3ddp) _3ddp =  pCkRegion->AddSubChunk(CHUNK_ID_3DDP, 16);
3478                uint8_t* pData = (uint8_t*) _3ddp->LoadChunkData();
3479                for (int i = 0; i < 16; i += 4) {
3480                    store32(&pData[i], 0xFFFFFFFF);
3481                }
3482    
3483                // move 3dnm and 3ddp to the end of the region list
3484                pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3DNM), (RIFF::Chunk*)NULL);
3485                pCkRegion->MoveSubChunk(pCkRegion->GetSubChunk(CHUNK_ID_3DDP), (RIFF::Chunk*)NULL);
3486            } else {
3487                // this is intended for the user switching from GSt >= 3 version
3488                // back to an older format version, delete GSt3 chunks ...
3489                RIFF::List* _3dnm = pCkRegion->GetSubList(LIST_TYPE_3DNM);
3490                if (_3dnm) pCkRegion->DeleteSubChunk(_3dnm);
3491    
3492                RIFF::Chunk* _3ddp = pCkRegion->GetSubChunk(CHUNK_ID_3DDP);
3493                if (_3ddp) pCkRegion->DeleteSubChunk(_3ddp);
3494            }
3495      }      }
3496    
3497      void Region::LoadDimensionRegions(RIFF::List* rgn) {      void Region::LoadDimensionRegions(RIFF::List* rgn) {
3498          RIFF::List* _3prg = rgn->GetSubList(LIST_TYPE_3PRG);          RIFF::List* _3prg = rgn->GetSubList(LIST_TYPE_3PRG);
3499          if (_3prg) {          if (_3prg) {
3500              int dimensionRegionNr = 0;              int dimensionRegionNr = 0;
3501              RIFF::List* _3ewl = _3prg->GetFirstSubList();              size_t i = 0;
3502              while (_3ewl) {              for (RIFF::List* _3ewl = _3prg->GetSubListAt(i); _3ewl;
3503                     _3ewl = _3prg->GetSubListAt(++i))
3504                {
3505                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {
3506                      pDimensionRegions[dimensionRegionNr] = new DimensionRegion(this, _3ewl);                      pDimensionRegions[dimensionRegionNr] = new DimensionRegion(this, _3ewl);
3507                      dimensionRegionNr++;                      dimensionRegionNr++;
3508                  }                  }
                 _3ewl = _3prg->GetNextSubList();  
3509              }              }
3510              if (dimensionRegionNr == 0) throw gig::Exception("No dimension region found.");              if (dimensionRegionNr == 0) throw gig::Exception("No dimension region found.");
3511          }          }
# Line 3102  namespace { Line 3532  namespace {
3532          int step = 1;          int step = 1;
3533          for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;          for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
3534          int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;          int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
         int end = step * pDimensionDefinitions[veldim].zones;  
3535    
3536          // loop through all dimension regions for all dimensions except the velocity dimension          // loop through all dimension regions for all dimensions except the velocity dimension
3537          int dim[8] = { 0 };          int dim[8] = { 0 };
3538          for (int i = 0 ; i < DimensionRegions ; i++) {          for (int i = 0 ; i < DimensionRegions ; i++) {
3539                const int end = i + step * pDimensionDefinitions[veldim].zones;
3540    
3541                // create a velocity table for all cases where the velocity zone is zero
3542              if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||              if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||
3543                  pDimensionRegions[i]->VelocityUpperLimit) {                  pDimensionRegions[i]->VelocityUpperLimit) {
3544                  // create the velocity table                  // create the velocity table
# Line 3138  namespace { Line 3569  namespace {
3569                  }                  }
3570              }              }
3571    
3572                // jump to the next case where the velocity zone is zero
3573              int j;              int j;
3574              int shift = 0;              int shift = 0;
3575              for (j = 0 ; j < Dimensions ; j++) {              for (j = 0 ; j < Dimensions ; j++) {
# Line 3188  namespace { Line 3620  namespace {
3620    
3621          // check if max. amount of dimensions reached          // check if max. amount of dimensions reached
3622          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
3623          const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;          const int iMaxDimensions = (file->pVersion && file->pVersion->major > 2) ? 8 : 5;
3624          if (Dimensions >= iMaxDimensions)          if (Dimensions >= iMaxDimensions)
3625              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");
3626          // check if max. amount of dimension bits reached          // check if max. amount of dimension bits reached
# Line 3376  namespace { Line 3808  namespace {
3808       * @throws gig::Exception if requested zone could not be deleted       * @throws gig::Exception if requested zone could not be deleted
3809       */       */
3810      void Region::DeleteDimensionZone(dimension_t type, int zone) {      void Region::DeleteDimensionZone(dimension_t type, int zone) {
3811            if (!Dimensions)
3812                throw gig::Exception("Could not delete dimension zone, because there is no dimension at all.");
3813          dimension_def_t* oldDef = GetDimensionDefinition(type);          dimension_def_t* oldDef = GetDimensionDefinition(type);
3814          if (!oldDef)          if (!oldDef)
3815              throw gig::Exception("Could not delete dimension zone, no such dimension of given type");              throw gig::Exception("Could not delete dimension zone, no such dimension of given type");
# Line 3404  namespace { Line 3838  namespace {
3838          // requested by the arguments of this method call) to the temporary          // requested by the arguments of this method call) to the temporary
3839          // region, and don't use Region::CopyAssign() here for this task, since          // region, and don't use Region::CopyAssign() here for this task, since
3840          // it would also alter fast lookup helper variables here and there          // it would also alter fast lookup helper variables here and there
3841          dimension_def_t newDef;          dimension_def_t newDef = {};
3842          for (int i = 0; i < Dimensions; ++i) {          for (int i = 0; i < Dimensions; ++i) {
3843              dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference              dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3844              // is this the dimension requested by the method arguments? ...              // is this the dimension requested by the method arguments? ...
# Line 3415  namespace { Line 3849  namespace {
3849              }              }
3850              tempRgn->AddDimension(&def);              tempRgn->AddDimension(&def);
3851          }          }
3852            // silence clang sanitizer warning
3853            if (newDef.dimension == dimension_none)
3854                throw gig::Exception("Unexpected internal failure resolving dimension in DeleteDimensionZone() [this is a bug].");
3855    
3856          // find the dimension index in the tempRegion which is the dimension          // find the dimension index in the tempRegion which is the dimension
3857          // type passed to this method (paranoidly expecting different order)          // type passed to this method (paranoidly expecting different order)
# Line 3459  namespace { Line 3896  namespace {
3896          // now tempRegion's dimensions and DimensionRegions basically reflect          // now tempRegion's dimensions and DimensionRegions basically reflect
3897          // what we wanted to get for this actual Region here, so we now just          // what we wanted to get for this actual Region here, so we now just
3898          // delete and recreate the dimension in question with the new amount          // delete and recreate the dimension in question with the new amount
3899          // zones and then copy back from tempRegion                // zones and then copy back from tempRegion. we're actually deleting and
3900          DeleteDimension(oldDef);          // recreating all dimensions here, to avoid altering the precise order
3901          AddDimension(&newDef);          // of the dimensions (which would not be an error per se, but it would
3902            // cause usability issues with instrument editors)
3903            {
3904                std::vector<dimension_def_t> oldDefs;
3905                for (int i = 0; i < Dimensions; ++i)
3906                    oldDefs.push_back(pDimensionDefinitions[i]); // copy, don't reference
3907                for (int i = Dimensions - 1; i >= 0; --i)
3908                    DeleteDimension(&pDimensionDefinitions[i]);
3909                for (int i = 0; i < oldDefs.size(); ++i) {
3910                    dimension_def_t& def = oldDefs[i];
3911                    AddDimension(
3912                        (def.dimension == newDef.dimension) ? &newDef : &def
3913                    );
3914                }
3915            }
3916          for (int iSrc = 0; iSrc < 256; ++iSrc) {          for (int iSrc = 0; iSrc < 256; ++iSrc) {
3917              DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];              DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
3918              if (!srcDimRgn) continue;              if (!srcDimRgn) continue;
# Line 3480  namespace { Line 3931  namespace {
3931          }          }
3932    
3933          // delete temporary region          // delete temporary region
3934            tempRgn->DeleteChunks();
3935          delete tempRgn;          delete tempRgn;
3936    
3937          UpdateVelocityTable();          UpdateVelocityTable();
# Line 3500  namespace { Line 3952  namespace {
3952       * @throws gig::Exception if requested zone could not be splitted       * @throws gig::Exception if requested zone could not be splitted
3953       */       */
3954      void Region::SplitDimensionZone(dimension_t type, int zone) {      void Region::SplitDimensionZone(dimension_t type, int zone) {
3955            if (!Dimensions)
3956                throw gig::Exception("Could not split dimension zone, because there is no dimension at all.");
3957          dimension_def_t* oldDef = GetDimensionDefinition(type);          dimension_def_t* oldDef = GetDimensionDefinition(type);
3958          if (!oldDef)          if (!oldDef)
3959              throw gig::Exception("Could not split dimension zone, no such dimension of given type");              throw gig::Exception("Could not split dimension zone, no such dimension of given type");
# Line 3526  namespace { Line 3980  namespace {
3980          // requested by the arguments of this method call) to the temporary          // requested by the arguments of this method call) to the temporary
3981          // region, and don't use Region::CopyAssign() here for this task, since          // region, and don't use Region::CopyAssign() here for this task, since
3982          // it would also alter fast lookup helper variables here and there          // it would also alter fast lookup helper variables here and there
3983          dimension_def_t newDef;          dimension_def_t newDef = {};
3984          for (int i = 0; i < Dimensions; ++i) {          for (int i = 0; i < Dimensions; ++i) {
3985              dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference              dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3986              // is this the dimension requested by the method arguments? ...              // is this the dimension requested by the method arguments? ...
# Line 3537  namespace { Line 3991  namespace {
3991              }              }
3992              tempRgn->AddDimension(&def);              tempRgn->AddDimension(&def);
3993          }          }
3994            // silence clang sanitizer warning
3995            if (newDef.dimension == dimension_none)
3996                throw gig::Exception("Unexpected internal failure resolving dimension in SplitDimensionZone() [this is a bug].");
3997    
3998          // find the dimension index in the tempRegion which is the dimension          // find the dimension index in the tempRegion which is the dimension
3999          // type passed to this method (paranoidly expecting different order)          // type passed to this method (paranoidly expecting different order)
# Line 3598  namespace { Line 4055  namespace {
4055          // now tempRegion's dimensions and DimensionRegions basically reflect          // now tempRegion's dimensions and DimensionRegions basically reflect
4056          // what we wanted to get for this actual Region here, so we now just          // what we wanted to get for this actual Region here, so we now just
4057          // delete and recreate the dimension in question with the new amount          // delete and recreate the dimension in question with the new amount
4058          // zones and then copy back from tempRegion                // zones and then copy back from tempRegion. we're actually deleting and
4059          DeleteDimension(oldDef);          // recreating all dimensions here, to avoid altering the precise order
4060          AddDimension(&newDef);          // of the dimensions (which would not be an error per se, but it would
4061            // cause usability issues with instrument editors)
4062            {
4063                std::vector<dimension_def_t> oldDefs;
4064                for (int i = 0; i < Dimensions; ++i)
4065                    oldDefs.push_back(pDimensionDefinitions[i]); // copy, don't reference
4066                for (int i = Dimensions - 1; i >= 0; --i)
4067                    DeleteDimension(&pDimensionDefinitions[i]);
4068                for (int i = 0; i < oldDefs.size(); ++i) {
4069                    dimension_def_t& def = oldDefs[i];
4070                    AddDimension(
4071                        (def.dimension == newDef.dimension) ? &newDef : &def
4072                    );
4073                }
4074            }
4075          for (int iSrc = 0; iSrc < 256; ++iSrc) {          for (int iSrc = 0; iSrc < 256; ++iSrc) {
4076              DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];              DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
4077              if (!srcDimRgn) continue;              if (!srcDimRgn) continue;
# Line 3619  namespace { Line 4090  namespace {
4090          }          }
4091    
4092          // delete temporary region          // delete temporary region
4093            tempRgn->DeleteChunks();
4094          delete tempRgn;          delete tempRgn;
4095    
4096          UpdateVelocityTable();          UpdateVelocityTable();
# Line 3712  namespace { Line 4184  namespace {
4184      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
4185          uint8_t bits;          uint8_t bits;
4186          int veldim = -1;          int veldim = -1;
4187          int velbitpos;          int velbitpos = 0;
4188          int bitpos = 0;          int bitpos = 0;
4189          int dimregidx = 0;          int dimregidx = 0;
4190          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
# Line 3761  namespace { Line 4233  namespace {
4233      int Region::GetDimensionRegionIndexByValue(const uint DimValues[8]) {      int Region::GetDimensionRegionIndexByValue(const uint DimValues[8]) {
4234          uint8_t bits;          uint8_t bits;
4235          int veldim = -1;          int veldim = -1;
4236          int velbitpos;          int velbitpos = 0;
4237          int bitpos = 0;          int bitpos = 0;
4238          int dimregidx = 0;          int dimregidx = 0;
4239          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
# Line 3846  namespace { Line 4318  namespace {
4318          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
4319          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
4320          if (!file->pWavePoolTable) return NULL;          if (!file->pWavePoolTable) return NULL;
4321          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          if (WavePoolTableIndex + 1 > file->WavePoolCount) return NULL;
4322          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];          // for new files or files >= 2 GB use 64 bit wave pool offsets
4323          Sample* sample = file->GetFirstSample(pProgress);          if (file->pRIFF->IsNew() || (file->pRIFF->GetCurrentFileSize() >> 31)) {
4324          while (sample) {              // use 64 bit wave pool offsets (treating this as large file)
4325              if (sample->ulWavePoolOffset == soughtoffset &&              uint64_t soughtoffset =
4326                  sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);                  uint64_t(file->pWavePoolTable[WavePoolTableIndex]) |
4327              sample = file->GetNextSample();                  uint64_t(file->pWavePoolTableHi[WavePoolTableIndex]) << 32;
4328                Sample* sample = file->GetFirstSample(pProgress);
4329                while (sample) {
4330                    if (sample->ullWavePoolOffset == soughtoffset)
4331                        return static_cast<gig::Sample*>(sample);
4332                    sample = file->GetNextSample();
4333                }
4334            } else {
4335                // use extension files and 32 bit wave pool offsets
4336                file_offset_t soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
4337                file_offset_t soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
4338                Sample* sample = file->GetFirstSample(pProgress);
4339                while (sample) {
4340                    if (sample->ullWavePoolOffset == soughtoffset &&
4341                        sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
4342                    sample = file->GetNextSample();
4343                }
4344          }          }
4345          return NULL;          return NULL;
4346      }      }
# Line 3907  namespace { Line 4395  namespace {
4395          Layers = orig->Layers;          Layers = orig->Layers;
4396      }      }
4397    
4398        /**
4399         * Returns @c true in case this Region object uses any gig format
4400         * extension, that is e.g. whether any DimensionRegion object currently
4401         * has any setting effective that would require our "LSDE" RIFF chunk to
4402         * be stored to the gig file.
4403         *
4404         * Right now this is a private method. It is considerable though this method
4405         * to become (in slightly modified form) a public API method in future, i.e.
4406         * to allow instrument editors to visualize and/or warn the user of any gig
4407         * format extension being used. See also comments on
4408         * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
4409         * potential public API change in future.
4410         */
4411        bool Region::UsesAnyGigFormatExtension() const {
4412            for (int i = 0; i < 256; i++) {
4413                if (pDimensionRegions[i]) {
4414                    if (pDimensionRegions[i]->UsesAnyGigFormatExtension())
4415                        return true;
4416                }
4417            }
4418            return false;
4419        }
4420    
4421    
4422  // *************** MidiRule ***************  // *************** MidiRule ***************
4423  // *  // *
# Line 4081  namespace { Line 4592  namespace {
4592          pGroup = group;          pGroup = group;
4593          pChunk = ckScri;          pChunk = ckScri;
4594          if (ckScri) { // object is loaded from file ...          if (ckScri) { // object is loaded from file ...
4595                ckScri->SetPos(0);
4596    
4597              // read header              // read header
4598              uint32_t headerSize = ckScri->ReadUint32();              uint32_t headerSize = ckScri->ReadUint32();
4599              Compression = (Compression_t) ckScri->ReadUint32();              Compression = (Compression_t) ckScri->ReadUint32();
4600              Encoding    = (Encoding_t) ckScri->ReadUint32();              Encoding    = (Encoding_t) ckScri->ReadUint32();
4601              Language    = (Language_t) ckScri->ReadUint32();              Language    = (Language_t) ckScri->ReadUint32();
4602              Bypass      = (Language_t) ckScri->ReadUint32() & 1;              Bypass      = ckScri->ReadUint32() & 1;
4603              crc         = ckScri->ReadUint32();              crc         = ckScri->ReadUint32();
4604              uint32_t nameSize = ckScri->ReadUint32();              uint32_t nameSize = ckScri->ReadUint32();
4605              Name.resize(nameSize, ' ');              Name.resize(nameSize, ' ');
4606              for (int i = 0; i < nameSize; ++i)              for (int i = 0; i < nameSize; ++i)
4607                  Name[i] = ckScri->ReadUint8();                  Name[i] = ckScri->ReadUint8();
4608                // check if an uuid was already stored along with this script
4609                if (headerSize >= 6*sizeof(int32_t) + nameSize + 16) { // yes ...
4610                    for (uint i = 0; i < 16; ++i) {
4611                        Uuid[i] = ckScri->ReadUint8();
4612                    }
4613                } else { // no uuid yet, generate one now ...
4614                    GenerateUuid();
4615                }
4616              // to handle potential future extensions of the header              // to handle potential future extensions of the header
4617              ckScri->SetPos(sizeof(int32_t) + headerSize);              ckScri->SetPos(sizeof(int32_t) + headerSize);
4618              // read actual script data              // read actual script data
4619              uint32_t scriptSize = ckScri->GetSize() - ckScri->GetPos();              uint32_t scriptSize = uint32_t(ckScri->GetSize() - ckScri->GetPos());
4620              data.resize(scriptSize);              data.resize(scriptSize);
4621              for (int i = 0; i < scriptSize; ++i)              for (int i = 0; i < scriptSize; ++i)
4622                  data[i] = ckScri->ReadUint8();                  data[i] = ckScri->ReadUint8();
# Line 4106  namespace { Line 4627  namespace {
4627              Bypass   = false;              Bypass   = false;
4628              crc      = 0;              crc      = 0;
4629              Name     = "Unnamed Script";              Name     = "Unnamed Script";
4630                GenerateUuid();
4631          }          }
4632      }      }
4633    
# Line 4133  namespace { Line 4655  namespace {
4655          memcpy(&data[0], &text[0], text.size());          memcpy(&data[0], &text[0], text.size());
4656      }      }
4657    
4658        /** @brief Remove all RIFF chunks associated with this Script object.
4659         *
4660         * At the moment Script::DeleteChunks() does nothing. It is
4661         * recommended to call this method explicitly though from deriving classes's
4662         * own overridden implementation of this method to avoid potential future
4663         * compatiblity issues.
4664         *
4665         * See DLS::Storage::DeleteChunks() for details.
4666         */
4667        void Script::DeleteChunks() {
4668        }
4669    
4670      /**      /**
4671       * Apply this script to the respective RIFF chunks. You have to call       * Apply this script to the respective RIFF chunks. You have to call
4672       * File::Save() to make changes persistent.       * File::Save() to make changes persistent.
# Line 4146  namespace { Line 4680  namespace {
4680          // recalculate CRC32 check sum          // recalculate CRC32 check sum
4681          __resetCRC(crc);          __resetCRC(crc);
4682          __calculateCRC(&data[0], data.size(), crc);          __calculateCRC(&data[0], data.size(), crc);
4683          __encodeCRC(crc);          __finalizeCRC(crc);
4684          // make sure chunk exists and has the required size          // make sure chunk exists and has the required size
4685          const int chunkSize = 7*sizeof(int32_t) + Name.size() + data.size();          const file_offset_t chunkSize =
4686                (file_offset_t) 7*sizeof(int32_t) + Name.size() + 16 + data.size();
4687          if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);          if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);
4688          else pChunk->Resize(chunkSize);          else pChunk->Resize(chunkSize);
4689          // fill the chunk data to be written to disk          // fill the chunk data to be written to disk
4690          uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();          uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();
4691          int pos = 0;          int pos = 0;
4692          store32(&pData[pos], 6*sizeof(int32_t) + Name.size()); // total header size          store32(&pData[pos], uint32_t(6*sizeof(int32_t) + Name.size() + 16)); // total header size
4693          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4694          store32(&pData[pos], Compression);          store32(&pData[pos], Compression);
4695          pos += sizeof(int32_t);          pos += sizeof(int32_t);
# Line 4166  namespace { Line 4701  namespace {
4701          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4702          store32(&pData[pos], crc);          store32(&pData[pos], crc);
4703          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4704          store32(&pData[pos], Name.size());          store32(&pData[pos], (uint32_t) Name.size());
4705          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4706          for (int i = 0; i < Name.size(); ++i, ++pos)          for (int i = 0; i < Name.size(); ++i, ++pos)
4707              pData[pos] = Name[i];              pData[pos] = Name[i];
4708            for (int i = 0; i < 16; ++i, ++pos)
4709                pData[pos] = Uuid[i];
4710          for (int i = 0; i < data.size(); ++i, ++pos)          for (int i = 0; i < data.size(); ++i, ++pos)
4711              pData[pos] = data[i];              pData[pos] = data[i];
4712      }      }
4713    
4714      /**      /**
4715         * Generate a new Universally Unique Identifier (UUID) for this script.
4716         */
4717        void Script::GenerateUuid() {
4718            DLS::dlsid_t dlsid;
4719            DLS::Resource::GenerateDLSID(&dlsid);
4720            Uuid[0]  = dlsid.ulData1       & 0xff;
4721            Uuid[1]  = dlsid.ulData1 >>  8 & 0xff;
4722            Uuid[2]  = dlsid.ulData1 >> 16 & 0xff;
4723            Uuid[3]  = dlsid.ulData1 >> 24 & 0xff;
4724            Uuid[4]  = dlsid.usData2       & 0xff;
4725            Uuid[5]  = dlsid.usData2 >>  8 & 0xff;
4726            Uuid[6]  = dlsid.usData3       & 0xff;
4727            Uuid[7]  = dlsid.usData3 >>  8 & 0xff;
4728            Uuid[8]  = dlsid.abData[0];
4729            Uuid[9]  = dlsid.abData[1];
4730            Uuid[10] = dlsid.abData[2];
4731            Uuid[11] = dlsid.abData[3];
4732            Uuid[12] = dlsid.abData[4];
4733            Uuid[13] = dlsid.abData[5];
4734            Uuid[14] = dlsid.abData[6];
4735            Uuid[15] = dlsid.abData[7];
4736        }
4737    
4738        /**
4739       * Move this script from its current ScriptGroup to another ScriptGroup       * Move this script from its current ScriptGroup to another ScriptGroup
4740       * given by @a pGroup.       * given by @a pGroup.
4741       *       *
4742       * @param pGroup - script's new group       * @param pGroup - script's new group
4743       */       */
4744      void Script::SetGroup(ScriptGroup* pGroup) {      void Script::SetGroup(ScriptGroup* pGroup) {
4745          if (this->pGroup = pGroup) return;          if (this->pGroup == pGroup) return;
4746          if (pChunk)          if (pChunk)
4747              pChunk->GetParent()->MoveSubChunk(pChunk, pGroup->pList);              pChunk->GetParent()->MoveSubChunk(pChunk, pGroup->pList);
4748          this->pGroup = pGroup;          this->pGroup = pGroup;
# Line 4197  namespace { Line 4758  namespace {
4758          return pGroup;          return pGroup;
4759      }      }
4760    
4761        /**
4762         * Make a (semi) deep copy of the Script object given by @a orig
4763         * and assign it to this object. Note: the ScriptGroup this Script
4764         * object belongs to remains untouched by this call.
4765         *
4766         * @param orig - original Script object to be copied from
4767         */
4768        void Script::CopyAssign(const Script* orig) {
4769            Name        = orig->Name;
4770            Compression = orig->Compression;
4771            Encoding    = orig->Encoding;
4772            Language    = orig->Language;
4773            Bypass      = orig->Bypass;
4774            data        = orig->data;
4775        }
4776    
4777      void Script::RemoveAllScriptReferences() {      void Script::RemoveAllScriptReferences() {
4778          File* pFile = pGroup->pFile;          File* pFile = pGroup->pFile;
4779          for (int i = 0; pFile->GetInstrument(i); ++i) {          for (int i = 0; pFile->GetInstrument(i); ++i) {
# Line 4232  namespace { Line 4809  namespace {
4809          }          }
4810      }      }
4811    
4812        /** @brief Remove all RIFF chunks associated with this ScriptGroup object.
4813         *
4814         * At the moment ScriptGroup::DeleteChunks() does nothing. It is
4815         * recommended to call this method explicitly though from deriving classes's
4816         * own overridden implementation of this method to avoid potential future
4817         * compatiblity issues.
4818         *
4819         * See DLS::Storage::DeleteChunks() for details.
4820         */
4821        void ScriptGroup::DeleteChunks() {
4822        }
4823    
4824      /**      /**
4825       * Apply this script group to the respective RIFF chunks. You have to call       * Apply this script group to the respective RIFF chunks. You have to call
4826       * File::Save() to make changes persistent.       * File::Save() to make changes persistent.
# Line 4318  namespace { Line 4907  namespace {
4907          pScripts = new std::list<Script*>;          pScripts = new std::list<Script*>;
4908          if (!pList) return;          if (!pList) return;
4909    
4910          for (RIFF::Chunk* ck = pList->GetFirstSubChunk(); ck;          size_t i = 0;
4911               ck = pList->GetNextSubChunk())          for (RIFF::Chunk* ck = pList->GetSubChunkAt(i); ck;
4912                 ck = pList->GetSubChunkAt(++i))
4913          {          {
4914              if (ck->GetChunkID() == CHUNK_ID_SCRI) {              if (ck->GetChunkID() == CHUNK_ID_SCRI) {
4915                  pScripts->push_back(new Script(this, ck));                  pScripts->push_back(new Script(this, ck));
# Line 4343  namespace { Line 4933  namespace {
4933          EffectSend = 0;          EffectSend = 0;
4934          Attenuation = 0;          Attenuation = 0;
4935          FineTune = 0;          FineTune = 0;
4936          PitchbendRange = 0;          PitchbendRange = 2;
4937          PianoReleaseMode = false;          PianoReleaseMode = false;
4938          DimensionKeyRange.low = 0;          DimensionKeyRange.low = 0;
4939          DimensionKeyRange.high = 0;          DimensionKeyRange.high = 0;
# Line 4356  namespace { Line 4946  namespace {
4946          if (lart) {          if (lart) {
4947              RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);              RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
4948              if (_3ewg) {              if (_3ewg) {
4949                    _3ewg->SetPos(0);
4950    
4951                  EffectSend             = _3ewg->ReadUint16();                  EffectSend             = _3ewg->ReadUint16();
4952                  Attenuation            = _3ewg->ReadInt32();                  Attenuation            = _3ewg->ReadInt32();
4953                  FineTune               = _3ewg->ReadInt16();                  FineTune               = _3ewg->ReadInt16();
# Line 4397  namespace { Line 4989  namespace {
4989              if (!pRegions) pRegions = new RegionList;              if (!pRegions) pRegions = new RegionList;
4990              RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);              RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
4991              if (lrgn) {              if (lrgn) {
4992                  RIFF::List* rgn = lrgn->GetFirstSubList();                  size_t i = 0;
4993                  while (rgn) {                  for (RIFF::List* rgn = lrgn->GetSubListAt(i); rgn;
4994                         rgn = lrgn->GetSubListAt(++i))
4995                    {
4996                      if (rgn->GetListType() == LIST_TYPE_RGN) {                      if (rgn->GetListType() == LIST_TYPE_RGN) {
4997                          __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);                          if (pProgress)
4998                                __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
4999                          pRegions->push_back(new Region(this, rgn));                          pRegions->push_back(new Region(this, rgn));
5000                      }                      }
                     rgn = lrgn->GetNextSubList();  
5001                  }                  }
5002                  // Creating Region Key Table for fast lookup                  // Creating Region Key Table for fast lookup
5003                  UpdateRegionKeyTable();                  UpdateRegionKeyTable();
# Line 4413  namespace { Line 5007  namespace {
5007          // own gig format extensions          // own gig format extensions
5008          RIFF::List* lst3LS = insList->GetSubList(LIST_TYPE_3LS);          RIFF::List* lst3LS = insList->GetSubList(LIST_TYPE_3LS);
5009          if (lst3LS) {          if (lst3LS) {
5010                // script slots (that is references to instrument scripts)
5011              RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);              RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
5012              if (ckSCSL) {              if (ckSCSL) {
5013                    ckSCSL->SetPos(0);
5014    
5015                  int headerSize = ckSCSL->ReadUint32();                  int headerSize = ckSCSL->ReadUint32();
5016                  int slotCount  = ckSCSL->ReadUint32();                  int slotCount  = ckSCSL->ReadUint32();
5017                  if (slotCount) {                  if (slotCount) {
# Line 4430  namespace { Line 5027  namespace {
5027                      }                      }
5028                  }                  }
5029              }              }
5030    
5031                // overridden script 'patch' variables
5032                RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV);
5033                if (ckSCPV) {
5034                    ckSCPV->SetPos(0);
5035    
5036                    int nScripts = ckSCPV->ReadUint32();
5037                    for (int iScript = 0; iScript < nScripts; ++iScript) {
5038                        _UUID uuid;
5039                        for (int i = 0; i < 16; ++i)
5040                            uuid[i] = ckSCPV->ReadUint8();
5041                        uint slot = ckSCPV->ReadUint32();
5042                        ckSCPV->ReadUint32(); // unused, reserved 32 bit
5043                        int nVars = ckSCPV->ReadUint32();
5044                        for (int iVar = 0; iVar < nVars; ++iVar) {
5045                            uint8_t type = ckSCPV->ReadUint8();
5046                            ckSCPV->ReadUint8();  // unused, reserved byte
5047                            int blobSize = ckSCPV->ReadUint16();
5048                            RIFF::file_offset_t pos = ckSCPV->GetPos();
5049                            // assuming 1st bit is set in 'type', otherwise blob not
5050                            // supported for decoding
5051                            if (type & 1) {
5052                                String name, value;
5053                                int len = ckSCPV->ReadUint16();
5054                                for (int i = 0; i < len; ++i)
5055                                    name += (char) ckSCPV->ReadUint8();
5056                                len = ckSCPV->ReadUint16();
5057                                for (int i = 0; i < len; ++i)
5058                                    value += (char) ckSCPV->ReadUint8();
5059                                if (!name.empty()) // 'name' should never be empty, but just to be sure
5060                                    scriptVars[uuid][slot][name] = value;
5061                            }
5062                            // also for potential future extensions: seek forward
5063                            // according to blob size
5064                            ckSCPV->SetPos(pos + blobSize);
5065                        }
5066                    }
5067                }
5068          }          }
5069    
5070          __notify_progress(pProgress, 1.0f); // notify done          if (pProgress)
5071                __notify_progress(pProgress, 1.0f); // notify done
5072      }      }
5073    
5074      void Instrument::UpdateRegionKeyTable() {      void Instrument::UpdateRegionKeyTable() {
# Line 4441  namespace { Line 5077  namespace {
5077          RegionList::iterator end  = pRegions->end();          RegionList::iterator end  = pRegions->end();
5078          for (; iter != end; ++iter) {          for (; iter != end; ++iter) {
5079              gig::Region* pRegion = static_cast<gig::Region*>(*iter);              gig::Region* pRegion = static_cast<gig::Region*>(*iter);
5080              for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {              const int low  = std::max(int(pRegion->KeyRange.low), 0);
5081                const int high = std::min(int(pRegion->KeyRange.high), 127);
5082                for (int iKey = low; iKey <= high; iKey++) {
5083                  RegionKeyTable[iKey] = pRegion;                  RegionKeyTable[iKey] = pRegion;
5084              }              }
5085          }          }
# Line 4486  namespace { Line 5124  namespace {
5124              File* pFile = (File*) GetParent();              File* pFile = (File*) GetParent();
5125    
5126              // 3ewg is bigger in gig3, as it includes the iMIDI rules              // 3ewg is bigger in gig3, as it includes the iMIDI rules
5127              int size = (pFile->pVersion && pFile->pVersion->major == 3) ? 16416 : 12;              int size = (pFile->pVersion && pFile->pVersion->major > 2) ? 16416 : 12;
5128              _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);              _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);
5129              memset(_3ewg->LoadChunkData(), 0, size);              memset(_3ewg->LoadChunkData(), 0, size);
5130          }          }
# Line 4518  namespace { Line 5156  namespace {
5156    
5157             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
5158             if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);             if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);
5159             const int slotCount = pScriptRefs->size();  
5160               // save script slots (that is references to instrument scripts)
5161               const int slotCount = (int) pScriptRefs->size();
5162             const int headerSize = 3 * sizeof(uint32_t);             const int headerSize = 3 * sizeof(uint32_t);
5163             const int slotSize  = 2 * sizeof(uint32_t);             const int slotSize  = 2 * sizeof(uint32_t);
5164             const int totalChunkSize = headerSize + slotCount * slotSize;             const int totalChunkSize = headerSize + slotCount * slotSize;
# Line 4542  namespace { Line 5182  namespace {
5182                 store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0);                 store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0);
5183                 pos += sizeof(uint32_t);                 pos += sizeof(uint32_t);
5184             }             }
5185    
5186               // save overridden script 'patch' variables ...
5187    
5188               // the actual 'scriptVars' member variable might contain variables of
5189               // scripts which are currently no longer assigned to any script slot
5190               // of this instrument, we need to get rid of these variables here to
5191               // prevent saving those persistently, however instead of touching the
5192               // member variable 'scriptVars' directly, rather strip a separate
5193               // copy such that the overridden values are not lost during an
5194               // instrument editor session (i.e. if script might be re-assigned)
5195               _VarsByScript vars = stripScriptVars();
5196               if (!vars.empty()) {
5197                   // determine total size required for 'SCPV' RIFF chunk, and the
5198                   // total amount of scripts being overridden (the latter is
5199                   // required because a script might be used on several script
5200                   // slots, hence vars.size() could then not be used here instead)
5201                   size_t totalChunkSize = 4;
5202                   size_t totalScriptsOverridden = 0;
5203                   for (const auto& script : vars) {
5204                       for (const auto& slot : script.second) {
5205                           totalScriptsOverridden++;
5206                           totalChunkSize += 16 + 4 + 4 + 4;
5207                           for (const auto& var : slot.second) {
5208                               totalChunkSize += 4 + 2 + var.first.length() +
5209                                                     2 + var.second.length();
5210                           }
5211                       }
5212                   }
5213    
5214                   // ensure 'SCPV' RIFF chunk exists (with required size)
5215                   RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV);
5216                   if (!ckSCPV) ckSCPV = lst3LS->AddSubChunk(CHUNK_ID_SCPV, totalChunkSize);
5217                   else ckSCPV->Resize(totalChunkSize);
5218    
5219                   // store the actual data to 'SCPV' RIFF chunk
5220                   uint8_t* pData = (uint8_t*) ckSCPV->LoadChunkData();
5221                   int pos = 0;
5222                   store32(&pData[pos], (uint32_t) totalScriptsOverridden); // scripts count
5223                   pos += 4;
5224                   for (const auto& script : vars) {
5225                       for (const auto& slot : script.second) {
5226                           for (int i = 0; i < 16; ++i)
5227                               pData[pos+i] = script.first[i]; // uuid
5228                           pos += 16;
5229                           store32(&pData[pos], (uint32_t) slot.first); // slot index
5230                           pos += 4;
5231                           store32(&pData[pos], (uint32_t) 0); // unused, reserved 32 bit
5232                           pos += 4;
5233                           store32(&pData[pos], (uint32_t) slot.second.size()); // variables count
5234                           pos += 4;
5235                           for (const auto& var : slot.second) {
5236                               pData[pos++] = 1; // type
5237                               pData[pos++] = 0; // reserved byte
5238                               store16(&pData[pos], 2 + var.first.size() + 2 + var.second.size()); // blob size
5239                               pos += 2;
5240                               store16(&pData[pos], var.first.size()); // variable name length
5241                               pos += 2;
5242                               for (int i = 0; i < var.first.size(); ++i)
5243                                   pData[pos++] = var.first[i];
5244                               store16(&pData[pos], var.second.size()); // variable value length
5245                               pos += 2;
5246                               for (int i = 0; i < var.second.size(); ++i)
5247                                   pData[pos++] = var.second[i];
5248                           }
5249                       }
5250                   }
5251               } else {
5252                   // no script variable overridden by this instrument, so get rid
5253                   // of 'SCPV' RIFF chunk (if any)
5254                   RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV);
5255                   if (ckSCPV) lst3LS->DeleteSubChunk(ckSCPV);
5256               }
5257         } else {         } else {
5258             // no script slots, so get rid of any LS custom RIFF chunks (if any)             // no script slots, so get rid of any LS custom RIFF chunks (if any)
5259             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
# Line 4554  namespace { Line 5266  namespace {
5266         if (pScriptRefs && pScriptRefs->size() > 0) {         if (pScriptRefs && pScriptRefs->size() > 0) {
5267             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
5268             RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);             RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
5269             const int slotCount = pScriptRefs->size();             const int slotCount = (int) pScriptRefs->size();
5270             const int headerSize = 3 * sizeof(uint32_t);             const int headerSize = 3 * sizeof(uint32_t);
5271             ckSCSL->SetPos(headerSize);             ckSCSL->SetPos(headerSize);
5272             for (int i = 0; i < slotCount; ++i) {             for (int i = 0; i < slotCount; ++i) {
5273                 uint32_t fileOffset =                 uint32_t fileOffset = uint32_t(
5274                      (*pScriptRefs)[i].script->pChunk->GetFilePos() -                      (*pScriptRefs)[i].script->pChunk->GetFilePos() -
5275                      (*pScriptRefs)[i].script->pChunk->GetPos() -                      (*pScriptRefs)[i].script->pChunk->GetPos() -
5276                      CHUNK_HEADER_SIZE;                      CHUNK_HEADER_SIZE(ckSCSL->GetFile()->GetFileOffsetSize())
5277                   );
5278                 ckSCSL->WriteUint32(&fileOffset);                 ckSCSL->WriteUint32(&fileOffset);
5279                 // jump over flags entry (containing the bypass flag)                 // jump over flags entry (containing the bypass flag)
5280                 ckSCSL->SetPos(sizeof(uint32_t), RIFF::stream_curpos);                 ckSCSL->SetPos(sizeof(uint32_t), RIFF::stream_curpos);
# Line 4621  namespace { Line 5334  namespace {
5334          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
5335          Region* pNewRegion = new Region(this, rgn);          Region* pNewRegion = new Region(this, rgn);
5336          pRegions->push_back(pNewRegion);          pRegions->push_back(pNewRegion);
5337          Regions = pRegions->size();          Regions = (uint32_t) pRegions->size();
5338          // update Region key table for fast lookup          // update Region key table for fast lookup
5339          UpdateRegionKeyTable();          UpdateRegionKeyTable();
5340          // done          // done
# Line 4673  namespace { Line 5386  namespace {
5386    
5387          // move this instrument within the instrument list          // move this instrument within the instrument list
5388          {          {
5389              DLS::File::InstrumentList& list = *pFile->pInstruments;              File::InstrumentList& list = *pFile->pInstruments;
5390    
5391              DLS::File::InstrumentList::iterator itFrom =              File::InstrumentList::iterator itFrom =
5392                  std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(this));                  std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(this));
5393    
5394              DLS::File::InstrumentList::iterator itTo =              File::InstrumentList::iterator itTo =
5395                  std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(dst));                  std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(dst));
5396    
5397              list.splice(itTo, list, itFrom);              list.splice(itTo, list, itFrom);
# Line 4767  namespace { Line 5480  namespace {
5480                  for (uint s = 0; group->GetScript(s); ++s) {                  for (uint s = 0; group->GetScript(s); ++s) {
5481                      Script* script = group->GetScript(s);                      Script* script = group->GetScript(s);
5482                      if (script->pChunk) {                      if (script->pChunk) {
5483                          uint32_t offset = script->pChunk->GetFilePos() -                          uint32_t offset = uint32_t(
5484                                            script->pChunk->GetPos() -                              script->pChunk->GetFilePos() -
5485                                            CHUNK_HEADER_SIZE;                              script->pChunk->GetPos() -
5486                                CHUNK_HEADER_SIZE(script->pChunk->GetFile()->GetFileOffsetSize())
5487                            );
5488                          if (offset == soughtOffset)                          if (offset == soughtOffset)
5489                          {                          {
5490                              _ScriptPooolRef ref;                              _ScriptPooolRef ref;
# Line 4894  namespace { Line 5609  namespace {
5609       */       */
5610      void Instrument::RemoveScript(Script* pScript) {      void Instrument::RemoveScript(Script* pScript) {
5611          LoadScripts();          LoadScripts();
5612          for (int i = pScriptRefs->size() - 1; i >= 0; --i) {          for (ssize_t i = pScriptRefs->size() - 1; i >= 0; --i) {
5613              if ((*pScriptRefs)[i].script == pScript) {              if ((*pScriptRefs)[i].script == pScript) {
5614                  pScriptRefs->erase( pScriptRefs->begin() + i );                  pScriptRefs->erase( pScriptRefs->begin() + i );
5615              }              }
# Line 4916  namespace { Line 5631  namespace {
5631       * gigedit.       * gigedit.
5632       */       */
5633      uint Instrument::ScriptSlotCount() const {      uint Instrument::ScriptSlotCount() const {
5634          return pScriptRefs ? pScriptRefs->size() : scriptPoolFileOffsets.size();          return uint(pScriptRefs ? pScriptRefs->size() : scriptPoolFileOffsets.size());
5635      }      }
5636    
5637      /** @brief Whether script execution shall be skipped.      /** @brief Whether script execution shall be skipped.
# Line 4963  namespace { Line 5678  namespace {
5678              scriptPoolFileOffsets.at(index).bypass = bBypass;              scriptPoolFileOffsets.at(index).bypass = bBypass;
5679      }      }
5680    
5681        /// type cast (by copy) uint8_t[16] -> std::array<uint8_t,16>
5682        inline std::array<uint8_t,16> _UUIDFromCArray(const uint8_t* pData) {
5683            std::array<uint8_t,16> uuid;
5684            memcpy(&uuid[0], pData, 16);
5685            return uuid;
5686        }
5687    
5688        /**
5689         * Returns true if this @c Instrument has any script slot which references
5690         * the @c Script identified by passed @p uuid.
5691         */
5692        bool Instrument::ReferencesScriptWithUuid(const _UUID& uuid) {
5693            const uint nSlots = ScriptSlotCount();
5694            for (uint iSlot = 0; iSlot < nSlots; ++iSlot)
5695                if (_UUIDFromCArray(&GetScriptOfSlot(iSlot)->Uuid[0]) == uuid)
5696                    return true;
5697            return false;
5698        }
5699    
5700        /** @brief Checks whether a certain script 'patch' variable value is set.
5701         *
5702         * Returns @c true if the initial value for the requested script variable is
5703         * currently overridden by this instrument.
5704         *
5705         * @remarks Real-time instrument scripts allow to declare special 'patch'
5706         * variables, which essentially behave like regular variables of their data
5707         * type, however their initial value may optionally be overridden on a per
5708         * instrument basis. That allows to share scripts between instruments while
5709         * still being able to fine tune certain aspects of the script for each
5710         * instrument individually.
5711         *
5712         * @note This is an own format extension which did not exist i.e. in the
5713         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5714         * Gigedit.
5715         *
5716         * @param slot - script slot index of the variable to be retrieved
5717         * @param variable - name of the 'patch' variable in that script
5718         */
5719        bool Instrument::IsScriptPatchVariableSet(int slot, String variable) {
5720            if (variable.empty()) return false;
5721            Script* script = GetScriptOfSlot(slot);
5722            if (!script) return false;
5723            const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5724            if (!scriptVars.count(uuid)) return false;
5725            const _VarsBySlot& slots = scriptVars.find(uuid)->second;
5726            if (slots.empty()) return false;
5727            if (slots.count(slot))
5728                return slots.find(slot)->second.count(variable);
5729            else
5730                return slots.begin()->second.count(variable);
5731        }
5732    
5733        /** @brief Get all overridden script 'patch' variables.
5734         *
5735         * Returns map of key-value pairs reflecting all patch variables currently
5736         * being overridden by this instrument for the given script @p slot, where
5737         * key is the variable name and value is the hereby currently overridden
5738         * value for that variable.
5739         *
5740         * @remarks Real-time instrument scripts allow to declare special 'patch'
5741         * variables, which essentially behave like regular variables of their data
5742         * type, however their initial value may optionally be overridden on a per
5743         * instrument basis. That allows to share scripts between instruments while
5744         * still being able to fine tune certain aspects of the script for each
5745         * instrument individually.
5746         *
5747         * @note This is an own format extension which did not exist i.e. in the
5748         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5749         * Gigedit.
5750         *
5751         * @param slot - script slot index of the variable to be retrieved
5752         */
5753        std::map<String,String> Instrument::GetScriptPatchVariables(int slot) {
5754            Script* script = GetScriptOfSlot(slot);
5755            if (!script) return std::map<String,String>();
5756            const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5757            if (!scriptVars.count(uuid)) return std::map<String,String>();
5758            const _VarsBySlot& slots = scriptVars.find(uuid)->second;
5759            if (slots.empty()) return std::map<String,String>();
5760            const _PatchVars& vars =
5761                (slots.count(slot)) ?
5762                    slots.find(slot)->second : slots.begin()->second;
5763            return vars;
5764        }
5765    
5766        /** @brief Get overridden initial value for 'patch' variable.
5767         *
5768         * Returns current initial value for the requested script variable being
5769         * overridden by this instrument.
5770         *
5771         * @remarks Real-time instrument scripts allow to declare special 'patch'
5772         * variables, which essentially behave like regular variables of their data
5773         * type, however their initial value may optionally be overridden on a per
5774         * instrument basis. That allows to share scripts between instruments while
5775         * still being able to fine tune certain aspects of the script for each
5776         * instrument individually.
5777         *
5778         * @note This is an own format extension which did not exist i.e. in the
5779         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5780         * Gigedit.
5781         *
5782         * @param slot - script slot index of the variable to be retrieved
5783         * @param variable - name of the 'patch' variable in that script
5784         */
5785        String Instrument::GetScriptPatchVariable(int slot, String variable) {
5786            std::map<String,String> vars = GetScriptPatchVariables(slot);
5787            return (vars.count(variable)) ? vars.find(variable)->second : "";
5788        }
5789    
5790        /** @brief Override initial value for 'patch' variable.
5791         *
5792         * Overrides initial value for the requested script variable for this
5793         * instrument with the passed value.
5794         *
5795         * @remarks Real-time instrument scripts allow to declare special 'patch'
5796         * variables, which essentially behave like regular variables of their data
5797         * type, however their initial value may optionally be overridden on a per
5798         * instrument basis. That allows to share scripts between instruments while
5799         * still being able to fine tune certain aspects of the script for each
5800         * instrument individually.
5801         *
5802         * @note This is an own format extension which did not exist i.e. in the
5803         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5804         * Gigedit.
5805         *
5806         * @param slot - script slot index of the variable to be set
5807         * @param variable - name of the 'patch' variable in that script
5808         * @param value - overridden initial value for that script variable
5809         * @throws gig::Exception if given script @p slot index is invalid or given
5810         *         @p variable name is empty
5811         */
5812        void Instrument::SetScriptPatchVariable(int slot, String variable, String value) {
5813            if (variable.empty())
5814                throw Exception("Variable name must not be empty");
5815            Script* script = GetScriptOfSlot(slot);
5816            if (!script)
5817                throw Exception("No script slot with index " + ToString(slot));
5818            const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5819            scriptVars[uuid][slot][variable] = value;
5820        }
5821    
5822        /** @brief Drop overridden initial value(s) for 'patch' variable(s).
5823         *
5824         * Reverts initial value(s) for requested script variable(s) back to their
5825         * default initial value(s) defined in the script itself.
5826         *
5827         * Both arguments of this method are optional. The most obvious use case of
5828         * this method would be passing a valid script @p slot index and a
5829         * (non-emtpy string as) @p variable name to this method, which would cause
5830         * that single variable to be unset for that specific script slot (on this
5831         * @c Instrument level).
5832         *
5833         * Not passing a value (or @c -1 for @p slot and/or empty string for
5834         * @p variable) means 'wildcard'. So accordingly absence of argument(s) will
5835         * cause all variables and/or for all script slots being unset. Hence this
5836         * method serves 2^2 = 4 possible use cases in total and accordingly covers
5837         * 4 different behaviours in one method.
5838         *
5839         * @remarks Real-time instrument scripts allow to declare special 'patch'
5840         * variables, which essentially behave like regular variables of their data
5841         * type, however their initial value may optionally be overridden on a per
5842         * instrument basis. That allows to share scripts between instruments while
5843         * still being able to fine tune certain aspects of the script for each
5844         * instrument individually.
5845         *
5846         * @note This is an own format extension which did not exist i.e. in the
5847         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5848         * Gigedit.
5849         *
5850         * @param slot - script slot index of the variable to be unset
5851         * @param variable - name of the 'patch' variable in that script
5852         */
5853        void Instrument::UnsetScriptPatchVariable(int slot, String variable) {
5854            Script* script = GetScriptOfSlot(slot);
5855    
5856            // option 1: unset a particular variable of one particular script slot
5857            if (slot != -1 && !variable.empty()) {
5858                if (!script) return;
5859                const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5860                if (!scriptVars.count(uuid)) return;
5861                if (!scriptVars[uuid].count(slot)) return;
5862                if (scriptVars[uuid][slot].count(variable))
5863                    scriptVars[uuid][slot].erase(
5864                        scriptVars[uuid][slot].find(variable)
5865                    );
5866                if (scriptVars[uuid][slot].empty())
5867                    scriptVars[uuid].erase( scriptVars[uuid].find(slot) );
5868                if (scriptVars[uuid].empty())
5869                    scriptVars.erase( scriptVars.find(uuid) );
5870                return;
5871            }
5872    
5873            // option 2: unset all variables of all script slots
5874            if (slot == -1 && variable.empty()) {
5875                scriptVars.clear();
5876                return;
5877            }
5878    
5879            // option 3: unset all variables of one particular script slot only
5880            if (slot != -1) {
5881                if (!script) return;
5882                const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5883                if (scriptVars.count(uuid))
5884                    scriptVars.erase( scriptVars.find(uuid) );
5885                return;
5886            }
5887    
5888            // option 4: unset a particular variable of all script slots
5889            _VarsByScript::iterator itScript = scriptVars.begin();
5890            _VarsByScript::iterator endScript = scriptVars.end();
5891            while (itScript != endScript) {
5892                _VarsBySlot& slots = itScript->second;
5893                _VarsBySlot::iterator itSlot = slots.begin();
5894                _VarsBySlot::iterator endSlot = slots.end();
5895                while (itSlot != endSlot) {
5896                    _PatchVars& vars = itSlot->second;
5897                    if (vars.count(variable))
5898                        vars.erase( vars.find(variable) );
5899                    if (vars.empty())
5900                        slots.erase(itSlot++); // postfix increment to avoid iterator invalidation
5901                    else
5902                        ++itSlot;
5903                }
5904                if (slots.empty())
5905                    scriptVars.erase(itScript++); // postfix increment to avoid iterator invalidation
5906                else
5907                    ++itScript;
5908            }
5909        }
5910    
5911        /**
5912         * Returns stripped version of member variable @c scriptVars, where scripts
5913         * no longer referenced by this @c Instrument are filtered out, and so are
5914         * variables of meanwhile obsolete slots (i.e. a script still being
5915         * referenced, but previously overridden on a script slot which either no
5916         * longer exists or is hosting another script now).
5917         */
5918        Instrument::_VarsByScript Instrument::stripScriptVars() {
5919            _VarsByScript vars;
5920            _VarsByScript::const_iterator itScript = scriptVars.begin();
5921            _VarsByScript::const_iterator endScript = scriptVars.end();
5922            for (; itScript != endScript; ++itScript) {
5923                const _UUID& uuid = itScript->first;
5924                if (!ReferencesScriptWithUuid(uuid))
5925                    continue;
5926                const _VarsBySlot& slots = itScript->second;
5927                _VarsBySlot::const_iterator itSlot = slots.begin();
5928                _VarsBySlot::const_iterator endSlot = slots.end();
5929                for (; itSlot != endSlot; ++itSlot) {
5930                    Script* script = GetScriptOfSlot(itSlot->first);
5931                    if (!script) continue;
5932                    if (_UUIDFromCArray(&script->Uuid[0]) != uuid) continue;
5933                    if (itSlot->second.empty()) continue;
5934                    vars[uuid][itSlot->first] = itSlot->second;
5935                }
5936            }
5937            return vars;
5938        }
5939    
5940      /**      /**
5941       * Make a (semi) deep copy of the Instrument object given by @a orig       * Make a (semi) deep copy of the Instrument object given by @a orig
5942       * and assign it to this object.       * and assign it to this object.
# Line 4997  namespace { Line 5971  namespace {
5971          PianoReleaseMode = orig->PianoReleaseMode;          PianoReleaseMode = orig->PianoReleaseMode;
5972          DimensionKeyRange = orig->DimensionKeyRange;          DimensionKeyRange = orig->DimensionKeyRange;
5973          scriptPoolFileOffsets = orig->scriptPoolFileOffsets;          scriptPoolFileOffsets = orig->scriptPoolFileOffsets;
5974          pScriptRefs = orig->pScriptRefs;          // deep copy of pScriptRefs required (to avoid undefined behaviour)
5975            if (pScriptRefs) delete pScriptRefs;
5976            pScriptRefs = new std::vector<_ScriptPooolRef>;
5977            if (orig->pScriptRefs)
5978                *pScriptRefs = *orig->pScriptRefs;
5979            scriptVars = orig->scriptVars;
5980                    
5981          // free old midi rules          // free old midi rules
5982          for (int i = 0 ; pMidiRules[i] ; i++) {          for (int i = 0 ; pMidiRules[i] ; i++) {
# Line 5024  namespace { Line 6003  namespace {
6003          UpdateRegionKeyTable();          UpdateRegionKeyTable();
6004      }      }
6005    
6006        /**
6007         * Returns @c true in case this Instrument object uses any gig format
6008         * extension, that is e.g. whether any DimensionRegion object currently
6009         * has any setting effective that would require our "LSDE" RIFF chunk to
6010         * be stored to the gig file.
6011         *
6012         * Right now this is a private method. It is considerable though this method
6013         * to become (in slightly modified form) a public API method in future, i.e.
6014         * to allow instrument editors to visualize and/or warn the user of any gig
6015         * format extension being used. See also comments on
6016         * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
6017         * potential public API change in future.
6018         */
6019        bool Instrument::UsesAnyGigFormatExtension() const {
6020            if (!pRegions) return false;
6021            if (!scriptVars.empty()) return true;
6022            RegionList::const_iterator iter = pRegions->begin();
6023            RegionList::const_iterator end  = pRegions->end();
6024            for (; iter != end; ++iter) {
6025                gig::Region* rgn = static_cast<gig::Region*>(*iter);
6026                if (rgn->UsesAnyGigFormatExtension())
6027                    return true;
6028            }
6029            return false;
6030        }
6031    
6032    
6033  // *************** Group ***************  // *************** Group ***************
6034  // *  // *
# Line 5040  namespace { Line 6045  namespace {
6045          ::LoadString(pNameChunk, Name);          ::LoadString(pNameChunk, Name);
6046      }      }
6047    
6048        /** @brief Destructor.
6049         *
6050         * Currently this destructor implementation does nothing.
6051         */
6052      Group::~Group() {      Group::~Group() {
6053          // remove the chunk associated with this group (if any)      }
6054          if (pNameChunk) pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);  
6055        /** @brief Remove all RIFF chunks associated with this Group object.
6056         *
6057         * See DLS::Storage::DeleteChunks() for details.
6058         */
6059        void Group::DeleteChunks() {
6060            // handle own RIFF chunks
6061            if (pNameChunk) {
6062                pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
6063                pNameChunk = NULL;
6064            }
6065      }      }
6066    
6067      /** @brief Update chunks with current group settings.      /** @brief Update chunks with current group settings.
# Line 5065  namespace { Line 6084  namespace {
6084          RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);          RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
6085          if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);          if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
6086    
6087          if (!pNameChunk && pFile->pVersion && pFile->pVersion->major == 3) {          if (!pNameChunk && pFile->pVersion && pFile->pVersion->major > 2) {
6088              // v3 has a fixed list of 128 strings, find a free one              // v3 has a fixed list of 128 strings, find a free one
6089              for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {              size_t i = 0;
6090                for (RIFF::Chunk* ck = _3gnl->GetSubChunkAt(i); ck; ck = _3gnl->GetSubChunkAt(++i)) {
6091                  if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {                  if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {
6092                      pNameChunk = ck;                      pNameChunk = ck;
6093                      break;                      break;
# Line 5160  namespace { Line 6180  namespace {
6180          0, 3, 20030331 & 0xffff, 20030331 >> 16          0, 3, 20030331 & 0xffff, 20030331 >> 16
6181      };      };
6182    
6183        /// Reflects Gigasampler file format version 4.0 (2007-10-12).
6184        const DLS::version_t File::VERSION_4 = {
6185            0, 4, 20071012 & 0xffff, 20071012 >> 16
6186        };
6187    
6188      static const DLS::Info::string_length_t _FileFixedStringLengths[] = {      static const DLS::Info::string_length_t _FileFixedStringLengths[] = {
6189          { CHUNK_ID_IARL, 256 },          { CHUNK_ID_IARL, 256 },
6190          { CHUNK_ID_IART, 128 },          { CHUNK_ID_IART, 128 },
# Line 5256  namespace { Line 6281  namespace {
6281          return static_cast<gig::Sample*>( *it );          return static_cast<gig::Sample*>( *it );
6282      }      }
6283    
6284        /**
6285         * Returns the total amount of samples of this gig file.
6286         *
6287         * Note that this method might block for a long time in case it is required
6288         * to load the sample info for the first time.
6289         *
6290         * @returns total amount of samples
6291         */
6292        size_t File::CountSamples() {
6293            if (!pSamples) LoadSamples();
6294            if (!pSamples) return 0;
6295            return pSamples->size();
6296        }
6297    
6298      /** @brief Add a new sample.      /** @brief Add a new sample.
6299       *       *
6300       * 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 5294  namespace { Line 6333  namespace {
6333          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");
6334          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
6335          pSamples->erase(iter);          pSamples->erase(iter);
6336            pSample->DeleteChunks();
6337          delete pSample;          delete pSample;
6338    
6339          SampleList::iterator tmp = SamplesIterator;          SampleList::iterator tmp = SamplesIterator;
# Line 5331  namespace { Line 6371  namespace {
6371          int iSampleIndex  = 0;          int iSampleIndex  = 0;
6372          int iTotalSamples = WavePoolCount;          int iTotalSamples = WavePoolCount;
6373    
6374          // check if samples should be loaded from extension files          // just for assembling path of optional extension files to be read
6375          int lastFileNo = 0;          const std::string folder = parentPath(pRIFF->GetFileName());
6376          for (int i = 0 ; i < WavePoolCount ; i++) {          const std::string baseName = pathWithoutExtension(pRIFF->GetFileName());
6377              if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];  
6378          }          // the main gig file and the extension files (.gx01, ... , .gx98) may
6379          String name(pRIFF->GetFileName());          // contain wave data (wave pool)
6380          int nameLen = name.length();          std::vector<RIFF::File*> poolFiles;
6381          char suffix[6];          poolFiles.push_back(pRIFF);
6382          if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;  
6383            // get info about all extension files
6384          for (int fileNo = 0 ; ; ) {          RIFF::Chunk* ckXfil = pRIFF->GetSubChunk(CHUNK_ID_XFIL);
6385            if (ckXfil) { // there are extension files (.gx01, ... , .gx98) ...
6386                const uint32_t n = ckXfil->ReadInt32();
6387                for (int i = 0; i < n; i++) {
6388                    // read the filename and load the extension file
6389                    std::string name;
6390                    ckXfil->ReadString(name, 128);
6391                    std::string path = concatPath(folder, name);
6392                    RIFF::File* pExtFile = new RIFF::File(path);
6393                    // check that the dlsids match
6394                    RIFF::Chunk* ckDLSID = pExtFile->GetSubChunk(CHUNK_ID_DLID);
6395                    if (ckDLSID) {
6396                        ::DLS::dlsid_t idExpected;
6397                        idExpected.ulData1 = ckXfil->ReadInt32();
6398                        idExpected.usData2 = ckXfil->ReadInt16();
6399                        idExpected.usData3 = ckXfil->ReadInt16();
6400                        ckXfil->Read(idExpected.abData, 8, 1);
6401                        ::DLS::dlsid_t idFound;
6402                        ckDLSID->Read(&idFound.ulData1, 1, 4);
6403                        ckDLSID->Read(&idFound.usData2, 1, 2);
6404                        ckDLSID->Read(&idFound.usData3, 1, 2);
6405                        ckDLSID->Read(idFound.abData, 8, 1);
6406                        if (memcmp(&idExpected, &idFound, 16) != 0)
6407                            throw gig::Exception("dlsid mismatch for extension file: %s", path.c_str());
6408                    }
6409                    poolFiles.push_back(pExtFile);
6410                    ExtensionFiles.push_back(pExtFile);
6411                }
6412            }
6413    
6414            // check if a .gx99 (GigaPulse) file exists
6415            RIFF::Chunk* ckDoxf = pRIFF->GetSubChunk(CHUNK_ID_DOXF);
6416            if (ckDoxf) { // there is a .gx99 (GigaPulse) file ...
6417                std::string path = baseName + ".gx99";
6418                RIFF::File* pExtFile = new RIFF::File(path);
6419    
6420                // skip unused int and filename
6421                ckDoxf->SetPos(132, RIFF::stream_curpos);
6422    
6423                // check that the dlsids match
6424                RIFF::Chunk* ckDLSID = pExtFile->GetSubChunk(CHUNK_ID_DLID);
6425                if (ckDLSID) {
6426                    ::DLS::dlsid_t idExpected;
6427                    idExpected.ulData1 = ckDoxf->ReadInt32();
6428                    idExpected.usData2 = ckDoxf->ReadInt16();
6429                    idExpected.usData3 = ckDoxf->ReadInt16();
6430                    ckDoxf->Read(idExpected.abData, 8, 1);
6431                    ::DLS::dlsid_t idFound;
6432                    ckDLSID->Read(&idFound.ulData1, 1, 4);
6433                    ckDLSID->Read(&idFound.usData2, 1, 2);
6434                    ckDLSID->Read(&idFound.usData3, 1, 2);
6435                    ckDLSID->Read(idFound.abData, 8, 1);
6436                    if (memcmp(&idExpected, &idFound, 16) != 0)
6437                        throw gig::Exception("dlsid mismatch for GigaPulse file: %s", path.c_str());
6438                }
6439                poolFiles.push_back(pExtFile);
6440                ExtensionFiles.push_back(pExtFile);
6441            }
6442    
6443            // load samples from extension files (if required)
6444            for (int i = 0; i < poolFiles.size(); i++) {
6445                RIFF::File* file = poolFiles[i];
6446              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
6447              if (wvpl) {              if (wvpl) {
6448                  unsigned long wvplFileOffset = wvpl->GetFilePos();                  file_offset_t wvplFileOffset = wvpl->GetFilePos() -
6449                  RIFF::List* wave = wvpl->GetFirstSubList();                                                 wvpl->GetPos(); // should be zero, but just to be sure
6450                  while (wave) {                  size_t i = 0;
6451                    for (RIFF::List* wave = wvpl->GetSubListAt(i); wave;
6452                         wave = wvpl->GetSubListAt(++i))
6453                    {
6454                      if (wave->GetListType() == LIST_TYPE_WAVE) {                      if (wave->GetListType() == LIST_TYPE_WAVE) {
6455                          // notify current progress                          // notify current progress
6456                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;                          if (pProgress) {
6457                          __notify_progress(pProgress, subprogress);                              const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
6458                                __notify_progress(pProgress, subprogress);
6459                            }
6460    
6461                          unsigned long waveFileOffset = wave->GetFilePos();                          file_offset_t waveFileOffset = wave->GetFilePos();
6462                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, i, iSampleIndex));
6463    
6464                          iSampleIndex++;                          iSampleIndex++;
6465                      }                      }
                     wave = wvpl->GetNextSubList();  
6466                  }                  }
6467                }
                 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;  
6468          }          }
6469    
6470          __notify_progress(pProgress, 1.0); // notify done          if (pProgress)
6471                __notify_progress(pProgress, 1.0); // notify done
6472      }      }
6473    
6474      Instrument* File::GetFirstInstrument() {      Instrument* File::GetFirstInstrument() {
# Line 5388  namespace { Line 6485  namespace {
6485      }      }
6486    
6487      /**      /**
6488         * Returns the total amount of instruments of this gig file.
6489         *
6490         * Note that this method might block for a long time in case it is required
6491         * to load the instruments info for the first time.
6492         *
6493         * @returns total amount of instruments
6494         */
6495        size_t File::CountInstruments() {
6496            if (!pInstruments) LoadInstruments();
6497            if (!pInstruments) return 0;
6498            return pInstruments->size();
6499        }
6500    
6501        /**
6502       * Returns the instrument with the given index.       * Returns the instrument with the given index.
6503       *       *
6504       * @param index     - number of the sought instrument (0..n)       * @param index     - number of the sought instrument (0..n)
# Line 5398  namespace { Line 6509  namespace {
6509          if (!pInstruments) {          if (!pInstruments) {
6510              // 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)
6511    
6512              // sample loading subtask              if (pProgress) {
6513              progress_t subprogress;                  // sample loading subtask
6514              __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask                  progress_t subprogress;
6515              __notify_progress(&subprogress, 0.0f);                  __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
6516              if (GetAutoLoad())                  __notify_progress(&subprogress, 0.0f);
6517                  GetFirstSample(&subprogress); // now force all samples to be loaded                  if (GetAutoLoad())
6518              __notify_progress(&subprogress, 1.0f);                      GetFirstSample(&subprogress); // now force all samples to be loaded
6519                    __notify_progress(&subprogress, 1.0f);
6520              // instrument loading subtask  
6521              if (pProgress && pProgress->callback) {                  // instrument loading subtask
6522                  subprogress.__range_min = subprogress.__range_max;                  if (pProgress->callback) {
6523                  subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask                      subprogress.__range_min = subprogress.__range_max;
6524              }                      subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask
6525              __notify_progress(&subprogress, 0.0f);                  }
6526              LoadInstruments(&subprogress);                  __notify_progress(&subprogress, 0.0f);
6527              __notify_progress(&subprogress, 1.0f);                  LoadInstruments(&subprogress);
6528                    __notify_progress(&subprogress, 1.0f);
6529                } else {
6530                    // sample loading subtask
6531                    if (GetAutoLoad())
6532                        GetFirstSample(); // now force all samples to be loaded
6533    
6534                    // instrument loading subtask
6535                    LoadInstruments();
6536                }
6537          }          }
6538          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
6539          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
# Line 5506  namespace { Line 6626  namespace {
6626              mGroups[pFile->GetSample(i)->GetGroup()]->AddSample(s);              mGroups[pFile->GetSample(i)->GetGroup()]->AddSample(s);
6627              mSamples[pFile->GetSample(i)] = s;              mSamples[pFile->GetSample(i)] = s;
6628          }          }
6629            
6630            // clone script groups and their scripts
6631            for (int iGroup = 0; pFile->GetScriptGroup(iGroup); ++iGroup) {
6632                ScriptGroup* sg = pFile->GetScriptGroup(iGroup);
6633                ScriptGroup* dg = AddScriptGroup();
6634                dg->Name = "COPY" + ToString(iCallCount) + "_" + sg->Name;
6635                for (int iScript = 0; sg->GetScript(iScript); ++iScript) {
6636                    Script* ss = sg->GetScript(iScript);
6637                    Script* ds = dg->AddScript();
6638                    ds->CopyAssign(ss);
6639                }
6640            }
6641    
6642          //BUG: For some reason this method only works with this additional          //BUG: For some reason this method only works with this additional
6643          //     Save() call in between here.          //     Save() call in between here.
6644          //          //
# Line 5550  namespace { Line 6682  namespace {
6682          InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);          InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);
6683          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");
6684          pInstruments->erase(iter);          pInstruments->erase(iter);
6685            pInstrument->DeleteChunks();
6686          delete pInstrument;          delete pInstrument;
6687      }      }
6688    
# Line 5562  namespace { Line 6695  namespace {
6695          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
6696          if (lstInstruments) {          if (lstInstruments) {
6697              int iInstrumentIndex = 0;              int iInstrumentIndex = 0;
6698              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();              size_t i = 0;
6699              while (lstInstr) {              for (RIFF::List* lstInstr = lstInstruments->GetSubListAt(i);
6700                     lstInstr; lstInstr = lstInstruments->GetSubListAt(++i))
6701                {
6702                  if (lstInstr->GetListType() == LIST_TYPE_INS) {                  if (lstInstr->GetListType() == LIST_TYPE_INS) {
6703                      // notify current progress                      if (pProgress) {
6704                      const float localProgress = (float) iInstrumentIndex / (float) Instruments;                          // notify current progress
6705                      __notify_progress(pProgress, localProgress);                          const float localProgress = (float) iInstrumentIndex / (float) Instruments;
6706                            __notify_progress(pProgress, localProgress);
                     // divide local progress into subprogress for loading current Instrument  
                     progress_t subprogress;  
                     __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);  
6707    
6708                      pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));                          // divide local progress into subprogress for loading current Instrument
6709                            progress_t subprogress;
6710                            __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
6711    
6712                            pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
6713                        } else {
6714                            pInstruments->push_back(new Instrument(this, lstInstr));
6715                        }
6716    
6717                      iInstrumentIndex++;                      iInstrumentIndex++;
6718                  }                  }
                 lstInstr = lstInstruments->GetNextSubList();  
6719              }              }
6720              __notify_progress(pProgress, 1.0); // notify done              if (pProgress)
6721                    __notify_progress(pProgress, 1.0); // notify done
6722          }          }
6723      }      }
6724    
# Line 5591  namespace { Line 6730  namespace {
6730          if (!_3crc) return;          if (!_3crc) return;
6731    
6732          // get the index of the sample          // get the index of the sample
6733          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;  
             }  
         }  
6734          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");
6735    
6736          // write the CRC-32 checksum to disk          // write the CRC-32 checksum to disk
6737          _3crc->SetPos(iWaveIndex * 8);          _3crc->SetPos(iWaveIndex * 8);
6738          uint32_t tmp = 1;          uint32_t one = 1;
6739          _3crc->WriteUint32(&tmp); // unknown, always 1?          _3crc->WriteUint32(&one); // always 1
6740          _3crc->WriteUint32(&crc);          _3crc->WriteUint32(&crc);
6741      }      }
6742    
6743        uint32_t File::GetSampleChecksum(Sample* pSample) {
6744            // get the index of the sample
6745            int iWaveIndex = GetWaveTableIndexOf(pSample);
6746            if (iWaveIndex < 0) throw gig::Exception("Could not retrieve reference crc of sample, could not resolve sample's wave table index");
6747    
6748            return GetSampleChecksumByIndex(iWaveIndex);
6749        }
6750    
6751        uint32_t File::GetSampleChecksumByIndex(int index) {
6752            if (index < 0) throw gig::Exception("Could not retrieve reference crc of sample, invalid wave pool index of sample");
6753    
6754            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6755            if (!_3crc) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
6756            uint8_t* pData = (uint8_t*) _3crc->LoadChunkData();
6757            if (!pData) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
6758    
6759            // read the CRC-32 checksum directly from disk
6760            size_t pos = index * 8;
6761            if (pos + 8 > _3crc->GetNewSize())
6762                throw gig::Exception("Could not retrieve reference crc of sample, could not seek to required position in crc chunk");
6763    
6764            uint32_t one = load32(&pData[pos]); // always 1
6765            if (one != 1)
6766                throw gig::Exception("Could not retrieve reference crc of sample, because reference checksum table is damaged");
6767    
6768            return load32(&pData[pos+4]);
6769        }
6770    
6771        int File::GetWaveTableIndexOf(gig::Sample* pSample) {
6772            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
6773            File::SampleList::iterator iter = pSamples->begin();
6774            File::SampleList::iterator end  = pSamples->end();
6775            for (int index = 0; iter != end; ++iter, ++index)
6776                if (*iter == pSample)
6777                    return index;
6778            return -1;
6779        }
6780    
6781        /**
6782         * Checks whether the file's "3CRC" chunk was damaged. This chunk contains
6783         * the CRC32 check sums of all samples' raw wave data.
6784         *
6785         * @return true if 3CRC chunk is OK, or false if 3CRC chunk is damaged
6786         */
6787        bool File::VerifySampleChecksumTable() {
6788            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6789            if (!_3crc) return false;
6790            if (_3crc->GetNewSize() <= 0) return false;
6791            if (_3crc->GetNewSize() % 8) return false;
6792            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
6793            if (_3crc->GetNewSize() != pSamples->size() * 8) return false;
6794    
6795            const file_offset_t n = _3crc->GetNewSize() / 8;
6796    
6797            uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6798            if (!pData) return false;
6799    
6800            for (file_offset_t i = 0; i < n; ++i) {
6801                uint32_t one = pData[i*2];
6802                if (one != 1) return false;
6803            }
6804    
6805            return true;
6806        }
6807    
6808        /**
6809         * Recalculates CRC32 checksums for all samples and rebuilds this gig
6810         * file's checksum table with those new checksums. This might usually
6811         * just be necessary if the checksum table was damaged.
6812         *
6813         * @e IMPORTANT: The current implementation of this method only works
6814         * with files that have not been modified since it was loaded, because
6815         * it expects that no externally caused file structure changes are
6816         * required!
6817         *
6818         * Due to the expectation above, this method is currently protected
6819         * and actually only used by the command line tool "gigdump" yet.
6820         *
6821         * @returns true if Save() is required to be called after this call,
6822         *          false if no further action is required
6823         */
6824        bool File::RebuildSampleChecksumTable() {
6825            // make sure sample chunks were scanned
6826            if (!pSamples) GetFirstSample();
6827    
6828            bool bRequiresSave = false;
6829    
6830            // make sure "3CRC" chunk exists with required size
6831            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6832            if (!_3crc) {
6833                _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
6834                // the order of einf and 3crc is not the same in v2 and v3
6835                RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
6836                if (einf && pVersion && pVersion->major > 2) pRIFF->MoveSubChunk(_3crc, einf);
6837                bRequiresSave = true;
6838            } else if (_3crc->GetNewSize() != pSamples->size() * 8) {
6839                _3crc->Resize(pSamples->size() * 8);
6840                bRequiresSave = true;
6841            }
6842    
6843            if (bRequiresSave) { // refill CRC table for all samples in RAM ...
6844                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6845                {
6846                    File::SampleList::iterator iter = pSamples->begin();
6847                    File::SampleList::iterator end  = pSamples->end();
6848                    for (; iter != end; ++iter) {
6849                        gig::Sample* pSample = (gig::Sample*) *iter;
6850                        int index = GetWaveTableIndexOf(pSample);
6851                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6852                        pData[index*2]   = 1; // always 1
6853                        pData[index*2+1] = pSample->CalculateWaveDataChecksum();
6854                    }
6855                }
6856            } else { // no file structure changes necessary, so directly write to disk and we are done ...
6857                // make sure file is in write mode
6858                pRIFF->SetMode(RIFF::stream_mode_read_write);
6859                {
6860                    File::SampleList::iterator iter = pSamples->begin();
6861                    File::SampleList::iterator end  = pSamples->end();
6862                    for (; iter != end; ++iter) {
6863                        gig::Sample* pSample = (gig::Sample*) *iter;
6864                        int index = GetWaveTableIndexOf(pSample);
6865                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6866                        pSample->crc  = pSample->CalculateWaveDataChecksum();
6867                        SetSampleChecksum(pSample, pSample->crc);
6868                    }
6869                }
6870            }
6871    
6872            return bRequiresSave;
6873        }
6874    
6875      Group* File::GetFirstGroup() {      Group* File::GetFirstGroup() {
6876          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6877          // there must always be at least one group          // there must always be at least one group
# Line 5685  namespace { Line 6948  namespace {
6948          }          }
6949          // now delete this group object          // now delete this group object
6950          pGroups->erase(iter);          pGroups->erase(iter);
6951            pGroup->DeleteChunks();
6952          delete pGroup;          delete pGroup;
6953      }      }
6954    
# Line 5706  namespace { Line 6970  namespace {
6970          // move all members of this group to another group          // move all members of this group to another group
6971          pGroup->MoveAll();          pGroup->MoveAll();
6972          pGroups->erase(iter);          pGroups->erase(iter);
6973            pGroup->DeleteChunks();
6974          delete pGroup;          delete pGroup;
6975      }      }
6976    
# Line 5716  namespace { Line 6981  namespace {
6981          if (lst3gri) {          if (lst3gri) {
6982              RIFF::List* lst3gnl = lst3gri->GetSubList(LIST_TYPE_3GNL);              RIFF::List* lst3gnl = lst3gri->GetSubList(LIST_TYPE_3GNL);
6983              if (lst3gnl) {              if (lst3gnl) {
6984                  RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();                  size_t i = 0;
6985                  while (ck) {                  for (RIFF::Chunk* ck = lst3gnl->GetSubChunkAt(i); ck;
6986                         ck = lst3gnl->GetSubChunkAt(++i))
6987                    {
6988                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {
6989                          if (pVersion && pVersion->major == 3 &&                          if (pVersion && pVersion->major > 2 &&
6990                              strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;                              strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;
6991    
6992                          pGroups->push_back(new Group(this, ck));                          pGroups->push_back(new Group(this, ck));
6993                      }                      }
                     ck = lst3gnl->GetNextSubChunk();  
6994                  }                  }
6995              }              }
6996          }          }
# Line 5805  namespace { Line 7071  namespace {
7071              pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));              pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));
7072          if (pScriptGroup->pList)          if (pScriptGroup->pList)
7073              pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);              pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);
7074            pScriptGroup->DeleteChunks();
7075          delete pScriptGroup;          delete pScriptGroup;
7076      }      }
7077    
# Line 5813  namespace { Line 7080  namespace {
7080          pScriptGroups = new std::list<ScriptGroup*>;          pScriptGroups = new std::list<ScriptGroup*>;
7081          RIFF::List* lstLS = pRIFF->GetSubList(LIST_TYPE_3LS);          RIFF::List* lstLS = pRIFF->GetSubList(LIST_TYPE_3LS);
7082          if (lstLS) {          if (lstLS) {
7083              for (RIFF::List* lst = lstLS->GetFirstSubList(); lst;              size_t i = 0;
7084                   lst = lstLS->GetNextSubList())              for (RIFF::List* lst = lstLS->GetSubListAt(i); lst;
7085                     lst = lstLS->GetSubListAt(++i))
7086              {              {
7087                  if (lst->GetListType() == LIST_TYPE_RTIS) {                  if (lst->GetListType() == LIST_TYPE_RTIS) {
7088                      pScriptGroups->push_back(new ScriptGroup(this, lst));                      pScriptGroups->push_back(new ScriptGroup(this, lst));
# Line 5837  namespace { Line 7105  namespace {
7105      void File::UpdateChunks(progress_t* pProgress) {      void File::UpdateChunks(progress_t* pProgress) {
7106          bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;          bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;
7107    
         b64BitWavePoolOffsets = pVersion && pVersion->major == 3;  
   
7108          // update own gig format extension chunks          // update own gig format extension chunks
7109          // (not part of the GigaStudio 4 format)          // (not part of the GigaStudio 4 format)
7110          //          RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);
7111            if (!lst3LS) {
7112                lst3LS = pRIFF->AddSubList(LIST_TYPE_3LS);
7113            }
7114            // Make sure <3LS > chunk is placed before <ptbl> chunk. The precise
7115            // location of <3LS > is irrelevant, however it should be located
7116            // before  the actual wave data
7117            RIFF::Chunk* ckPTBL = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
7118            pRIFF->MoveSubChunk(lst3LS, ckPTBL);
7119    
7120          // This must be performed before writing the chunks for instruments,          // This must be performed before writing the chunks for instruments,
7121          // because the instruments' script slots will write the file offsets          // because the instruments' script slots will write the file offsets
7122          // of the respective instrument script chunk as reference.          // of the respective instrument script chunk as reference.
7123          if (pScriptGroups) {          if (pScriptGroups) {
7124              RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);              // Update instrument script (group) chunks.
7125              if (pScriptGroups->empty()) {              for (std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
7126                  if (lst3LS) pRIFF->DeleteSubChunk(lst3LS);                   it != pScriptGroups->end(); ++it)
7127              } else {              {
7128                  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(pProgress);  
                 }  
7129              }              }
7130          }          }
7131    
7132            // in case no libgig custom format data was added, then remove the
7133            // custom "3LS " chunk again
7134            if (!lst3LS->CountSubChunks()) {
7135                pRIFF->DeleteSubChunk(lst3LS);
7136                lst3LS = NULL;
7137            }
7138    
7139          // first update base class's chunks          // first update base class's chunks
7140          DLS::File::UpdateChunks(pProgress);          DLS::File::UpdateChunks(pProgress);
7141    
# Line 5869  namespace { Line 7143  namespace {
7143              // INFO was added by Resource::UpdateChunks - make sure it              // INFO was added by Resource::UpdateChunks - make sure it
7144              // is placed first in file              // is placed first in file
7145              RIFF::Chunk* info = pRIFF->GetSubList(LIST_TYPE_INFO);              RIFF::Chunk* info = pRIFF->GetSubList(LIST_TYPE_INFO);
7146              RIFF::Chunk* first = pRIFF->GetFirstSubChunk();              RIFF::Chunk* first = pRIFF->GetSubChunkAt(0);
7147              if (first != info) {              if (first != info) {
7148                  pRIFF->MoveSubChunk(info, first);                  pRIFF->MoveSubChunk(info, first);
7149              }              }
# Line 5889  namespace { Line 7163  namespace {
7163    
7164              // v3: make sure the file has 128 3gnm chunks              // v3: make sure the file has 128 3gnm chunks
7165              // (before updating the Group chunks)              // (before updating the Group chunks)
7166              if (pVersion && pVersion->major == 3) {              if (pVersion && pVersion->major > 2) {
7167                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();                  size_t i = 0;
7168                  for (int i = 0 ; i < 128 ; i++) {                  for (RIFF::Chunk* _3gnm = _3gnl->GetSubChunkAt(i); i < 128;
7169                      if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);                       _3gnm = _3gnl->GetSubChunkAt(++i))
7170                      if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();                  {
7171                        // create 128 empty placeholder strings which will either
7172                        // be filled by Group::UpdateChunks below or left empty.
7173                        ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
7174                  }                  }
7175              }              }
7176    
# Line 5920  namespace { Line 7197  namespace {
7197          // Note that there are several fields with unknown use. These          // Note that there are several fields with unknown use. These
7198          // are set to zero.          // are set to zero.
7199    
7200          int sublen = pSamples->size() / 8 + 49;          int sublen = int(pSamples->size() / 8 + 49);
7201          int einfSize = (Instruments + 1) * sublen;          int einfSize = (Instruments + 1) * sublen;
7202    
7203          RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);          RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
# Line 5993  namespace { Line 7270  namespace {
7270                  store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);                  store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);
7271                  // next 8 bytes unknown                  // next 8 bytes unknown
7272                  store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);                  store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);
7273                  store32(&pData[(instrumentIdx + 1) * sublen + 40], pSamples->size());                  store32(&pData[(instrumentIdx + 1) * sublen + 40], (uint32_t) pSamples->size());
7274                  // next 4 bytes unknown                  // next 4 bytes unknown
7275    
7276                  totnbregions += instrument->Regions;                  totnbregions += instrument->Regions;
# Line 6011  namespace { Line 7288  namespace {
7288              store32(&pData[24], totnbloops);              store32(&pData[24], totnbloops);
7289              // next 8 bytes unknown              // next 8 bytes unknown
7290              // next 4 bytes unknown, not always 0              // next 4 bytes unknown, not always 0
7291              store32(&pData[40], pSamples->size());              store32(&pData[40], (uint32_t) pSamples->size());
7292              // next 4 bytes unknown              // next 4 bytes unknown
7293          }          }
7294    
7295          // update 3crc chunk          // update 3crc chunk
7296    
7297          // The 3crc chunk contains CRC-32 checksums for the          // The 3crc chunk contains CRC-32 checksums for the
7298          // samples. The actual checksum values will be filled in          // samples. When saving a gig file to disk, we first update the 3CRC
7299          // later, by Sample::Write.          // chunk here (in RAM) with the old crc values which we read from the
7300            // 3CRC chunk when we opened the file (available with gig::Sample::crc
7301            // member variable). This step is required, because samples might have
7302            // been deleted by the user since the file was opened, which in turn
7303            // changes the order of the (i.e. old) checksums within the 3crc chunk.
7304            // If a sample was conciously modified by the user (that is if
7305            // Sample::Write() was called later on) then Sample::Write() will just
7306            // update the respective individual checksum(s) directly on disk and
7307            // leaves all other sample checksums untouched.
7308    
7309          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
7310          if (_3crc) {          if (_3crc) {
7311              _3crc->Resize(pSamples->size() * 8);              _3crc->Resize(pSamples->size() * 8);
7312          } else if (newFile) {          } else /*if (newFile)*/ {
7313              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
             _3crc->LoadChunkData();  
   
7314              // 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
7315              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);              if (einf && pVersion && pVersion->major > 2) pRIFF->MoveSubChunk(_3crc, einf);
7316            }
7317            { // must be performed in RAM here ...
7318                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
7319                if (pData) {
7320                    File::SampleList::iterator iter = pSamples->begin();
7321                    File::SampleList::iterator end  = pSamples->end();
7322                    for (int index = 0; iter != end; ++iter, ++index) {
7323                        gig::Sample* pSample = (gig::Sample*) *iter;
7324                        pData[index*2]   = 1; // always 1
7325                        pData[index*2+1] = pSample->crc;
7326                    }
7327                }
7328          }          }
7329      }      }
7330            
# Line 6044  namespace { Line 7339  namespace {
7339      }      }
7340    
7341      /**      /**
7342       * Enable / disable automatic loading. By default this properyt is       * Enable / disable automatic loading. By default this property is
7343       * enabled and all informations are loaded automatically. However       * enabled and every information is loaded automatically. However
7344       * loading all Regions, DimensionRegions and especially samples might       * loading all Regions, DimensionRegions and especially samples might
7345       * 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
7346       * be interested in retrieving very superficial informations like the       * be interested in retrieving very superficial informations like the
# Line 6053  namespace { Line 7348  namespace {
7348       * automatic loading to avoid very slow response times.       * automatic loading to avoid very slow response times.
7349       *       *
7350       * @e CAUTION: by disabling this property many pointers (i.e. sample       * @e CAUTION: by disabling this property many pointers (i.e. sample
7351       * references) and informations will have invalid or even undefined       * references) and attributes will have invalid or even undefined
7352       * data! This feature is currently only intended for retrieving very       * data! This feature is currently only intended for retrieving very
7353       * 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
7354       * details like synthesis informations or even to modify .gig files!       * details like synthesis information or even to modify .gig files!
7355       */       */
7356      void File::SetAutoLoad(bool b) {      void File::SetAutoLoad(bool b) {
7357          bAutoLoad = b;          bAutoLoad = b;
# Line 6070  namespace { Line 7365  namespace {
7365          return bAutoLoad;          return bAutoLoad;
7366      }      }
7367    
7368        /**
7369         * Returns @c true in case this gig File object uses any gig format
7370         * extension, that is e.g. whether any DimensionRegion object currently
7371         * has any setting effective that would require our "LSDE" RIFF chunk to
7372         * be stored to the gig file.
7373         *
7374         * Right now this is a private method. It is considerable though this method
7375         * to become (in slightly modified form) a public API method in future, i.e.
7376         * to allow instrument editors to visualize and/or warn the user of any gig
7377         * format extension being used. See also comments on
7378         * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
7379         * potential public API change in future.
7380         */
7381        bool File::UsesAnyGigFormatExtension() const {
7382            if (!pInstruments) return false;
7383            InstrumentList::iterator iter = pInstruments->begin();
7384            InstrumentList::iterator end  = pInstruments->end();
7385            for (; iter != end; ++iter) {
7386                Instrument* pInstrument = static_cast<gig::Instrument*>(*iter);
7387                if (pInstrument->UsesAnyGigFormatExtension())
7388                    return true;
7389            }
7390            return false;
7391        }
7392    
7393    
7394  // *************** Exception ***************  // *************** Exception ***************
7395  // *  // *
7396    
7397      Exception::Exception(String Message) : DLS::Exception(Message) {      Exception::Exception() : DLS::Exception() {
7398        }
7399    
7400        Exception::Exception(String format, ...) : DLS::Exception() {
7401            va_list arg;
7402            va_start(arg, format);
7403            Message = assemble(format, arg);
7404            va_end(arg);
7405        }
7406    
7407        Exception::Exception(String format, va_list arg) : DLS::Exception() {
7408            Message = assemble(format, arg);
7409      }      }
7410    
7411      void Exception::PrintMessage() {      void Exception::PrintMessage() {

Legend:
Removed from v.2702  
changed lines
  Added in v.3924

  ViewVC Help
Powered by ViewVC