/[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 3723 by schoenebeck, Wed Jan 22 15:48:32 2020 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-2020 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 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) {
# Line 3102  namespace { Line 3531  namespace {
3531          int step = 1;          int step = 1;
3532          for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;          for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
3533          int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;          int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
         int end = step * pDimensionDefinitions[veldim].zones;  
3534    
3535          // loop through all dimension regions for all dimensions except the velocity dimension          // loop through all dimension regions for all dimensions except the velocity dimension
3536          int dim[8] = { 0 };          int dim[8] = { 0 };
3537          for (int i = 0 ; i < DimensionRegions ; i++) {          for (int i = 0 ; i < DimensionRegions ; i++) {
3538                const int end = i + step * pDimensionDefinitions[veldim].zones;
3539    
3540                // create a velocity table for all cases where the velocity zone is zero
3541              if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||              if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||
3542                  pDimensionRegions[i]->VelocityUpperLimit) {                  pDimensionRegions[i]->VelocityUpperLimit) {
3543                  // create the velocity table                  // create the velocity table
# Line 3138  namespace { Line 3568  namespace {
3568                  }                  }
3569              }              }
3570    
3571                // jump to the next case where the velocity zone is zero
3572              int j;              int j;
3573              int shift = 0;              int shift = 0;
3574              for (j = 0 ; j < Dimensions ; j++) {              for (j = 0 ; j < Dimensions ; j++) {
# Line 3188  namespace { Line 3619  namespace {
3619    
3620          // check if max. amount of dimensions reached          // check if max. amount of dimensions reached
3621          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
3622          const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;          const int iMaxDimensions = (file->pVersion && file->pVersion->major > 2) ? 8 : 5;
3623          if (Dimensions >= iMaxDimensions)          if (Dimensions >= iMaxDimensions)
3624              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");
3625          // check if max. amount of dimension bits reached          // check if max. amount of dimension bits reached
# Line 3459  namespace { Line 3890  namespace {
3890          // now tempRegion's dimensions and DimensionRegions basically reflect          // now tempRegion's dimensions and DimensionRegions basically reflect
3891          // 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
3892          // delete and recreate the dimension in question with the new amount          // delete and recreate the dimension in question with the new amount
3893          // zones and then copy back from tempRegion                // zones and then copy back from tempRegion. we're actually deleting and
3894          DeleteDimension(oldDef);          // recreating all dimensions here, to avoid altering the precise order
3895          AddDimension(&newDef);          // of the dimensions (which would not be an error per se, but it would
3896            // cause usability issues with instrument editors)
3897            {
3898                std::vector<dimension_def_t> oldDefs;
3899                for (int i = 0; i < Dimensions; ++i)
3900                    oldDefs.push_back(pDimensionDefinitions[i]); // copy, don't reference
3901                for (int i = Dimensions - 1; i >= 0; --i)
3902                    DeleteDimension(&pDimensionDefinitions[i]);
3903                for (int i = 0; i < oldDefs.size(); ++i) {
3904                    dimension_def_t& def = oldDefs[i];
3905                    AddDimension(
3906                        (def.dimension == newDef.dimension) ? &newDef : &def
3907                    );
3908                }
3909            }
3910          for (int iSrc = 0; iSrc < 256; ++iSrc) {          for (int iSrc = 0; iSrc < 256; ++iSrc) {
3911              DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];              DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
3912              if (!srcDimRgn) continue;              if (!srcDimRgn) continue;
# Line 3480  namespace { Line 3925  namespace {
3925          }          }
3926    
3927          // delete temporary region          // delete temporary region
3928            tempRgn->DeleteChunks();
3929          delete tempRgn;          delete tempRgn;
3930    
3931          UpdateVelocityTable();          UpdateVelocityTable();
# Line 3598  namespace { Line 4044  namespace {
4044          // now tempRegion's dimensions and DimensionRegions basically reflect          // now tempRegion's dimensions and DimensionRegions basically reflect
4045          // 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
4046          // delete and recreate the dimension in question with the new amount          // delete and recreate the dimension in question with the new amount
4047          // zones and then copy back from tempRegion                // zones and then copy back from tempRegion. we're actually deleting and
4048          DeleteDimension(oldDef);          // recreating all dimensions here, to avoid altering the precise order
4049          AddDimension(&newDef);          // of the dimensions (which would not be an error per se, but it would
4050            // cause usability issues with instrument editors)
4051            {
4052                std::vector<dimension_def_t> oldDefs;
4053                for (int i = 0; i < Dimensions; ++i)
4054                    oldDefs.push_back(pDimensionDefinitions[i]); // copy, don't reference
4055                for (int i = Dimensions - 1; i >= 0; --i)
4056                    DeleteDimension(&pDimensionDefinitions[i]);
4057                for (int i = 0; i < oldDefs.size(); ++i) {
4058                    dimension_def_t& def = oldDefs[i];
4059                    AddDimension(
4060                        (def.dimension == newDef.dimension) ? &newDef : &def
4061                    );
4062                }
4063            }
4064          for (int iSrc = 0; iSrc < 256; ++iSrc) {          for (int iSrc = 0; iSrc < 256; ++iSrc) {
4065              DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];              DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
4066              if (!srcDimRgn) continue;              if (!srcDimRgn) continue;
# Line 3619  namespace { Line 4079  namespace {
4079          }          }
4080    
4081          // delete temporary region          // delete temporary region
4082            tempRgn->DeleteChunks();
4083          delete tempRgn;          delete tempRgn;
4084    
4085          UpdateVelocityTable();          UpdateVelocityTable();
# Line 3712  namespace { Line 4173  namespace {
4173      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
4174          uint8_t bits;          uint8_t bits;
4175          int veldim = -1;          int veldim = -1;
4176          int velbitpos;          int velbitpos = 0;
4177          int bitpos = 0;          int bitpos = 0;
4178          int dimregidx = 0;          int dimregidx = 0;
4179          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
# Line 3761  namespace { Line 4222  namespace {
4222      int Region::GetDimensionRegionIndexByValue(const uint DimValues[8]) {      int Region::GetDimensionRegionIndexByValue(const uint DimValues[8]) {
4223          uint8_t bits;          uint8_t bits;
4224          int veldim = -1;          int veldim = -1;
4225          int velbitpos;          int velbitpos = 0;
4226          int bitpos = 0;          int bitpos = 0;
4227          int dimregidx = 0;          int dimregidx = 0;
4228          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
# Line 3846  namespace { Line 4307  namespace {
4307          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
4308          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
4309          if (!file->pWavePoolTable) return NULL;          if (!file->pWavePoolTable) return NULL;
4310          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          if (WavePoolTableIndex + 1 > file->WavePoolCount) return NULL;
4311          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];          // for new files or files >= 2 GB use 64 bit wave pool offsets
4312          Sample* sample = file->GetFirstSample(pProgress);          if (file->pRIFF->IsNew() || (file->pRIFF->GetCurrentFileSize() >> 31)) {
4313          while (sample) {              // use 64 bit wave pool offsets (treating this as large file)
4314              if (sample->ulWavePoolOffset == soughtoffset &&              uint64_t soughtoffset =
4315                  sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);                  uint64_t(file->pWavePoolTable[WavePoolTableIndex]) |
4316              sample = file->GetNextSample();                  uint64_t(file->pWavePoolTableHi[WavePoolTableIndex]) << 32;
4317                Sample* sample = file->GetFirstSample(pProgress);
4318                while (sample) {
4319                    if (sample->ullWavePoolOffset == soughtoffset)
4320                        return static_cast<gig::Sample*>(sample);
4321                    sample = file->GetNextSample();
4322                }
4323            } else {
4324                // use extension files and 32 bit wave pool offsets
4325                file_offset_t soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
4326                file_offset_t soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
4327                Sample* sample = file->GetFirstSample(pProgress);
4328                while (sample) {
4329                    if (sample->ullWavePoolOffset == soughtoffset &&
4330                        sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
4331                    sample = file->GetNextSample();
4332                }
4333          }          }
4334          return NULL;          return NULL;
4335      }      }
# Line 3907  namespace { Line 4384  namespace {
4384          Layers = orig->Layers;          Layers = orig->Layers;
4385      }      }
4386    
4387        /**
4388         * Returns @c true in case this Region object uses any gig format
4389         * extension, that is e.g. whether any DimensionRegion object currently
4390         * has any setting effective that would require our "LSDE" RIFF chunk to
4391         * be stored to the gig file.
4392         *
4393         * Right now this is a private method. It is considerable though this method
4394         * to become (in slightly modified form) a public API method in future, i.e.
4395         * to allow instrument editors to visualize and/or warn the user of any gig
4396         * format extension being used. See also comments on
4397         * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
4398         * potential public API change in future.
4399         */
4400        bool Region::UsesAnyGigFormatExtension() const {
4401            for (int i = 0; i < 256; i++) {
4402                if (pDimensionRegions[i]) {
4403                    if (pDimensionRegions[i]->UsesAnyGigFormatExtension())
4404                        return true;
4405                }
4406            }
4407            return false;
4408        }
4409    
4410    
4411  // *************** MidiRule ***************  // *************** MidiRule ***************
4412  // *  // *
# Line 4081  namespace { Line 4581  namespace {
4581          pGroup = group;          pGroup = group;
4582          pChunk = ckScri;          pChunk = ckScri;
4583          if (ckScri) { // object is loaded from file ...          if (ckScri) { // object is loaded from file ...
4584                ckScri->SetPos(0);
4585    
4586              // read header              // read header
4587              uint32_t headerSize = ckScri->ReadUint32();              uint32_t headerSize = ckScri->ReadUint32();
4588              Compression = (Compression_t) ckScri->ReadUint32();              Compression = (Compression_t) ckScri->ReadUint32();
4589              Encoding    = (Encoding_t) ckScri->ReadUint32();              Encoding    = (Encoding_t) ckScri->ReadUint32();
4590              Language    = (Language_t) ckScri->ReadUint32();              Language    = (Language_t) ckScri->ReadUint32();
4591              Bypass      = (Language_t) ckScri->ReadUint32() & 1;              Bypass      = ckScri->ReadUint32() & 1;
4592              crc         = ckScri->ReadUint32();              crc         = ckScri->ReadUint32();
4593              uint32_t nameSize = ckScri->ReadUint32();              uint32_t nameSize = ckScri->ReadUint32();
4594              Name.resize(nameSize, ' ');              Name.resize(nameSize, ' ');
4595              for (int i = 0; i < nameSize; ++i)              for (int i = 0; i < nameSize; ++i)
4596                  Name[i] = ckScri->ReadUint8();                  Name[i] = ckScri->ReadUint8();
4597                // check if an uuid was already stored along with this script
4598                if (headerSize >= 6*sizeof(int32_t) + nameSize + 16) { // yes ...
4599                    for (uint i = 0; i < 16; ++i) {
4600                        Uuid[i] = ckScri->ReadUint8();
4601                    }
4602                } else { // no uuid yet, generate one now ...
4603                    GenerateUuid();
4604                }
4605              // to handle potential future extensions of the header              // to handle potential future extensions of the header
4606              ckScri->SetPos(sizeof(int32_t) + headerSize);              ckScri->SetPos(sizeof(int32_t) + headerSize);
4607              // read actual script data              // read actual script data
4608              uint32_t scriptSize = ckScri->GetSize() - ckScri->GetPos();              uint32_t scriptSize = uint32_t(ckScri->GetSize() - ckScri->GetPos());
4609              data.resize(scriptSize);              data.resize(scriptSize);
4610              for (int i = 0; i < scriptSize; ++i)              for (int i = 0; i < scriptSize; ++i)
4611                  data[i] = ckScri->ReadUint8();                  data[i] = ckScri->ReadUint8();
# Line 4106  namespace { Line 4616  namespace {
4616              Bypass   = false;              Bypass   = false;
4617              crc      = 0;              crc      = 0;
4618              Name     = "Unnamed Script";              Name     = "Unnamed Script";
4619                GenerateUuid();
4620          }          }
4621      }      }
4622    
# Line 4133  namespace { Line 4644  namespace {
4644          memcpy(&data[0], &text[0], text.size());          memcpy(&data[0], &text[0], text.size());
4645      }      }
4646    
4647        /** @brief Remove all RIFF chunks associated with this Script object.
4648         *
4649         * At the moment Script::DeleteChunks() does nothing. It is
4650         * recommended to call this method explicitly though from deriving classes's
4651         * own overridden implementation of this method to avoid potential future
4652         * compatiblity issues.
4653         *
4654         * See DLS::Storage::DeleteChunks() for details.
4655         */
4656        void Script::DeleteChunks() {
4657        }
4658    
4659      /**      /**
4660       * Apply this script to the respective RIFF chunks. You have to call       * Apply this script to the respective RIFF chunks. You have to call
4661       * File::Save() to make changes persistent.       * File::Save() to make changes persistent.
# Line 4146  namespace { Line 4669  namespace {
4669          // recalculate CRC32 check sum          // recalculate CRC32 check sum
4670          __resetCRC(crc);          __resetCRC(crc);
4671          __calculateCRC(&data[0], data.size(), crc);          __calculateCRC(&data[0], data.size(), crc);
4672          __encodeCRC(crc);          __finalizeCRC(crc);
4673          // make sure chunk exists and has the required size          // make sure chunk exists and has the required size
4674          const int chunkSize = 7*sizeof(int32_t) + Name.size() + data.size();          const file_offset_t chunkSize =
4675                (file_offset_t) 7*sizeof(int32_t) + Name.size() + 16 + data.size();
4676          if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);          if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);
4677          else pChunk->Resize(chunkSize);          else pChunk->Resize(chunkSize);
4678          // fill the chunk data to be written to disk          // fill the chunk data to be written to disk
4679          uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();          uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();
4680          int pos = 0;          int pos = 0;
4681          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
4682          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4683          store32(&pData[pos], Compression);          store32(&pData[pos], Compression);
4684          pos += sizeof(int32_t);          pos += sizeof(int32_t);
# Line 4166  namespace { Line 4690  namespace {
4690          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4691          store32(&pData[pos], crc);          store32(&pData[pos], crc);
4692          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4693          store32(&pData[pos], Name.size());          store32(&pData[pos], (uint32_t) Name.size());
4694          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4695          for (int i = 0; i < Name.size(); ++i, ++pos)          for (int i = 0; i < Name.size(); ++i, ++pos)
4696              pData[pos] = Name[i];              pData[pos] = Name[i];
4697            for (int i = 0; i < 16; ++i, ++pos)
4698                pData[pos] = Uuid[i];
4699          for (int i = 0; i < data.size(); ++i, ++pos)          for (int i = 0; i < data.size(); ++i, ++pos)
4700              pData[pos] = data[i];              pData[pos] = data[i];
4701      }      }
4702    
4703      /**      /**
4704         * Generate a new Universally Unique Identifier (UUID) for this script.
4705         */
4706        void Script::GenerateUuid() {
4707            DLS::dlsid_t dlsid;
4708            DLS::Resource::GenerateDLSID(&dlsid);
4709            Uuid[0]  = dlsid.ulData1       & 0xff;
4710            Uuid[1]  = dlsid.ulData1 >>  8 & 0xff;
4711            Uuid[2]  = dlsid.ulData1 >> 16 & 0xff;
4712            Uuid[3]  = dlsid.ulData1 >> 24 & 0xff;
4713            Uuid[4]  = dlsid.usData2       & 0xff;
4714            Uuid[5]  = dlsid.usData2 >>  8 & 0xff;
4715            Uuid[6]  = dlsid.usData3       & 0xff;
4716            Uuid[7]  = dlsid.usData3 >>  8 & 0xff;
4717            Uuid[8]  = dlsid.abData[0];
4718            Uuid[9]  = dlsid.abData[1];
4719            Uuid[10] = dlsid.abData[2];
4720            Uuid[11] = dlsid.abData[3];
4721            Uuid[12] = dlsid.abData[4];
4722            Uuid[13] = dlsid.abData[5];
4723            Uuid[14] = dlsid.abData[6];
4724            Uuid[15] = dlsid.abData[7];
4725        }
4726    
4727        /**
4728       * Move this script from its current ScriptGroup to another ScriptGroup       * Move this script from its current ScriptGroup to another ScriptGroup
4729       * given by @a pGroup.       * given by @a pGroup.
4730       *       *
4731       * @param pGroup - script's new group       * @param pGroup - script's new group
4732       */       */
4733      void Script::SetGroup(ScriptGroup* pGroup) {      void Script::SetGroup(ScriptGroup* pGroup) {
4734          if (this->pGroup = pGroup) return;          if (this->pGroup == pGroup) return;
4735          if (pChunk)          if (pChunk)
4736              pChunk->GetParent()->MoveSubChunk(pChunk, pGroup->pList);              pChunk->GetParent()->MoveSubChunk(pChunk, pGroup->pList);
4737          this->pGroup = pGroup;          this->pGroup = pGroup;
# Line 4197  namespace { Line 4747  namespace {
4747          return pGroup;          return pGroup;
4748      }      }
4749    
4750        /**
4751         * Make a (semi) deep copy of the Script object given by @a orig
4752         * and assign it to this object. Note: the ScriptGroup this Script
4753         * object belongs to remains untouched by this call.
4754         *
4755         * @param orig - original Script object to be copied from
4756         */
4757        void Script::CopyAssign(const Script* orig) {
4758            Name        = orig->Name;
4759            Compression = orig->Compression;
4760            Encoding    = orig->Encoding;
4761            Language    = orig->Language;
4762            Bypass      = orig->Bypass;
4763            data        = orig->data;
4764        }
4765    
4766      void Script::RemoveAllScriptReferences() {      void Script::RemoveAllScriptReferences() {
4767          File* pFile = pGroup->pFile;          File* pFile = pGroup->pFile;
4768          for (int i = 0; pFile->GetInstrument(i); ++i) {          for (int i = 0; pFile->GetInstrument(i); ++i) {
# Line 4232  namespace { Line 4798  namespace {
4798          }          }
4799      }      }
4800    
4801        /** @brief Remove all RIFF chunks associated with this ScriptGroup object.
4802         *
4803         * At the moment ScriptGroup::DeleteChunks() does nothing. It is
4804         * recommended to call this method explicitly though from deriving classes's
4805         * own overridden implementation of this method to avoid potential future
4806         * compatiblity issues.
4807         *
4808         * See DLS::Storage::DeleteChunks() for details.
4809         */
4810        void ScriptGroup::DeleteChunks() {
4811        }
4812    
4813      /**      /**
4814       * 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
4815       * File::Save() to make changes persistent.       * File::Save() to make changes persistent.
# Line 4343  namespace { Line 4921  namespace {
4921          EffectSend = 0;          EffectSend = 0;
4922          Attenuation = 0;          Attenuation = 0;
4923          FineTune = 0;          FineTune = 0;
4924          PitchbendRange = 0;          PitchbendRange = 2;
4925          PianoReleaseMode = false;          PianoReleaseMode = false;
4926          DimensionKeyRange.low = 0;          DimensionKeyRange.low = 0;
4927          DimensionKeyRange.high = 0;          DimensionKeyRange.high = 0;
# Line 4356  namespace { Line 4934  namespace {
4934          if (lart) {          if (lart) {
4935              RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);              RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
4936              if (_3ewg) {              if (_3ewg) {
4937                    _3ewg->SetPos(0);
4938    
4939                  EffectSend             = _3ewg->ReadUint16();                  EffectSend             = _3ewg->ReadUint16();
4940                  Attenuation            = _3ewg->ReadInt32();                  Attenuation            = _3ewg->ReadInt32();
4941                  FineTune               = _3ewg->ReadInt16();                  FineTune               = _3ewg->ReadInt16();
# Line 4400  namespace { Line 4980  namespace {
4980                  RIFF::List* rgn = lrgn->GetFirstSubList();                  RIFF::List* rgn = lrgn->GetFirstSubList();
4981                  while (rgn) {                  while (rgn) {
4982                      if (rgn->GetListType() == LIST_TYPE_RGN) {                      if (rgn->GetListType() == LIST_TYPE_RGN) {
4983                          __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);                          if (pProgress)
4984                                __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
4985                          pRegions->push_back(new Region(this, rgn));                          pRegions->push_back(new Region(this, rgn));
4986                      }                      }
4987                      rgn = lrgn->GetNextSubList();                      rgn = lrgn->GetNextSubList();
# Line 4415  namespace { Line 4996  namespace {
4996          if (lst3LS) {          if (lst3LS) {
4997              RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);              RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4998              if (ckSCSL) {              if (ckSCSL) {
4999                    ckSCSL->SetPos(0);
5000    
5001                  int headerSize = ckSCSL->ReadUint32();                  int headerSize = ckSCSL->ReadUint32();
5002                  int slotCount  = ckSCSL->ReadUint32();                  int slotCount  = ckSCSL->ReadUint32();
5003                  if (slotCount) {                  if (slotCount) {
# Line 4432  namespace { Line 5015  namespace {
5015              }              }
5016          }          }
5017    
5018          __notify_progress(pProgress, 1.0f); // notify done          if (pProgress)
5019                __notify_progress(pProgress, 1.0f); // notify done
5020      }      }
5021    
5022      void Instrument::UpdateRegionKeyTable() {      void Instrument::UpdateRegionKeyTable() {
# Line 4441  namespace { Line 5025  namespace {
5025          RegionList::iterator end  = pRegions->end();          RegionList::iterator end  = pRegions->end();
5026          for (; iter != end; ++iter) {          for (; iter != end; ++iter) {
5027              gig::Region* pRegion = static_cast<gig::Region*>(*iter);              gig::Region* pRegion = static_cast<gig::Region*>(*iter);
5028              for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {              const int low  = std::max(int(pRegion->KeyRange.low), 0);
5029                const int high = std::min(int(pRegion->KeyRange.high), 127);
5030                for (int iKey = low; iKey <= high; iKey++) {
5031                  RegionKeyTable[iKey] = pRegion;                  RegionKeyTable[iKey] = pRegion;
5032              }              }
5033          }          }
# Line 4486  namespace { Line 5072  namespace {
5072              File* pFile = (File*) GetParent();              File* pFile = (File*) GetParent();
5073    
5074              // 3ewg is bigger in gig3, as it includes the iMIDI rules              // 3ewg is bigger in gig3, as it includes the iMIDI rules
5075              int size = (pFile->pVersion && pFile->pVersion->major == 3) ? 16416 : 12;              int size = (pFile->pVersion && pFile->pVersion->major > 2) ? 16416 : 12;
5076              _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);              _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);
5077              memset(_3ewg->LoadChunkData(), 0, size);              memset(_3ewg->LoadChunkData(), 0, size);
5078          }          }
# Line 4518  namespace { Line 5104  namespace {
5104    
5105             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
5106             if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);             if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);
5107             const int slotCount = pScriptRefs->size();             const int slotCount = (int) pScriptRefs->size();
5108             const int headerSize = 3 * sizeof(uint32_t);             const int headerSize = 3 * sizeof(uint32_t);
5109             const int slotSize  = 2 * sizeof(uint32_t);             const int slotSize  = 2 * sizeof(uint32_t);
5110             const int totalChunkSize = headerSize + slotCount * slotSize;             const int totalChunkSize = headerSize + slotCount * slotSize;
# Line 4554  namespace { Line 5140  namespace {
5140         if (pScriptRefs && pScriptRefs->size() > 0) {         if (pScriptRefs && pScriptRefs->size() > 0) {
5141             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
5142             RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);             RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
5143             const int slotCount = pScriptRefs->size();             const int slotCount = (int) pScriptRefs->size();
5144             const int headerSize = 3 * sizeof(uint32_t);             const int headerSize = 3 * sizeof(uint32_t);
5145             ckSCSL->SetPos(headerSize);             ckSCSL->SetPos(headerSize);
5146             for (int i = 0; i < slotCount; ++i) {             for (int i = 0; i < slotCount; ++i) {
5147                 uint32_t fileOffset =                 uint32_t fileOffset = uint32_t(
5148                      (*pScriptRefs)[i].script->pChunk->GetFilePos() -                      (*pScriptRefs)[i].script->pChunk->GetFilePos() -
5149                      (*pScriptRefs)[i].script->pChunk->GetPos() -                      (*pScriptRefs)[i].script->pChunk->GetPos() -
5150                      CHUNK_HEADER_SIZE;                      CHUNK_HEADER_SIZE(ckSCSL->GetFile()->GetFileOffsetSize())
5151                   );
5152                 ckSCSL->WriteUint32(&fileOffset);                 ckSCSL->WriteUint32(&fileOffset);
5153                 // jump over flags entry (containing the bypass flag)                 // jump over flags entry (containing the bypass flag)
5154                 ckSCSL->SetPos(sizeof(uint32_t), RIFF::stream_curpos);                 ckSCSL->SetPos(sizeof(uint32_t), RIFF::stream_curpos);
# Line 4621  namespace { Line 5208  namespace {
5208          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
5209          Region* pNewRegion = new Region(this, rgn);          Region* pNewRegion = new Region(this, rgn);
5210          pRegions->push_back(pNewRegion);          pRegions->push_back(pNewRegion);
5211          Regions = pRegions->size();          Regions = (uint32_t) pRegions->size();
5212          // update Region key table for fast lookup          // update Region key table for fast lookup
5213          UpdateRegionKeyTable();          UpdateRegionKeyTable();
5214          // done          // done
# Line 4673  namespace { Line 5260  namespace {
5260    
5261          // move this instrument within the instrument list          // move this instrument within the instrument list
5262          {          {
5263              DLS::File::InstrumentList& list = *pFile->pInstruments;              File::InstrumentList& list = *pFile->pInstruments;
5264    
5265              DLS::File::InstrumentList::iterator itFrom =              File::InstrumentList::iterator itFrom =
5266                  std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(this));                  std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(this));
5267    
5268              DLS::File::InstrumentList::iterator itTo =              File::InstrumentList::iterator itTo =
5269                  std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(dst));                  std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(dst));
5270    
5271              list.splice(itTo, list, itFrom);              list.splice(itTo, list, itFrom);
# Line 4767  namespace { Line 5354  namespace {
5354                  for (uint s = 0; group->GetScript(s); ++s) {                  for (uint s = 0; group->GetScript(s); ++s) {
5355                      Script* script = group->GetScript(s);                      Script* script = group->GetScript(s);
5356                      if (script->pChunk) {                      if (script->pChunk) {
5357                          uint32_t offset = script->pChunk->GetFilePos() -                          uint32_t offset = uint32_t(
5358                                            script->pChunk->GetPos() -                              script->pChunk->GetFilePos() -
5359                                            CHUNK_HEADER_SIZE;                              script->pChunk->GetPos() -
5360                                CHUNK_HEADER_SIZE(script->pChunk->GetFile()->GetFileOffsetSize())
5361                            );
5362                          if (offset == soughtOffset)                          if (offset == soughtOffset)
5363                          {                          {
5364                              _ScriptPooolRef ref;                              _ScriptPooolRef ref;
# Line 4894  namespace { Line 5483  namespace {
5483       */       */
5484      void Instrument::RemoveScript(Script* pScript) {      void Instrument::RemoveScript(Script* pScript) {
5485          LoadScripts();          LoadScripts();
5486          for (int i = pScriptRefs->size() - 1; i >= 0; --i) {          for (ssize_t i = pScriptRefs->size() - 1; i >= 0; --i) {
5487              if ((*pScriptRefs)[i].script == pScript) {              if ((*pScriptRefs)[i].script == pScript) {
5488                  pScriptRefs->erase( pScriptRefs->begin() + i );                  pScriptRefs->erase( pScriptRefs->begin() + i );
5489              }              }
# Line 4916  namespace { Line 5505  namespace {
5505       * gigedit.       * gigedit.
5506       */       */
5507      uint Instrument::ScriptSlotCount() const {      uint Instrument::ScriptSlotCount() const {
5508          return pScriptRefs ? pScriptRefs->size() : scriptPoolFileOffsets.size();          return uint(pScriptRefs ? pScriptRefs->size() : scriptPoolFileOffsets.size());
5509      }      }
5510    
5511      /** @brief Whether script execution shall be skipped.      /** @brief Whether script execution shall be skipped.
# Line 5024  namespace { Line 5613  namespace {
5613          UpdateRegionKeyTable();          UpdateRegionKeyTable();
5614      }      }
5615    
5616        /**
5617         * Returns @c true in case this Instrument object uses any gig format
5618         * extension, that is e.g. whether any DimensionRegion object currently
5619         * has any setting effective that would require our "LSDE" RIFF chunk to
5620         * be stored to the gig file.
5621         *
5622         * Right now this is a private method. It is considerable though this method
5623         * to become (in slightly modified form) a public API method in future, i.e.
5624         * to allow instrument editors to visualize and/or warn the user of any gig
5625         * format extension being used. See also comments on
5626         * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
5627         * potential public API change in future.
5628         */
5629        bool Instrument::UsesAnyGigFormatExtension() const {
5630            if (!pRegions) return false;
5631            RegionList::const_iterator iter = pRegions->begin();
5632            RegionList::const_iterator end  = pRegions->end();
5633            for (; iter != end; ++iter) {
5634                gig::Region* rgn = static_cast<gig::Region*>(*iter);
5635                if (rgn->UsesAnyGigFormatExtension())
5636                    return true;
5637            }
5638            return false;
5639        }
5640    
5641    
5642  // *************** Group ***************  // *************** Group ***************
5643  // *  // *
# Line 5040  namespace { Line 5654  namespace {
5654          ::LoadString(pNameChunk, Name);          ::LoadString(pNameChunk, Name);
5655      }      }
5656    
5657        /** @brief Destructor.
5658         *
5659         * Currently this destructor implementation does nothing.
5660         */
5661      Group::~Group() {      Group::~Group() {
5662          // remove the chunk associated with this group (if any)      }
5663          if (pNameChunk) pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);  
5664        /** @brief Remove all RIFF chunks associated with this Group object.
5665         *
5666         * See DLS::Storage::DeleteChunks() for details.
5667         */
5668        void Group::DeleteChunks() {
5669            // handle own RIFF chunks
5670            if (pNameChunk) {
5671                pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
5672                pNameChunk = NULL;
5673            }
5674      }      }
5675    
5676      /** @brief Update chunks with current group settings.      /** @brief Update chunks with current group settings.
# Line 5065  namespace { Line 5693  namespace {
5693          RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);          RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
5694          if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);          if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
5695    
5696          if (!pNameChunk && pFile->pVersion && pFile->pVersion->major == 3) {          if (!pNameChunk && pFile->pVersion && pFile->pVersion->major > 2) {
5697              // v3 has a fixed list of 128 strings, find a free one              // v3 has a fixed list of 128 strings, find a free one
5698              for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {              for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {
5699                  if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {                  if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {
# Line 5160  namespace { Line 5788  namespace {
5788          0, 3, 20030331 & 0xffff, 20030331 >> 16          0, 3, 20030331 & 0xffff, 20030331 >> 16
5789      };      };
5790    
5791        /// Reflects Gigasampler file format version 4.0 (2007-10-12).
5792        const DLS::version_t File::VERSION_4 = {
5793            0, 4, 20071012 & 0xffff, 20071012 >> 16
5794        };
5795    
5796      static const DLS::Info::string_length_t _FileFixedStringLengths[] = {      static const DLS::Info::string_length_t _FileFixedStringLengths[] = {
5797          { CHUNK_ID_IARL, 256 },          { CHUNK_ID_IARL, 256 },
5798          { CHUNK_ID_IART, 128 },          { CHUNK_ID_IART, 128 },
# Line 5256  namespace { Line 5889  namespace {
5889          return static_cast<gig::Sample*>( *it );          return static_cast<gig::Sample*>( *it );
5890      }      }
5891    
5892        /**
5893         * Returns the total amount of samples of this gig file.
5894         *
5895         * Note that this method might block for a long time in case it is required
5896         * to load the sample info for the first time.
5897         *
5898         * @returns total amount of samples
5899         */
5900        size_t File::CountSamples() {
5901            if (!pSamples) LoadSamples();
5902            if (!pSamples) return 0;
5903            return pSamples->size();
5904        }
5905    
5906      /** @brief Add a new sample.      /** @brief Add a new sample.
5907       *       *
5908       * 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 5941  namespace {
5941          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");
5942          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
5943          pSamples->erase(iter);          pSamples->erase(iter);
5944            pSample->DeleteChunks();
5945          delete pSample;          delete pSample;
5946    
5947          SampleList::iterator tmp = SamplesIterator;          SampleList::iterator tmp = SamplesIterator;
# Line 5331  namespace { Line 5979  namespace {
5979          int iSampleIndex  = 0;          int iSampleIndex  = 0;
5980          int iTotalSamples = WavePoolCount;          int iTotalSamples = WavePoolCount;
5981    
5982          // check if samples should be loaded from extension files          // just for assembling path of optional extension files to be read
5983          int lastFileNo = 0;          const std::string folder = parentPath(pRIFF->GetFileName());
5984          for (int i = 0 ; i < WavePoolCount ; i++) {          const std::string baseName = pathWithoutExtension(pRIFF->GetFileName());
5985              if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];  
5986          }          // the main gig file and the extension files (.gx01, ... , .gx98) may
5987          String name(pRIFF->GetFileName());          // contain wave data (wave pool)
5988          int nameLen = name.length();          std::vector<RIFF::File*> poolFiles;
5989          char suffix[6];          poolFiles.push_back(pRIFF);
5990          if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;  
5991            // get info about all extension files
5992          for (int fileNo = 0 ; ; ) {          RIFF::Chunk* ckXfil = pRIFF->GetSubChunk(CHUNK_ID_XFIL);
5993            if (ckXfil) { // there are extension files (.gx01, ... , .gx98) ...
5994                const uint32_t n = ckXfil->ReadInt32();
5995                for (int i = 0; i < n; i++) {
5996                    // read the filename and load the extension file
5997                    std::string name;
5998                    ckXfil->ReadString(name, 128);
5999                    std::string path = concatPath(folder, name);
6000                    RIFF::File* pExtFile = new RIFF::File(path);
6001                    // check that the dlsids match
6002                    RIFF::Chunk* ckDLSID = pExtFile->GetSubChunk(CHUNK_ID_DLID);
6003                    if (ckDLSID) {
6004                        ::DLS::dlsid_t idExpected;
6005                        idExpected.ulData1 = ckXfil->ReadInt32();
6006                        idExpected.usData2 = ckXfil->ReadInt16();
6007                        idExpected.usData3 = ckXfil->ReadInt16();
6008                        ckXfil->Read(idExpected.abData, 8, 1);
6009                        ::DLS::dlsid_t idFound;
6010                        ckDLSID->Read(&idFound.ulData1, 1, 4);
6011                        ckDLSID->Read(&idFound.usData2, 1, 2);
6012                        ckDLSID->Read(&idFound.usData3, 1, 2);
6013                        ckDLSID->Read(idFound.abData, 8, 1);
6014                        if (memcmp(&idExpected, &idFound, 16) != 0)
6015                            throw gig::Exception("dlsid mismatch for extension file: %s", path.c_str());
6016                    }
6017                    poolFiles.push_back(pExtFile);
6018                    ExtensionFiles.push_back(pExtFile);
6019                }
6020            }
6021    
6022            // check if a .gx99 (GigaPulse) file exists
6023            RIFF::Chunk* ckDoxf = pRIFF->GetSubChunk(CHUNK_ID_DOXF);
6024            if (ckDoxf) { // there is a .gx99 (GigaPulse) file ...
6025                std::string path = baseName + ".gx99";
6026                RIFF::File* pExtFile = new RIFF::File(path);
6027    
6028                // skip unused int and filename
6029                ckDoxf->SetPos(132, RIFF::stream_curpos);
6030    
6031                // check that the dlsids match
6032                RIFF::Chunk* ckDLSID = pExtFile->GetSubChunk(CHUNK_ID_DLID);
6033                if (ckDLSID) {
6034                    ::DLS::dlsid_t idExpected;
6035                    idExpected.ulData1 = ckDoxf->ReadInt32();
6036                    idExpected.usData2 = ckDoxf->ReadInt16();
6037                    idExpected.usData3 = ckDoxf->ReadInt16();
6038                    ckDoxf->Read(idExpected.abData, 8, 1);
6039                    ::DLS::dlsid_t idFound;
6040                    ckDLSID->Read(&idFound.ulData1, 1, 4);
6041                    ckDLSID->Read(&idFound.usData2, 1, 2);
6042                    ckDLSID->Read(&idFound.usData3, 1, 2);
6043                    ckDLSID->Read(idFound.abData, 8, 1);
6044                    if (memcmp(&idExpected, &idFound, 16) != 0)
6045                        throw gig::Exception("dlsid mismatch for GigaPulse file: %s", path.c_str());
6046                }
6047                poolFiles.push_back(pExtFile);
6048                ExtensionFiles.push_back(pExtFile);
6049            }
6050    
6051            // load samples from extension files (if required)
6052            for (int i = 0; i < poolFiles.size(); i++) {
6053                RIFF::File* file = poolFiles[i];
6054              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
6055              if (wvpl) {              if (wvpl) {
6056                  unsigned long wvplFileOffset = wvpl->GetFilePos();                  file_offset_t wvplFileOffset = wvpl->GetFilePos() -
6057                                                   wvpl->GetPos(); // should be zero, but just to be sure
6058                  RIFF::List* wave = wvpl->GetFirstSubList();                  RIFF::List* wave = wvpl->GetFirstSubList();
6059                  while (wave) {                  while (wave) {
6060                      if (wave->GetListType() == LIST_TYPE_WAVE) {                      if (wave->GetListType() == LIST_TYPE_WAVE) {
6061                          // notify current progress                          // notify current progress
6062                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;                          if (pProgress) {
6063                          __notify_progress(pProgress, subprogress);                              const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
6064                                __notify_progress(pProgress, subprogress);
6065                            }
6066    
6067                          unsigned long waveFileOffset = wave->GetFilePos();                          file_offset_t waveFileOffset = wave->GetFilePos();
6068                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, i, iSampleIndex));
6069    
6070                          iSampleIndex++;                          iSampleIndex++;
6071                      }                      }
6072                      wave = wvpl->GetNextSubList();                      wave = wvpl->GetNextSubList();
6073                  }                  }
6074                }
                 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;  
6075          }          }
6076    
6077          __notify_progress(pProgress, 1.0); // notify done          if (pProgress)
6078                __notify_progress(pProgress, 1.0); // notify done
6079      }      }
6080    
6081      Instrument* File::GetFirstInstrument() {      Instrument* File::GetFirstInstrument() {
# Line 5388  namespace { Line 6092  namespace {
6092      }      }
6093    
6094      /**      /**
6095         * Returns the total amount of instruments of this gig file.
6096         *
6097         * Note that this method might block for a long time in case it is required
6098         * to load the instruments info for the first time.
6099         *
6100         * @returns total amount of instruments
6101         */
6102        size_t File::CountInstruments() {
6103            if (!pInstruments) LoadInstruments();
6104            if (!pInstruments) return 0;
6105            return pInstruments->size();
6106        }
6107    
6108        /**
6109       * Returns the instrument with the given index.       * Returns the instrument with the given index.
6110       *       *
6111       * @param index     - number of the sought instrument (0..n)       * @param index     - number of the sought instrument (0..n)
# Line 5398  namespace { Line 6116  namespace {
6116          if (!pInstruments) {          if (!pInstruments) {
6117              // 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)
6118    
6119              // sample loading subtask              if (pProgress) {
6120              progress_t subprogress;                  // sample loading subtask
6121              __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask                  progress_t subprogress;
6122              __notify_progress(&subprogress, 0.0f);                  __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
6123              if (GetAutoLoad())                  __notify_progress(&subprogress, 0.0f);
6124                  GetFirstSample(&subprogress); // now force all samples to be loaded                  if (GetAutoLoad())
6125              __notify_progress(&subprogress, 1.0f);                      GetFirstSample(&subprogress); // now force all samples to be loaded
6126                    __notify_progress(&subprogress, 1.0f);
6127              // instrument loading subtask  
6128              if (pProgress && pProgress->callback) {                  // instrument loading subtask
6129                  subprogress.__range_min = subprogress.__range_max;                  if (pProgress->callback) {
6130                  subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask                      subprogress.__range_min = subprogress.__range_max;
6131              }                      subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask
6132              __notify_progress(&subprogress, 0.0f);                  }
6133              LoadInstruments(&subprogress);                  __notify_progress(&subprogress, 0.0f);
6134              __notify_progress(&subprogress, 1.0f);                  LoadInstruments(&subprogress);
6135                    __notify_progress(&subprogress, 1.0f);
6136                } else {
6137                    // sample loading subtask
6138                    if (GetAutoLoad())
6139                        GetFirstSample(); // now force all samples to be loaded
6140    
6141                    // instrument loading subtask
6142                    LoadInstruments();
6143                }
6144          }          }
6145          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
6146          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
# Line 5506  namespace { Line 6233  namespace {
6233              mGroups[pFile->GetSample(i)->GetGroup()]->AddSample(s);              mGroups[pFile->GetSample(i)->GetGroup()]->AddSample(s);
6234              mSamples[pFile->GetSample(i)] = s;              mSamples[pFile->GetSample(i)] = s;
6235          }          }
6236            
6237            // clone script groups and their scripts
6238            for (int iGroup = 0; pFile->GetScriptGroup(iGroup); ++iGroup) {
6239                ScriptGroup* sg = pFile->GetScriptGroup(iGroup);
6240                ScriptGroup* dg = AddScriptGroup();
6241                dg->Name = "COPY" + ToString(iCallCount) + "_" + sg->Name;
6242                for (int iScript = 0; sg->GetScript(iScript); ++iScript) {
6243                    Script* ss = sg->GetScript(iScript);
6244                    Script* ds = dg->AddScript();
6245                    ds->CopyAssign(ss);
6246                }
6247            }
6248    
6249          //BUG: For some reason this method only works with this additional          //BUG: For some reason this method only works with this additional
6250          //     Save() call in between here.          //     Save() call in between here.
6251          //          //
# Line 5550  namespace { Line 6289  namespace {
6289          InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);          InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);
6290          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");
6291          pInstruments->erase(iter);          pInstruments->erase(iter);
6292            pInstrument->DeleteChunks();
6293          delete pInstrument;          delete pInstrument;
6294      }      }
6295    
# Line 5565  namespace { Line 6305  namespace {
6305              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();
6306              while (lstInstr) {              while (lstInstr) {
6307                  if (lstInstr->GetListType() == LIST_TYPE_INS) {                  if (lstInstr->GetListType() == LIST_TYPE_INS) {
6308                      // notify current progress                      if (pProgress) {
6309                      const float localProgress = (float) iInstrumentIndex / (float) Instruments;                          // notify current progress
6310                      __notify_progress(pProgress, localProgress);                          const float localProgress = (float) iInstrumentIndex / (float) Instruments;
6311                            __notify_progress(pProgress, localProgress);
                     // divide local progress into subprogress for loading current Instrument  
                     progress_t subprogress;  
                     __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);  
6312    
6313                      pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));                          // divide local progress into subprogress for loading current Instrument
6314                            progress_t subprogress;
6315                            __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
6316    
6317                            pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
6318                        } else {
6319                            pInstruments->push_back(new Instrument(this, lstInstr));
6320                        }
6321    
6322                      iInstrumentIndex++;                      iInstrumentIndex++;
6323                  }                  }
6324                  lstInstr = lstInstruments->GetNextSubList();                  lstInstr = lstInstruments->GetNextSubList();
6325              }              }
6326              __notify_progress(pProgress, 1.0); // notify done              if (pProgress)
6327                    __notify_progress(pProgress, 1.0); // notify done
6328          }          }
6329      }      }
6330    
# Line 5591  namespace { Line 6336  namespace {
6336          if (!_3crc) return;          if (!_3crc) return;
6337    
6338          // get the index of the sample          // get the index of the sample
6339          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;  
             }  
         }  
6340          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");
6341    
6342          // write the CRC-32 checksum to disk          // write the CRC-32 checksum to disk
6343          _3crc->SetPos(iWaveIndex * 8);          _3crc->SetPos(iWaveIndex * 8);
6344          uint32_t tmp = 1;          uint32_t one = 1;
6345          _3crc->WriteUint32(&tmp); // unknown, always 1?          _3crc->WriteUint32(&one); // always 1
6346          _3crc->WriteUint32(&crc);          _3crc->WriteUint32(&crc);
6347      }      }
6348    
6349        uint32_t File::GetSampleChecksum(Sample* pSample) {
6350            // get the index of the sample
6351            int iWaveIndex = GetWaveTableIndexOf(pSample);
6352            if (iWaveIndex < 0) throw gig::Exception("Could not retrieve reference crc of sample, could not resolve sample's wave table index");
6353    
6354            return GetSampleChecksumByIndex(iWaveIndex);
6355        }
6356    
6357        uint32_t File::GetSampleChecksumByIndex(int index) {
6358            if (index < 0) throw gig::Exception("Could not retrieve reference crc of sample, invalid wave pool index of sample");
6359    
6360            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6361            if (!_3crc) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
6362            uint8_t* pData = (uint8_t*) _3crc->LoadChunkData();
6363            if (!pData) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
6364    
6365            // read the CRC-32 checksum directly from disk
6366            size_t pos = index * 8;
6367            if (pos + 8 > _3crc->GetNewSize())
6368                throw gig::Exception("Could not retrieve reference crc of sample, could not seek to required position in crc chunk");
6369    
6370            uint32_t one = load32(&pData[pos]); // always 1
6371            if (one != 1)
6372                throw gig::Exception("Could not retrieve reference crc of sample, because reference checksum table is damaged");
6373    
6374            return load32(&pData[pos+4]);
6375        }
6376    
6377        int File::GetWaveTableIndexOf(gig::Sample* pSample) {
6378            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
6379            File::SampleList::iterator iter = pSamples->begin();
6380            File::SampleList::iterator end  = pSamples->end();
6381            for (int index = 0; iter != end; ++iter, ++index)
6382                if (*iter == pSample)
6383                    return index;
6384            return -1;
6385        }
6386    
6387        /**
6388         * Checks whether the file's "3CRC" chunk was damaged. This chunk contains
6389         * the CRC32 check sums of all samples' raw wave data.
6390         *
6391         * @return true if 3CRC chunk is OK, or false if 3CRC chunk is damaged
6392         */
6393        bool File::VerifySampleChecksumTable() {
6394            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6395            if (!_3crc) return false;
6396            if (_3crc->GetNewSize() <= 0) return false;
6397            if (_3crc->GetNewSize() % 8) return false;
6398            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
6399            if (_3crc->GetNewSize() != pSamples->size() * 8) return false;
6400    
6401            const file_offset_t n = _3crc->GetNewSize() / 8;
6402    
6403            uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6404            if (!pData) return false;
6405    
6406            for (file_offset_t i = 0; i < n; ++i) {
6407                uint32_t one = pData[i*2];
6408                if (one != 1) return false;
6409            }
6410    
6411            return true;
6412        }
6413    
6414        /**
6415         * Recalculates CRC32 checksums for all samples and rebuilds this gig
6416         * file's checksum table with those new checksums. This might usually
6417         * just be necessary if the checksum table was damaged.
6418         *
6419         * @e IMPORTANT: The current implementation of this method only works
6420         * with files that have not been modified since it was loaded, because
6421         * it expects that no externally caused file structure changes are
6422         * required!
6423         *
6424         * Due to the expectation above, this method is currently protected
6425         * and actually only used by the command line tool "gigdump" yet.
6426         *
6427         * @returns true if Save() is required to be called after this call,
6428         *          false if no further action is required
6429         */
6430        bool File::RebuildSampleChecksumTable() {
6431            // make sure sample chunks were scanned
6432            if (!pSamples) GetFirstSample();
6433    
6434            bool bRequiresSave = false;
6435    
6436            // make sure "3CRC" chunk exists with required size
6437            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6438            if (!_3crc) {
6439                _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
6440                // the order of einf and 3crc is not the same in v2 and v3
6441                RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
6442                if (einf && pVersion && pVersion->major > 2) pRIFF->MoveSubChunk(_3crc, einf);
6443                bRequiresSave = true;
6444            } else if (_3crc->GetNewSize() != pSamples->size() * 8) {
6445                _3crc->Resize(pSamples->size() * 8);
6446                bRequiresSave = true;
6447            }
6448    
6449            if (bRequiresSave) { // refill CRC table for all samples in RAM ...
6450                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6451                {
6452                    File::SampleList::iterator iter = pSamples->begin();
6453                    File::SampleList::iterator end  = pSamples->end();
6454                    for (; iter != end; ++iter) {
6455                        gig::Sample* pSample = (gig::Sample*) *iter;
6456                        int index = GetWaveTableIndexOf(pSample);
6457                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6458                        pData[index*2]   = 1; // always 1
6459                        pData[index*2+1] = pSample->CalculateWaveDataChecksum();
6460                    }
6461                }
6462            } else { // no file structure changes necessary, so directly write to disk and we are done ...
6463                // make sure file is in write mode
6464                pRIFF->SetMode(RIFF::stream_mode_read_write);
6465                {
6466                    File::SampleList::iterator iter = pSamples->begin();
6467                    File::SampleList::iterator end  = pSamples->end();
6468                    for (; iter != end; ++iter) {
6469                        gig::Sample* pSample = (gig::Sample*) *iter;
6470                        int index = GetWaveTableIndexOf(pSample);
6471                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6472                        pSample->crc  = pSample->CalculateWaveDataChecksum();
6473                        SetSampleChecksum(pSample, pSample->crc);
6474                    }
6475                }
6476            }
6477    
6478            return bRequiresSave;
6479        }
6480    
6481      Group* File::GetFirstGroup() {      Group* File::GetFirstGroup() {
6482          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6483          // there must always be at least one group          // there must always be at least one group
# Line 5685  namespace { Line 6554  namespace {
6554          }          }
6555          // now delete this group object          // now delete this group object
6556          pGroups->erase(iter);          pGroups->erase(iter);
6557            pGroup->DeleteChunks();
6558          delete pGroup;          delete pGroup;
6559      }      }
6560    
# Line 5706  namespace { Line 6576  namespace {
6576          // move all members of this group to another group          // move all members of this group to another group
6577          pGroup->MoveAll();          pGroup->MoveAll();
6578          pGroups->erase(iter);          pGroups->erase(iter);
6579            pGroup->DeleteChunks();
6580          delete pGroup;          delete pGroup;
6581      }      }
6582    
# Line 5719  namespace { Line 6590  namespace {
6590                  RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();                  RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();
6591                  while (ck) {                  while (ck) {
6592                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {
6593                          if (pVersion && pVersion->major == 3 &&                          if (pVersion && pVersion->major > 2 &&
6594                              strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;                              strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;
6595    
6596                          pGroups->push_back(new Group(this, ck));                          pGroups->push_back(new Group(this, ck));
# Line 5805  namespace { Line 6676  namespace {
6676              pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));              pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));
6677          if (pScriptGroup->pList)          if (pScriptGroup->pList)
6678              pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);              pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);
6679            pScriptGroup->DeleteChunks();
6680          delete pScriptGroup;          delete pScriptGroup;
6681      }      }
6682    
# Line 5837  namespace { Line 6709  namespace {
6709      void File::UpdateChunks(progress_t* pProgress) {      void File::UpdateChunks(progress_t* pProgress) {
6710          bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;          bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;
6711    
         b64BitWavePoolOffsets = pVersion && pVersion->major == 3;  
   
6712          // update own gig format extension chunks          // update own gig format extension chunks
6713          // (not part of the GigaStudio 4 format)          // (not part of the GigaStudio 4 format)
6714          //          RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);
6715            if (!lst3LS) {
6716                lst3LS = pRIFF->AddSubList(LIST_TYPE_3LS);
6717            }
6718            // Make sure <3LS > chunk is placed before <ptbl> chunk. The precise
6719            // location of <3LS > is irrelevant, however it should be located
6720            // before  the actual wave data
6721            RIFF::Chunk* ckPTBL = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
6722            pRIFF->MoveSubChunk(lst3LS, ckPTBL);
6723    
6724          // This must be performed before writing the chunks for instruments,          // This must be performed before writing the chunks for instruments,
6725          // because the instruments' script slots will write the file offsets          // because the instruments' script slots will write the file offsets
6726          // of the respective instrument script chunk as reference.          // of the respective instrument script chunk as reference.
6727          if (pScriptGroups) {          if (pScriptGroups) {
6728              RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);              // Update instrument script (group) chunks.
6729              if (pScriptGroups->empty()) {              for (std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
6730                  if (lst3LS) pRIFF->DeleteSubChunk(lst3LS);                   it != pScriptGroups->end(); ++it)
6731              } else {              {
6732                  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);  
                 }  
6733              }              }
6734          }          }
6735    
6736            // in case no libgig custom format data was added, then remove the
6737            // custom "3LS " chunk again
6738            if (!lst3LS->CountSubChunks()) {
6739                pRIFF->DeleteSubChunk(lst3LS);
6740                lst3LS = NULL;
6741            }
6742    
6743          // first update base class's chunks          // first update base class's chunks
6744          DLS::File::UpdateChunks(pProgress);          DLS::File::UpdateChunks(pProgress);
6745    
# Line 5889  namespace { Line 6767  namespace {
6767    
6768              // v3: make sure the file has 128 3gnm chunks              // v3: make sure the file has 128 3gnm chunks
6769              // (before updating the Group chunks)              // (before updating the Group chunks)
6770              if (pVersion && pVersion->major == 3) {              if (pVersion && pVersion->major > 2) {
6771                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
6772                  for (int i = 0 ; i < 128 ; i++) {                  for (int i = 0 ; i < 128 ; i++) {
6773                      if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);                      // create 128 empty placeholder strings which will either
6774                        // be filled by Group::UpdateChunks below or left empty.
6775                        ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
6776                      if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();                      if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();
6777                  }                  }
6778              }              }
# Line 5920  namespace { Line 6800  namespace {
6800          // Note that there are several fields with unknown use. These          // Note that there are several fields with unknown use. These
6801          // are set to zero.          // are set to zero.
6802    
6803          int sublen = pSamples->size() / 8 + 49;          int sublen = int(pSamples->size() / 8 + 49);
6804          int einfSize = (Instruments + 1) * sublen;          int einfSize = (Instruments + 1) * sublen;
6805    
6806          RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);          RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
# Line 5993  namespace { Line 6873  namespace {
6873                  store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);                  store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);
6874                  // next 8 bytes unknown                  // next 8 bytes unknown
6875                  store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);                  store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);
6876                  store32(&pData[(instrumentIdx + 1) * sublen + 40], pSamples->size());                  store32(&pData[(instrumentIdx + 1) * sublen + 40], (uint32_t) pSamples->size());
6877                  // next 4 bytes unknown                  // next 4 bytes unknown
6878    
6879                  totnbregions += instrument->Regions;                  totnbregions += instrument->Regions;
# Line 6011  namespace { Line 6891  namespace {
6891              store32(&pData[24], totnbloops);              store32(&pData[24], totnbloops);
6892              // next 8 bytes unknown              // next 8 bytes unknown
6893              // next 4 bytes unknown, not always 0              // next 4 bytes unknown, not always 0
6894              store32(&pData[40], pSamples->size());              store32(&pData[40], (uint32_t) pSamples->size());
6895              // next 4 bytes unknown              // next 4 bytes unknown
6896          }          }
6897    
6898          // update 3crc chunk          // update 3crc chunk
6899    
6900          // The 3crc chunk contains CRC-32 checksums for the          // The 3crc chunk contains CRC-32 checksums for the
6901          // samples. The actual checksum values will be filled in          // samples. When saving a gig file to disk, we first update the 3CRC
6902          // later, by Sample::Write.          // chunk here (in RAM) with the old crc values which we read from the
6903            // 3CRC chunk when we opened the file (available with gig::Sample::crc
6904            // member variable). This step is required, because samples might have
6905            // been deleted by the user since the file was opened, which in turn
6906            // changes the order of the (i.e. old) checksums within the 3crc chunk.
6907            // If a sample was conciously modified by the user (that is if
6908            // Sample::Write() was called later on) then Sample::Write() will just
6909            // update the respective individual checksum(s) directly on disk and
6910            // leaves all other sample checksums untouched.
6911    
6912          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6913          if (_3crc) {          if (_3crc) {
6914              _3crc->Resize(pSamples->size() * 8);              _3crc->Resize(pSamples->size() * 8);
6915          } else if (newFile) {          } else /*if (newFile)*/ {
6916              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
             _3crc->LoadChunkData();  
   
6917              // 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
6918              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);              if (einf && pVersion && pVersion->major > 2) pRIFF->MoveSubChunk(_3crc, einf);
6919            }
6920            { // must be performed in RAM here ...
6921                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6922                if (pData) {
6923                    File::SampleList::iterator iter = pSamples->begin();
6924                    File::SampleList::iterator end  = pSamples->end();
6925                    for (int index = 0; iter != end; ++iter, ++index) {
6926                        gig::Sample* pSample = (gig::Sample*) *iter;
6927                        pData[index*2]   = 1; // always 1
6928                        pData[index*2+1] = pSample->crc;
6929                    }
6930                }
6931          }          }
6932      }      }
6933            
# Line 6044  namespace { Line 6942  namespace {
6942      }      }
6943    
6944      /**      /**
6945       * Enable / disable automatic loading. By default this properyt is       * Enable / disable automatic loading. By default this property is
6946       * enabled and all informations are loaded automatically. However       * enabled and every information is loaded automatically. However
6947       * loading all Regions, DimensionRegions and especially samples might       * loading all Regions, DimensionRegions and especially samples might
6948       * 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
6949       * be interested in retrieving very superficial informations like the       * be interested in retrieving very superficial informations like the
# Line 6053  namespace { Line 6951  namespace {
6951       * automatic loading to avoid very slow response times.       * automatic loading to avoid very slow response times.
6952       *       *
6953       * @e CAUTION: by disabling this property many pointers (i.e. sample       * @e CAUTION: by disabling this property many pointers (i.e. sample
6954       * references) and informations will have invalid or even undefined       * references) and attributes will have invalid or even undefined
6955       * data! This feature is currently only intended for retrieving very       * data! This feature is currently only intended for retrieving very
6956       * 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
6957       * details like synthesis informations or even to modify .gig files!       * details like synthesis information or even to modify .gig files!
6958       */       */
6959      void File::SetAutoLoad(bool b) {      void File::SetAutoLoad(bool b) {
6960          bAutoLoad = b;          bAutoLoad = b;
# Line 6070  namespace { Line 6968  namespace {
6968          return bAutoLoad;          return bAutoLoad;
6969      }      }
6970    
6971        /**
6972         * Returns @c true in case this gig File object uses any gig format
6973         * extension, that is e.g. whether any DimensionRegion object currently
6974         * has any setting effective that would require our "LSDE" RIFF chunk to
6975         * be stored to the gig file.
6976         *
6977         * Right now this is a private method. It is considerable though this method
6978         * to become (in slightly modified form) a public API method in future, i.e.
6979         * to allow instrument editors to visualize and/or warn the user of any gig
6980         * format extension being used. See also comments on
6981         * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
6982         * potential public API change in future.
6983         */
6984        bool File::UsesAnyGigFormatExtension() const {
6985            if (!pInstruments) return false;
6986            InstrumentList::iterator iter = pInstruments->begin();
6987            InstrumentList::iterator end  = pInstruments->end();
6988            for (; iter != end; ++iter) {
6989                Instrument* pInstrument = static_cast<gig::Instrument*>(*iter);
6990                if (pInstrument->UsesAnyGigFormatExtension())
6991                    return true;
6992            }
6993            return false;
6994        }
6995    
6996    
6997  // *************** Exception ***************  // *************** Exception ***************
6998  // *  // *
6999    
7000      Exception::Exception(String Message) : DLS::Exception(Message) {      Exception::Exception() : DLS::Exception() {
7001        }
7002    
7003        Exception::Exception(String format, ...) : DLS::Exception() {
7004            va_list arg;
7005            va_start(arg, format);
7006            Message = assemble(format, arg);
7007            va_end(arg);
7008        }
7009    
7010        Exception::Exception(String format, va_list arg) : DLS::Exception() {
7011            Message = assemble(format, arg);
7012      }      }
7013    
7014      void Exception::PrintMessage() {      void Exception::PrintMessage() {

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

  ViewVC Help
Powered by ViewVC