/[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 2394 by schoenebeck, Mon Jan 7 23:23:58 2013 UTC revision 3478 by schoenebeck, Thu Feb 21 20:10:08 2019 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file access library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2013 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2019 by Christian Schoenebeck                      *
6   *                              <cuse@users.sourceforge.net>               *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   This library is free software; you can redistribute it and/or modify  *
# Line 24  Line 24 
24  #include "gig.h"  #include "gig.h"
25    
26  #include "helper.h"  #include "helper.h"
27    #include "Serialization.h"
28    
29  #include <algorithm>  #include <algorithm>
30  #include <math.h>  #include <math.h>
31  #include <iostream>  #include <iostream>
32    #include <assert.h>
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
# Line 50  Line 56 
56  #define GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(x)    ((x & 0x03) << 3)  #define GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(x)    ((x & 0x03) << 3)
57  #define GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(x)  ((x & 0x03) << 5)  #define GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(x)  ((x & 0x03) << 5)
58    
59  namespace gig {  #define SRLZ(member) \
60        archive->serializeMember(*this, member, #member);
 // *************** progress_t ***************  
 // *  
   
     progress_t::progress_t() {  
         callback    = NULL;  
         custom      = NULL;  
         __range_min = 0.0f;  
         __range_max = 1.0f;  
     }  
   
     // private helper function to convert progress of a subprocess into the global progress  
     static void __notify_progress(progress_t* pProgress, float subprogress) {  
         if (pProgress && pProgress->callback) {  
             const float totalrange    = pProgress->__range_max - pProgress->__range_min;  
             const float totalprogress = pProgress->__range_min + subprogress * totalrange;  
             pProgress->factor         = totalprogress;  
             pProgress->callback(pProgress); // now actually notify about the progress  
         }  
     }  
   
     // private helper function to divide a progress into subprogresses  
     static void __divide_progress(progress_t* pParentProgress, progress_t* pSubProgress, float totalTasks, float currentTask) {  
         if (pParentProgress && pParentProgress->callback) {  
             const float totalrange    = pParentProgress->__range_max - pParentProgress->__range_min;  
             pSubProgress->callback    = pParentProgress->callback;  
             pSubProgress->custom      = pParentProgress->custom;  
             pSubProgress->__range_min = pParentProgress->__range_min + totalrange * currentTask / totalTasks;  
             pSubProgress->__range_max = pSubProgress->__range_min + totalrange / totalTasks;  
         }  
     }  
61    
62    namespace gig {
63    
64  // *************** Internal functions for sample decompression ***************  // *************** Internal functions for sample decompression ***************
65  // *  // *
# Line 122  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 159  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 296  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 313  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 342  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 365  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 376  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 388  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 434  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 454  namespace { Line 493  namespace {
493      }      }
494    
495      /**      /**
496         * Make a (semi) deep copy of the Sample object given by @a orig (without
497         * the actual waveform data) and assign it to this object.
498         *
499         * Discussion: copying .gig samples is a bit tricky. It requires three
500         * steps:
501         * 1. Copy sample's meta informations (done by CopyAssignMeta()) including
502         *    its new sample waveform data size.
503         * 2. Saving the file (done by File::Save()) so that it gains correct size
504         *    and layout for writing the actual wave form data directly to disc
505         *    in next step.
506         * 3. Copy the waveform data with disk streaming (done by CopyAssignWave()).
507         *
508         * @param orig - original Sample object to be copied from
509         */
510        void Sample::CopyAssignMeta(const Sample* orig) {
511            // handle base classes
512            DLS::Sample::CopyAssignCore(orig);
513            
514            // handle actual own attributes of this class
515            Manufacturer = orig->Manufacturer;
516            Product = orig->Product;
517            SamplePeriod = orig->SamplePeriod;
518            MIDIUnityNote = orig->MIDIUnityNote;
519            FineTune = orig->FineTune;
520            SMPTEFormat = orig->SMPTEFormat;
521            SMPTEOffset = orig->SMPTEOffset;
522            Loops = orig->Loops;
523            LoopID = orig->LoopID;
524            LoopType = orig->LoopType;
525            LoopStart = orig->LoopStart;
526            LoopEnd = orig->LoopEnd;
527            LoopSize = orig->LoopSize;
528            LoopFraction = orig->LoopFraction;
529            LoopPlayCount = orig->LoopPlayCount;
530            
531            // schedule resizing this sample to the given sample's size
532            Resize(orig->GetSize());
533        }
534    
535        /**
536         * Should be called after CopyAssignMeta() and File::Save() sequence.
537         * Read more about it in the discussion of CopyAssignMeta(). This method
538         * copies the actual waveform data by disk streaming.
539         *
540         * @e CAUTION: this method is currently not thread safe! During this
541         * operation the sample must not be used for other purposes by other
542         * threads!
543         *
544         * @param orig - original Sample object to be copied from
545         */
546        void Sample::CopyAssignWave(const Sample* orig) {
547            const int iReadAtOnce = 32*1024;
548            char* buf = new char[iReadAtOnce * orig->FrameSize];
549            Sample* pOrig = (Sample*) orig; //HACK: remove constness for now
550            file_offset_t restorePos = pOrig->GetPos();
551            pOrig->SetPos(0);
552            SetPos(0);
553            for (file_offset_t n = pOrig->Read(buf, iReadAtOnce); n;
554                               n = pOrig->Read(buf, iReadAtOnce))
555            {
556                Write(buf, n);
557            }
558            pOrig->SetPos(restorePos);
559            delete [] buf;
560        }
561    
562        /**
563       * Apply sample and its settings to the respective RIFF chunks. You have       * Apply sample and its settings to the respective RIFF chunks. You have
564       * to call File::Save() to make changes persistent.       * to call File::Save() to make changes persistent.
565       *       *
566       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
567       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
568       *       *
569         * @param pProgress - callback function for progress notification
570       * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data       * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data
571       *                        was provided yet       *                        was provided yet
572       * @throws gig::Exception if there is any invalid sample setting       * @throws gig::Exception if there is any invalid sample setting
573       */       */
574      void Sample::UpdateChunks() {      void Sample::UpdateChunks(progress_t* pProgress) {
575          // first update base class's chunks          // first update base class's chunks
576          DLS::Sample::UpdateChunks();          DLS::Sample::UpdateChunks(pProgress);
577    
578          // make sure 'smpl' chunk exists          // make sure 'smpl' chunk exists
579          pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);          pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);
# Line 514  namespace { Line 621  namespace {
621          // update '3gix' chunk          // update '3gix' chunk
622          pData = (uint8_t*) pCk3gix->LoadChunkData();          pData = (uint8_t*) pCk3gix->LoadChunkData();
623          store16(&pData[0], iSampleGroup);          store16(&pData[0], iSampleGroup);
624    
625            // if the library user toggled the "Compressed" attribute from true to
626            // false, then the EWAV chunk associated with compressed samples needs
627            // to be deleted
628            RIFF::Chunk* ewav = pWaveList->GetSubChunk(CHUNK_ID_EWAV);
629            if (ewav && !Compressed) {
630                pWaveList->DeleteSubChunk(ewav);
631            }
632      }      }
633    
634      /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).      /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).
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 536  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 555  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 571  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 614  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 673  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 740  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 774  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 792  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 808  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() {      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 847  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 887  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 938  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 1022  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 1037  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 1060  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 1211  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 1220  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 1232  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 1254  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 1292  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 1308  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 1324  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 1433  namespace { Line 1617  namespace {
1617                                                          : vcf_res_ctrl_none;                                                          : vcf_res_ctrl_none;
1618              uint16_t eg3depth = _3ewa->ReadUint16();              uint16_t eg3depth = _3ewa->ReadUint16();
1619              EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */              EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */
1620                                          : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */                                          : (-1) * (int16_t) ((eg3depth ^ 0xfff) + 1); /* binary complementary for negatives */
1621              _3ewa->ReadInt16(); // unknown              _3ewa->ReadInt16(); // unknown
1622              ChannelOffset = _3ewa->ReadUint8() / 4;              ChannelOffset = _3ewa->ReadUint8() / 4;
1623              uint8_t regoptions = _3ewa->ReadUint8();              uint8_t regoptions = _3ewa->ReadUint8();
# Line 1502  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 1556  namespace { Line 1740  namespace {
1740              VCFType                         = vcf_type_lowpass;              VCFType                         = vcf_type_lowpass;
1741              memset(DimensionUpperLimits, 127, 8);              memset(DimensionUpperLimits, 127, 8);
1742          }          }
1743            // chunk for own format extensions, these will *NOT* work with Gigasampler/GigaStudio !
1744            RIFF::Chunk* lsde = _3ewl->GetSubChunk(CHUNK_ID_LSDE);
1745            if (lsde) { // format extension for EG behavior options
1746                lsde->SetPos(0);
1747    
1748                eg_opt_t* pEGOpts[2] = { &EG1Options, &EG2Options };
1749                for (int i = 0; i < 2; ++i) { // NOTE: we reserved a 3rd byte for a potential future EG3 option
1750                    unsigned char byte = lsde->ReadUint8();
1751                    pEGOpts[i]->AttackCancel     = byte & 1;
1752                    pEGOpts[i]->AttackHoldCancel = byte & (1 << 1);
1753                    pEGOpts[i]->Decay1Cancel     = byte & (1 << 2);
1754                    pEGOpts[i]->Decay2Cancel     = byte & (1 << 3);
1755                    pEGOpts[i]->ReleaseCancel    = byte & (1 << 4);
1756                }
1757            }
1758            // format extension for sustain pedal up effect on release trigger samples
1759            if (lsde && lsde->GetSize() > 3) { // NOTE: we reserved the 3rd byte for a potential future EG3 option
1760                lsde->SetPos(3);
1761                uint8_t byte = lsde->ReadUint8();
1762                SustainReleaseTrigger   = static_cast<sust_rel_trg_t>(byte & 0x03);
1763                NoNoteOffReleaseTrigger = byte >> 7;
1764            } else {
1765                SustainReleaseTrigger   = sust_rel_trg_none;
1766                NoNoteOffReleaseTrigger = false;
1767            }
1768    
1769          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
1770                                                       VelocityResponseDepth,                                                       VelocityResponseDepth,
# Line 1608  namespace { Line 1817  namespace {
1817       * @param orig - original DimensionRegion object to be copied from       * @param orig - original DimensionRegion object to be copied from
1818       */       */
1819      void DimensionRegion::CopyAssign(const DimensionRegion* orig) {      void DimensionRegion::CopyAssign(const DimensionRegion* orig) {
1820            CopyAssign(orig, NULL);
1821        }
1822    
1823        /**
1824         * Make a (semi) deep copy of the DimensionRegion object given by @a orig
1825         * and assign it to this object.
1826         *
1827         * @param orig - original DimensionRegion object to be copied from
1828         * @param mSamples - crosslink map between the foreign file's samples and
1829         *                   this file's samples
1830         */
1831        void DimensionRegion::CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples) {
1832          // delete all allocated data first          // delete all allocated data first
1833          if (VelocityTable) delete [] VelocityTable;          if (VelocityTable) delete [] VelocityTable;
1834          if (pSampleLoops) delete [] pSampleLoops;          if (pSampleLoops) delete [] pSampleLoops;
# Line 1615  namespace { Line 1836  namespace {
1836          // backup parent list pointer          // backup parent list pointer
1837          RIFF::List* p = pParentList;          RIFF::List* p = pParentList;
1838                    
1839            gig::Sample* pOriginalSample = pSample;
1840            gig::Region* pOriginalRegion = pRegion;
1841            
1842          //NOTE: copy code copied from assignment constructor above, see comment there as well          //NOTE: copy code copied from assignment constructor above, see comment there as well
1843                    
1844          *this = *orig; // default memberwise shallow copy of all parameters          *this = *orig; // default memberwise shallow copy of all parameters
1845            
1846            // restore members that shall not be altered
1847          pParentList = p; // restore the chunk pointer          pParentList = p; // restore the chunk pointer
1848            pRegion = pOriginalRegion;
1849            
1850            // only take the raw sample reference reference if the
1851            // two DimensionRegion objects are part of the same file
1852            if (pOriginalRegion->GetParent()->GetParent() != orig->pRegion->GetParent()->GetParent()) {
1853                pSample = pOriginalSample;
1854            }
1855            
1856            if (mSamples && mSamples->count(orig->pSample)) {
1857                pSample = mSamples->find(orig->pSample)->second;
1858            }
1859    
1860          // deep copy of owned structures          // deep copy of owned structures
1861          if (orig->VelocityTable) {          if (orig->VelocityTable) {
# Line 1633  namespace { Line 1870  namespace {
1870          }          }
1871      }      }
1872    
1873        void DimensionRegion::serialize(Serialization::Archive* archive) {
1874            // in case this class will become backward incompatible one day,
1875            // then set a version and minimum version for this class like:
1876            //archive->setVersion(*this, 2);
1877            //archive->setMinVersion(*this, 1);
1878    
1879            SRLZ(VelocityUpperLimit);
1880            SRLZ(EG1PreAttack);
1881            SRLZ(EG1Attack);
1882            SRLZ(EG1Decay1);
1883            SRLZ(EG1Decay2);
1884            SRLZ(EG1InfiniteSustain);
1885            SRLZ(EG1Sustain);
1886            SRLZ(EG1Release);
1887            SRLZ(EG1Hold);
1888            SRLZ(EG1Controller);
1889            SRLZ(EG1ControllerInvert);
1890            SRLZ(EG1ControllerAttackInfluence);
1891            SRLZ(EG1ControllerDecayInfluence);
1892            SRLZ(EG1ControllerReleaseInfluence);
1893            SRLZ(LFO1Frequency);
1894            SRLZ(LFO1InternalDepth);
1895            SRLZ(LFO1ControlDepth);
1896            SRLZ(LFO1Controller);
1897            SRLZ(LFO1FlipPhase);
1898            SRLZ(LFO1Sync);
1899            SRLZ(EG2PreAttack);
1900            SRLZ(EG2Attack);
1901            SRLZ(EG2Decay1);
1902            SRLZ(EG2Decay2);
1903            SRLZ(EG2InfiniteSustain);
1904            SRLZ(EG2Sustain);
1905            SRLZ(EG2Release);
1906            SRLZ(EG2Controller);
1907            SRLZ(EG2ControllerInvert);
1908            SRLZ(EG2ControllerAttackInfluence);
1909            SRLZ(EG2ControllerDecayInfluence);
1910            SRLZ(EG2ControllerReleaseInfluence);
1911            SRLZ(LFO2Frequency);
1912            SRLZ(LFO2InternalDepth);
1913            SRLZ(LFO2ControlDepth);
1914            SRLZ(LFO2Controller);
1915            SRLZ(LFO2FlipPhase);
1916            SRLZ(LFO2Sync);
1917            SRLZ(EG3Attack);
1918            SRLZ(EG3Depth);
1919            SRLZ(LFO3Frequency);
1920            SRLZ(LFO3InternalDepth);
1921            SRLZ(LFO3ControlDepth);
1922            SRLZ(LFO3Controller);
1923            SRLZ(LFO3Sync);
1924            SRLZ(VCFEnabled);
1925            SRLZ(VCFType);
1926            SRLZ(VCFCutoffController);
1927            SRLZ(VCFCutoffControllerInvert);
1928            SRLZ(VCFCutoff);
1929            SRLZ(VCFVelocityCurve);
1930            SRLZ(VCFVelocityScale);
1931            SRLZ(VCFVelocityDynamicRange);
1932            SRLZ(VCFResonance);
1933            SRLZ(VCFResonanceDynamic);
1934            SRLZ(VCFResonanceController);
1935            SRLZ(VCFKeyboardTracking);
1936            SRLZ(VCFKeyboardTrackingBreakpoint);
1937            SRLZ(VelocityResponseCurve);
1938            SRLZ(VelocityResponseDepth);
1939            SRLZ(VelocityResponseCurveScaling);
1940            SRLZ(ReleaseVelocityResponseCurve);
1941            SRLZ(ReleaseVelocityResponseDepth);
1942            SRLZ(ReleaseTriggerDecay);
1943            SRLZ(Crossfade);
1944            SRLZ(PitchTrack);
1945            SRLZ(DimensionBypass);
1946            SRLZ(Pan);
1947            SRLZ(SelfMask);
1948            SRLZ(AttenuationController);
1949            SRLZ(InvertAttenuationController);
1950            SRLZ(AttenuationControllerThreshold);
1951            SRLZ(ChannelOffset);
1952            SRLZ(SustainDefeat);
1953            SRLZ(MSDecode);
1954            //SRLZ(SampleStartOffset);
1955            SRLZ(SampleAttenuation);
1956            SRLZ(EG1Options);
1957            SRLZ(EG2Options);
1958            SRLZ(SustainReleaseTrigger);
1959            SRLZ(NoNoteOffReleaseTrigger);
1960    
1961            // derived attributes from DLS::Sampler
1962            SRLZ(FineTune);
1963            SRLZ(Gain);
1964        }
1965    
1966      /**      /**
1967       * Updates the respective member variable and updates @c SampleAttenuation       * Updates the respective member variable and updates @c SampleAttenuation
1968       * which depends on this value.       * which depends on this value.
# Line 1648  namespace { Line 1978  namespace {
1978       *       *
1979       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
1980       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
1981         *
1982         * @param pProgress - callback function for progress notification
1983       */       */
1984      void DimensionRegion::UpdateChunks() {      void DimensionRegion::UpdateChunks(progress_t* pProgress) {
1985          // first update base class's chunk          // first update base class's chunk
1986          DLS::Sampler::UpdateChunks();          DLS::Sampler::UpdateChunks(pProgress);
1987    
1988          RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);          RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);
1989          uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();          uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();
# Line 1664  namespace { Line 1996  namespace {
1996          RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);
1997          if (!_3ewa) {          if (!_3ewa) {
1998              File* pFile = (File*) GetParent()->GetParent()->GetParent();              File* pFile = (File*) GetParent()->GetParent()->GetParent();
1999              bool version3 = pFile->pVersion && pFile->pVersion->major == 3;              bool versiongt2 = pFile->pVersion && pFile->pVersion->major > 2;
2000              _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, version3 ? 148 : 140);              _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, versiongt2 ? 148 : 140);
2001          }          }
2002          pData = (uint8_t*) _3ewa->LoadChunkData();          pData = (uint8_t*) _3ewa->LoadChunkData();
2003    
2004          // update '3ewa' chunk with DimensionRegion's current settings          // update '3ewa' chunk with DimensionRegion's current settings
2005    
2006          const uint32_t chunksize = _3ewa->GetNewSize();          const uint32_t chunksize = (uint32_t) _3ewa->GetNewSize();
2007          store32(&pData[0], chunksize); // unknown, always chunk size?          store32(&pData[0], chunksize); // unknown, always chunk size?
2008    
2009          const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);          const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);
# Line 1873  namespace { Line 2205  namespace {
2205          }          }
2206    
2207          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
2208                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xfff); /* binary complementary for negatives */
2209          store16(&pData[116], eg3depth);          store16(&pData[116], eg3depth);
2210    
2211          // next 2 bytes unknown          // next 2 bytes unknown
# Line 1931  namespace { Line 2263  namespace {
2263          if (chunksize >= 148) {          if (chunksize >= 148) {
2264              memcpy(&pData[140], DimensionUpperLimits, 8);              memcpy(&pData[140], DimensionUpperLimits, 8);
2265          }          }
2266    
2267            // chunk for own format extensions, these will *NOT* work with
2268            // Gigasampler/GigaStudio !
2269            RIFF::Chunk* lsde = pParentList->GetSubChunk(CHUNK_ID_LSDE);
2270            const int lsdeSize = 4; // NOTE: we reserved the 3rd byte for a potential future EG3 option
2271            if (!lsde) {
2272                // only add this "LSDE" chunk if either EG options or release
2273                // trigger options deviate from their default behaviour
2274                eg_opt_t defaultOpt;
2275                if (memcmp(&EG1Options, &defaultOpt, sizeof(eg_opt_t)) ||
2276                    memcmp(&EG2Options, &defaultOpt, sizeof(eg_opt_t)) ||
2277                    SustainReleaseTrigger || NoNoteOffReleaseTrigger)
2278                {
2279                    lsde = pParentList->AddSubChunk(CHUNK_ID_LSDE, lsdeSize);
2280                    // move LSDE chunk to the end of parent list
2281                    pParentList->MoveSubChunk(lsde, (RIFF::Chunk*)NULL);
2282                }
2283            }
2284            if (lsde) {
2285                if (lsde->GetNewSize() < lsdeSize)
2286                    lsde->Resize(lsdeSize);
2287                // format extension for EG behavior options
2288                unsigned char* pData = (unsigned char*) lsde->LoadChunkData();
2289                eg_opt_t* pEGOpts[2] = { &EG1Options, &EG2Options };
2290                for (int i = 0; i < 2; ++i) { // NOTE: we reserved the 3rd byte for a potential future EG3 option
2291                    pData[i] =
2292                        (pEGOpts[i]->AttackCancel     ? 1 : 0) |
2293                        (pEGOpts[i]->AttackHoldCancel ? (1<<1) : 0) |
2294                        (pEGOpts[i]->Decay1Cancel     ? (1<<2) : 0) |
2295                        (pEGOpts[i]->Decay2Cancel     ? (1<<3) : 0) |
2296                        (pEGOpts[i]->ReleaseCancel    ? (1<<4) : 0);
2297                }
2298                // format extension for release trigger options
2299                pData[3] = static_cast<uint8_t>(SustainReleaseTrigger) | (NoNoteOffReleaseTrigger ? (1<<7) : 0);
2300            }
2301      }      }
2302    
2303      double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {      double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {
# Line 1970  namespace { Line 2337  namespace {
2337      // 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
2338      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)
2339      {      {
2340            // sanity check input parameters
2341            // (fallback to some default parameters on ill input)
2342            switch (curveType) {
2343                case curve_type_nonlinear:
2344                case curve_type_linear:
2345                    if (depth > 4) {
2346                        printf("Warning: Invalid depth (0x%x) for velocity curve type (0x%x).\n", depth, curveType);
2347                        depth   = 0;
2348                        scaling = 0;
2349                    }
2350                    break;
2351                case curve_type_special:
2352                    if (depth > 5) {
2353                        printf("Warning: Invalid depth (0x%x) for velocity curve type 'special'.\n", depth);
2354                        depth   = 0;
2355                        scaling = 0;
2356                    }
2357                    break;
2358                case curve_type_unknown:
2359                default:
2360                    printf("Warning: Unknown velocity curve type (0x%x).\n", curveType);
2361                    curveType = curve_type_linear;
2362                    depth     = 0;
2363                    scaling   = 0;
2364                    break;
2365            }
2366    
2367          double* table;          double* table;
2368          uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;          uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;
2369          if (pVelocityTables->count(tableKey)) { // if key exists          if (pVelocityTables->count(tableKey)) { // if key exists
# Line 1986  namespace { Line 2380  namespace {
2380          return pRegion;          return pRegion;
2381      }      }
2382    
2383    // show error if some _lev_ctrl_* enum entry is not listed in the following function
2384    // (commented out for now, because "diagnostic push" not supported prior GCC 4.6)
2385    // TODO: uncomment and add a GCC version check (see also commented "#pragma GCC diagnostic pop" below)
2386    //#pragma GCC diagnostic push
2387    //#pragma GCC diagnostic error "-Wswitch"
2388    
2389      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {
2390          leverage_ctrl_t decodedcontroller;          leverage_ctrl_t decodedcontroller;
2391          switch (EncodedController) {          switch (EncodedController) {
# Line 2097  namespace { Line 2497  namespace {
2497                  decodedcontroller.controller_number = 95;                  decodedcontroller.controller_number = 95;
2498                  break;                  break;
2499    
2500                // format extension (these controllers are so far only supported by
2501                // LinuxSampler & gigedit) they will *NOT* work with
2502                // Gigasampler/GigaStudio !
2503                case _lev_ctrl_CC3_EXT:
2504                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2505                    decodedcontroller.controller_number = 3;
2506                    break;
2507                case _lev_ctrl_CC6_EXT:
2508                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2509                    decodedcontroller.controller_number = 6;
2510                    break;
2511                case _lev_ctrl_CC7_EXT:
2512                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2513                    decodedcontroller.controller_number = 7;
2514                    break;
2515                case _lev_ctrl_CC8_EXT:
2516                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2517                    decodedcontroller.controller_number = 8;
2518                    break;
2519                case _lev_ctrl_CC9_EXT:
2520                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2521                    decodedcontroller.controller_number = 9;
2522                    break;
2523                case _lev_ctrl_CC10_EXT:
2524                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2525                    decodedcontroller.controller_number = 10;
2526                    break;
2527                case _lev_ctrl_CC11_EXT:
2528                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2529                    decodedcontroller.controller_number = 11;
2530                    break;
2531                case _lev_ctrl_CC14_EXT:
2532                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2533                    decodedcontroller.controller_number = 14;
2534                    break;
2535                case _lev_ctrl_CC15_EXT:
2536                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2537                    decodedcontroller.controller_number = 15;
2538                    break;
2539                case _lev_ctrl_CC20_EXT:
2540                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2541                    decodedcontroller.controller_number = 20;
2542                    break;
2543                case _lev_ctrl_CC21_EXT:
2544                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2545                    decodedcontroller.controller_number = 21;
2546                    break;
2547                case _lev_ctrl_CC22_EXT:
2548                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2549                    decodedcontroller.controller_number = 22;
2550                    break;
2551                case _lev_ctrl_CC23_EXT:
2552                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2553                    decodedcontroller.controller_number = 23;
2554                    break;
2555                case _lev_ctrl_CC24_EXT:
2556                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2557                    decodedcontroller.controller_number = 24;
2558                    break;
2559                case _lev_ctrl_CC25_EXT:
2560                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2561                    decodedcontroller.controller_number = 25;
2562                    break;
2563                case _lev_ctrl_CC26_EXT:
2564                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2565                    decodedcontroller.controller_number = 26;
2566                    break;
2567                case _lev_ctrl_CC27_EXT:
2568                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2569                    decodedcontroller.controller_number = 27;
2570                    break;
2571                case _lev_ctrl_CC28_EXT:
2572                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2573                    decodedcontroller.controller_number = 28;
2574                    break;
2575                case _lev_ctrl_CC29_EXT:
2576                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2577                    decodedcontroller.controller_number = 29;
2578                    break;
2579                case _lev_ctrl_CC30_EXT:
2580                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2581                    decodedcontroller.controller_number = 30;
2582                    break;
2583                case _lev_ctrl_CC31_EXT:
2584                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2585                    decodedcontroller.controller_number = 31;
2586                    break;
2587                case _lev_ctrl_CC68_EXT:
2588                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2589                    decodedcontroller.controller_number = 68;
2590                    break;
2591                case _lev_ctrl_CC69_EXT:
2592                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2593                    decodedcontroller.controller_number = 69;
2594                    break;
2595                case _lev_ctrl_CC70_EXT:
2596                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2597                    decodedcontroller.controller_number = 70;
2598                    break;
2599                case _lev_ctrl_CC71_EXT:
2600                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2601                    decodedcontroller.controller_number = 71;
2602                    break;
2603                case _lev_ctrl_CC72_EXT:
2604                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2605                    decodedcontroller.controller_number = 72;
2606                    break;
2607                case _lev_ctrl_CC73_EXT:
2608                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2609                    decodedcontroller.controller_number = 73;
2610                    break;
2611                case _lev_ctrl_CC74_EXT:
2612                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2613                    decodedcontroller.controller_number = 74;
2614                    break;
2615                case _lev_ctrl_CC75_EXT:
2616                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2617                    decodedcontroller.controller_number = 75;
2618                    break;
2619                case _lev_ctrl_CC76_EXT:
2620                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2621                    decodedcontroller.controller_number = 76;
2622                    break;
2623                case _lev_ctrl_CC77_EXT:
2624                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2625                    decodedcontroller.controller_number = 77;
2626                    break;
2627                case _lev_ctrl_CC78_EXT:
2628                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2629                    decodedcontroller.controller_number = 78;
2630                    break;
2631                case _lev_ctrl_CC79_EXT:
2632                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2633                    decodedcontroller.controller_number = 79;
2634                    break;
2635                case _lev_ctrl_CC84_EXT:
2636                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2637                    decodedcontroller.controller_number = 84;
2638                    break;
2639                case _lev_ctrl_CC85_EXT:
2640                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2641                    decodedcontroller.controller_number = 85;
2642                    break;
2643                case _lev_ctrl_CC86_EXT:
2644                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2645                    decodedcontroller.controller_number = 86;
2646                    break;
2647                case _lev_ctrl_CC87_EXT:
2648                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2649                    decodedcontroller.controller_number = 87;
2650                    break;
2651                case _lev_ctrl_CC89_EXT:
2652                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2653                    decodedcontroller.controller_number = 89;
2654                    break;
2655                case _lev_ctrl_CC90_EXT:
2656                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2657                    decodedcontroller.controller_number = 90;
2658                    break;
2659                case _lev_ctrl_CC96_EXT:
2660                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2661                    decodedcontroller.controller_number = 96;
2662                    break;
2663                case _lev_ctrl_CC97_EXT:
2664                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2665                    decodedcontroller.controller_number = 97;
2666                    break;
2667                case _lev_ctrl_CC102_EXT:
2668                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2669                    decodedcontroller.controller_number = 102;
2670                    break;
2671                case _lev_ctrl_CC103_EXT:
2672                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2673                    decodedcontroller.controller_number = 103;
2674                    break;
2675                case _lev_ctrl_CC104_EXT:
2676                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2677                    decodedcontroller.controller_number = 104;
2678                    break;
2679                case _lev_ctrl_CC105_EXT:
2680                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2681                    decodedcontroller.controller_number = 105;
2682                    break;
2683                case _lev_ctrl_CC106_EXT:
2684                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2685                    decodedcontroller.controller_number = 106;
2686                    break;
2687                case _lev_ctrl_CC107_EXT:
2688                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2689                    decodedcontroller.controller_number = 107;
2690                    break;
2691                case _lev_ctrl_CC108_EXT:
2692                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2693                    decodedcontroller.controller_number = 108;
2694                    break;
2695                case _lev_ctrl_CC109_EXT:
2696                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2697                    decodedcontroller.controller_number = 109;
2698                    break;
2699                case _lev_ctrl_CC110_EXT:
2700                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2701                    decodedcontroller.controller_number = 110;
2702                    break;
2703                case _lev_ctrl_CC111_EXT:
2704                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2705                    decodedcontroller.controller_number = 111;
2706                    break;
2707                case _lev_ctrl_CC112_EXT:
2708                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2709                    decodedcontroller.controller_number = 112;
2710                    break;
2711                case _lev_ctrl_CC113_EXT:
2712                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2713                    decodedcontroller.controller_number = 113;
2714                    break;
2715                case _lev_ctrl_CC114_EXT:
2716                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2717                    decodedcontroller.controller_number = 114;
2718                    break;
2719                case _lev_ctrl_CC115_EXT:
2720                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2721                    decodedcontroller.controller_number = 115;
2722                    break;
2723                case _lev_ctrl_CC116_EXT:
2724                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2725                    decodedcontroller.controller_number = 116;
2726                    break;
2727                case _lev_ctrl_CC117_EXT:
2728                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2729                    decodedcontroller.controller_number = 117;
2730                    break;
2731                case _lev_ctrl_CC118_EXT:
2732                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2733                    decodedcontroller.controller_number = 118;
2734                    break;
2735                case _lev_ctrl_CC119_EXT:
2736                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2737                    decodedcontroller.controller_number = 119;
2738                    break;
2739    
2740              // unknown controller type              // unknown controller type
2741              default:              default:
2742                  throw gig::Exception("Unknown leverage controller type.");                  decodedcontroller.type = leverage_ctrl_t::type_none;
2743                    decodedcontroller.controller_number = 0;
2744                    printf("Warning: Unknown leverage controller type (0x%x).\n", EncodedController);
2745                    break;
2746          }          }
2747          return decodedcontroller;          return decodedcontroller;
2748      }      }
2749        
2750    // see above (diagnostic push not supported prior GCC 4.6)
2751    //#pragma GCC diagnostic pop
2752    
2753      DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {      DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {
2754          _lev_ctrl_t encodedcontroller;          _lev_ctrl_t encodedcontroller;
# Line 2190  namespace { Line 2836  namespace {
2836                      case 95:                      case 95:
2837                          encodedcontroller = _lev_ctrl_effect5depth;                          encodedcontroller = _lev_ctrl_effect5depth;
2838                          break;                          break;
2839    
2840                        // format extension (these controllers are so far only
2841                        // supported by LinuxSampler & gigedit) they will *NOT*
2842                        // work with Gigasampler/GigaStudio !
2843                        case 3:
2844                            encodedcontroller = _lev_ctrl_CC3_EXT;
2845                            break;
2846                        case 6:
2847                            encodedcontroller = _lev_ctrl_CC6_EXT;
2848                            break;
2849                        case 7:
2850                            encodedcontroller = _lev_ctrl_CC7_EXT;
2851                            break;
2852                        case 8:
2853                            encodedcontroller = _lev_ctrl_CC8_EXT;
2854                            break;
2855                        case 9:
2856                            encodedcontroller = _lev_ctrl_CC9_EXT;
2857                            break;
2858                        case 10:
2859                            encodedcontroller = _lev_ctrl_CC10_EXT;
2860                            break;
2861                        case 11:
2862                            encodedcontroller = _lev_ctrl_CC11_EXT;
2863                            break;
2864                        case 14:
2865                            encodedcontroller = _lev_ctrl_CC14_EXT;
2866                            break;
2867                        case 15:
2868                            encodedcontroller = _lev_ctrl_CC15_EXT;
2869                            break;
2870                        case 20:
2871                            encodedcontroller = _lev_ctrl_CC20_EXT;
2872                            break;
2873                        case 21:
2874                            encodedcontroller = _lev_ctrl_CC21_EXT;
2875                            break;
2876                        case 22:
2877                            encodedcontroller = _lev_ctrl_CC22_EXT;
2878                            break;
2879                        case 23:
2880                            encodedcontroller = _lev_ctrl_CC23_EXT;
2881                            break;
2882                        case 24:
2883                            encodedcontroller = _lev_ctrl_CC24_EXT;
2884                            break;
2885                        case 25:
2886                            encodedcontroller = _lev_ctrl_CC25_EXT;
2887                            break;
2888                        case 26:
2889                            encodedcontroller = _lev_ctrl_CC26_EXT;
2890                            break;
2891                        case 27:
2892                            encodedcontroller = _lev_ctrl_CC27_EXT;
2893                            break;
2894                        case 28:
2895                            encodedcontroller = _lev_ctrl_CC28_EXT;
2896                            break;
2897                        case 29:
2898                            encodedcontroller = _lev_ctrl_CC29_EXT;
2899                            break;
2900                        case 30:
2901                            encodedcontroller = _lev_ctrl_CC30_EXT;
2902                            break;
2903                        case 31:
2904                            encodedcontroller = _lev_ctrl_CC31_EXT;
2905                            break;
2906                        case 68:
2907                            encodedcontroller = _lev_ctrl_CC68_EXT;
2908                            break;
2909                        case 69:
2910                            encodedcontroller = _lev_ctrl_CC69_EXT;
2911                            break;
2912                        case 70:
2913                            encodedcontroller = _lev_ctrl_CC70_EXT;
2914                            break;
2915                        case 71:
2916                            encodedcontroller = _lev_ctrl_CC71_EXT;
2917                            break;
2918                        case 72:
2919                            encodedcontroller = _lev_ctrl_CC72_EXT;
2920                            break;
2921                        case 73:
2922                            encodedcontroller = _lev_ctrl_CC73_EXT;
2923                            break;
2924                        case 74:
2925                            encodedcontroller = _lev_ctrl_CC74_EXT;
2926                            break;
2927                        case 75:
2928                            encodedcontroller = _lev_ctrl_CC75_EXT;
2929                            break;
2930                        case 76:
2931                            encodedcontroller = _lev_ctrl_CC76_EXT;
2932                            break;
2933                        case 77:
2934                            encodedcontroller = _lev_ctrl_CC77_EXT;
2935                            break;
2936                        case 78:
2937                            encodedcontroller = _lev_ctrl_CC78_EXT;
2938                            break;
2939                        case 79:
2940                            encodedcontroller = _lev_ctrl_CC79_EXT;
2941                            break;
2942                        case 84:
2943                            encodedcontroller = _lev_ctrl_CC84_EXT;
2944                            break;
2945                        case 85:
2946                            encodedcontroller = _lev_ctrl_CC85_EXT;
2947                            break;
2948                        case 86:
2949                            encodedcontroller = _lev_ctrl_CC86_EXT;
2950                            break;
2951                        case 87:
2952                            encodedcontroller = _lev_ctrl_CC87_EXT;
2953                            break;
2954                        case 89:
2955                            encodedcontroller = _lev_ctrl_CC89_EXT;
2956                            break;
2957                        case 90:
2958                            encodedcontroller = _lev_ctrl_CC90_EXT;
2959                            break;
2960                        case 96:
2961                            encodedcontroller = _lev_ctrl_CC96_EXT;
2962                            break;
2963                        case 97:
2964                            encodedcontroller = _lev_ctrl_CC97_EXT;
2965                            break;
2966                        case 102:
2967                            encodedcontroller = _lev_ctrl_CC102_EXT;
2968                            break;
2969                        case 103:
2970                            encodedcontroller = _lev_ctrl_CC103_EXT;
2971                            break;
2972                        case 104:
2973                            encodedcontroller = _lev_ctrl_CC104_EXT;
2974                            break;
2975                        case 105:
2976                            encodedcontroller = _lev_ctrl_CC105_EXT;
2977                            break;
2978                        case 106:
2979                            encodedcontroller = _lev_ctrl_CC106_EXT;
2980                            break;
2981                        case 107:
2982                            encodedcontroller = _lev_ctrl_CC107_EXT;
2983                            break;
2984                        case 108:
2985                            encodedcontroller = _lev_ctrl_CC108_EXT;
2986                            break;
2987                        case 109:
2988                            encodedcontroller = _lev_ctrl_CC109_EXT;
2989                            break;
2990                        case 110:
2991                            encodedcontroller = _lev_ctrl_CC110_EXT;
2992                            break;
2993                        case 111:
2994                            encodedcontroller = _lev_ctrl_CC111_EXT;
2995                            break;
2996                        case 112:
2997                            encodedcontroller = _lev_ctrl_CC112_EXT;
2998                            break;
2999                        case 113:
3000                            encodedcontroller = _lev_ctrl_CC113_EXT;
3001                            break;
3002                        case 114:
3003                            encodedcontroller = _lev_ctrl_CC114_EXT;
3004                            break;
3005                        case 115:
3006                            encodedcontroller = _lev_ctrl_CC115_EXT;
3007                            break;
3008                        case 116:
3009                            encodedcontroller = _lev_ctrl_CC116_EXT;
3010                            break;
3011                        case 117:
3012                            encodedcontroller = _lev_ctrl_CC117_EXT;
3013                            break;
3014                        case 118:
3015                            encodedcontroller = _lev_ctrl_CC118_EXT;
3016                            break;
3017                        case 119:
3018                            encodedcontroller = _lev_ctrl_CC119_EXT;
3019                            break;
3020    
3021                      default:                      default:
3022                          throw gig::Exception("leverage controller number is not supported by the gig format");                          throw gig::Exception("leverage controller number is not supported by the gig format");
3023                  }                  }
# Line 2408  namespace { Line 3236  namespace {
3236          }          }
3237          Layers = 1;          Layers = 1;
3238          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
3239          int dimensionBits = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;          int dimensionBits = (file->pVersion && file->pVersion->major > 2) ? 8 : 5;
3240    
3241          // Actual Loading          // Actual Loading
3242    
# Line 2418  namespace { Line 3246  namespace {
3246    
3247          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);
3248          if (_3lnk) {          if (_3lnk) {
3249                _3lnk->SetPos(0);
3250    
3251              DimensionRegions = _3lnk->ReadUint32();              DimensionRegions = _3lnk->ReadUint32();
3252              for (int i = 0; i < dimensionBits; i++) {              for (int i = 0; i < dimensionBits; i++) {
3253                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());
# Line 2452  namespace { Line 3282  namespace {
3282              UpdateVelocityTable();              UpdateVelocityTable();
3283    
3284              // jump to start of the wave pool indices (if not already there)              // jump to start of the wave pool indices (if not already there)
3285              if (file->pVersion && file->pVersion->major == 3)              if (file->pVersion && file->pVersion->major > 2)
3286                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure
3287              else              else
3288                  _3lnk->SetPos(44);                  _3lnk->SetPos(44);
# Line 2461  namespace { Line 3291  namespace {
3291              if (file->GetAutoLoad()) {              if (file->GetAutoLoad()) {
3292                  for (uint i = 0; i < DimensionRegions; i++) {                  for (uint i = 0; i < DimensionRegions; i++) {
3293                      uint32_t wavepoolindex = _3lnk->ReadUint32();                      uint32_t wavepoolindex = _3lnk->ReadUint32();
3294                      if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);                      if (file->pWavePoolTable && pDimensionRegions[i])
3295                            pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
3296                  }                  }
3297                  GetSample(); // load global region sample reference                  GetSample(); // load global region sample reference
3298              }              }
# Line 2491  namespace { Line 3322  namespace {
3322       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
3323       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
3324       *       *
3325         * @param pProgress - callback function for progress notification
3326       * @throws gig::Exception if samples cannot be dereferenced       * @throws gig::Exception if samples cannot be dereferenced
3327       */       */
3328      void Region::UpdateChunks() {      void Region::UpdateChunks(progress_t* pProgress) {
3329          // in the gig format we don't care about the Region's sample reference          // in the gig format we don't care about the Region's sample reference
3330          // but we still have to provide some existing one to not corrupt the          // but we still have to provide some existing one to not corrupt the
3331          // file, so to avoid the latter we simply always assign the sample of          // file, so to avoid the latter we simply always assign the sample of
# Line 2501  namespace { Line 3333  namespace {
3333          pSample = pDimensionRegions[0]->pSample;          pSample = pDimensionRegions[0]->pSample;
3334    
3335          // first update base class's chunks          // first update base class's chunks
3336          DLS::Region::UpdateChunks();          DLS::Region::UpdateChunks(pProgress);
3337    
3338          // update dimension region's chunks          // update dimension region's chunks
3339          for (int i = 0; i < DimensionRegions; i++) {          for (int i = 0; i < DimensionRegions; i++) {
3340              pDimensionRegions[i]->UpdateChunks();              pDimensionRegions[i]->UpdateChunks(pProgress);
3341          }          }
3342    
3343          File* pFile = (File*) GetParent()->GetParent();          File* pFile = (File*) GetParent()->GetParent();
3344          bool version3 = pFile->pVersion && pFile->pVersion->major == 3;          bool versiongt2 = pFile->pVersion && pFile->pVersion->major > 2;
3345          const int iMaxDimensions =  version3 ? 8 : 5;          const int iMaxDimensions =  versiongt2 ? 8 : 5;
3346          const int iMaxDimensionRegions = version3 ? 256 : 32;          const int iMaxDimensionRegions = versiongt2 ? 256 : 32;
3347    
3348          // make sure '3lnk' chunk exists          // make sure '3lnk' chunk exists
3349          RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);          RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);
3350          if (!_3lnk) {          if (!_3lnk) {
3351              const int _3lnkChunkSize = version3 ? 1092 : 172;              const int _3lnkChunkSize = versiongt2 ? 1092 : 172;
3352              _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);              _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);
3353              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
3354    
3355              // move 3prg to last position              // move 3prg to last position
3356              pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), 0);              pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), (RIFF::Chunk*)NULL);
3357          }          }
3358    
3359          // update dimension definitions in '3lnk' chunk          // update dimension definitions in '3lnk' chunk
# Line 2540  namespace { Line 3372  namespace {
3372          }          }
3373    
3374          // update wave pool table in '3lnk' chunk          // update wave pool table in '3lnk' chunk
3375          const int iWavePoolOffset = version3 ? 68 : 44;          const int iWavePoolOffset = versiongt2 ? 68 : 44;
3376          for (uint i = 0; i < iMaxDimensionRegions; i++) {          for (uint i = 0; i < iMaxDimensionRegions; i++) {
3377              int iWaveIndex = -1;              int iWaveIndex = -1;
3378              if (i < DimensionRegions) {              if (i < DimensionRegions) {
# Line 2595  namespace { Line 3427  namespace {
3427          int step = 1;          int step = 1;
3428          for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;          for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
3429          int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;          int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
         int end = step * pDimensionDefinitions[veldim].zones;  
3430    
3431          // loop through all dimension regions for all dimensions except the velocity dimension          // loop through all dimension regions for all dimensions except the velocity dimension
3432          int dim[8] = { 0 };          int dim[8] = { 0 };
3433          for (int i = 0 ; i < DimensionRegions ; i++) {          for (int i = 0 ; i < DimensionRegions ; i++) {
3434                const int end = i + step * pDimensionDefinitions[veldim].zones;
3435    
3436                // create a velocity table for all cases where the velocity zone is zero
3437              if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||              if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||
3438                  pDimensionRegions[i]->VelocityUpperLimit) {                  pDimensionRegions[i]->VelocityUpperLimit) {
3439                  // create the velocity table                  // create the velocity table
# Line 2631  namespace { Line 3464  namespace {
3464                  }                  }
3465              }              }
3466    
3467                // jump to the next case where the velocity zone is zero
3468              int j;              int j;
3469              int shift = 0;              int shift = 0;
3470              for (j = 0 ; j < Dimensions ; j++) {              for (j = 0 ; j < Dimensions ; j++) {
# Line 2667  namespace { Line 3501  namespace {
3501       *                        dimension bits limit is violated       *                        dimension bits limit is violated
3502       */       */
3503      void Region::AddDimension(dimension_def_t* pDimDef) {      void Region::AddDimension(dimension_def_t* pDimDef) {
3504            // some initial sanity checks of the given dimension definition
3505            if (pDimDef->zones < 2)
3506                throw gig::Exception("Could not add new dimension, amount of requested zones must always be at least two");
3507            if (pDimDef->bits < 1)
3508                throw gig::Exception("Could not add new dimension, amount of requested requested zone bits must always be at least one");
3509            if (pDimDef->dimension == dimension_samplechannel) {
3510                if (pDimDef->zones != 2)
3511                    throw gig::Exception("Could not add new 'sample channel' dimensions, the requested amount of zones must always be 2 for this dimension type");
3512                if (pDimDef->bits != 1)
3513                    throw gig::Exception("Could not add new 'sample channel' dimensions, the requested amount of zone bits must always be 1 for this dimension type");
3514            }
3515    
3516          // check if max. amount of dimensions reached          // check if max. amount of dimensions reached
3517          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
3518          const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;          const int iMaxDimensions = (file->pVersion && file->pVersion->major > 2) ? 8 : 5;
3519          if (Dimensions >= iMaxDimensions)          if (Dimensions >= iMaxDimensions)
3520              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");
3521          // check if max. amount of dimension bits reached          // check if max. amount of dimension bits reached
# Line 2842  namespace { Line 3688  namespace {
3688          if (pDimDef->dimension == dimension_layer) Layers = 1;          if (pDimDef->dimension == dimension_layer) Layers = 1;
3689      }      }
3690    
3691        /** @brief Delete one split zone of a dimension (decrement zone amount).
3692         *
3693         * Instead of deleting an entire dimensions, this method will only delete
3694         * one particular split zone given by @a zone of the Region's dimension
3695         * given by @a type. So this method will simply decrement the amount of
3696         * zones by one of the dimension in question. To be able to do that, the
3697         * respective dimension must exist on this Region and it must have at least
3698         * 3 zones. All DimensionRegion objects associated with the zone will be
3699         * deleted.
3700         *
3701         * @param type - identifies the dimension where a zone shall be deleted
3702         * @param zone - index of the dimension split zone that shall be deleted
3703         * @throws gig::Exception if requested zone could not be deleted
3704         */
3705        void Region::DeleteDimensionZone(dimension_t type, int zone) {
3706            dimension_def_t* oldDef = GetDimensionDefinition(type);
3707            if (!oldDef)
3708                throw gig::Exception("Could not delete dimension zone, no such dimension of given type");
3709            if (oldDef->zones <= 2)
3710                throw gig::Exception("Could not delete dimension zone, because it would end up with only one zone.");
3711            if (zone < 0 || zone >= oldDef->zones)
3712                throw gig::Exception("Could not delete dimension zone, requested zone index out of bounds.");
3713    
3714            const int newZoneSize = oldDef->zones - 1;
3715    
3716            // create a temporary Region which just acts as a temporary copy
3717            // container and will be deleted at the end of this function and will
3718            // also not be visible through the API during this process
3719            gig::Region* tempRgn = NULL;
3720            {
3721                // adding these temporary chunks is probably not even necessary
3722                Instrument* instr = static_cast<Instrument*>(GetParent());
3723                RIFF::List* pCkInstrument = instr->pCkInstrument;
3724                RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
3725                if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3726                RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3727                tempRgn = new Region(instr, rgn);
3728            }
3729    
3730            // copy this region's dimensions (with already the dimension split size
3731            // requested by the arguments of this method call) to the temporary
3732            // region, and don't use Region::CopyAssign() here for this task, since
3733            // it would also alter fast lookup helper variables here and there
3734            dimension_def_t newDef;
3735            for (int i = 0; i < Dimensions; ++i) {
3736                dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3737                // is this the dimension requested by the method arguments? ...
3738                if (def.dimension == type) { // ... if yes, decrement zone amount by one
3739                    def.zones = newZoneSize;
3740                    if ((1 << (def.bits - 1)) == def.zones) def.bits--;
3741                    newDef = def;
3742                }
3743                tempRgn->AddDimension(&def);
3744            }
3745    
3746            // find the dimension index in the tempRegion which is the dimension
3747            // type passed to this method (paranoidly expecting different order)
3748            int tempReducedDimensionIndex = -1;
3749            for (int d = 0; d < tempRgn->Dimensions; ++d) {
3750                if (tempRgn->pDimensionDefinitions[d].dimension == type) {
3751                    tempReducedDimensionIndex = d;
3752                    break;
3753                }
3754            }
3755    
3756            // copy dimension regions from this region to the temporary region
3757            for (int iDst = 0; iDst < 256; ++iDst) {
3758                DimensionRegion* dstDimRgn = tempRgn->pDimensionRegions[iDst];
3759                if (!dstDimRgn) continue;
3760                std::map<dimension_t,int> dimCase;
3761                bool isValidZone = true;
3762                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3763                    const int dstBits = tempRgn->pDimensionDefinitions[d].bits;
3764                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3765                        (iDst >> baseBits) & ((1 << dstBits) - 1);
3766                    baseBits += dstBits;
3767                    // there are also DimensionRegion objects of unused zones, skip them
3768                    if (dimCase[tempRgn->pDimensionDefinitions[d].dimension] >= tempRgn->pDimensionDefinitions[d].zones) {
3769                        isValidZone = false;
3770                        break;
3771                    }
3772                }
3773                if (!isValidZone) continue;
3774                // a bit paranoid: cope with the chance that the dimensions would
3775                // have different order in source and destination regions
3776                const bool isLastZone = (dimCase[type] == newZoneSize - 1);
3777                if (dimCase[type] >= zone) dimCase[type]++;
3778                DimensionRegion* srcDimRgn = GetDimensionRegionByBit(dimCase);
3779                dstDimRgn->CopyAssign(srcDimRgn);
3780                // if this is the upper most zone of the dimension passed to this
3781                // method, then correct (raise) its upper limit to 127
3782                if (newDef.split_type == split_type_normal && isLastZone)
3783                    dstDimRgn->DimensionUpperLimits[tempReducedDimensionIndex] = 127;
3784            }
3785    
3786            // now tempRegion's dimensions and DimensionRegions basically reflect
3787            // what we wanted to get for this actual Region here, so we now just
3788            // delete and recreate the dimension in question with the new amount
3789            // zones and then copy back from tempRegion      
3790            DeleteDimension(oldDef);
3791            AddDimension(&newDef);
3792            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3793                DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
3794                if (!srcDimRgn) continue;
3795                std::map<dimension_t,int> dimCase;
3796                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3797                    const int srcBits = tempRgn->pDimensionDefinitions[d].bits;
3798                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3799                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3800                    baseBits += srcBits;
3801                }
3802                // a bit paranoid: cope with the chance that the dimensions would
3803                // have different order in source and destination regions
3804                DimensionRegion* dstDimRgn = GetDimensionRegionByBit(dimCase);
3805                if (!dstDimRgn) continue;
3806                dstDimRgn->CopyAssign(srcDimRgn);
3807            }
3808    
3809            // delete temporary region
3810            tempRgn->DeleteChunks();
3811            delete tempRgn;
3812    
3813            UpdateVelocityTable();
3814        }
3815    
3816        /** @brief Divide split zone of a dimension in two (increment zone amount).
3817         *
3818         * This will increment the amount of zones for the dimension (given by
3819         * @a type) by one. It will do so by dividing the zone (given by @a zone)
3820         * in the middle of its zone range in two. So the two zones resulting from
3821         * the zone being splitted, will be an equivalent copy regarding all their
3822         * articulation informations and sample reference. The two zones will only
3823         * differ in their zone's upper limit
3824         * (DimensionRegion::DimensionUpperLimits).
3825         *
3826         * @param type - identifies the dimension where a zone shall be splitted
3827         * @param zone - index of the dimension split zone that shall be splitted
3828         * @throws gig::Exception if requested zone could not be splitted
3829         */
3830        void Region::SplitDimensionZone(dimension_t type, int zone) {
3831            dimension_def_t* oldDef = GetDimensionDefinition(type);
3832            if (!oldDef)
3833                throw gig::Exception("Could not split dimension zone, no such dimension of given type");
3834            if (zone < 0 || zone >= oldDef->zones)
3835                throw gig::Exception("Could not split dimension zone, requested zone index out of bounds.");
3836    
3837            const int newZoneSize = oldDef->zones + 1;
3838    
3839            // create a temporary Region which just acts as a temporary copy
3840            // container and will be deleted at the end of this function and will
3841            // also not be visible through the API during this process
3842            gig::Region* tempRgn = NULL;
3843            {
3844                // adding these temporary chunks is probably not even necessary
3845                Instrument* instr = static_cast<Instrument*>(GetParent());
3846                RIFF::List* pCkInstrument = instr->pCkInstrument;
3847                RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
3848                if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3849                RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3850                tempRgn = new Region(instr, rgn);
3851            }
3852    
3853            // copy this region's dimensions (with already the dimension split size
3854            // requested by the arguments of this method call) to the temporary
3855            // region, and don't use Region::CopyAssign() here for this task, since
3856            // it would also alter fast lookup helper variables here and there
3857            dimension_def_t newDef;
3858            for (int i = 0; i < Dimensions; ++i) {
3859                dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3860                // is this the dimension requested by the method arguments? ...
3861                if (def.dimension == type) { // ... if yes, increment zone amount by one
3862                    def.zones = newZoneSize;
3863                    if ((1 << oldDef->bits) < newZoneSize) def.bits++;
3864                    newDef = def;
3865                }
3866                tempRgn->AddDimension(&def);
3867            }
3868    
3869            // find the dimension index in the tempRegion which is the dimension
3870            // type passed to this method (paranoidly expecting different order)
3871            int tempIncreasedDimensionIndex = -1;
3872            for (int d = 0; d < tempRgn->Dimensions; ++d) {
3873                if (tempRgn->pDimensionDefinitions[d].dimension == type) {
3874                    tempIncreasedDimensionIndex = d;
3875                    break;
3876                }
3877            }
3878    
3879            // copy dimension regions from this region to the temporary region
3880            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3881                DimensionRegion* srcDimRgn = pDimensionRegions[iSrc];
3882                if (!srcDimRgn) continue;
3883                std::map<dimension_t,int> dimCase;
3884                bool isValidZone = true;
3885                for (int d = 0, baseBits = 0; d < Dimensions; ++d) {
3886                    const int srcBits = pDimensionDefinitions[d].bits;
3887                    dimCase[pDimensionDefinitions[d].dimension] =
3888                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3889                    // there are also DimensionRegion objects for unused zones, skip them
3890                    if (dimCase[pDimensionDefinitions[d].dimension] >= pDimensionDefinitions[d].zones) {
3891                        isValidZone = false;
3892                        break;
3893                    }
3894                    baseBits += srcBits;
3895                }
3896                if (!isValidZone) continue;
3897                // a bit paranoid: cope with the chance that the dimensions would
3898                // have different order in source and destination regions            
3899                if (dimCase[type] > zone) dimCase[type]++;
3900                DimensionRegion* dstDimRgn = tempRgn->GetDimensionRegionByBit(dimCase);
3901                dstDimRgn->CopyAssign(srcDimRgn);
3902                // if this is the requested zone to be splitted, then also copy
3903                // the source DimensionRegion to the newly created target zone
3904                // and set the old zones upper limit lower
3905                if (dimCase[type] == zone) {
3906                    // lower old zones upper limit
3907                    if (newDef.split_type == split_type_normal) {
3908                        const int high =
3909                            dstDimRgn->DimensionUpperLimits[tempIncreasedDimensionIndex];
3910                        int low = 0;
3911                        if (zone > 0) {
3912                            std::map<dimension_t,int> lowerCase = dimCase;
3913                            lowerCase[type]--;
3914                            DimensionRegion* dstDimRgnLow = tempRgn->GetDimensionRegionByBit(lowerCase);
3915                            low = dstDimRgnLow->DimensionUpperLimits[tempIncreasedDimensionIndex];
3916                        }
3917                        dstDimRgn->DimensionUpperLimits[tempIncreasedDimensionIndex] = low + (high - low) / 2;
3918                    }
3919                    // fill the newly created zone of the divided zone as well
3920                    dimCase[type]++;
3921                    dstDimRgn = tempRgn->GetDimensionRegionByBit(dimCase);
3922                    dstDimRgn->CopyAssign(srcDimRgn);
3923                }
3924            }
3925    
3926            // now tempRegion's dimensions and DimensionRegions basically reflect
3927            // what we wanted to get for this actual Region here, so we now just
3928            // delete and recreate the dimension in question with the new amount
3929            // zones and then copy back from tempRegion      
3930            DeleteDimension(oldDef);
3931            AddDimension(&newDef);
3932            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3933                DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
3934                if (!srcDimRgn) continue;
3935                std::map<dimension_t,int> dimCase;
3936                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3937                    const int srcBits = tempRgn->pDimensionDefinitions[d].bits;
3938                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3939                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3940                    baseBits += srcBits;
3941                }
3942                // a bit paranoid: cope with the chance that the dimensions would
3943                // have different order in source and destination regions
3944                DimensionRegion* dstDimRgn = GetDimensionRegionByBit(dimCase);
3945                if (!dstDimRgn) continue;
3946                dstDimRgn->CopyAssign(srcDimRgn);
3947            }
3948    
3949            // delete temporary region
3950            tempRgn->DeleteChunks();
3951            delete tempRgn;
3952    
3953            UpdateVelocityTable();
3954        }
3955    
3956        /** @brief Change type of an existing dimension.
3957         *
3958         * Alters the dimension type of a dimension already existing on this
3959         * region. If there is currently no dimension on this Region with type
3960         * @a oldType, then this call with throw an Exception. Likewise there are
3961         * cases where the requested dimension type cannot be performed. For example
3962         * if the new dimension type shall be gig::dimension_samplechannel, and the
3963         * current dimension has more than 2 zones. In such cases an Exception is
3964         * thrown as well.
3965         *
3966         * @param oldType - identifies the existing dimension to be changed
3967         * @param newType - to which dimension type it should be changed to
3968         * @throws gig::Exception if requested change cannot be performed
3969         */
3970        void Region::SetDimensionType(dimension_t oldType, dimension_t newType) {
3971            if (oldType == newType) return;
3972            dimension_def_t* def = GetDimensionDefinition(oldType);
3973            if (!def)
3974                throw gig::Exception("No dimension with provided old dimension type exists on this region");
3975            if (newType == dimension_samplechannel && def->zones != 2)
3976                throw gig::Exception("Cannot change to dimension type 'sample channel', because existing dimension does not have 2 zones");
3977            if (GetDimensionDefinition(newType))
3978                throw gig::Exception("There is already a dimension with requested new dimension type on this region");
3979            def->dimension  = newType;
3980            def->split_type = __resolveSplitType(newType);
3981        }
3982    
3983        DimensionRegion* Region::GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase) {
3984            uint8_t bits[8] = {};
3985            for (std::map<dimension_t,int>::const_iterator it = DimCase.begin();
3986                 it != DimCase.end(); ++it)
3987            {
3988                for (int d = 0; d < Dimensions; ++d) {
3989                    if (pDimensionDefinitions[d].dimension == it->first) {
3990                        bits[d] = it->second;
3991                        goto nextDimCaseSlice;
3992                    }
3993                }
3994                assert(false); // do crash ... too harsh maybe ? ignore it instead ?
3995                nextDimCaseSlice:
3996                ; // noop
3997            }
3998            return GetDimensionRegionByBit(bits);
3999        }
4000    
4001        /**
4002         * Searches in the current Region for a dimension of the given dimension
4003         * type and returns the precise configuration of that dimension in this
4004         * Region.
4005         *
4006         * @param type - dimension type of the sought dimension
4007         * @returns dimension definition or NULL if there is no dimension with
4008         *          sought type in this Region.
4009         */
4010        dimension_def_t* Region::GetDimensionDefinition(dimension_t type) {
4011            for (int i = 0; i < Dimensions; ++i)
4012                if (pDimensionDefinitions[i].dimension == type)
4013                    return &pDimensionDefinitions[i];
4014            return NULL;
4015        }
4016    
4017      Region::~Region() {      Region::~Region() {
4018          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
4019              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
# Line 2869  namespace { Line 4041  namespace {
4041      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
4042          uint8_t bits;          uint8_t bits;
4043          int veldim = -1;          int veldim = -1;
4044          int velbitpos;          int velbitpos = 0;
4045          int bitpos = 0;          int bitpos = 0;
4046          int dimregidx = 0;          int dimregidx = 0;
4047          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
# Line 2899  namespace { Line 4071  namespace {
4071              }              }
4072              bitpos += pDimensionDefinitions[i].bits;              bitpos += pDimensionDefinitions[i].bits;
4073          }          }
4074          DimensionRegion* dimreg = pDimensionRegions[dimregidx];          DimensionRegion* dimreg = pDimensionRegions[dimregidx & 255];
4075            if (!dimreg) return NULL;
4076          if (veldim != -1) {          if (veldim != -1) {
4077              // (dimreg is now the dimension region for the lowest velocity)              // (dimreg is now the dimension region for the lowest velocity)
4078              if (dimreg->VelocityTable) // custom defined zone ranges              if (dimreg->VelocityTable) // custom defined zone ranges
4079                  bits = dimreg->VelocityTable[DimValues[veldim]];                  bits = dimreg->VelocityTable[DimValues[veldim] & 127];
4080              else // normal split type              else // normal split type
4081                  bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);                  bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
4082    
4083              dimregidx |= bits << velbitpos;              const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
4084              dimreg = pDimensionRegions[dimregidx];              dimregidx |= (bits & limiter_mask) << velbitpos;
4085                dimreg = pDimensionRegions[dimregidx & 255];
4086          }          }
4087          return dimreg;          return dimreg;
4088      }      }
4089    
4090        int Region::GetDimensionRegionIndexByValue(const uint DimValues[8]) {
4091            uint8_t bits;
4092            int veldim = -1;
4093            int velbitpos = 0;
4094            int bitpos = 0;
4095            int dimregidx = 0;
4096            for (uint i = 0; i < Dimensions; i++) {
4097                if (pDimensionDefinitions[i].dimension == dimension_velocity) {
4098                    // the velocity dimension must be handled after the other dimensions
4099                    veldim = i;
4100                    velbitpos = bitpos;
4101                } else {
4102                    switch (pDimensionDefinitions[i].split_type) {
4103                        case split_type_normal:
4104                            if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
4105                                // gig3: all normal dimensions (not just the velocity dimension) have custom zone ranges
4106                                for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
4107                                    if (DimValues[i] <= pDimensionRegions[bits << bitpos]->DimensionUpperLimits[i]) break;
4108                                }
4109                            } else {
4110                                // gig2: evenly sized zones
4111                                bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
4112                            }
4113                            break;
4114                        case split_type_bit: // the value is already the sought dimension bit number
4115                            const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
4116                            bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
4117                            break;
4118                    }
4119                    dimregidx |= bits << bitpos;
4120                }
4121                bitpos += pDimensionDefinitions[i].bits;
4122            }
4123            dimregidx &= 255;
4124            DimensionRegion* dimreg = pDimensionRegions[dimregidx];
4125            if (!dimreg) return -1;
4126            if (veldim != -1) {
4127                // (dimreg is now the dimension region for the lowest velocity)
4128                if (dimreg->VelocityTable) // custom defined zone ranges
4129                    bits = dimreg->VelocityTable[DimValues[veldim] & 127];
4130                else // normal split type
4131                    bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
4132    
4133                const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
4134                dimregidx |= (bits & limiter_mask) << velbitpos;
4135                dimregidx &= 255;
4136            }
4137            return dimregidx;
4138        }
4139    
4140      /**      /**
4141       * Returns the appropriate DimensionRegion for the given dimension bit       * Returns the appropriate DimensionRegion for the given dimension bit
4142       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>
# Line 2951  namespace { Line 4175  namespace {
4175          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
4176          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
4177          if (!file->pWavePoolTable) return NULL;          if (!file->pWavePoolTable) return NULL;
4178          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          if (WavePoolTableIndex + 1 > file->WavePoolCount) return NULL;
4179          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];          // for new files or files >= 2 GB use 64 bit wave pool offsets
4180          Sample* sample = file->GetFirstSample(pProgress);          if (file->pRIFF->IsNew() || (file->pRIFF->GetCurrentFileSize() >> 31)) {
4181          while (sample) {              // use 64 bit wave pool offsets (treating this as large file)
4182              if (sample->ulWavePoolOffset == soughtoffset &&              uint64_t soughtoffset =
4183                  sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);                  uint64_t(file->pWavePoolTable[WavePoolTableIndex]) |
4184              sample = file->GetNextSample();                  uint64_t(file->pWavePoolTableHi[WavePoolTableIndex]) << 32;
4185                Sample* sample = file->GetFirstSample(pProgress);
4186                while (sample) {
4187                    if (sample->ullWavePoolOffset == soughtoffset)
4188                        return static_cast<gig::Sample*>(sample);
4189                    sample = file->GetNextSample();
4190                }
4191            } else {
4192                // use extension files and 32 bit wave pool offsets
4193                file_offset_t soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
4194                file_offset_t soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
4195                Sample* sample = file->GetFirstSample(pProgress);
4196                while (sample) {
4197                    if (sample->ullWavePoolOffset == soughtoffset &&
4198                        sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
4199                    sample = file->GetNextSample();
4200                }
4201          }          }
4202          return NULL;          return NULL;
4203      }      }
# Line 2972  namespace { Line 4212  namespace {
4212       * @param orig - original Region object to be copied from       * @param orig - original Region object to be copied from
4213       */       */
4214      void Region::CopyAssign(const Region* orig) {      void Region::CopyAssign(const Region* orig) {
4215            CopyAssign(orig, NULL);
4216        }
4217        
4218        /**
4219         * Make a (semi) deep copy of the Region object given by @a orig and
4220         * assign it to this object
4221         *
4222         * @param mSamples - crosslink map between the foreign file's samples and
4223         *                   this file's samples
4224         */
4225        void Region::CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples) {
4226          // handle base classes          // handle base classes
4227          DLS::Region::CopyAssign(orig);          DLS::Region::CopyAssign(orig);
4228                    
4229            if (mSamples && mSamples->count((gig::Sample*)orig->pSample)) {
4230                pSample = mSamples->find((gig::Sample*)orig->pSample)->second;
4231            }
4232            
4233          // handle own member variables          // handle own member variables
4234          for (int i = Dimensions - 1; i >= 0; --i) {          for (int i = Dimensions - 1; i >= 0; --i) {
4235              DeleteDimension(&pDimensionDefinitions[i]);              DeleteDimension(&pDimensionDefinitions[i]);
# Line 2989  namespace { Line 4244  namespace {
4244          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
4245              if (pDimensionRegions[i] && orig->pDimensionRegions[i]) {              if (pDimensionRegions[i] && orig->pDimensionRegions[i]) {
4246                  pDimensionRegions[i]->CopyAssign(                  pDimensionRegions[i]->CopyAssign(
4247                      orig->pDimensionRegions[i]                      orig->pDimensionRegions[i],
4248                        mSamples
4249                  );                  );
4250              }              }
4251          }          }
# Line 3000  namespace { Line 4256  namespace {
4256  // *************** MidiRule ***************  // *************** MidiRule ***************
4257  // *  // *
4258    
4259  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg) {      MidiRuleCtrlTrigger::MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg) {
4260      _3ewg->SetPos(36);          _3ewg->SetPos(36);
4261      Triggers = _3ewg->ReadUint8();          Triggers = _3ewg->ReadUint8();
4262      _3ewg->SetPos(40);          _3ewg->SetPos(40);
4263      ControllerNumber = _3ewg->ReadUint8();          ControllerNumber = _3ewg->ReadUint8();
4264      _3ewg->SetPos(46);          _3ewg->SetPos(46);
4265      for (int i = 0 ; i < Triggers ; i++) {          for (int i = 0 ; i < Triggers ; i++) {
4266          pTriggers[i].TriggerPoint = _3ewg->ReadUint8();              pTriggers[i].TriggerPoint = _3ewg->ReadUint8();
4267          pTriggers[i].Descending = _3ewg->ReadUint8();              pTriggers[i].Descending = _3ewg->ReadUint8();
4268          pTriggers[i].VelSensitivity = _3ewg->ReadUint8();              pTriggers[i].VelSensitivity = _3ewg->ReadUint8();
4269          pTriggers[i].Key = _3ewg->ReadUint8();              pTriggers[i].Key = _3ewg->ReadUint8();
4270          pTriggers[i].NoteOff = _3ewg->ReadUint8();              pTriggers[i].NoteOff = _3ewg->ReadUint8();
4271          pTriggers[i].Velocity = _3ewg->ReadUint8();              pTriggers[i].Velocity = _3ewg->ReadUint8();
4272          pTriggers[i].OverridePedal = _3ewg->ReadUint8();              pTriggers[i].OverridePedal = _3ewg->ReadUint8();
4273          _3ewg->ReadUint8();              _3ewg->ReadUint8();
4274            }
4275        }
4276    
4277        MidiRuleCtrlTrigger::MidiRuleCtrlTrigger() :
4278            ControllerNumber(0),
4279            Triggers(0) {
4280        }
4281    
4282        void MidiRuleCtrlTrigger::UpdateChunks(uint8_t* pData) const {
4283            pData[32] = 4;
4284            pData[33] = 16;
4285            pData[36] = Triggers;
4286            pData[40] = ControllerNumber;
4287            for (int i = 0 ; i < Triggers ; i++) {
4288                pData[46 + i * 8] = pTriggers[i].TriggerPoint;
4289                pData[47 + i * 8] = pTriggers[i].Descending;
4290                pData[48 + i * 8] = pTriggers[i].VelSensitivity;
4291                pData[49 + i * 8] = pTriggers[i].Key;
4292                pData[50 + i * 8] = pTriggers[i].NoteOff;
4293                pData[51 + i * 8] = pTriggers[i].Velocity;
4294                pData[52 + i * 8] = pTriggers[i].OverridePedal;
4295            }
4296        }
4297    
4298        MidiRuleLegato::MidiRuleLegato(RIFF::Chunk* _3ewg) {
4299            _3ewg->SetPos(36);
4300            LegatoSamples = _3ewg->ReadUint8(); // always 12
4301            _3ewg->SetPos(40);
4302            BypassUseController = _3ewg->ReadUint8();
4303            BypassKey = _3ewg->ReadUint8();
4304            BypassController = _3ewg->ReadUint8();
4305            ThresholdTime = _3ewg->ReadUint16();
4306            _3ewg->ReadInt16();
4307            ReleaseTime = _3ewg->ReadUint16();
4308            _3ewg->ReadInt16();
4309            KeyRange.low = _3ewg->ReadUint8();
4310            KeyRange.high = _3ewg->ReadUint8();
4311            _3ewg->SetPos(64);
4312            ReleaseTriggerKey = _3ewg->ReadUint8();
4313            AltSustain1Key = _3ewg->ReadUint8();
4314            AltSustain2Key = _3ewg->ReadUint8();
4315        }
4316    
4317        MidiRuleLegato::MidiRuleLegato() :
4318            LegatoSamples(12),
4319            BypassUseController(false),
4320            BypassKey(0),
4321            BypassController(1),
4322            ThresholdTime(20),
4323            ReleaseTime(20),
4324            ReleaseTriggerKey(0),
4325            AltSustain1Key(0),
4326            AltSustain2Key(0)
4327        {
4328            KeyRange.low = KeyRange.high = 0;
4329        }
4330    
4331        void MidiRuleLegato::UpdateChunks(uint8_t* pData) const {
4332            pData[32] = 0;
4333            pData[33] = 16;
4334            pData[36] = LegatoSamples;
4335            pData[40] = BypassUseController;
4336            pData[41] = BypassKey;
4337            pData[42] = BypassController;
4338            store16(&pData[43], ThresholdTime);
4339            store16(&pData[47], ReleaseTime);
4340            pData[51] = KeyRange.low;
4341            pData[52] = KeyRange.high;
4342            pData[64] = ReleaseTriggerKey;
4343            pData[65] = AltSustain1Key;
4344            pData[66] = AltSustain2Key;
4345        }
4346    
4347        MidiRuleAlternator::MidiRuleAlternator(RIFF::Chunk* _3ewg) {
4348            _3ewg->SetPos(36);
4349            Articulations = _3ewg->ReadUint8();
4350            int flags = _3ewg->ReadUint8();
4351            Polyphonic = flags & 8;
4352            Chained = flags & 4;
4353            Selector = (flags & 2) ? selector_controller :
4354                (flags & 1) ? selector_key_switch : selector_none;
4355            Patterns = _3ewg->ReadUint8();
4356            _3ewg->ReadUint8(); // chosen row
4357            _3ewg->ReadUint8(); // unknown
4358            _3ewg->ReadUint8(); // unknown
4359            _3ewg->ReadUint8(); // unknown
4360            KeySwitchRange.low = _3ewg->ReadUint8();
4361            KeySwitchRange.high = _3ewg->ReadUint8();
4362            Controller = _3ewg->ReadUint8();
4363            PlayRange.low = _3ewg->ReadUint8();
4364            PlayRange.high = _3ewg->ReadUint8();
4365    
4366            int n = std::min(int(Articulations), 32);
4367            for (int i = 0 ; i < n ; i++) {
4368                _3ewg->ReadString(pArticulations[i], 32);
4369            }
4370            _3ewg->SetPos(1072);
4371            n = std::min(int(Patterns), 32);
4372            for (int i = 0 ; i < n ; i++) {
4373                _3ewg->ReadString(pPatterns[i].Name, 16);
4374                pPatterns[i].Size = _3ewg->ReadUint8();
4375                _3ewg->Read(&pPatterns[i][0], 1, 32);
4376            }
4377        }
4378    
4379        MidiRuleAlternator::MidiRuleAlternator() :
4380            Articulations(0),
4381            Patterns(0),
4382            Selector(selector_none),
4383            Controller(0),
4384            Polyphonic(false),
4385            Chained(false)
4386        {
4387            PlayRange.low = PlayRange.high = 0;
4388            KeySwitchRange.low = KeySwitchRange.high = 0;
4389        }
4390    
4391        void MidiRuleAlternator::UpdateChunks(uint8_t* pData) const {
4392            pData[32] = 3;
4393            pData[33] = 16;
4394            pData[36] = Articulations;
4395            pData[37] = (Polyphonic ? 8 : 0) | (Chained ? 4 : 0) |
4396                (Selector == selector_controller ? 2 :
4397                 (Selector == selector_key_switch ? 1 : 0));
4398            pData[38] = Patterns;
4399    
4400            pData[43] = KeySwitchRange.low;
4401            pData[44] = KeySwitchRange.high;
4402            pData[45] = Controller;
4403            pData[46] = PlayRange.low;
4404            pData[47] = PlayRange.high;
4405    
4406            char* str = reinterpret_cast<char*>(pData);
4407            int pos = 48;
4408            int n = std::min(int(Articulations), 32);
4409            for (int i = 0 ; i < n ; i++, pos += 32) {
4410                strncpy(&str[pos], pArticulations[i].c_str(), 32);
4411            }
4412    
4413            pos = 1072;
4414            n = std::min(int(Patterns), 32);
4415            for (int i = 0 ; i < n ; i++, pos += 49) {
4416                strncpy(&str[pos], pPatterns[i].Name.c_str(), 16);
4417                pData[pos + 16] = pPatterns[i].Size;
4418                memcpy(&pData[pos + 16], &(pPatterns[i][0]), 32);
4419            }
4420      }      }
 }  
4421    
4422    // *************** Script ***************
4423    // *
4424    
4425        Script::Script(ScriptGroup* group, RIFF::Chunk* ckScri) {
4426            pGroup = group;
4427            pChunk = ckScri;
4428            if (ckScri) { // object is loaded from file ...
4429                ckScri->SetPos(0);
4430    
4431                // read header
4432                uint32_t headerSize = ckScri->ReadUint32();
4433                Compression = (Compression_t) ckScri->ReadUint32();
4434                Encoding    = (Encoding_t) ckScri->ReadUint32();
4435                Language    = (Language_t) ckScri->ReadUint32();
4436                Bypass      = (Language_t) ckScri->ReadUint32() & 1;
4437                crc         = ckScri->ReadUint32();
4438                uint32_t nameSize = ckScri->ReadUint32();
4439                Name.resize(nameSize, ' ');
4440                for (int i = 0; i < nameSize; ++i)
4441                    Name[i] = ckScri->ReadUint8();
4442                // to handle potential future extensions of the header
4443                ckScri->SetPos(sizeof(int32_t) + headerSize);
4444                // read actual script data
4445                uint32_t scriptSize = uint32_t(ckScri->GetSize() - ckScri->GetPos());
4446                data.resize(scriptSize);
4447                for (int i = 0; i < scriptSize; ++i)
4448                    data[i] = ckScri->ReadUint8();
4449            } else { // this is a new script object, so just initialize it as such ...
4450                Compression = COMPRESSION_NONE;
4451                Encoding = ENCODING_ASCII;
4452                Language = LANGUAGE_NKSP;
4453                Bypass   = false;
4454                crc      = 0;
4455                Name     = "Unnamed Script";
4456            }
4457        }
4458    
4459        Script::~Script() {
4460        }
4461    
4462        /**
4463         * Returns the current script (i.e. as source code) in text format.
4464         */
4465        String Script::GetScriptAsText() {
4466            String s;
4467            s.resize(data.size(), ' ');
4468            memcpy(&s[0], &data[0], data.size());
4469            return s;
4470        }
4471    
4472        /**
4473         * Replaces the current script with the new script source code text given
4474         * by @a text.
4475         *
4476         * @param text - new script source code
4477         */
4478        void Script::SetScriptAsText(const String& text) {
4479            data.resize(text.size());
4480            memcpy(&data[0], &text[0], text.size());
4481        }
4482    
4483        /** @brief Remove all RIFF chunks associated with this Script object.
4484         *
4485         * At the moment Script::DeleteChunks() does nothing. It is
4486         * recommended to call this method explicitly though from deriving classes's
4487         * own overridden implementation of this method to avoid potential future
4488         * compatiblity issues.
4489         *
4490         * See DLS::Storage::DeleteChunks() for details.
4491         */
4492        void Script::DeleteChunks() {
4493        }
4494    
4495        /**
4496         * Apply this script to the respective RIFF chunks. You have to call
4497         * File::Save() to make changes persistent.
4498         *
4499         * Usually there is absolutely no need to call this method explicitly.
4500         * It will be called automatically when File::Save() was called.
4501         *
4502         * @param pProgress - callback function for progress notification
4503         */
4504        void Script::UpdateChunks(progress_t* pProgress) {
4505            // recalculate CRC32 check sum
4506            __resetCRC(crc);
4507            __calculateCRC(&data[0], data.size(), crc);
4508            __finalizeCRC(crc);
4509            // make sure chunk exists and has the required size
4510            const file_offset_t chunkSize = (file_offset_t) 7*sizeof(int32_t) + Name.size() + data.size();
4511            if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);
4512            else pChunk->Resize(chunkSize);
4513            // fill the chunk data to be written to disk
4514            uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();
4515            int pos = 0;
4516            store32(&pData[pos], uint32_t(6*sizeof(int32_t) + Name.size())); // total header size
4517            pos += sizeof(int32_t);
4518            store32(&pData[pos], Compression);
4519            pos += sizeof(int32_t);
4520            store32(&pData[pos], Encoding);
4521            pos += sizeof(int32_t);
4522            store32(&pData[pos], Language);
4523            pos += sizeof(int32_t);
4524            store32(&pData[pos], Bypass ? 1 : 0);
4525            pos += sizeof(int32_t);
4526            store32(&pData[pos], crc);
4527            pos += sizeof(int32_t);
4528            store32(&pData[pos], (uint32_t) Name.size());
4529            pos += sizeof(int32_t);
4530            for (int i = 0; i < Name.size(); ++i, ++pos)
4531                pData[pos] = Name[i];
4532            for (int i = 0; i < data.size(); ++i, ++pos)
4533                pData[pos] = data[i];
4534        }
4535    
4536        /**
4537         * Move this script from its current ScriptGroup to another ScriptGroup
4538         * given by @a pGroup.
4539         *
4540         * @param pGroup - script's new group
4541         */
4542        void Script::SetGroup(ScriptGroup* pGroup) {
4543            if (this->pGroup == pGroup) return;
4544            if (pChunk)
4545                pChunk->GetParent()->MoveSubChunk(pChunk, pGroup->pList);
4546            this->pGroup = pGroup;
4547        }
4548    
4549        /**
4550         * Returns the script group this script currently belongs to. Each script
4551         * is a member of exactly one ScriptGroup.
4552         *
4553         * @returns current script group
4554         */
4555        ScriptGroup* Script::GetGroup() const {
4556            return pGroup;
4557        }
4558    
4559        /**
4560         * Make a (semi) deep copy of the Script object given by @a orig
4561         * and assign it to this object. Note: the ScriptGroup this Script
4562         * object belongs to remains untouched by this call.
4563         *
4564         * @param orig - original Script object to be copied from
4565         */
4566        void Script::CopyAssign(const Script* orig) {
4567            Name        = orig->Name;
4568            Compression = orig->Compression;
4569            Encoding    = orig->Encoding;
4570            Language    = orig->Language;
4571            Bypass      = orig->Bypass;
4572            data        = orig->data;
4573        }
4574    
4575        void Script::RemoveAllScriptReferences() {
4576            File* pFile = pGroup->pFile;
4577            for (int i = 0; pFile->GetInstrument(i); ++i) {
4578                Instrument* instr = pFile->GetInstrument(i);
4579                instr->RemoveScript(this);
4580            }
4581        }
4582    
4583    // *************** ScriptGroup ***************
4584    // *
4585    
4586        ScriptGroup::ScriptGroup(File* file, RIFF::List* lstRTIS) {
4587            pFile = file;
4588            pList = lstRTIS;
4589            pScripts = NULL;
4590            if (lstRTIS) {
4591                RIFF::Chunk* ckName = lstRTIS->GetSubChunk(CHUNK_ID_LSNM);
4592                ::LoadString(ckName, Name);
4593            } else {
4594                Name = "Default Group";
4595            }
4596        }
4597    
4598        ScriptGroup::~ScriptGroup() {
4599            if (pScripts) {
4600                std::list<Script*>::iterator iter = pScripts->begin();
4601                std::list<Script*>::iterator end  = pScripts->end();
4602                while (iter != end) {
4603                    delete *iter;
4604                    ++iter;
4605                }
4606                delete pScripts;
4607            }
4608        }
4609    
4610        /** @brief Remove all RIFF chunks associated with this ScriptGroup object.
4611         *
4612         * At the moment ScriptGroup::DeleteChunks() does nothing. It is
4613         * recommended to call this method explicitly though from deriving classes's
4614         * own overridden implementation of this method to avoid potential future
4615         * compatiblity issues.
4616         *
4617         * See DLS::Storage::DeleteChunks() for details.
4618         */
4619        void ScriptGroup::DeleteChunks() {
4620        }
4621    
4622        /**
4623         * Apply this script group to the respective RIFF chunks. You have to call
4624         * File::Save() to make changes persistent.
4625         *
4626         * Usually there is absolutely no need to call this method explicitly.
4627         * It will be called automatically when File::Save() was called.
4628         *
4629         * @param pProgress - callback function for progress notification
4630         */
4631        void ScriptGroup::UpdateChunks(progress_t* pProgress) {
4632            if (pScripts) {
4633                if (!pList)
4634                    pList = pFile->pRIFF->GetSubList(LIST_TYPE_3LS)->AddSubList(LIST_TYPE_RTIS);
4635    
4636                // now store the name of this group as <LSNM> chunk as subchunk of the <RTIS> list chunk
4637                ::SaveString(CHUNK_ID_LSNM, NULL, pList, Name, String("Unnamed Group"), true, 64);
4638    
4639                for (std::list<Script*>::iterator it = pScripts->begin();
4640                     it != pScripts->end(); ++it)
4641                {
4642                    (*it)->UpdateChunks(pProgress);
4643                }
4644            }
4645        }
4646    
4647        /** @brief Get instrument script.
4648         *
4649         * Returns the real-time instrument script with the given index.
4650         *
4651         * @param index - number of the sought script (0..n)
4652         * @returns sought script or NULL if there's no such script
4653         */
4654        Script* ScriptGroup::GetScript(uint index) {
4655            if (!pScripts) LoadScripts();
4656            std::list<Script*>::iterator it = pScripts->begin();
4657            for (uint i = 0; it != pScripts->end(); ++i, ++it)
4658                if (i == index) return *it;
4659            return NULL;
4660        }
4661    
4662        /** @brief Add new instrument script.
4663         *
4664         * Adds a new real-time instrument script to the file. The script is not
4665         * actually used / executed unless it is referenced by an instrument to be
4666         * used. This is similar to samples, which you can add to a file, without
4667         * an instrument necessarily actually using it.
4668         *
4669         * You have to call Save() to make this persistent to the file.
4670         *
4671         * @return new empty script object
4672         */
4673        Script* ScriptGroup::AddScript() {
4674            if (!pScripts) LoadScripts();
4675            Script* pScript = new Script(this, NULL);
4676            pScripts->push_back(pScript);
4677            return pScript;
4678        }
4679    
4680        /** @brief Delete an instrument script.
4681         *
4682         * This will delete the given real-time instrument script. References of
4683         * instruments that are using that script will be removed accordingly.
4684         *
4685         * You have to call Save() to make this persistent to the file.
4686         *
4687         * @param pScript - script to delete
4688         * @throws gig::Exception if given script could not be found
4689         */
4690        void ScriptGroup::DeleteScript(Script* pScript) {
4691            if (!pScripts) LoadScripts();
4692            std::list<Script*>::iterator iter =
4693                find(pScripts->begin(), pScripts->end(), pScript);
4694            if (iter == pScripts->end())
4695                throw gig::Exception("Could not delete script, could not find given script");
4696            pScripts->erase(iter);
4697            pScript->RemoveAllScriptReferences();
4698            if (pScript->pChunk)
4699                pScript->pChunk->GetParent()->DeleteSubChunk(pScript->pChunk);
4700            delete pScript;
4701        }
4702    
4703        void ScriptGroup::LoadScripts() {
4704            if (pScripts) return;
4705            pScripts = new std::list<Script*>;
4706            if (!pList) return;
4707    
4708            for (RIFF::Chunk* ck = pList->GetFirstSubChunk(); ck;
4709                 ck = pList->GetNextSubChunk())
4710            {
4711                if (ck->GetChunkID() == CHUNK_ID_SCRI) {
4712                    pScripts->push_back(new Script(this, ck));
4713                }
4714            }
4715        }
4716    
4717  // *************** Instrument ***************  // *************** Instrument ***************
4718  // *  // *
# Line 3035  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4730  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4730          EffectSend = 0;          EffectSend = 0;
4731          Attenuation = 0;          Attenuation = 0;
4732          FineTune = 0;          FineTune = 0;
4733          PitchbendRange = 0;          PitchbendRange = 2;
4734          PianoReleaseMode = false;          PianoReleaseMode = false;
4735          DimensionKeyRange.low = 0;          DimensionKeyRange.low = 0;
4736          DimensionKeyRange.high = 0;          DimensionKeyRange.high = 0;
4737          pMidiRules = new MidiRule*[3];          pMidiRules = new MidiRule*[3];
4738          pMidiRules[0] = NULL;          pMidiRules[0] = NULL;
4739            pScriptRefs = NULL;
4740    
4741          // Loading          // Loading
4742          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
4743          if (lart) {          if (lart) {
4744              RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);              RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
4745              if (_3ewg) {              if (_3ewg) {
4746                    _3ewg->SetPos(0);
4747    
4748                  EffectSend             = _3ewg->ReadUint16();                  EffectSend             = _3ewg->ReadUint16();
4749                  Attenuation            = _3ewg->ReadInt32();                  Attenuation            = _3ewg->ReadInt32();
4750                  FineTune               = _3ewg->ReadInt16();                  FineTune               = _3ewg->ReadInt16();
# Line 3063  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4761  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4761                      uint8_t id1 = _3ewg->ReadUint8();                      uint8_t id1 = _3ewg->ReadUint8();
4762                      uint8_t id2 = _3ewg->ReadUint8();                      uint8_t id2 = _3ewg->ReadUint8();
4763    
4764                      if (id1 == 4 && id2 == 16) {                      if (id2 == 16) {
4765                          pMidiRules[i++] = new MidiRuleCtrlTrigger(_3ewg);                          if (id1 == 4) {
4766                                pMidiRules[i++] = new MidiRuleCtrlTrigger(_3ewg);
4767                            } else if (id1 == 0) {
4768                                pMidiRules[i++] = new MidiRuleLegato(_3ewg);
4769                            } else if (id1 == 3) {
4770                                pMidiRules[i++] = new MidiRuleAlternator(_3ewg);
4771                            } else {
4772                                pMidiRules[i++] = new MidiRuleUnknown;
4773                            }
4774                        }
4775                        else if (id1 != 0 || id2 != 0) {
4776                            pMidiRules[i++] = new MidiRuleUnknown;
4777                      }                      }
4778                      //TODO: all the other types of rules                      //TODO: all the other types of rules
4779    
# Line 3090  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4799  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4799              }              }
4800          }          }
4801    
4802            // own gig format extensions
4803            RIFF::List* lst3LS = insList->GetSubList(LIST_TYPE_3LS);
4804            if (lst3LS) {
4805                RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4806                if (ckSCSL) {
4807                    ckSCSL->SetPos(0);
4808    
4809                    int headerSize = ckSCSL->ReadUint32();
4810                    int slotCount  = ckSCSL->ReadUint32();
4811                    if (slotCount) {
4812                        int slotSize  = ckSCSL->ReadUint32();
4813                        ckSCSL->SetPos(headerSize); // in case of future header extensions
4814                        int unknownSpace = slotSize - 2*sizeof(uint32_t); // in case of future slot extensions
4815                        for (int i = 0; i < slotCount; ++i) {
4816                            _ScriptPooolEntry e;
4817                            e.fileOffset = ckSCSL->ReadUint32();
4818                            e.bypass     = ckSCSL->ReadUint32() & 1;
4819                            if (unknownSpace) ckSCSL->SetPos(unknownSpace, RIFF::stream_curpos); // in case of future extensions
4820                            scriptPoolFileOffsets.push_back(e);
4821                        }
4822                    }
4823                }
4824            }
4825    
4826          __notify_progress(pProgress, 1.0f); // notify done          __notify_progress(pProgress, 1.0f); // notify done
4827      }      }
4828    
# Line 3099  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4832  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4832          RegionList::iterator end  = pRegions->end();          RegionList::iterator end  = pRegions->end();
4833          for (; iter != end; ++iter) {          for (; iter != end; ++iter) {
4834              gig::Region* pRegion = static_cast<gig::Region*>(*iter);              gig::Region* pRegion = static_cast<gig::Region*>(*iter);
4835              for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {              const int low  = std::max(int(pRegion->KeyRange.low), 0);
4836                const int high = std::min(int(pRegion->KeyRange.high), 127);
4837                for (int iKey = low; iKey <= high; iKey++) {
4838                  RegionKeyTable[iKey] = pRegion;                  RegionKeyTable[iKey] = pRegion;
4839              }              }
4840          }          }
# Line 3110  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4845  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4845              delete pMidiRules[i];              delete pMidiRules[i];
4846          }          }
4847          delete[] pMidiRules;          delete[] pMidiRules;
4848            if (pScriptRefs) delete pScriptRefs;
4849      }      }
4850    
4851      /**      /**
# Line 3119  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4855  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4855       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
4856       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
4857       *       *
4858         * @param pProgress - callback function for progress notification
4859       * @throws gig::Exception if samples cannot be dereferenced       * @throws gig::Exception if samples cannot be dereferenced
4860       */       */
4861      void Instrument::UpdateChunks() {      void Instrument::UpdateChunks(progress_t* pProgress) {
4862          // first update base classes' chunks          // first update base classes' chunks
4863          DLS::Instrument::UpdateChunks();          DLS::Instrument::UpdateChunks(pProgress);
4864    
4865          // update Regions' chunks          // update Regions' chunks
4866          {          {
4867              RegionList::iterator iter = pRegions->begin();              RegionList::iterator iter = pRegions->begin();
4868              RegionList::iterator end  = pRegions->end();              RegionList::iterator end  = pRegions->end();
4869              for (; iter != end; ++iter)              for (; iter != end; ++iter)
4870                  (*iter)->UpdateChunks();                  (*iter)->UpdateChunks(pProgress);
4871          }          }
4872    
4873          // make sure 'lart' RIFF list chunk exists          // make sure 'lart' RIFF list chunk exists
# Line 3142  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4879  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4879              File* pFile = (File*) GetParent();              File* pFile = (File*) GetParent();
4880    
4881              // 3ewg is bigger in gig3, as it includes the iMIDI rules              // 3ewg is bigger in gig3, as it includes the iMIDI rules
4882              int size = (pFile->pVersion && pFile->pVersion->major == 3) ? 16416 : 12;              int size = (pFile->pVersion && pFile->pVersion->major > 2) ? 16416 : 12;
4883              _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);              _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);
4884              memset(_3ewg->LoadChunkData(), 0, size);              memset(_3ewg->LoadChunkData(), 0, size);
4885          }          }
# Line 3156  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4893  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4893                                      DimensionKeyRange.low << 1;                                      DimensionKeyRange.low << 1;
4894          pData[10] = dimkeystart;          pData[10] = dimkeystart;
4895          pData[11] = DimensionKeyRange.high;          pData[11] = DimensionKeyRange.high;
4896    
4897            if (pMidiRules[0] == 0 && _3ewg->GetSize() >= 34) {
4898                pData[32] = 0;
4899                pData[33] = 0;
4900            } else {
4901                for (int i = 0 ; pMidiRules[i] ; i++) {
4902                    pMidiRules[i]->UpdateChunks(pData);
4903                }
4904            }
4905    
4906            // own gig format extensions
4907           if (ScriptSlotCount()) {
4908               // make sure we have converted the original loaded script file
4909               // offsets into valid Script object pointers
4910               LoadScripts();
4911    
4912               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4913               if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);
4914               const int slotCount = (int) pScriptRefs->size();
4915               const int headerSize = 3 * sizeof(uint32_t);
4916               const int slotSize  = 2 * sizeof(uint32_t);
4917               const int totalChunkSize = headerSize + slotCount * slotSize;
4918               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4919               if (!ckSCSL) ckSCSL = lst3LS->AddSubChunk(CHUNK_ID_SCSL, totalChunkSize);
4920               else ckSCSL->Resize(totalChunkSize);
4921               uint8_t* pData = (uint8_t*) ckSCSL->LoadChunkData();
4922               int pos = 0;
4923               store32(&pData[pos], headerSize);
4924               pos += sizeof(uint32_t);
4925               store32(&pData[pos], slotCount);
4926               pos += sizeof(uint32_t);
4927               store32(&pData[pos], slotSize);
4928               pos += sizeof(uint32_t);
4929               for (int i = 0; i < slotCount; ++i) {
4930                   // arbitrary value, the actual file offset will be updated in
4931                   // UpdateScriptFileOffsets() after the file has been resized
4932                   int bogusFileOffset = 0;
4933                   store32(&pData[pos], bogusFileOffset);
4934                   pos += sizeof(uint32_t);
4935                   store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0);
4936                   pos += sizeof(uint32_t);
4937               }
4938           } else {
4939               // no script slots, so get rid of any LS custom RIFF chunks (if any)
4940               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4941               if (lst3LS) pCkInstrument->DeleteSubChunk(lst3LS);
4942           }
4943        }
4944    
4945        void Instrument::UpdateScriptFileOffsets() {
4946           // own gig format extensions
4947           if (pScriptRefs && pScriptRefs->size() > 0) {
4948               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4949               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4950               const int slotCount = (int) pScriptRefs->size();
4951               const int headerSize = 3 * sizeof(uint32_t);
4952               ckSCSL->SetPos(headerSize);
4953               for (int i = 0; i < slotCount; ++i) {
4954                   uint32_t fileOffset = uint32_t(
4955                        (*pScriptRefs)[i].script->pChunk->GetFilePos() -
4956                        (*pScriptRefs)[i].script->pChunk->GetPos() -
4957                        CHUNK_HEADER_SIZE(ckSCSL->GetFile()->GetFileOffsetSize())
4958                   );
4959                   ckSCSL->WriteUint32(&fileOffset);
4960                   // jump over flags entry (containing the bypass flag)
4961                   ckSCSL->SetPos(sizeof(uint32_t), RIFF::stream_curpos);
4962               }
4963           }        
4964      }      }
4965    
4966      /**      /**
# Line 3210  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5015  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5015          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
5016          Region* pNewRegion = new Region(this, rgn);          Region* pNewRegion = new Region(this, rgn);
5017          pRegions->push_back(pNewRegion);          pRegions->push_back(pNewRegion);
5018          Regions = pRegions->size();          Regions = (uint32_t) pRegions->size();
5019          // update Region key table for fast lookup          // update Region key table for fast lookup
5020          UpdateRegionKeyTable();          UpdateRegionKeyTable();
5021          // done          // done
# Line 3225  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5030  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5030      }      }
5031    
5032      /**      /**
5033         * Move this instrument at the position before @arg dst.
5034         *
5035         * This method can be used to reorder the sequence of instruments in a
5036         * .gig file. This might be helpful especially on large .gig files which
5037         * contain a large number of instruments within the same .gig file. So
5038         * grouping such instruments to similar ones, can help to keep track of them
5039         * when working with such complex .gig files.
5040         *
5041         * When calling this method, this instrument will be removed from in its
5042         * current position in the instruments list and moved to the requested
5043         * target position provided by @param dst. You may also pass NULL as
5044         * argument to this method, in that case this intrument will be moved to the
5045         * very end of the .gig file's instrument list.
5046         *
5047         * You have to call Save() to make the order change persistent to the .gig
5048         * file.
5049         *
5050         * Currently this method is limited to moving the instrument within the same
5051         * .gig file. Trying to move it to another .gig file by calling this method
5052         * will throw an exception.
5053         *
5054         * @param dst - destination instrument at which this instrument will be
5055         *              moved to, or pass NULL for moving to end of list
5056         * @throw gig::Exception if this instrument and target instrument are not
5057         *                       part of the same file
5058         */
5059        void Instrument::MoveTo(Instrument* dst) {
5060            if (dst && GetParent() != dst->GetParent())
5061                throw Exception(
5062                    "gig::Instrument::MoveTo() can only be used for moving within "
5063                    "the same gig file."
5064                );
5065    
5066            File* pFile = (File*) GetParent();
5067    
5068            // move this instrument within the instrument list
5069            {
5070                File::InstrumentList& list = *pFile->pInstruments;
5071    
5072                File::InstrumentList::iterator itFrom =
5073                    std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(this));
5074    
5075                File::InstrumentList::iterator itTo =
5076                    std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(dst));
5077    
5078                list.splice(itTo, list, itFrom);
5079            }
5080    
5081            // move the instrument's actual list RIFF chunk appropriately
5082            RIFF::List* lstCkInstruments = pFile->pRIFF->GetSubList(LIST_TYPE_LINS);
5083            lstCkInstruments->MoveSubChunk(
5084                this->pCkInstrument,
5085                (RIFF::Chunk*) ((dst) ? dst->pCkInstrument : NULL)
5086            );
5087        }
5088    
5089        /**
5090       * Returns a MIDI rule of the instrument.       * Returns a MIDI rule of the instrument.
5091       *       *
5092       * The list of MIDI rules, at least in gig v3, always contains at       * The list of MIDI rules, at least in gig v3, always contains at
# Line 3237  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5099  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5099      MidiRule* Instrument::GetMidiRule(int i) {      MidiRule* Instrument::GetMidiRule(int i) {
5100          return pMidiRules[i];          return pMidiRules[i];
5101      }      }
5102        
5103        /**
5104         * Adds the "controller trigger" MIDI rule to the instrument.
5105         *
5106         * @returns the new MIDI rule
5107         */
5108        MidiRuleCtrlTrigger* Instrument::AddMidiRuleCtrlTrigger() {
5109            delete pMidiRules[0];
5110            MidiRuleCtrlTrigger* r = new MidiRuleCtrlTrigger;
5111            pMidiRules[0] = r;
5112            pMidiRules[1] = 0;
5113            return r;
5114        }
5115    
5116        /**
5117         * Adds the legato MIDI rule to the instrument.
5118         *
5119         * @returns the new MIDI rule
5120         */
5121        MidiRuleLegato* Instrument::AddMidiRuleLegato() {
5122            delete pMidiRules[0];
5123            MidiRuleLegato* r = new MidiRuleLegato;
5124            pMidiRules[0] = r;
5125            pMidiRules[1] = 0;
5126            return r;
5127        }
5128    
5129        /**
5130         * Adds the alternator MIDI rule to the instrument.
5131         *
5132         * @returns the new MIDI rule
5133         */
5134        MidiRuleAlternator* Instrument::AddMidiRuleAlternator() {
5135            delete pMidiRules[0];
5136            MidiRuleAlternator* r = new MidiRuleAlternator;
5137            pMidiRules[0] = r;
5138            pMidiRules[1] = 0;
5139            return r;
5140        }
5141    
5142        /**
5143         * Deletes a MIDI rule from the instrument.
5144         *
5145         * @param i - MIDI rule number
5146         */
5147        void Instrument::DeleteMidiRule(int i) {
5148            delete pMidiRules[i];
5149            pMidiRules[i] = 0;
5150        }
5151    
5152        void Instrument::LoadScripts() {
5153            if (pScriptRefs) return;
5154            pScriptRefs = new std::vector<_ScriptPooolRef>;
5155            if (scriptPoolFileOffsets.empty()) return;
5156            File* pFile = (File*) GetParent();
5157            for (uint k = 0; k < scriptPoolFileOffsets.size(); ++k) {
5158                uint32_t soughtOffset = scriptPoolFileOffsets[k].fileOffset;
5159                for (uint i = 0; pFile->GetScriptGroup(i); ++i) {
5160                    ScriptGroup* group = pFile->GetScriptGroup(i);
5161                    for (uint s = 0; group->GetScript(s); ++s) {
5162                        Script* script = group->GetScript(s);
5163                        if (script->pChunk) {
5164                            uint32_t offset = uint32_t(
5165                                script->pChunk->GetFilePos() -
5166                                script->pChunk->GetPos() -
5167                                CHUNK_HEADER_SIZE(script->pChunk->GetFile()->GetFileOffsetSize())
5168                            );
5169                            if (offset == soughtOffset)
5170                            {
5171                                _ScriptPooolRef ref;
5172                                ref.script = script;
5173                                ref.bypass = scriptPoolFileOffsets[k].bypass;
5174                                pScriptRefs->push_back(ref);
5175                                break;
5176                            }
5177                        }
5178                    }
5179                }
5180            }
5181            // we don't need that anymore
5182            scriptPoolFileOffsets.clear();
5183        }
5184    
5185        /** @brief Get instrument script (gig format extension).
5186         *
5187         * Returns the real-time instrument script of instrument script slot
5188         * @a index.
5189         *
5190         * @note This is an own format extension which did not exist i.e. in the
5191         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5192         * gigedit.
5193         *
5194         * @param index - instrument script slot index
5195         * @returns script or NULL if index is out of bounds
5196         */
5197        Script* Instrument::GetScriptOfSlot(uint index) {
5198            LoadScripts();
5199            if (index >= pScriptRefs->size()) return NULL;
5200            return pScriptRefs->at(index).script;
5201        }
5202    
5203        /** @brief Add new instrument script slot (gig format extension).
5204         *
5205         * Add the given real-time instrument script reference to this instrument,
5206         * which shall be executed by the sampler for for this instrument. The
5207         * script will be added to the end of the script list of this instrument.
5208         * The positions of the scripts in the Instrument's Script list are
5209         * relevant, because they define in which order they shall be executed by
5210         * the sampler. For this reason it is also legal to add the same script
5211         * twice to an instrument, for example you might have a script called
5212         * "MyFilter" which performs an event filter task, and you might have
5213         * another script called "MyNoteTrigger" which triggers new notes, then you
5214         * might for example have the following list of scripts on the instrument:
5215         *
5216         * 1. Script "MyFilter"
5217         * 2. Script "MyNoteTrigger"
5218         * 3. Script "MyFilter"
5219         *
5220         * Which would make sense, because the 2nd script launched new events, which
5221         * you might need to filter as well.
5222         *
5223         * There are two ways to disable / "bypass" scripts. You can either disable
5224         * a script locally for the respective script slot on an instrument (i.e. by
5225         * passing @c false to the 2nd argument of this method, or by calling
5226         * SetScriptBypassed()). Or you can disable a script globally for all slots
5227         * and all instruments by setting Script::Bypass.
5228         *
5229         * @note This is an own format extension which did not exist i.e. in the
5230         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5231         * gigedit.
5232         *
5233         * @param pScript - script that shall be executed for this instrument
5234         * @param bypass  - if enabled, the sampler shall skip executing this
5235         *                  script (in the respective list position)
5236         * @see SetScriptBypassed()
5237         */
5238        void Instrument::AddScriptSlot(Script* pScript, bool bypass) {
5239            LoadScripts();
5240            _ScriptPooolRef ref = { pScript, bypass };
5241            pScriptRefs->push_back(ref);
5242        }
5243    
5244        /** @brief Flip two script slots with each other (gig format extension).
5245         *
5246         * Swaps the position of the two given scripts in the Instrument's Script
5247         * list. The positions of the scripts in the Instrument's Script list are
5248         * relevant, because they define in which order they shall be executed by
5249         * the sampler.
5250         *
5251         * @note This is an own format extension which did not exist i.e. in the
5252         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5253         * gigedit.
5254         *
5255         * @param index1 - index of the first script slot to swap
5256         * @param index2 - index of the second script slot to swap
5257         */
5258        void Instrument::SwapScriptSlots(uint index1, uint index2) {
5259            LoadScripts();
5260            if (index1 >= pScriptRefs->size() || index2 >= pScriptRefs->size())
5261                return;
5262            _ScriptPooolRef tmp = (*pScriptRefs)[index1];
5263            (*pScriptRefs)[index1] = (*pScriptRefs)[index2];
5264            (*pScriptRefs)[index2] = tmp;
5265        }
5266    
5267        /** @brief Remove script slot.
5268         *
5269         * Removes the script slot with the given slot index.
5270         *
5271         * @param index - index of script slot to remove
5272         */
5273        void Instrument::RemoveScriptSlot(uint index) {
5274            LoadScripts();
5275            if (index >= pScriptRefs->size()) return;
5276            pScriptRefs->erase( pScriptRefs->begin() + index );
5277        }
5278    
5279        /** @brief Remove reference to given Script (gig format extension).
5280         *
5281         * This will remove all script slots on the instrument which are referencing
5282         * the given script.
5283         *
5284         * @note This is an own format extension which did not exist i.e. in the
5285         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5286         * gigedit.
5287         *
5288         * @param pScript - script reference to remove from this instrument
5289         * @see RemoveScriptSlot()
5290         */
5291        void Instrument::RemoveScript(Script* pScript) {
5292            LoadScripts();
5293            for (ssize_t i = pScriptRefs->size() - 1; i >= 0; --i) {
5294                if ((*pScriptRefs)[i].script == pScript) {
5295                    pScriptRefs->erase( pScriptRefs->begin() + i );
5296                }
5297            }
5298        }
5299    
5300        /** @brief Instrument's amount of script slots.
5301         *
5302         * This method returns the amount of script slots this instrument currently
5303         * uses.
5304         *
5305         * A script slot is a reference of a real-time instrument script to be
5306         * executed by the sampler. The scripts will be executed by the sampler in
5307         * sequence of the slots. One (same) script may be referenced multiple
5308         * times in different slots.
5309         *
5310         * @note This is an own format extension which did not exist i.e. in the
5311         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5312         * gigedit.
5313         */
5314        uint Instrument::ScriptSlotCount() const {
5315            return uint(pScriptRefs ? pScriptRefs->size() : scriptPoolFileOffsets.size());
5316        }
5317    
5318        /** @brief Whether script execution shall be skipped.
5319         *
5320         * Defines locally for the Script reference slot in the Instrument's Script
5321         * list, whether the script shall be skipped by the sampler regarding
5322         * execution.
5323         *
5324         * It is also possible to ignore exeuction of the script globally, for all
5325         * slots and for all instruments by setting Script::Bypass.
5326         *
5327         * @note This is an own format extension which did not exist i.e. in the
5328         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5329         * gigedit.
5330         *
5331         * @param index - index of the script slot on this instrument
5332         * @see Script::Bypass
5333         */
5334        bool Instrument::IsScriptSlotBypassed(uint index) {
5335            if (index >= ScriptSlotCount()) return false;
5336            return pScriptRefs ? pScriptRefs->at(index).bypass
5337                               : scriptPoolFileOffsets.at(index).bypass;
5338            
5339        }
5340    
5341        /** @brief Defines whether execution shall be skipped.
5342         *
5343         * You can call this method to define locally whether or whether not the
5344         * given script slot shall be executed by the sampler.
5345         *
5346         * @note This is an own format extension which did not exist i.e. in the
5347         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5348         * gigedit.
5349         *
5350         * @param index - script slot index on this instrument
5351         * @param bBypass - if true, the script slot will be skipped by the sampler
5352         * @see Script::Bypass
5353         */
5354        void Instrument::SetScriptSlotBypassed(uint index, bool bBypass) {
5355            if (index >= ScriptSlotCount()) return;
5356            if (pScriptRefs)
5357                pScriptRefs->at(index).bypass = bBypass;
5358            else
5359                scriptPoolFileOffsets.at(index).bypass = bBypass;
5360        }
5361    
5362      /**      /**
5363       * Make a (semi) deep copy of the Instrument object given by @a orig       * Make a (semi) deep copy of the Instrument object given by @a orig
5364       * and assign it to this object.       * and assign it to this object.
# Line 3248  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5369  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5369       * @param orig - original Instrument object to be copied from       * @param orig - original Instrument object to be copied from
5370       */       */
5371      void Instrument::CopyAssign(const Instrument* orig) {      void Instrument::CopyAssign(const Instrument* orig) {
5372            CopyAssign(orig, NULL);
5373        }
5374            
5375        /**
5376         * Make a (semi) deep copy of the Instrument object given by @a orig
5377         * and assign it to this object.
5378         *
5379         * @param orig - original Instrument object to be copied from
5380         * @param mSamples - crosslink map between the foreign file's samples and
5381         *                   this file's samples
5382         */
5383        void Instrument::CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples) {
5384          // handle base class          // handle base class
5385          // (without copying DLS region stuff)          // (without copying DLS region stuff)
5386          DLS::Instrument::CopyAssignCore(orig);          DLS::Instrument::CopyAssignCore(orig);
# Line 3259  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5392  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5392          PitchbendRange = orig->PitchbendRange;          PitchbendRange = orig->PitchbendRange;
5393          PianoReleaseMode = orig->PianoReleaseMode;          PianoReleaseMode = orig->PianoReleaseMode;
5394          DimensionKeyRange = orig->DimensionKeyRange;          DimensionKeyRange = orig->DimensionKeyRange;
5395            scriptPoolFileOffsets = orig->scriptPoolFileOffsets;
5396            pScriptRefs = orig->pScriptRefs;
5397                    
5398          // free old midi rules          // free old midi rules
5399          for (int i = 0 ; pMidiRules[i] ; i++) {          for (int i = 0 ; pMidiRules[i] ; i++) {
# Line 3276  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5411  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5411                  Region* dstRgn = AddRegion();                  Region* dstRgn = AddRegion();
5412                  //NOTE: Region does semi-deep copy !                  //NOTE: Region does semi-deep copy !
5413                  dstRgn->CopyAssign(                  dstRgn->CopyAssign(
5414                      static_cast<gig::Region*>(*it)                      static_cast<gig::Region*>(*it),
5415                        mSamples
5416                  );                  );
5417              }              }
5418          }          }
# Line 3300  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5436  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5436          ::LoadString(pNameChunk, Name);          ::LoadString(pNameChunk, Name);
5437      }      }
5438    
5439        /** @brief Destructor.
5440         *
5441         * Currently this destructor implementation does nothing.
5442         */
5443      Group::~Group() {      Group::~Group() {
5444          // remove the chunk associated with this group (if any)      }
5445          if (pNameChunk) pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);  
5446        /** @brief Remove all RIFF chunks associated with this Group object.
5447         *
5448         * See DLS::Storage::DeleteChunks() for details.
5449         */
5450        void Group::DeleteChunks() {
5451            // handle own RIFF chunks
5452            if (pNameChunk) {
5453                pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
5454                pNameChunk = NULL;
5455            }
5456      }      }
5457    
5458      /** @brief Update chunks with current group settings.      /** @brief Update chunks with current group settings.
# Line 3312  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5462  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5462       *       *
5463       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
5464       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
5465         *
5466         * @param pProgress - callback function for progress notification
5467       */       */
5468      void Group::UpdateChunks() {      void Group::UpdateChunks(progress_t* pProgress) {
5469          // make sure <3gri> and <3gnl> list chunks exist          // make sure <3gri> and <3gnl> list chunks exist
5470          RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);          RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);
5471          if (!_3gri) {          if (!_3gri) {
# Line 3323  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5475  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5475          RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);          RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
5476          if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);          if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
5477    
5478          if (!pNameChunk && pFile->pVersion && pFile->pVersion->major == 3) {          if (!pNameChunk && pFile->pVersion && pFile->pVersion->major > 2) {
5479              // v3 has a fixed list of 128 strings, find a free one              // v3 has a fixed list of 128 strings, find a free one
5480              for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {              for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {
5481                  if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {                  if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {
# Line 3418  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5570  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5570          0, 3, 20030331 & 0xffff, 20030331 >> 16          0, 3, 20030331 & 0xffff, 20030331 >> 16
5571      };      };
5572    
5573        /// Reflects Gigasampler file format version 4.0 (2007-10-12).
5574        const DLS::version_t File::VERSION_4 = {
5575            0, 4, 20071012 & 0xffff, 20071012 >> 16
5576        };
5577    
5578      static const DLS::Info::string_length_t _FileFixedStringLengths[] = {      static const DLS::Info::string_length_t _FileFixedStringLengths[] = {
5579          { CHUNK_ID_IARL, 256 },          { CHUNK_ID_IARL, 256 },
5580          { CHUNK_ID_IART, 128 },          { CHUNK_ID_IART, 128 },
# Line 3443  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5600  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5600          bAutoLoad = true;          bAutoLoad = true;
5601          *pVersion = VERSION_3;          *pVersion = VERSION_3;
5602          pGroups = NULL;          pGroups = NULL;
5603            pScriptGroups = NULL;
5604          pInfo->SetFixedStringLengths(_FileFixedStringLengths);          pInfo->SetFixedStringLengths(_FileFixedStringLengths);
5605          pInfo->ArchivalLocation = String(256, ' ');          pInfo->ArchivalLocation = String(256, ' ');
5606    
# Line 3458  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5616  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5616      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
5617          bAutoLoad = true;          bAutoLoad = true;
5618          pGroups = NULL;          pGroups = NULL;
5619            pScriptGroups = NULL;
5620          pInfo->SetFixedStringLengths(_FileFixedStringLengths);          pInfo->SetFixedStringLengths(_FileFixedStringLengths);
5621      }      }
5622    
# Line 3471  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5630  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5630              }              }
5631              delete pGroups;              delete pGroups;
5632          }          }
5633            if (pScriptGroups) {
5634                std::list<ScriptGroup*>::iterator iter = pScriptGroups->begin();
5635                std::list<ScriptGroup*>::iterator end  = pScriptGroups->end();
5636                while (iter != end) {
5637                    delete *iter;
5638                    ++iter;
5639                }
5640                delete pScriptGroups;
5641            }
5642      }      }
5643    
5644      Sample* File::GetFirstSample(progress_t* pProgress) {      Sample* File::GetFirstSample(progress_t* pProgress) {
# Line 3485  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5653  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5653          SamplesIterator++;          SamplesIterator++;
5654          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
5655      }      }
5656        
5657        /**
5658         * Returns Sample object of @a index.
5659         *
5660         * @returns sample object or NULL if index is out of bounds
5661         */
5662        Sample* File::GetSample(uint index) {
5663            if (!pSamples) LoadSamples();
5664            if (!pSamples) return NULL;
5665            DLS::File::SampleList::iterator it = pSamples->begin();
5666            for (int i = 0; i < index; ++i) {
5667                ++it;
5668                if (it == pSamples->end()) return NULL;
5669            }
5670            if (it == pSamples->end()) return NULL;
5671            return static_cast<gig::Sample*>( *it );
5672        }
5673    
5674        /**
5675         * Returns the total amount of samples of this gig file.
5676         *
5677         * Note that this method might block for a long time in case it is required
5678         * to load the sample info for the first time.
5679         *
5680         * @returns total amount of samples
5681         */
5682        size_t File::CountSamples() {
5683            if (!pSamples) LoadSamples();
5684            if (!pSamples) return 0;
5685            return pSamples->size();
5686        }
5687    
5688      /** @brief Add a new sample.      /** @brief Add a new sample.
5689       *       *
# Line 3524  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5723  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5723          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");
5724          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
5725          pSamples->erase(iter);          pSamples->erase(iter);
5726            pSample->DeleteChunks();
5727          delete pSample;          delete pSample;
5728    
5729          SampleList::iterator tmp = SamplesIterator;          SampleList::iterator tmp = SamplesIterator;
# Line 3561  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5761  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5761          int iSampleIndex  = 0;          int iSampleIndex  = 0;
5762          int iTotalSamples = WavePoolCount;          int iTotalSamples = WavePoolCount;
5763    
5764          // check if samples should be loaded from extension files          // just for assembling path of optional extension files to be read
5765          int lastFileNo = 0;          const std::string folder = parentPath(pRIFF->GetFileName());
5766          for (int i = 0 ; i < WavePoolCount ; i++) {          const std::string baseName = pathWithoutExtension(pRIFF->GetFileName());
5767              if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];  
5768          }          // the main gig file and the extension files (.gx01, ... , .gx98) may
5769          String name(pRIFF->GetFileName());          // contain wave data (wave pool)
5770          int nameLen = name.length();          std::vector<RIFF::File*> poolFiles;
5771          char suffix[6];          poolFiles.push_back(pRIFF);
5772          if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;  
5773            // get info about all extension files
5774          for (int fileNo = 0 ; ; ) {          RIFF::Chunk* ckXfil = pRIFF->GetSubChunk(CHUNK_ID_XFIL);
5775            if (ckXfil) { // there are extension files (.gx01, ... , .gx98) ...
5776                const uint32_t n = ckXfil->ReadInt32();
5777                for (int i = 0; i < n; i++) {
5778                    // read the filename and load the extension file
5779                    std::string name;
5780                    ckXfil->ReadString(name, 128);
5781                    std::string path = concatPath(folder, name);
5782                    RIFF::File* pExtFile = new RIFF::File(path);
5783                    // check that the dlsids match
5784                    RIFF::Chunk* ckDLSID = pExtFile->GetSubChunk(CHUNK_ID_DLID);
5785                    if (ckDLSID) {
5786                        ::DLS::dlsid_t idExpected;
5787                        idExpected.ulData1 = ckXfil->ReadInt32();
5788                        idExpected.usData2 = ckXfil->ReadInt16();
5789                        idExpected.usData3 = ckXfil->ReadInt16();
5790                        ckXfil->Read(idExpected.abData, 8, 1);
5791                        ::DLS::dlsid_t idFound;
5792                        ckDLSID->Read(&idFound.ulData1, 1, 4);
5793                        ckDLSID->Read(&idFound.usData2, 1, 2);
5794                        ckDLSID->Read(&idFound.usData3, 1, 2);
5795                        ckDLSID->Read(idFound.abData, 8, 1);
5796                        if (memcmp(&idExpected, &idFound, 16) != 0)
5797                            throw gig::Exception("dlsid mismatch for extension file: %s", path.c_str());
5798                    }
5799                    poolFiles.push_back(pExtFile);
5800                    ExtensionFiles.push_back(pExtFile);
5801                }
5802            }
5803    
5804            // check if a .gx99 (GigaPulse) file exists
5805            RIFF::Chunk* ckDoxf = pRIFF->GetSubChunk(CHUNK_ID_DOXF);
5806            if (ckDoxf) { // there is a .gx99 (GigaPulse) file ...
5807                std::string path = baseName + ".gx99";
5808                RIFF::File* pExtFile = new RIFF::File(path);
5809    
5810                // skip unused int and filename
5811                ckDoxf->SetPos(132, RIFF::stream_curpos);
5812    
5813                // check that the dlsids match
5814                RIFF::Chunk* ckDLSID = pExtFile->GetSubChunk(CHUNK_ID_DLID);
5815                if (ckDLSID) {
5816                    ::DLS::dlsid_t idExpected;
5817                    idExpected.ulData1 = ckDoxf->ReadInt32();
5818                    idExpected.usData2 = ckDoxf->ReadInt16();
5819                    idExpected.usData3 = ckDoxf->ReadInt16();
5820                    ckDoxf->Read(idExpected.abData, 8, 1);
5821                    ::DLS::dlsid_t idFound;
5822                    ckDLSID->Read(&idFound.ulData1, 1, 4);
5823                    ckDLSID->Read(&idFound.usData2, 1, 2);
5824                    ckDLSID->Read(&idFound.usData3, 1, 2);
5825                    ckDLSID->Read(idFound.abData, 8, 1);
5826                    if (memcmp(&idExpected, &idFound, 16) != 0)
5827                        throw gig::Exception("dlsid mismatch for GigaPulse file: %s", path.c_str());
5828                }
5829                poolFiles.push_back(pExtFile);
5830                ExtensionFiles.push_back(pExtFile);
5831            }
5832    
5833            // load samples from extension files (if required)
5834            for (int i = 0; i < poolFiles.size(); i++) {
5835                RIFF::File* file = poolFiles[i];
5836              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
5837              if (wvpl) {              if (wvpl) {
5838                  unsigned long wvplFileOffset = wvpl->GetFilePos();                  file_offset_t wvplFileOffset = wvpl->GetFilePos() -
5839                                                   wvpl->GetPos(); // should be zero, but just to be sure
5840                  RIFF::List* wave = wvpl->GetFirstSubList();                  RIFF::List* wave = wvpl->GetFirstSubList();
5841                  while (wave) {                  while (wave) {
5842                      if (wave->GetListType() == LIST_TYPE_WAVE) {                      if (wave->GetListType() == LIST_TYPE_WAVE) {
# Line 3582  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5844  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5844                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
5845                          __notify_progress(pProgress, subprogress);                          __notify_progress(pProgress, subprogress);
5846    
5847                          unsigned long waveFileOffset = wave->GetFilePos();                          file_offset_t waveFileOffset = wave->GetFilePos();
5848                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, i, iSampleIndex));
5849    
5850                          iSampleIndex++;                          iSampleIndex++;
5851                      }                      }
5852                      wave = wvpl->GetNextSubList();                      wave = wvpl->GetNextSubList();
5853                  }                  }
5854                }
                 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;  
5855          }          }
5856    
5857          __notify_progress(pProgress, 1.0); // notify done          __notify_progress(pProgress, 1.0); // notify done
# Line 3618  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5871  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5871      }      }
5872    
5873      /**      /**
5874         * Returns the total amount of instruments of this gig file.
5875         *
5876         * Note that this method might block for a long time in case it is required
5877         * to load the instruments info for the first time.
5878         *
5879         * @returns total amount of instruments
5880         */
5881        size_t File::CountInstruments() {
5882            if (!pInstruments) LoadInstruments();
5883            if (!pInstruments) return 0;
5884            return pInstruments->size();
5885        }
5886    
5887        /**
5888       * Returns the instrument with the given index.       * Returns the instrument with the given index.
5889       *       *
5890       * @param index     - number of the sought instrument (0..n)       * @param index     - number of the sought instrument (0..n)
# Line 3703  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5970  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5970          instr->CopyAssign(orig);          instr->CopyAssign(orig);
5971          return instr;          return instr;
5972      }      }
5973        
5974        /** @brief Add content of another existing file.
5975         *
5976         * Duplicates the samples, groups and instruments of the original file
5977         * given by @a pFile and adds them to @c this File. In case @c this File is
5978         * a new one that you haven't saved before, then you have to call
5979         * SetFileName() before calling AddContentOf(), because this method will
5980         * automatically save this file during operation, which is required for
5981         * writing the sample waveform data by disk streaming.
5982         *
5983         * @param pFile - original file whose's content shall be copied from
5984         */
5985        void File::AddContentOf(File* pFile) {
5986            static int iCallCount = -1;
5987            iCallCount++;
5988            std::map<Group*,Group*> mGroups;
5989            std::map<Sample*,Sample*> mSamples;
5990            
5991            // clone sample groups
5992            for (int i = 0; pFile->GetGroup(i); ++i) {
5993                Group* g = AddGroup();
5994                g->Name =
5995                    "COPY" + ToString(iCallCount) + "_" + pFile->GetGroup(i)->Name;
5996                mGroups[pFile->GetGroup(i)] = g;
5997            }
5998            
5999            // clone samples (not waveform data here yet)
6000            for (int i = 0; pFile->GetSample(i); ++i) {
6001                Sample* s = AddSample();
6002                s->CopyAssignMeta(pFile->GetSample(i));
6003                mGroups[pFile->GetSample(i)->GetGroup()]->AddSample(s);
6004                mSamples[pFile->GetSample(i)] = s;
6005            }
6006    
6007            // clone script groups and their scripts
6008            for (int iGroup = 0; pFile->GetScriptGroup(iGroup); ++iGroup) {
6009                ScriptGroup* sg = pFile->GetScriptGroup(iGroup);
6010                ScriptGroup* dg = AddScriptGroup();
6011                dg->Name = "COPY" + ToString(iCallCount) + "_" + sg->Name;
6012                for (int iScript = 0; sg->GetScript(iScript); ++iScript) {
6013                    Script* ss = sg->GetScript(iScript);
6014                    Script* ds = dg->AddScript();
6015                    ds->CopyAssign(ss);
6016                }
6017            }
6018    
6019            //BUG: For some reason this method only works with this additional
6020            //     Save() call in between here.
6021            //
6022            // Important: The correct one of the 2 Save() methods has to be called
6023            // here, depending on whether the file is completely new or has been
6024            // saved to disk already, otherwise it will result in data corruption.
6025            if (pRIFF->IsNew())
6026                Save(GetFileName());
6027            else
6028                Save();
6029            
6030            // clone instruments
6031            // (passing the crosslink table here for the cloned samples)
6032            for (int i = 0; pFile->GetInstrument(i); ++i) {
6033                Instrument* instr = AddInstrument();
6034                instr->CopyAssign(pFile->GetInstrument(i), &mSamples);
6035            }
6036            
6037            // Mandatory: file needs to be saved to disk at this point, so this
6038            // file has the correct size and data layout for writing the samples'
6039            // waveform data to disk.
6040            Save();
6041            
6042            // clone samples' waveform data
6043            // (using direct read & write disk streaming)
6044            for (int i = 0; pFile->GetSample(i); ++i) {
6045                mSamples[pFile->GetSample(i)]->CopyAssignWave(pFile->GetSample(i));
6046            }
6047        }
6048    
6049      /** @brief Delete an instrument.      /** @brief Delete an instrument.
6050       *       *
# Line 3717  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6059  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6059          InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);          InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);
6060          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");
6061          pInstruments->erase(iter);          pInstruments->erase(iter);
6062            pInstrument->DeleteChunks();
6063          delete pInstrument;          delete pInstrument;
6064      }      }
6065    
# Line 3758  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6101  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6101          if (!_3crc) return;          if (!_3crc) return;
6102    
6103          // get the index of the sample          // get the index of the sample
6104          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;  
             }  
         }  
6105          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");
6106    
6107          // write the CRC-32 checksum to disk          // write the CRC-32 checksum to disk
6108          _3crc->SetPos(iWaveIndex * 8);          _3crc->SetPos(iWaveIndex * 8);
6109          uint32_t tmp = 1;          uint32_t one = 1;
6110          _3crc->WriteUint32(&tmp); // unknown, always 1?          _3crc->WriteUint32(&one); // always 1
6111          _3crc->WriteUint32(&crc);          _3crc->WriteUint32(&crc);
6112      }      }
6113    
6114        uint32_t File::GetSampleChecksum(Sample* pSample) {
6115            // get the index of the sample
6116            int iWaveIndex = GetWaveTableIndexOf(pSample);
6117            if (iWaveIndex < 0) throw gig::Exception("Could not retrieve reference crc of sample, could not resolve sample's wave table index");
6118    
6119            return GetSampleChecksumByIndex(iWaveIndex);
6120        }
6121    
6122        uint32_t File::GetSampleChecksumByIndex(int index) {
6123            if (index < 0) throw gig::Exception("Could not retrieve reference crc of sample, invalid wave pool index of sample");
6124    
6125            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6126            if (!_3crc) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
6127            uint8_t* pData = (uint8_t*) _3crc->LoadChunkData();
6128            if (!pData) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
6129    
6130            // read the CRC-32 checksum directly from disk
6131            size_t pos = index * 8;
6132            if (pos + 8 > _3crc->GetNewSize())
6133                throw gig::Exception("Could not retrieve reference crc of sample, could not seek to required position in crc chunk");
6134    
6135            uint32_t one = load32(&pData[pos]); // always 1
6136            if (one != 1)
6137                throw gig::Exception("Could not retrieve reference crc of sample, because reference checksum table is damaged");
6138    
6139            return load32(&pData[pos+4]);
6140        }
6141    
6142        int File::GetWaveTableIndexOf(gig::Sample* pSample) {
6143            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
6144            File::SampleList::iterator iter = pSamples->begin();
6145            File::SampleList::iterator end  = pSamples->end();
6146            for (int index = 0; iter != end; ++iter, ++index)
6147                if (*iter == pSample)
6148                    return index;
6149            return -1;
6150        }
6151    
6152        /**
6153         * Checks whether the file's "3CRC" chunk was damaged. This chunk contains
6154         * the CRC32 check sums of all samples' raw wave data.
6155         *
6156         * @return true if 3CRC chunk is OK, or false if 3CRC chunk is damaged
6157         */
6158        bool File::VerifySampleChecksumTable() {
6159            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6160            if (!_3crc) return false;
6161            if (_3crc->GetNewSize() <= 0) return false;
6162            if (_3crc->GetNewSize() % 8) return false;
6163            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
6164            if (_3crc->GetNewSize() != pSamples->size() * 8) return false;
6165    
6166            const file_offset_t n = _3crc->GetNewSize() / 8;
6167    
6168            uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6169            if (!pData) return false;
6170    
6171            for (file_offset_t i = 0; i < n; ++i) {
6172                uint32_t one = pData[i*2];
6173                if (one != 1) return false;
6174            }
6175    
6176            return true;
6177        }
6178    
6179        /**
6180         * Recalculates CRC32 checksums for all samples and rebuilds this gig
6181         * file's checksum table with those new checksums. This might usually
6182         * just be necessary if the checksum table was damaged.
6183         *
6184         * @e IMPORTANT: The current implementation of this method only works
6185         * with files that have not been modified since it was loaded, because
6186         * it expects that no externally caused file structure changes are
6187         * required!
6188         *
6189         * Due to the expectation above, this method is currently protected
6190         * and actually only used by the command line tool "gigdump" yet.
6191         *
6192         * @returns true if Save() is required to be called after this call,
6193         *          false if no further action is required
6194         */
6195        bool File::RebuildSampleChecksumTable() {
6196            // make sure sample chunks were scanned
6197            if (!pSamples) GetFirstSample();
6198    
6199            bool bRequiresSave = false;
6200    
6201            // make sure "3CRC" chunk exists with required size
6202            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6203            if (!_3crc) {
6204                _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
6205                // the order of einf and 3crc is not the same in v2 and v3
6206                RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
6207                if (einf && pVersion && pVersion->major > 2) pRIFF->MoveSubChunk(_3crc, einf);
6208                bRequiresSave = true;
6209            } else if (_3crc->GetNewSize() != pSamples->size() * 8) {
6210                _3crc->Resize(pSamples->size() * 8);
6211                bRequiresSave = true;
6212            }
6213    
6214            if (bRequiresSave) { // refill CRC table for all samples in RAM ...
6215                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6216                {
6217                    File::SampleList::iterator iter = pSamples->begin();
6218                    File::SampleList::iterator end  = pSamples->end();
6219                    for (; iter != end; ++iter) {
6220                        gig::Sample* pSample = (gig::Sample*) *iter;
6221                        int index = GetWaveTableIndexOf(pSample);
6222                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6223                        pData[index*2]   = 1; // always 1
6224                        pData[index*2+1] = pSample->CalculateWaveDataChecksum();
6225                    }
6226                }
6227            } else { // no file structure changes necessary, so directly write to disk and we are done ...
6228                // make sure file is in write mode
6229                pRIFF->SetMode(RIFF::stream_mode_read_write);
6230                {
6231                    File::SampleList::iterator iter = pSamples->begin();
6232                    File::SampleList::iterator end  = pSamples->end();
6233                    for (; iter != end; ++iter) {
6234                        gig::Sample* pSample = (gig::Sample*) *iter;
6235                        int index = GetWaveTableIndexOf(pSample);
6236                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6237                        pSample->crc  = pSample->CalculateWaveDataChecksum();
6238                        SetSampleChecksum(pSample, pSample->crc);
6239                    }
6240                }
6241            }
6242    
6243            return bRequiresSave;
6244        }
6245    
6246      Group* File::GetFirstGroup() {      Group* File::GetFirstGroup() {
6247          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6248          // there must always be at least one group          // there must always be at least one group
# Line 3805  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6272  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6272          return NULL;          return NULL;
6273      }      }
6274    
6275        /**
6276         * Returns the group with the given group name.
6277         *
6278         * Note: group names don't have to be unique in the gig format! So there
6279         * can be multiple groups with the same name. This method will simply
6280         * return the first group found with the given name.
6281         *
6282         * @param name - name of the sought group
6283         * @returns sought group or NULL if there's no group with that name
6284         */
6285        Group* File::GetGroup(String name) {
6286            if (!pGroups) LoadGroups();
6287            GroupsIterator = pGroups->begin();
6288            for (uint i = 0; GroupsIterator != pGroups->end(); ++GroupsIterator, ++i)
6289                if ((*GroupsIterator)->Name == name) return *GroupsIterator;
6290            return NULL;
6291        }
6292    
6293      Group* File::AddGroup() {      Group* File::AddGroup() {
6294          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6295          // there must always be at least one group          // there must always be at least one group
# Line 3834  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6319  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6319          }          }
6320          // now delete this group object          // now delete this group object
6321          pGroups->erase(iter);          pGroups->erase(iter);
6322            pGroup->DeleteChunks();
6323          delete pGroup;          delete pGroup;
6324      }      }
6325    
# Line 3855  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6341  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6341          // move all members of this group to another group          // move all members of this group to another group
6342          pGroup->MoveAll();          pGroup->MoveAll();
6343          pGroups->erase(iter);          pGroups->erase(iter);
6344            pGroup->DeleteChunks();
6345          delete pGroup;          delete pGroup;
6346      }      }
6347    
# Line 3868  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6355  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6355                  RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();                  RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();
6356                  while (ck) {                  while (ck) {
6357                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {
6358                          if (pVersion && pVersion->major == 3 &&                          if (pVersion && pVersion->major > 2 &&
6359                              strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;                              strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;
6360    
6361                          pGroups->push_back(new Group(this, ck));                          pGroups->push_back(new Group(this, ck));
# Line 3885  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6372  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6372          }          }
6373      }      }
6374    
6375        /** @brief Get instrument script group (by index).
6376         *
6377         * Returns the real-time instrument script group with the given index.
6378         *
6379         * @param index - number of the sought group (0..n)
6380         * @returns sought script group or NULL if there's no such group
6381         */
6382        ScriptGroup* File::GetScriptGroup(uint index) {
6383            if (!pScriptGroups) LoadScriptGroups();
6384            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
6385            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
6386                if (i == index) return *it;
6387            return NULL;
6388        }
6389    
6390        /** @brief Get instrument script group (by name).
6391         *
6392         * Returns the first real-time instrument script group found with the given
6393         * group name. Note that group names may not necessarily be unique.
6394         *
6395         * @param name - name of the sought script group
6396         * @returns sought script group or NULL if there's no such group
6397         */
6398        ScriptGroup* File::GetScriptGroup(const String& name) {
6399            if (!pScriptGroups) LoadScriptGroups();
6400            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
6401            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
6402                if ((*it)->Name == name) return *it;
6403            return NULL;
6404        }
6405    
6406        /** @brief Add new instrument script group.
6407         *
6408         * Adds a new, empty real-time instrument script group to the file.
6409         *
6410         * You have to call Save() to make this persistent to the file.
6411         *
6412         * @return new empty script group
6413         */
6414        ScriptGroup* File::AddScriptGroup() {
6415            if (!pScriptGroups) LoadScriptGroups();
6416            ScriptGroup* pScriptGroup = new ScriptGroup(this, NULL);
6417            pScriptGroups->push_back(pScriptGroup);
6418            return pScriptGroup;
6419        }
6420    
6421        /** @brief Delete an instrument script group.
6422         *
6423         * This will delete the given real-time instrument script group and all its
6424         * instrument scripts it contains. References inside instruments that are
6425         * using the deleted scripts will be removed from the respective instruments
6426         * accordingly.
6427         *
6428         * You have to call Save() to make this persistent to the file.
6429         *
6430         * @param pScriptGroup - script group to delete
6431         * @throws gig::Exception if given script group could not be found
6432         */
6433        void File::DeleteScriptGroup(ScriptGroup* pScriptGroup) {
6434            if (!pScriptGroups) LoadScriptGroups();
6435            std::list<ScriptGroup*>::iterator iter =
6436                find(pScriptGroups->begin(), pScriptGroups->end(), pScriptGroup);
6437            if (iter == pScriptGroups->end())
6438                throw gig::Exception("Could not delete script group, could not find given script group");
6439            pScriptGroups->erase(iter);
6440            for (int i = 0; pScriptGroup->GetScript(i); ++i)
6441                pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));
6442            if (pScriptGroup->pList)
6443                pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);
6444            pScriptGroup->DeleteChunks();
6445            delete pScriptGroup;
6446        }
6447    
6448        void File::LoadScriptGroups() {
6449            if (pScriptGroups) return;
6450            pScriptGroups = new std::list<ScriptGroup*>;
6451            RIFF::List* lstLS = pRIFF->GetSubList(LIST_TYPE_3LS);
6452            if (lstLS) {
6453                for (RIFF::List* lst = lstLS->GetFirstSubList(); lst;
6454                     lst = lstLS->GetNextSubList())
6455                {
6456                    if (lst->GetListType() == LIST_TYPE_RTIS) {
6457                        pScriptGroups->push_back(new ScriptGroup(this, lst));
6458                    }
6459                }
6460            }
6461        }
6462    
6463      /**      /**
6464       * Apply all the gig file's current instruments, samples, groups and settings       * Apply all the gig file's current instruments, samples, groups and settings
6465       * to the respective RIFF chunks. You have to call Save() to make changes       * to the respective RIFF chunks. You have to call Save() to make changes
# Line 3893  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6468  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6468       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
6469       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
6470       *       *
6471         * @param pProgress - callback function for progress notification
6472       * @throws Exception - on errors       * @throws Exception - on errors
6473       */       */
6474      void File::UpdateChunks() {      void File::UpdateChunks(progress_t* pProgress) {
6475          bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;          bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;
6476    
6477          b64BitWavePoolOffsets = pVersion && pVersion->major == 3;          // update own gig format extension chunks
6478            // (not part of the GigaStudio 4 format)
6479            RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);
6480            if (!lst3LS) {
6481                lst3LS = pRIFF->AddSubList(LIST_TYPE_3LS);
6482            }
6483            // Make sure <3LS > chunk is placed before <ptbl> chunk. The precise
6484            // location of <3LS > is irrelevant, however it should be located
6485            // before  the actual wave data
6486            RIFF::Chunk* ckPTBL = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
6487            pRIFF->MoveSubChunk(lst3LS, ckPTBL);
6488    
6489            // This must be performed before writing the chunks for instruments,
6490            // because the instruments' script slots will write the file offsets
6491            // of the respective instrument script chunk as reference.
6492            if (pScriptGroups) {
6493                // Update instrument script (group) chunks.
6494                for (std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
6495                     it != pScriptGroups->end(); ++it)
6496                {
6497                    (*it)->UpdateChunks(pProgress);
6498                }
6499            }
6500    
6501            // in case no libgig custom format data was added, then remove the
6502            // custom "3LS " chunk again
6503            if (!lst3LS->CountSubChunks()) {
6504                pRIFF->DeleteSubChunk(lst3LS);
6505                lst3LS = NULL;
6506            }
6507    
6508          // first update base class's chunks          // first update base class's chunks
6509          DLS::File::UpdateChunks();          DLS::File::UpdateChunks(pProgress);
6510    
6511          if (newFile) {          if (newFile) {
6512              // INFO was added by Resource::UpdateChunks - make sure it              // INFO was added by Resource::UpdateChunks - make sure it
# Line 3915  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6520  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6520    
6521          // update group's chunks          // update group's chunks
6522          if (pGroups) {          if (pGroups) {
6523              std::list<Group*>::iterator iter = pGroups->begin();              // make sure '3gri' and '3gnl' list chunks exist
6524              std::list<Group*>::iterator end  = pGroups->end();              // (before updating the Group chunks)
6525              for (; iter != end; ++iter) {              RIFF::List* _3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
6526                  (*iter)->UpdateChunks();              if (!_3gri) {
6527                    _3gri = pRIFF->AddSubList(LIST_TYPE_3GRI);
6528                    pRIFF->MoveSubChunk(_3gri, pRIFF->GetSubChunk(CHUNK_ID_PTBL));
6529              }              }
6530                RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
6531                if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
6532    
6533              // v3: make sure the file has 128 3gnm chunks              // v3: make sure the file has 128 3gnm chunks
6534              if (pVersion && pVersion->major == 3) {              // (before updating the Group chunks)
6535                  RIFF::List* _3gnl = pRIFF->GetSubList(LIST_TYPE_3GRI)->GetSubList(LIST_TYPE_3GNL);              if (pVersion && pVersion->major > 2) {
6536                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
6537                  for (int i = 0 ; i < 128 ; i++) {                  for (int i = 0 ; i < 128 ; i++) {
6538                      if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);                      if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
6539                      if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();                      if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();
6540                  }                  }
6541              }              }
6542    
6543                std::list<Group*>::iterator iter = pGroups->begin();
6544                std::list<Group*>::iterator end  = pGroups->end();
6545                for (; iter != end; ++iter) {
6546                    (*iter)->UpdateChunks(pProgress);
6547                }
6548          }          }
6549    
6550          // update einf chunk          // update einf chunk
# Line 3948  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6563  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6563          // Note that there are several fields with unknown use. These          // Note that there are several fields with unknown use. These
6564          // are set to zero.          // are set to zero.
6565    
6566          int sublen = pSamples->size() / 8 + 49;          int sublen = int(pSamples->size() / 8 + 49);
6567          int einfSize = (Instruments + 1) * sublen;          int einfSize = (Instruments + 1) * sublen;
6568    
6569          RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);          RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
# Line 4021  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6636  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6636                  store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);                  store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);
6637                  // next 8 bytes unknown                  // next 8 bytes unknown
6638                  store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);                  store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);
6639                  store32(&pData[(instrumentIdx + 1) * sublen + 40], pSamples->size());                  store32(&pData[(instrumentIdx + 1) * sublen + 40], (uint32_t) pSamples->size());
6640                  // next 4 bytes unknown                  // next 4 bytes unknown
6641    
6642                  totnbregions += instrument->Regions;                  totnbregions += instrument->Regions;
# Line 4039  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6654  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6654              store32(&pData[24], totnbloops);              store32(&pData[24], totnbloops);
6655              // next 8 bytes unknown              // next 8 bytes unknown
6656              // next 4 bytes unknown, not always 0              // next 4 bytes unknown, not always 0
6657              store32(&pData[40], pSamples->size());              store32(&pData[40], (uint32_t) pSamples->size());
6658              // next 4 bytes unknown              // next 4 bytes unknown
6659          }          }
6660    
6661          // update 3crc chunk          // update 3crc chunk
6662    
6663          // The 3crc chunk contains CRC-32 checksums for the          // The 3crc chunk contains CRC-32 checksums for the
6664          // samples. The actual checksum values will be filled in          // samples. When saving a gig file to disk, we first update the 3CRC
6665          // later, by Sample::Write.          // chunk here (in RAM) with the old crc values which we read from the
6666            // 3CRC chunk when we opened the file (available with gig::Sample::crc
6667            // member variable). This step is required, because samples might have
6668            // been deleted by the user since the file was opened, which in turn
6669            // changes the order of the (i.e. old) checksums within the 3crc chunk.
6670            // If a sample was conciously modified by the user (that is if
6671            // Sample::Write() was called later on) then Sample::Write() will just
6672            // update the respective individual checksum(s) directly on disk and
6673            // leaves all other sample checksums untouched.
6674    
6675          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6676          if (_3crc) {          if (_3crc) {
6677              _3crc->Resize(pSamples->size() * 8);              _3crc->Resize(pSamples->size() * 8);
6678          } else if (newFile) {          } else /*if (newFile)*/ {
6679              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
             _3crc->LoadChunkData();  
   
6680              // 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
6681              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);              if (einf && pVersion && pVersion->major > 2) pRIFF->MoveSubChunk(_3crc, einf);
6682            }
6683            { // must be performed in RAM here ...
6684                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6685                if (pData) {
6686                    File::SampleList::iterator iter = pSamples->begin();
6687                    File::SampleList::iterator end  = pSamples->end();
6688                    for (int index = 0; iter != end; ++iter, ++index) {
6689                        gig::Sample* pSample = (gig::Sample*) *iter;
6690                        pData[index*2]   = 1; // always 1
6691                        pData[index*2+1] = pSample->crc;
6692                    }
6693                }
6694            }
6695        }
6696        
6697        void File::UpdateFileOffsets() {
6698            DLS::File::UpdateFileOffsets();
6699    
6700            for (Instrument* instrument = GetFirstInstrument(); instrument;
6701                 instrument = GetNextInstrument())
6702            {
6703                instrument->UpdateScriptFileOffsets();
6704          }          }
6705      }      }
6706    
# Line 4093  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6736  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6736  // *************** Exception ***************  // *************** Exception ***************
6737  // *  // *
6738    
6739      Exception::Exception(String Message) : DLS::Exception(Message) {      Exception::Exception() : DLS::Exception() {
6740        }
6741    
6742        Exception::Exception(String format, ...) : DLS::Exception() {
6743            va_list arg;
6744            va_start(arg, format);
6745            Message = assemble(format, arg);
6746            va_end(arg);
6747        }
6748    
6749        Exception::Exception(String format, va_list arg) : DLS::Exception() {
6750            Message = assemble(format, arg);
6751      }      }
6752    
6753      void Exception::PrintMessage() {      void Exception::PrintMessage() {

Legend:
Removed from v.2394  
changed lines
  Added in v.3478

  ViewVC Help
Powered by ViewVC