/[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 1875 by schoenebeck, Thu Mar 26 13:32:59 2009 UTC revision 3324 by schoenebeck, Fri Jul 21 13:05:39 2017 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-2009 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2017 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) {
# Line 454  namespace { Line 487  namespace {
487      }      }
488    
489      /**      /**
490         * Make a (semi) deep copy of the Sample object given by @a orig (without
491         * the actual waveform data) and assign it to this object.
492         *
493         * Discussion: copying .gig samples is a bit tricky. It requires three
494         * steps:
495         * 1. Copy sample's meta informations (done by CopyAssignMeta()) including
496         *    its new sample waveform data size.
497         * 2. Saving the file (done by File::Save()) so that it gains correct size
498         *    and layout for writing the actual wave form data directly to disc
499         *    in next step.
500         * 3. Copy the waveform data with disk streaming (done by CopyAssignWave()).
501         *
502         * @param orig - original Sample object to be copied from
503         */
504        void Sample::CopyAssignMeta(const Sample* orig) {
505            // handle base classes
506            DLS::Sample::CopyAssignCore(orig);
507            
508            // handle actual own attributes of this class
509            Manufacturer = orig->Manufacturer;
510            Product = orig->Product;
511            SamplePeriod = orig->SamplePeriod;
512            MIDIUnityNote = orig->MIDIUnityNote;
513            FineTune = orig->FineTune;
514            SMPTEFormat = orig->SMPTEFormat;
515            SMPTEOffset = orig->SMPTEOffset;
516            Loops = orig->Loops;
517            LoopID = orig->LoopID;
518            LoopType = orig->LoopType;
519            LoopStart = orig->LoopStart;
520            LoopEnd = orig->LoopEnd;
521            LoopSize = orig->LoopSize;
522            LoopFraction = orig->LoopFraction;
523            LoopPlayCount = orig->LoopPlayCount;
524            
525            // schedule resizing this sample to the given sample's size
526            Resize(orig->GetSize());
527        }
528    
529        /**
530         * Should be called after CopyAssignMeta() and File::Save() sequence.
531         * Read more about it in the discussion of CopyAssignMeta(). This method
532         * copies the actual waveform data by disk streaming.
533         *
534         * @e CAUTION: this method is currently not thread safe! During this
535         * operation the sample must not be used for other purposes by other
536         * threads!
537         *
538         * @param orig - original Sample object to be copied from
539         */
540        void Sample::CopyAssignWave(const Sample* orig) {
541            const int iReadAtOnce = 32*1024;
542            char* buf = new char[iReadAtOnce * orig->FrameSize];
543            Sample* pOrig = (Sample*) orig; //HACK: remove constness for now
544            file_offset_t restorePos = pOrig->GetPos();
545            pOrig->SetPos(0);
546            SetPos(0);
547            for (file_offset_t n = pOrig->Read(buf, iReadAtOnce); n;
548                               n = pOrig->Read(buf, iReadAtOnce))
549            {
550                Write(buf, n);
551            }
552            pOrig->SetPos(restorePos);
553            delete [] buf;
554        }
555    
556        /**
557       * Apply sample and its settings to the respective RIFF chunks. You have       * Apply sample and its settings to the respective RIFF chunks. You have
558       * to call File::Save() to make changes persistent.       * to call File::Save() to make changes persistent.
559       *       *
560       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
561       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
562       *       *
563         * @param pProgress - callback function for progress notification
564       * @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
565       *                        was provided yet       *                        was provided yet
566       * @throws gig::Exception if there is any invalid sample setting       * @throws gig::Exception if there is any invalid sample setting
567       */       */
568      void Sample::UpdateChunks() {      void Sample::UpdateChunks(progress_t* pProgress) {
569          // first update base class's chunks          // first update base class's chunks
570          DLS::Sample::UpdateChunks();          DLS::Sample::UpdateChunks(pProgress);
571    
572          // make sure 'smpl' chunk exists          // make sure 'smpl' chunk exists
573          pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);          pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);
# Line 514  namespace { Line 615  namespace {
615          // update '3gix' chunk          // update '3gix' chunk
616          pData = (uint8_t*) pCk3gix->LoadChunkData();          pData = (uint8_t*) pCk3gix->LoadChunkData();
617          store16(&pData[0], iSampleGroup);          store16(&pData[0], iSampleGroup);
618    
619            // if the library user toggled the "Compressed" attribute from true to
620            // false, then the EWAV chunk associated with compressed samples needs
621            // to be deleted
622            RIFF::Chunk* ewav = pWaveList->GetSubChunk(CHUNK_ID_EWAV);
623            if (ewav && !Compressed) {
624                pWaveList->DeleteSubChunk(ewav);
625            }
626      }      }
627    
628      /// 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).
629      void Sample::ScanCompressedSample() {      void Sample::ScanCompressedSample() {
630          //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)
631          this->SamplesTotal = 0;          this->SamplesTotal = 0;
632          std::list<unsigned long> frameOffsets;          std::list<file_offset_t> frameOffsets;
633    
634          SamplesPerFrame = BitDepth == 24 ? 256 : 2048;          SamplesPerFrame = BitDepth == 24 ? 256 : 2048;
635          WorstCaseFrameSize = SamplesPerFrame * FrameSize + Channels; // +Channels for compression flag          WorstCaseFrameSize = SamplesPerFrame * FrameSize + Channels; // +Channels for compression flag
# Line 536  namespace { Line 645  namespace {
645                  const int mode_l = pCkData->ReadUint8();                  const int mode_l = pCkData->ReadUint8();
646                  const int mode_r = pCkData->ReadUint8();                  const int mode_r = pCkData->ReadUint8();
647                  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");
648                  const unsigned long frameSize = bytesPerFrame[mode_l] + bytesPerFrame[mode_r];                  const file_offset_t frameSize = bytesPerFrame[mode_l] + bytesPerFrame[mode_r];
649    
650                  if (pCkData->RemainingBytes() <= frameSize) {                  if (pCkData->RemainingBytes() <= frameSize) {
651                      SamplesInLastFrame =                      SamplesInLastFrame =
# Line 555  namespace { Line 664  namespace {
664    
665                  const int mode = pCkData->ReadUint8();                  const int mode = pCkData->ReadUint8();
666                  if (mode > 5) throw gig::Exception("Unknown compression mode");                  if (mode > 5) throw gig::Exception("Unknown compression mode");
667                  const unsigned long frameSize = bytesPerFrame[mode];                  const file_offset_t frameSize = bytesPerFrame[mode];
668    
669                  if (pCkData->RemainingBytes() <= frameSize) {                  if (pCkData->RemainingBytes() <= frameSize) {
670                      SamplesInLastFrame =                      SamplesInLastFrame =
# Line 571  namespace { Line 680  namespace {
680    
681          // 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)
682          if (FrameTable) delete[] FrameTable;          if (FrameTable) delete[] FrameTable;
683          FrameTable = new unsigned long[frameOffsets.size()];          FrameTable = new file_offset_t[frameOffsets.size()];
684          std::list<unsigned long>::iterator end  = frameOffsets.end();          std::list<file_offset_t>::iterator end  = frameOffsets.end();
685          std::list<unsigned long>::iterator iter = frameOffsets.begin();          std::list<file_offset_t>::iterator iter = frameOffsets.begin();
686          for (int i = 0; iter != end; i++, iter++) {          for (int i = 0; iter != end; i++, iter++) {
687              FrameTable[i] = *iter;              FrameTable[i] = *iter;
688          }          }
# Line 614  namespace { Line 723  namespace {
723       *                      the cached sample data in bytes       *                      the cached sample data in bytes
724       * @see                 ReleaseSampleData(), Read(), SetPos()       * @see                 ReleaseSampleData(), Read(), SetPos()
725       */       */
726      buffer_t Sample::LoadSampleData(unsigned long SampleCount) {      buffer_t Sample::LoadSampleData(file_offset_t SampleCount) {
727          return LoadSampleDataWithNullSamplesExtension(SampleCount, 0); // 0 amount of NullSamples          return LoadSampleDataWithNullSamplesExtension(SampleCount, 0); // 0 amount of NullSamples
728      }      }
729    
# Line 673  namespace { Line 782  namespace {
782       *                           size of the cached sample data in bytes       *                           size of the cached sample data in bytes
783       * @see                      ReleaseSampleData(), Read(), SetPos()       * @see                      ReleaseSampleData(), Read(), SetPos()
784       */       */
785      buffer_t Sample::LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount) {      buffer_t Sample::LoadSampleDataWithNullSamplesExtension(file_offset_t SampleCount, uint NullSamplesCount) {
786          if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;          if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;
787          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
788          unsigned long allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;          file_offset_t allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;
789          SetPos(0); // reset read position to begin of sample          SetPos(0); // reset read position to begin of sample
790          RAMCache.pStart            = new int8_t[allocationsize];          RAMCache.pStart            = new int8_t[allocationsize];
791          RAMCache.Size              = Read(RAMCache.pStart, SampleCount) * this->FrameSize;          RAMCache.Size              = Read(RAMCache.pStart, SampleCount) * this->FrameSize;
# Line 740  namespace { Line 849  namespace {
849       * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with       * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with
850       * other formats will fail!       * other formats will fail!
851       *       *
852       * @param iNewSize - new sample wave data size in sample points (must be       * @param NewSize - new sample wave data size in sample points (must be
853       *                   greater than zero)       *                  greater than zero)
854       * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM       * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM
855       *                         or if \a iNewSize is less than 1       * @throws DLS::Exception if \a NewSize is less than 1 or unrealistic large
856       * @throws gig::Exception if existing sample is compressed       * @throws gig::Exception if existing sample is compressed
857       * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,       * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,
858       *      DLS::Sample::FormatTag, File::Save()       *      DLS::Sample::FormatTag, File::Save()
859       */       */
860      void Sample::Resize(int iNewSize) {      void Sample::Resize(file_offset_t NewSize) {
861          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)");
862          DLS::Sample::Resize(iNewSize);          DLS::Sample::Resize(NewSize);
863      }      }
864    
865      /**      /**
# Line 774  namespace { Line 883  namespace {
883       * @returns            the new sample position       * @returns            the new sample position
884       * @see                Read()       * @see                Read()
885       */       */
886      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) {
887          if (Compressed) {          if (Compressed) {
888              switch (Whence) {              switch (Whence) {
889                  case RIFF::stream_curpos:                  case RIFF::stream_curpos:
# Line 792  namespace { Line 901  namespace {
901              }              }
902              if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;              if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;
903    
904              unsigned long frame = this->SamplePos / 2048; // to which frame to jump              file_offset_t frame = this->SamplePos / 2048; // to which frame to jump
905              this->FrameOffset   = this->SamplePos % 2048; // offset (in sample points) within that frame              this->FrameOffset   = this->SamplePos % 2048; // offset (in sample points) within that frame
906              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
907              return this->SamplePos;              return this->SamplePos;
908          }          }
909          else { // not compressed          else { // not compressed
910              unsigned long orderedBytes = SampleCount * this->FrameSize;              file_offset_t orderedBytes = SampleCount * this->FrameSize;
911              unsigned long result = pCkData->SetPos(orderedBytes, Whence);              file_offset_t result = pCkData->SetPos(orderedBytes, Whence);
912              return (result == orderedBytes) ? SampleCount              return (result == orderedBytes) ? SampleCount
913                                              : result / this->FrameSize;                                              : result / this->FrameSize;
914          }          }
# Line 808  namespace { Line 917  namespace {
917      /**      /**
918       * Returns the current position in the sample (in sample points).       * Returns the current position in the sample (in sample points).
919       */       */
920      unsigned long Sample::GetPos() {      file_offset_t Sample::GetPos() const {
921          if (Compressed) return SamplePos;          if (Compressed) return SamplePos;
922          else            return pCkData->GetPos() / FrameSize;          else            return pCkData->GetPos() / FrameSize;
923      }      }
# Line 847  namespace { Line 956  namespace {
956       * @returns                number of successfully read sample points       * @returns                number of successfully read sample points
957       * @see                    CreateDecompressionBuffer()       * @see                    CreateDecompressionBuffer()
958       */       */
959      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,
960                                        DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {                                        DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {
961          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;          file_offset_t samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;
962          uint8_t* pDst = (uint8_t*) pBuffer;          uint8_t* pDst = (uint8_t*) pBuffer;
963    
964          SetPos(pPlaybackState->position); // recover position from the last time          SetPos(pPlaybackState->position); // recover position from the last time
# Line 887  namespace { Line 996  namespace {
996                                  // reading, swap all sample frames so it reflects                                  // reading, swap all sample frames so it reflects
997                                  // backward playback                                  // backward playback
998    
999                                  unsigned long swapareastart       = totalreadsamples;                                  file_offset_t swapareastart       = totalreadsamples;
1000                                  unsigned long loopoffset          = GetPos() - loop.LoopStart;                                  file_offset_t loopoffset          = GetPos() - loop.LoopStart;
1001                                  unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);                                  file_offset_t samplestoreadinloop = Min(samplestoread, loopoffset);
1002                                  unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;                                  file_offset_t reverseplaybackend  = GetPos() - samplestoreadinloop;
1003    
1004                                  SetPos(reverseplaybackend);                                  SetPos(reverseplaybackend);
1005    
# Line 938  namespace { Line 1047  namespace {
1047                          // reading, swap all sample frames so it reflects                          // reading, swap all sample frames so it reflects
1048                          // backward playback                          // backward playback
1049    
1050                          unsigned long swapareastart       = totalreadsamples;                          file_offset_t swapareastart       = totalreadsamples;
1051                          unsigned long loopoffset          = GetPos() - loop.LoopStart;                          file_offset_t loopoffset          = GetPos() - loop.LoopStart;
1052                          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)
1053                                                                                    : samplestoread;                                                                                    : samplestoread;
1054                          unsigned long reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);                          file_offset_t reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);
1055    
1056                          SetPos(reverseplaybackend);                          SetPos(reverseplaybackend);
1057    
# Line 1022  namespace { Line 1131  namespace {
1131       * @returns            number of successfully read sample points       * @returns            number of successfully read sample points
1132       * @see                SetPos(), CreateDecompressionBuffer()       * @see                SetPos(), CreateDecompressionBuffer()
1133       */       */
1134      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) {
1135          if (SampleCount == 0) return 0;          if (SampleCount == 0) return 0;
1136          if (!Compressed) {          if (!Compressed) {
1137              if (BitDepth == 24) {              if (BitDepth == 24) {
# Line 1037  namespace { Line 1146  namespace {
1146          else {          else {
1147              if (this->SamplePos >= this->SamplesTotal) return 0;              if (this->SamplePos >= this->SamplesTotal) return 0;
1148              //TODO: efficiency: maybe we should test for an average compression rate              //TODO: efficiency: maybe we should test for an average compression rate
1149              unsigned long assumedsize      = GuessSize(SampleCount),              file_offset_t assumedsize      = GuessSize(SampleCount),
1150                            remainingbytes   = 0,           // remaining bytes in the local buffer                            remainingbytes   = 0,           // remaining bytes in the local buffer
1151                            remainingsamples = SampleCount,                            remainingsamples = SampleCount,
1152                            copysamples, skipsamples,                            copysamples, skipsamples,
# Line 1060  namespace { Line 1169  namespace {
1169              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);
1170    
1171              while (remainingsamples && remainingbytes) {              while (remainingsamples && remainingbytes) {
1172                  unsigned long framesamples = SamplesPerFrame;                  file_offset_t framesamples = SamplesPerFrame;
1173                  unsigned long framebytes, rightChannelOffset = 0, nextFrameOffset;                  file_offset_t framebytes, rightChannelOffset = 0, nextFrameOffset;
1174    
1175                  int mode_l = *pSrc++, mode_r = 0;                  int mode_l = *pSrc++, mode_r = 0;
1176    
# Line 1211  namespace { Line 1320  namespace {
1320       * @throws gig::Exception if sample is compressed       * @throws gig::Exception if sample is compressed
1321       * @see DLS::LoadSampleData()       * @see DLS::LoadSampleData()
1322       */       */
1323      unsigned long Sample::Write(void* pBuffer, unsigned long SampleCount) {      file_offset_t Sample::Write(void* pBuffer, file_offset_t SampleCount) {
1324          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)");
1325    
1326          // 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 1329  namespace {
1329              __resetCRC(crc);              __resetCRC(crc);
1330          }          }
1331          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");
1332          unsigned long res;          file_offset_t res;
1333          if (BitDepth == 24) {          if (BitDepth == 24) {
1334              res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;              res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
1335          } else { // 16 bit          } else { // 16 bit
# Line 1232  namespace { Line 1341  namespace {
1341          // if this is the last write, update the checksum chunk in the          // if this is the last write, update the checksum chunk in the
1342          // file          // file
1343          if (pCkData->GetPos() == pCkData->GetSize()) {          if (pCkData->GetPos() == pCkData->GetSize()) {
1344                __finalizeCRC(crc);
1345              File* pFile = static_cast<File*>(GetParent());              File* pFile = static_cast<File*>(GetParent());
1346              pFile->SetSampleChecksum(this, __encodeCRC(crc));              pFile->SetSampleChecksum(this, crc);
1347          }          }
1348          return res;          return res;
1349      }      }
# Line 1254  namespace { Line 1364  namespace {
1364       * @returns allocated decompression buffer       * @returns allocated decompression buffer
1365       * @see DestroyDecompressionBuffer()       * @see DestroyDecompressionBuffer()
1366       */       */
1367      buffer_t Sample::CreateDecompressionBuffer(unsigned long MaxReadSize) {      buffer_t Sample::CreateDecompressionBuffer(file_offset_t MaxReadSize) {
1368          buffer_t result;          buffer_t result;
1369          const double worstCaseHeaderOverhead =          const double worstCaseHeaderOverhead =
1370                  (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;
1371          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);
1372          result.pStart            = new int8_t[result.Size];          result.pStart            = new int8_t[result.Size];
1373          result.NullExtensionSize = 0;          result.NullExtensionSize = 0;
1374          return result;          return result;
# Line 1292  namespace { Line 1402  namespace {
1402          return pGroup;          return pGroup;
1403      }      }
1404    
1405        /**
1406         * Returns the CRC-32 checksum of the sample's raw wave form data at the
1407         * time when this sample's wave form data was modified for the last time
1408         * by calling Write(). This checksum only covers the raw wave form data,
1409         * not any meta informations like i.e. bit depth or loop points. Since
1410         * this method just returns the checksum stored for this sample i.e. when
1411         * the gig file was loaded, this method returns immediately. So it does no
1412         * recalcuation of the checksum with the currently available sample wave
1413         * form data.
1414         *
1415         * @see VerifyWaveData()
1416         */
1417        uint32_t Sample::GetWaveDataCRC32Checksum() {
1418            return crc;
1419        }
1420    
1421        /**
1422         * Checks the integrity of this sample's raw audio wave data. Whenever a
1423         * Sample's raw wave data is intentionally modified (i.e. by calling
1424         * Write() and supplying the new raw audio wave form data) a CRC32 checksum
1425         * is calculated and stored/updated for this sample, along to the sample's
1426         * meta informations.
1427         *
1428         * Now by calling this method the current raw audio wave data is checked
1429         * against the already stored CRC32 check sum in order to check whether the
1430         * sample data had been damaged unintentionally for some reason. Since by
1431         * calling this method always the entire raw audio wave data has to be
1432         * read, verifying all samples this way may take a long time accordingly.
1433         * And that's also the reason why the sample integrity is not checked by
1434         * default whenever a gig file is loaded. So this method must be called
1435         * explicitly to fulfill this task.
1436         *
1437         * @param pActually - (optional) if provided, will be set to the actually
1438         *                    calculated checksum of the current raw wave form data,
1439         *                    you can get the expected checksum instead by calling
1440         *                    GetWaveDataCRC32Checksum()
1441         * @returns true if sample is OK or false if the sample is damaged
1442         * @throws Exception if no checksum had been stored to disk for this
1443         *         sample yet, or on I/O issues
1444         * @see GetWaveDataCRC32Checksum()
1445         */
1446        bool Sample::VerifyWaveData(uint32_t* pActually) {
1447            //File* pFile = static_cast<File*>(GetParent());
1448            uint32_t crc = CalculateWaveDataChecksum();
1449            if (pActually) *pActually = crc;
1450            return crc == this->crc;
1451        }
1452    
1453        uint32_t Sample::CalculateWaveDataChecksum() {
1454            const size_t sz = 20*1024; // 20kB buffer size
1455            std::vector<uint8_t> buffer(sz);
1456            buffer.resize(sz);
1457    
1458            const size_t n = sz / FrameSize;
1459            SetPos(0);
1460            uint32_t crc = 0;
1461            __resetCRC(crc);
1462            while (true) {
1463                file_offset_t nRead = Read(&buffer[0], n);
1464                if (nRead <= 0) break;
1465                __calculateCRC(&buffer[0], nRead * FrameSize, crc);
1466            }
1467            __finalizeCRC(crc);
1468            return crc;
1469        }
1470    
1471      Sample::~Sample() {      Sample::~Sample() {
1472          Instances--;          Instances--;
1473          if (!Instances && InternalDecompressionBuffer.Size) {          if (!Instances && InternalDecompressionBuffer.Size) {
# Line 1308  namespace { Line 1484  namespace {
1484  // *************** DimensionRegion ***************  // *************** DimensionRegion ***************
1485  // *  // *
1486    
1487      uint                               DimensionRegion::Instances       = 0;      size_t                             DimensionRegion::Instances       = 0;
1488      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;
1489    
1490      DimensionRegion::DimensionRegion(Region* pParent, RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(Region* pParent, RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
# Line 1433  namespace { Line 1609  namespace {
1609                                                          : vcf_res_ctrl_none;                                                          : vcf_res_ctrl_none;
1610              uint16_t eg3depth = _3ewa->ReadUint16();              uint16_t eg3depth = _3ewa->ReadUint16();
1611              EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */              EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */
1612                                          : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */                                          : (-1) * (int16_t) ((eg3depth ^ 0xfff) + 1); /* binary complementary for negatives */
1613              _3ewa->ReadInt16(); // unknown              _3ewa->ReadInt16(); // unknown
1614              ChannelOffset = _3ewa->ReadUint8() / 4;              ChannelOffset = _3ewa->ReadUint8() / 4;
1615              uint8_t regoptions = _3ewa->ReadUint8();              uint8_t regoptions = _3ewa->ReadUint8();
# Line 1502  namespace { Line 1678  namespace {
1678              EG2Attack                       = 0.0;              EG2Attack                       = 0.0;
1679              EG2Decay1                       = 0.005;              EG2Decay1                       = 0.005;
1680              EG2Sustain                      = 1000;              EG2Sustain                      = 1000;
1681              EG2Release                      = 0.3;              EG2Release                      = 60;
1682              LFO2ControlDepth                = 0;              LFO2ControlDepth                = 0;
1683              LFO2Frequency                   = 1.0;              LFO2Frequency                   = 1.0;
1684              LFO2InternalDepth               = 0;              LFO2InternalDepth               = 0;
# Line 1556  namespace { Line 1732  namespace {
1732              VCFType                         = vcf_type_lowpass;              VCFType                         = vcf_type_lowpass;
1733              memset(DimensionUpperLimits, 127, 8);              memset(DimensionUpperLimits, 127, 8);
1734          }          }
1735            // format extension for EG behavior options, these will *NOT* work with
1736            // Gigasampler/GigaStudio !
1737            RIFF::Chunk* lsde = _3ewl->GetSubChunk(CHUNK_ID_LSDE);
1738            if (lsde) {
1739                unsigned char byte = lsde->ReadUint8();
1740                EGOptions.AttackCancel     = byte & 1;
1741                EGOptions.AttackHoldCancel = byte & (1 << 1);
1742                EGOptions.Decay1Cancel     = byte & (1 << 2);
1743                EGOptions.Decay2Cancel     = byte & (1 << 3);
1744                EGOptions.ReleaseCancel    = byte & (1 << 4);
1745            }
1746    
1747          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
1748                                                       VelocityResponseDepth,                                                       VelocityResponseDepth,
# Line 1581  namespace { Line 1768  namespace {
1768       */       */
1769      DimensionRegion::DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src) : DLS::Sampler(_3ewl) {
1770          Instances++;          Instances++;
1771            //NOTE: I think we cannot call CopyAssign() here (in a constructor) as long as its a virtual method
1772          *this = src; // default memberwise shallow copy of all parameters          *this = src; // default memberwise shallow copy of all parameters
1773          pParentList = _3ewl; // restore the chunk pointer          pParentList = _3ewl; // restore the chunk pointer
1774    
# Line 1596  namespace { Line 1784  namespace {
1784                  pSampleLoops[k] = src.pSampleLoops[k];                  pSampleLoops[k] = src.pSampleLoops[k];
1785          }          }
1786      }      }
1787        
1788        /**
1789         * Make a (semi) deep copy of the DimensionRegion object given by @a orig
1790         * and assign it to this object.
1791         *
1792         * Note that all sample pointers referenced by @a orig are simply copied as
1793         * memory address. Thus the respective samples are shared, not duplicated!
1794         *
1795         * @param orig - original DimensionRegion object to be copied from
1796         */
1797        void DimensionRegion::CopyAssign(const DimensionRegion* orig) {
1798            CopyAssign(orig, NULL);
1799        }
1800    
1801        /**
1802         * Make a (semi) deep copy of the DimensionRegion object given by @a orig
1803         * and assign it to this object.
1804         *
1805         * @param orig - original DimensionRegion object to be copied from
1806         * @param mSamples - crosslink map between the foreign file's samples and
1807         *                   this file's samples
1808         */
1809        void DimensionRegion::CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples) {
1810            // delete all allocated data first
1811            if (VelocityTable) delete [] VelocityTable;
1812            if (pSampleLoops) delete [] pSampleLoops;
1813            
1814            // backup parent list pointer
1815            RIFF::List* p = pParentList;
1816            
1817            gig::Sample* pOriginalSample = pSample;
1818            gig::Region* pOriginalRegion = pRegion;
1819            
1820            //NOTE: copy code copied from assignment constructor above, see comment there as well
1821            
1822            *this = *orig; // default memberwise shallow copy of all parameters
1823            
1824            // restore members that shall not be altered
1825            pParentList = p; // restore the chunk pointer
1826            pRegion = pOriginalRegion;
1827            
1828            // only take the raw sample reference reference if the
1829            // two DimensionRegion objects are part of the same file
1830            if (pOriginalRegion->GetParent()->GetParent() != orig->pRegion->GetParent()->GetParent()) {
1831                pSample = pOriginalSample;
1832            }
1833            
1834            if (mSamples && mSamples->count(orig->pSample)) {
1835                pSample = mSamples->find(orig->pSample)->second;
1836            }
1837    
1838            // deep copy of owned structures
1839            if (orig->VelocityTable) {
1840                VelocityTable = new uint8_t[128];
1841                for (int k = 0 ; k < 128 ; k++)
1842                    VelocityTable[k] = orig->VelocityTable[k];
1843            }
1844            if (orig->pSampleLoops) {
1845                pSampleLoops = new DLS::sample_loop_t[orig->SampleLoops];
1846                for (int k = 0 ; k < orig->SampleLoops ; k++)
1847                    pSampleLoops[k] = orig->pSampleLoops[k];
1848            }
1849        }
1850    
1851        void DimensionRegion::serialize(Serialization::Archive* archive) {
1852            // in case this class will become backward incompatible one day,
1853            // then set a version and minimum version for this class like:
1854            //archive->setVersion(*this, 2);
1855            //archive->setMinVersion(*this, 1);
1856    
1857            SRLZ(VelocityUpperLimit);
1858            SRLZ(EG1PreAttack);
1859            SRLZ(EG1Attack);
1860            SRLZ(EG1Decay1);
1861            SRLZ(EG1Decay2);
1862            SRLZ(EG1InfiniteSustain);
1863            SRLZ(EG1Sustain);
1864            SRLZ(EG1Release);
1865            SRLZ(EG1Hold);
1866            SRLZ(EG1Controller);
1867            SRLZ(EG1ControllerInvert);
1868            SRLZ(EG1ControllerAttackInfluence);
1869            SRLZ(EG1ControllerDecayInfluence);
1870            SRLZ(EG1ControllerReleaseInfluence);
1871            SRLZ(LFO1Frequency);
1872            SRLZ(LFO1InternalDepth);
1873            SRLZ(LFO1ControlDepth);
1874            SRLZ(LFO1Controller);
1875            SRLZ(LFO1FlipPhase);
1876            SRLZ(LFO1Sync);
1877            SRLZ(EG2PreAttack);
1878            SRLZ(EG2Attack);
1879            SRLZ(EG2Decay1);
1880            SRLZ(EG2Decay2);
1881            SRLZ(EG2InfiniteSustain);
1882            SRLZ(EG2Sustain);
1883            SRLZ(EG2Release);
1884            SRLZ(EG2Controller);
1885            SRLZ(EG2ControllerInvert);
1886            SRLZ(EG2ControllerAttackInfluence);
1887            SRLZ(EG2ControllerDecayInfluence);
1888            SRLZ(EG2ControllerReleaseInfluence);
1889            SRLZ(LFO2Frequency);
1890            SRLZ(LFO2InternalDepth);
1891            SRLZ(LFO2ControlDepth);
1892            SRLZ(LFO2Controller);
1893            SRLZ(LFO2FlipPhase);
1894            SRLZ(LFO2Sync);
1895            SRLZ(EG3Attack);
1896            SRLZ(EG3Depth);
1897            SRLZ(LFO3Frequency);
1898            SRLZ(LFO3InternalDepth);
1899            SRLZ(LFO3ControlDepth);
1900            SRLZ(LFO3Controller);
1901            SRLZ(LFO3Sync);
1902            SRLZ(VCFEnabled);
1903            SRLZ(VCFType);
1904            SRLZ(VCFCutoffController);
1905            SRLZ(VCFCutoffControllerInvert);
1906            SRLZ(VCFCutoff);
1907            SRLZ(VCFVelocityCurve);
1908            SRLZ(VCFVelocityScale);
1909            SRLZ(VCFVelocityDynamicRange);
1910            SRLZ(VCFResonance);
1911            SRLZ(VCFResonanceDynamic);
1912            SRLZ(VCFResonanceController);
1913            SRLZ(VCFKeyboardTracking);
1914            SRLZ(VCFKeyboardTrackingBreakpoint);
1915            SRLZ(VelocityResponseCurve);
1916            SRLZ(VelocityResponseDepth);
1917            SRLZ(VelocityResponseCurveScaling);
1918            SRLZ(ReleaseVelocityResponseCurve);
1919            SRLZ(ReleaseVelocityResponseDepth);
1920            SRLZ(ReleaseTriggerDecay);
1921            SRLZ(Crossfade);
1922            SRLZ(PitchTrack);
1923            SRLZ(DimensionBypass);
1924            SRLZ(Pan);
1925            SRLZ(SelfMask);
1926            SRLZ(AttenuationController);
1927            SRLZ(InvertAttenuationController);
1928            SRLZ(AttenuationControllerThreshold);
1929            SRLZ(ChannelOffset);
1930            SRLZ(SustainDefeat);
1931            SRLZ(MSDecode);
1932            //SRLZ(SampleStartOffset);
1933            SRLZ(SampleAttenuation);
1934            SRLZ(EGOptions);
1935    
1936            // derived attributes from DLS::Sampler
1937            SRLZ(FineTune);
1938            SRLZ(Gain);
1939        }
1940    
1941      /**      /**
1942       * Updates the respective member variable and updates @c SampleAttenuation       * Updates the respective member variable and updates @c SampleAttenuation
# Line 1612  namespace { Line 1953  namespace {
1953       *       *
1954       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
1955       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
1956         *
1957         * @param pProgress - callback function for progress notification
1958       */       */
1959      void DimensionRegion::UpdateChunks() {      void DimensionRegion::UpdateChunks(progress_t* pProgress) {
1960          // first update base class's chunk          // first update base class's chunk
1961          DLS::Sampler::UpdateChunks();          DLS::Sampler::UpdateChunks(pProgress);
1962    
1963          RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);          RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);
1964          uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();          uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();
# Line 1635  namespace { Line 1978  namespace {
1978    
1979          // update '3ewa' chunk with DimensionRegion's current settings          // update '3ewa' chunk with DimensionRegion's current settings
1980    
1981          const uint32_t chunksize = _3ewa->GetNewSize();          const uint32_t chunksize = (uint32_t) _3ewa->GetNewSize();
1982          store32(&pData[0], chunksize); // unknown, always chunk size?          store32(&pData[0], chunksize); // unknown, always chunk size?
1983    
1984          const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);          const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);
# Line 1837  namespace { Line 2180  namespace {
2180          }          }
2181    
2182          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
2183                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xfff); /* binary complementary for negatives */
2184          store16(&pData[116], eg3depth);          store16(&pData[116], eg3depth);
2185    
2186          // next 2 bytes unknown          // next 2 bytes unknown
# Line 1885  namespace { Line 2228  namespace {
2228                                        (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */                                        (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */
2229          pData[137] = vcfbreakpoint;          pData[137] = vcfbreakpoint;
2230    
2231          const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |          const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 +
2232                                      VCFVelocityCurve * 5;                                      VCFVelocityCurve * 5;
2233          pData[138] = vcfvelocity;          pData[138] = vcfvelocity;
2234    
# Line 1895  namespace { Line 2238  namespace {
2238          if (chunksize >= 148) {          if (chunksize >= 148) {
2239              memcpy(&pData[140], DimensionUpperLimits, 8);              memcpy(&pData[140], DimensionUpperLimits, 8);
2240          }          }
2241    
2242            // format extension for EG behavior options, these will *NOT* work with
2243            // Gigasampler/GigaStudio !
2244            RIFF::Chunk* lsde = pParentList->GetSubChunk(CHUNK_ID_LSDE);
2245            if (!lsde) {
2246                // only add this "LSDE" chunk if the EG options do not match the
2247                // default EG behavior
2248                eg_opt_t defaultOpt;
2249                if (memcmp(&EGOptions, &defaultOpt, sizeof(eg_opt_t))) {
2250                    lsde = pParentList->AddSubChunk(CHUNK_ID_LSDE, 1);
2251                    // move LSDE chunk to the end of parent list
2252                    pParentList->MoveSubChunk(lsde, (RIFF::Chunk*)NULL);
2253                }
2254            }
2255            if (lsde) {
2256                unsigned char* pByte = (unsigned char*) lsde->LoadChunkData();
2257                *pByte =
2258                    (EGOptions.AttackCancel     ? 1 : 0) |
2259                    (EGOptions.AttackHoldCancel ? (1<<1) : 0) |
2260                    (EGOptions.Decay1Cancel     ? (1<<2) : 0) |
2261                    (EGOptions.Decay2Cancel     ? (1<<3) : 0) |
2262                    (EGOptions.ReleaseCancel    ? (1<<4) : 0);
2263            }
2264      }      }
2265    
2266      double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {      double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {
# Line 1950  namespace { Line 2316  namespace {
2316          return pRegion;          return pRegion;
2317      }      }
2318    
2319    // show error if some _lev_ctrl_* enum entry is not listed in the following function
2320    // (commented out for now, because "diagnostic push" not supported prior GCC 4.6)
2321    // TODO: uncomment and add a GCC version check (see also commented "#pragma GCC diagnostic pop" below)
2322    //#pragma GCC diagnostic push
2323    //#pragma GCC diagnostic error "-Wswitch"
2324    
2325      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {
2326          leverage_ctrl_t decodedcontroller;          leverage_ctrl_t decodedcontroller;
2327          switch (EncodedController) {          switch (EncodedController) {
# Line 2061  namespace { Line 2433  namespace {
2433                  decodedcontroller.controller_number = 95;                  decodedcontroller.controller_number = 95;
2434                  break;                  break;
2435    
2436                // format extension (these controllers are so far only supported by
2437                // LinuxSampler & gigedit) they will *NOT* work with
2438                // Gigasampler/GigaStudio !
2439                case _lev_ctrl_CC3_EXT:
2440                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2441                    decodedcontroller.controller_number = 3;
2442                    break;
2443                case _lev_ctrl_CC6_EXT:
2444                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2445                    decodedcontroller.controller_number = 6;
2446                    break;
2447                case _lev_ctrl_CC7_EXT:
2448                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2449                    decodedcontroller.controller_number = 7;
2450                    break;
2451                case _lev_ctrl_CC8_EXT:
2452                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2453                    decodedcontroller.controller_number = 8;
2454                    break;
2455                case _lev_ctrl_CC9_EXT:
2456                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2457                    decodedcontroller.controller_number = 9;
2458                    break;
2459                case _lev_ctrl_CC10_EXT:
2460                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2461                    decodedcontroller.controller_number = 10;
2462                    break;
2463                case _lev_ctrl_CC11_EXT:
2464                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2465                    decodedcontroller.controller_number = 11;
2466                    break;
2467                case _lev_ctrl_CC14_EXT:
2468                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2469                    decodedcontroller.controller_number = 14;
2470                    break;
2471                case _lev_ctrl_CC15_EXT:
2472                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2473                    decodedcontroller.controller_number = 15;
2474                    break;
2475                case _lev_ctrl_CC20_EXT:
2476                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2477                    decodedcontroller.controller_number = 20;
2478                    break;
2479                case _lev_ctrl_CC21_EXT:
2480                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2481                    decodedcontroller.controller_number = 21;
2482                    break;
2483                case _lev_ctrl_CC22_EXT:
2484                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2485                    decodedcontroller.controller_number = 22;
2486                    break;
2487                case _lev_ctrl_CC23_EXT:
2488                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2489                    decodedcontroller.controller_number = 23;
2490                    break;
2491                case _lev_ctrl_CC24_EXT:
2492                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2493                    decodedcontroller.controller_number = 24;
2494                    break;
2495                case _lev_ctrl_CC25_EXT:
2496                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2497                    decodedcontroller.controller_number = 25;
2498                    break;
2499                case _lev_ctrl_CC26_EXT:
2500                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2501                    decodedcontroller.controller_number = 26;
2502                    break;
2503                case _lev_ctrl_CC27_EXT:
2504                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2505                    decodedcontroller.controller_number = 27;
2506                    break;
2507                case _lev_ctrl_CC28_EXT:
2508                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2509                    decodedcontroller.controller_number = 28;
2510                    break;
2511                case _lev_ctrl_CC29_EXT:
2512                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2513                    decodedcontroller.controller_number = 29;
2514                    break;
2515                case _lev_ctrl_CC30_EXT:
2516                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2517                    decodedcontroller.controller_number = 30;
2518                    break;
2519                case _lev_ctrl_CC31_EXT:
2520                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2521                    decodedcontroller.controller_number = 31;
2522                    break;
2523                case _lev_ctrl_CC68_EXT:
2524                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2525                    decodedcontroller.controller_number = 68;
2526                    break;
2527                case _lev_ctrl_CC69_EXT:
2528                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2529                    decodedcontroller.controller_number = 69;
2530                    break;
2531                case _lev_ctrl_CC70_EXT:
2532                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2533                    decodedcontroller.controller_number = 70;
2534                    break;
2535                case _lev_ctrl_CC71_EXT:
2536                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2537                    decodedcontroller.controller_number = 71;
2538                    break;
2539                case _lev_ctrl_CC72_EXT:
2540                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2541                    decodedcontroller.controller_number = 72;
2542                    break;
2543                case _lev_ctrl_CC73_EXT:
2544                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2545                    decodedcontroller.controller_number = 73;
2546                    break;
2547                case _lev_ctrl_CC74_EXT:
2548                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2549                    decodedcontroller.controller_number = 74;
2550                    break;
2551                case _lev_ctrl_CC75_EXT:
2552                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2553                    decodedcontroller.controller_number = 75;
2554                    break;
2555                case _lev_ctrl_CC76_EXT:
2556                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2557                    decodedcontroller.controller_number = 76;
2558                    break;
2559                case _lev_ctrl_CC77_EXT:
2560                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2561                    decodedcontroller.controller_number = 77;
2562                    break;
2563                case _lev_ctrl_CC78_EXT:
2564                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2565                    decodedcontroller.controller_number = 78;
2566                    break;
2567                case _lev_ctrl_CC79_EXT:
2568                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2569                    decodedcontroller.controller_number = 79;
2570                    break;
2571                case _lev_ctrl_CC84_EXT:
2572                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2573                    decodedcontroller.controller_number = 84;
2574                    break;
2575                case _lev_ctrl_CC85_EXT:
2576                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2577                    decodedcontroller.controller_number = 85;
2578                    break;
2579                case _lev_ctrl_CC86_EXT:
2580                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2581                    decodedcontroller.controller_number = 86;
2582                    break;
2583                case _lev_ctrl_CC87_EXT:
2584                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2585                    decodedcontroller.controller_number = 87;
2586                    break;
2587                case _lev_ctrl_CC89_EXT:
2588                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2589                    decodedcontroller.controller_number = 89;
2590                    break;
2591                case _lev_ctrl_CC90_EXT:
2592                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2593                    decodedcontroller.controller_number = 90;
2594                    break;
2595                case _lev_ctrl_CC96_EXT:
2596                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2597                    decodedcontroller.controller_number = 96;
2598                    break;
2599                case _lev_ctrl_CC97_EXT:
2600                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2601                    decodedcontroller.controller_number = 97;
2602                    break;
2603                case _lev_ctrl_CC102_EXT:
2604                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2605                    decodedcontroller.controller_number = 102;
2606                    break;
2607                case _lev_ctrl_CC103_EXT:
2608                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2609                    decodedcontroller.controller_number = 103;
2610                    break;
2611                case _lev_ctrl_CC104_EXT:
2612                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2613                    decodedcontroller.controller_number = 104;
2614                    break;
2615                case _lev_ctrl_CC105_EXT:
2616                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2617                    decodedcontroller.controller_number = 105;
2618                    break;
2619                case _lev_ctrl_CC106_EXT:
2620                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2621                    decodedcontroller.controller_number = 106;
2622                    break;
2623                case _lev_ctrl_CC107_EXT:
2624                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2625                    decodedcontroller.controller_number = 107;
2626                    break;
2627                case _lev_ctrl_CC108_EXT:
2628                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2629                    decodedcontroller.controller_number = 108;
2630                    break;
2631                case _lev_ctrl_CC109_EXT:
2632                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2633                    decodedcontroller.controller_number = 109;
2634                    break;
2635                case _lev_ctrl_CC110_EXT:
2636                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2637                    decodedcontroller.controller_number = 110;
2638                    break;
2639                case _lev_ctrl_CC111_EXT:
2640                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2641                    decodedcontroller.controller_number = 111;
2642                    break;
2643                case _lev_ctrl_CC112_EXT:
2644                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2645                    decodedcontroller.controller_number = 112;
2646                    break;
2647                case _lev_ctrl_CC113_EXT:
2648                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2649                    decodedcontroller.controller_number = 113;
2650                    break;
2651                case _lev_ctrl_CC114_EXT:
2652                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2653                    decodedcontroller.controller_number = 114;
2654                    break;
2655                case _lev_ctrl_CC115_EXT:
2656                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2657                    decodedcontroller.controller_number = 115;
2658                    break;
2659                case _lev_ctrl_CC116_EXT:
2660                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2661                    decodedcontroller.controller_number = 116;
2662                    break;
2663                case _lev_ctrl_CC117_EXT:
2664                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2665                    decodedcontroller.controller_number = 117;
2666                    break;
2667                case _lev_ctrl_CC118_EXT:
2668                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2669                    decodedcontroller.controller_number = 118;
2670                    break;
2671                case _lev_ctrl_CC119_EXT:
2672                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2673                    decodedcontroller.controller_number = 119;
2674                    break;
2675    
2676              // unknown controller type              // unknown controller type
2677              default:              default:
2678                  throw gig::Exception("Unknown leverage controller type.");                  decodedcontroller.type = leverage_ctrl_t::type_none;
2679                    decodedcontroller.controller_number = 0;
2680                    printf("Warning: Unknown leverage controller type (0x%x).\n", EncodedController);
2681                    break;
2682          }          }
2683          return decodedcontroller;          return decodedcontroller;
2684      }      }
2685        
2686    // see above (diagnostic push not supported prior GCC 4.6)
2687    //#pragma GCC diagnostic pop
2688    
2689      DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {      DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {
2690          _lev_ctrl_t encodedcontroller;          _lev_ctrl_t encodedcontroller;
# Line 2154  namespace { Line 2772  namespace {
2772                      case 95:                      case 95:
2773                          encodedcontroller = _lev_ctrl_effect5depth;                          encodedcontroller = _lev_ctrl_effect5depth;
2774                          break;                          break;
2775    
2776                        // format extension (these controllers are so far only
2777                        // supported by LinuxSampler & gigedit) they will *NOT*
2778                        // work with Gigasampler/GigaStudio !
2779                        case 3:
2780                            encodedcontroller = _lev_ctrl_CC3_EXT;
2781                            break;
2782                        case 6:
2783                            encodedcontroller = _lev_ctrl_CC6_EXT;
2784                            break;
2785                        case 7:
2786                            encodedcontroller = _lev_ctrl_CC7_EXT;
2787                            break;
2788                        case 8:
2789                            encodedcontroller = _lev_ctrl_CC8_EXT;
2790                            break;
2791                        case 9:
2792                            encodedcontroller = _lev_ctrl_CC9_EXT;
2793                            break;
2794                        case 10:
2795                            encodedcontroller = _lev_ctrl_CC10_EXT;
2796                            break;
2797                        case 11:
2798                            encodedcontroller = _lev_ctrl_CC11_EXT;
2799                            break;
2800                        case 14:
2801                            encodedcontroller = _lev_ctrl_CC14_EXT;
2802                            break;
2803                        case 15:
2804                            encodedcontroller = _lev_ctrl_CC15_EXT;
2805                            break;
2806                        case 20:
2807                            encodedcontroller = _lev_ctrl_CC20_EXT;
2808                            break;
2809                        case 21:
2810                            encodedcontroller = _lev_ctrl_CC21_EXT;
2811                            break;
2812                        case 22:
2813                            encodedcontroller = _lev_ctrl_CC22_EXT;
2814                            break;
2815                        case 23:
2816                            encodedcontroller = _lev_ctrl_CC23_EXT;
2817                            break;
2818                        case 24:
2819                            encodedcontroller = _lev_ctrl_CC24_EXT;
2820                            break;
2821                        case 25:
2822                            encodedcontroller = _lev_ctrl_CC25_EXT;
2823                            break;
2824                        case 26:
2825                            encodedcontroller = _lev_ctrl_CC26_EXT;
2826                            break;
2827                        case 27:
2828                            encodedcontroller = _lev_ctrl_CC27_EXT;
2829                            break;
2830                        case 28:
2831                            encodedcontroller = _lev_ctrl_CC28_EXT;
2832                            break;
2833                        case 29:
2834                            encodedcontroller = _lev_ctrl_CC29_EXT;
2835                            break;
2836                        case 30:
2837                            encodedcontroller = _lev_ctrl_CC30_EXT;
2838                            break;
2839                        case 31:
2840                            encodedcontroller = _lev_ctrl_CC31_EXT;
2841                            break;
2842                        case 68:
2843                            encodedcontroller = _lev_ctrl_CC68_EXT;
2844                            break;
2845                        case 69:
2846                            encodedcontroller = _lev_ctrl_CC69_EXT;
2847                            break;
2848                        case 70:
2849                            encodedcontroller = _lev_ctrl_CC70_EXT;
2850                            break;
2851                        case 71:
2852                            encodedcontroller = _lev_ctrl_CC71_EXT;
2853                            break;
2854                        case 72:
2855                            encodedcontroller = _lev_ctrl_CC72_EXT;
2856                            break;
2857                        case 73:
2858                            encodedcontroller = _lev_ctrl_CC73_EXT;
2859                            break;
2860                        case 74:
2861                            encodedcontroller = _lev_ctrl_CC74_EXT;
2862                            break;
2863                        case 75:
2864                            encodedcontroller = _lev_ctrl_CC75_EXT;
2865                            break;
2866                        case 76:
2867                            encodedcontroller = _lev_ctrl_CC76_EXT;
2868                            break;
2869                        case 77:
2870                            encodedcontroller = _lev_ctrl_CC77_EXT;
2871                            break;
2872                        case 78:
2873                            encodedcontroller = _lev_ctrl_CC78_EXT;
2874                            break;
2875                        case 79:
2876                            encodedcontroller = _lev_ctrl_CC79_EXT;
2877                            break;
2878                        case 84:
2879                            encodedcontroller = _lev_ctrl_CC84_EXT;
2880                            break;
2881                        case 85:
2882                            encodedcontroller = _lev_ctrl_CC85_EXT;
2883                            break;
2884                        case 86:
2885                            encodedcontroller = _lev_ctrl_CC86_EXT;
2886                            break;
2887                        case 87:
2888                            encodedcontroller = _lev_ctrl_CC87_EXT;
2889                            break;
2890                        case 89:
2891                            encodedcontroller = _lev_ctrl_CC89_EXT;
2892                            break;
2893                        case 90:
2894                            encodedcontroller = _lev_ctrl_CC90_EXT;
2895                            break;
2896                        case 96:
2897                            encodedcontroller = _lev_ctrl_CC96_EXT;
2898                            break;
2899                        case 97:
2900                            encodedcontroller = _lev_ctrl_CC97_EXT;
2901                            break;
2902                        case 102:
2903                            encodedcontroller = _lev_ctrl_CC102_EXT;
2904                            break;
2905                        case 103:
2906                            encodedcontroller = _lev_ctrl_CC103_EXT;
2907                            break;
2908                        case 104:
2909                            encodedcontroller = _lev_ctrl_CC104_EXT;
2910                            break;
2911                        case 105:
2912                            encodedcontroller = _lev_ctrl_CC105_EXT;
2913                            break;
2914                        case 106:
2915                            encodedcontroller = _lev_ctrl_CC106_EXT;
2916                            break;
2917                        case 107:
2918                            encodedcontroller = _lev_ctrl_CC107_EXT;
2919                            break;
2920                        case 108:
2921                            encodedcontroller = _lev_ctrl_CC108_EXT;
2922                            break;
2923                        case 109:
2924                            encodedcontroller = _lev_ctrl_CC109_EXT;
2925                            break;
2926                        case 110:
2927                            encodedcontroller = _lev_ctrl_CC110_EXT;
2928                            break;
2929                        case 111:
2930                            encodedcontroller = _lev_ctrl_CC111_EXT;
2931                            break;
2932                        case 112:
2933                            encodedcontroller = _lev_ctrl_CC112_EXT;
2934                            break;
2935                        case 113:
2936                            encodedcontroller = _lev_ctrl_CC113_EXT;
2937                            break;
2938                        case 114:
2939                            encodedcontroller = _lev_ctrl_CC114_EXT;
2940                            break;
2941                        case 115:
2942                            encodedcontroller = _lev_ctrl_CC115_EXT;
2943                            break;
2944                        case 116:
2945                            encodedcontroller = _lev_ctrl_CC116_EXT;
2946                            break;
2947                        case 117:
2948                            encodedcontroller = _lev_ctrl_CC117_EXT;
2949                            break;
2950                        case 118:
2951                            encodedcontroller = _lev_ctrl_CC118_EXT;
2952                            break;
2953                        case 119:
2954                            encodedcontroller = _lev_ctrl_CC119_EXT;
2955                            break;
2956    
2957                      default:                      default:
2958                          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");
2959                  }                  }
# Line 2455  namespace { Line 3255  namespace {
3255       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
3256       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
3257       *       *
3258         * @param pProgress - callback function for progress notification
3259       * @throws gig::Exception if samples cannot be dereferenced       * @throws gig::Exception if samples cannot be dereferenced
3260       */       */
3261      void Region::UpdateChunks() {      void Region::UpdateChunks(progress_t* pProgress) {
3262          // 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
3263          // 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
3264          // 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 2465  namespace { Line 3266  namespace {
3266          pSample = pDimensionRegions[0]->pSample;          pSample = pDimensionRegions[0]->pSample;
3267    
3268          // first update base class's chunks          // first update base class's chunks
3269          DLS::Region::UpdateChunks();          DLS::Region::UpdateChunks(pProgress);
3270    
3271          // update dimension region's chunks          // update dimension region's chunks
3272          for (int i = 0; i < DimensionRegions; i++) {          for (int i = 0; i < DimensionRegions; i++) {
3273              pDimensionRegions[i]->UpdateChunks();              pDimensionRegions[i]->UpdateChunks(pProgress);
3274          }          }
3275    
3276          File* pFile = (File*) GetParent()->GetParent();          File* pFile = (File*) GetParent()->GetParent();
# Line 2485  namespace { Line 3286  namespace {
3286              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
3287    
3288              // move 3prg to last position              // move 3prg to last position
3289              pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), 0);              pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), (RIFF::Chunk*)NULL);
3290          }          }
3291    
3292          // update dimension definitions in '3lnk' chunk          // update dimension definitions in '3lnk' chunk
# Line 2559  namespace { Line 3360  namespace {
3360          int step = 1;          int step = 1;
3361          for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;          for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
3362          int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;          int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
         int end = step * pDimensionDefinitions[veldim].zones;  
3363    
3364          // loop through all dimension regions for all dimensions except the velocity dimension          // loop through all dimension regions for all dimensions except the velocity dimension
3365          int dim[8] = { 0 };          int dim[8] = { 0 };
3366          for (int i = 0 ; i < DimensionRegions ; i++) {          for (int i = 0 ; i < DimensionRegions ; i++) {
3367                const int end = i + step * pDimensionDefinitions[veldim].zones;
3368    
3369                // create a velocity table for all cases where the velocity zone is zero
3370              if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||              if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||
3371                  pDimensionRegions[i]->VelocityUpperLimit) {                  pDimensionRegions[i]->VelocityUpperLimit) {
3372                  // create the velocity table                  // create the velocity table
# Line 2595  namespace { Line 3397  namespace {
3397                  }                  }
3398              }              }
3399    
3400                // jump to the next case where the velocity zone is zero
3401              int j;              int j;
3402              int shift = 0;              int shift = 0;
3403              for (j = 0 ; j < Dimensions ; j++) {              for (j = 0 ; j < Dimensions ; j++) {
# Line 2631  namespace { Line 3434  namespace {
3434       *                        dimension bits limit is violated       *                        dimension bits limit is violated
3435       */       */
3436      void Region::AddDimension(dimension_def_t* pDimDef) {      void Region::AddDimension(dimension_def_t* pDimDef) {
3437            // some initial sanity checks of the given dimension definition
3438            if (pDimDef->zones < 2)
3439                throw gig::Exception("Could not add new dimension, amount of requested zones must always be at least two");
3440            if (pDimDef->bits < 1)
3441                throw gig::Exception("Could not add new dimension, amount of requested requested zone bits must always be at least one");
3442            if (pDimDef->dimension == dimension_samplechannel) {
3443                if (pDimDef->zones != 2)
3444                    throw gig::Exception("Could not add new 'sample channel' dimensions, the requested amount of zones must always be 2 for this dimension type");
3445                if (pDimDef->bits != 1)
3446                    throw gig::Exception("Could not add new 'sample channel' dimensions, the requested amount of zone bits must always be 1 for this dimension type");
3447            }
3448    
3449          // check if max. amount of dimensions reached          // check if max. amount of dimensions reached
3450          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
3451          const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;          const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
# Line 2806  namespace { Line 3621  namespace {
3621          if (pDimDef->dimension == dimension_layer) Layers = 1;          if (pDimDef->dimension == dimension_layer) Layers = 1;
3622      }      }
3623    
3624        /** @brief Delete one split zone of a dimension (decrement zone amount).
3625         *
3626         * Instead of deleting an entire dimensions, this method will only delete
3627         * one particular split zone given by @a zone of the Region's dimension
3628         * given by @a type. So this method will simply decrement the amount of
3629         * zones by one of the dimension in question. To be able to do that, the
3630         * respective dimension must exist on this Region and it must have at least
3631         * 3 zones. All DimensionRegion objects associated with the zone will be
3632         * deleted.
3633         *
3634         * @param type - identifies the dimension where a zone shall be deleted
3635         * @param zone - index of the dimension split zone that shall be deleted
3636         * @throws gig::Exception if requested zone could not be deleted
3637         */
3638        void Region::DeleteDimensionZone(dimension_t type, int zone) {
3639            dimension_def_t* oldDef = GetDimensionDefinition(type);
3640            if (!oldDef)
3641                throw gig::Exception("Could not delete dimension zone, no such dimension of given type");
3642            if (oldDef->zones <= 2)
3643                throw gig::Exception("Could not delete dimension zone, because it would end up with only one zone.");
3644            if (zone < 0 || zone >= oldDef->zones)
3645                throw gig::Exception("Could not delete dimension zone, requested zone index out of bounds.");
3646    
3647            const int newZoneSize = oldDef->zones - 1;
3648    
3649            // create a temporary Region which just acts as a temporary copy
3650            // container and will be deleted at the end of this function and will
3651            // also not be visible through the API during this process
3652            gig::Region* tempRgn = NULL;
3653            {
3654                // adding these temporary chunks is probably not even necessary
3655                Instrument* instr = static_cast<Instrument*>(GetParent());
3656                RIFF::List* pCkInstrument = instr->pCkInstrument;
3657                RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
3658                if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3659                RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3660                tempRgn = new Region(instr, rgn);
3661            }
3662    
3663            // copy this region's dimensions (with already the dimension split size
3664            // requested by the arguments of this method call) to the temporary
3665            // region, and don't use Region::CopyAssign() here for this task, since
3666            // it would also alter fast lookup helper variables here and there
3667            dimension_def_t newDef;
3668            for (int i = 0; i < Dimensions; ++i) {
3669                dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3670                // is this the dimension requested by the method arguments? ...
3671                if (def.dimension == type) { // ... if yes, decrement zone amount by one
3672                    def.zones = newZoneSize;
3673                    if ((1 << (def.bits - 1)) == def.zones) def.bits--;
3674                    newDef = def;
3675                }
3676                tempRgn->AddDimension(&def);
3677            }
3678    
3679            // find the dimension index in the tempRegion which is the dimension
3680            // type passed to this method (paranoidly expecting different order)
3681            int tempReducedDimensionIndex = -1;
3682            for (int d = 0; d < tempRgn->Dimensions; ++d) {
3683                if (tempRgn->pDimensionDefinitions[d].dimension == type) {
3684                    tempReducedDimensionIndex = d;
3685                    break;
3686                }
3687            }
3688    
3689            // copy dimension regions from this region to the temporary region
3690            for (int iDst = 0; iDst < 256; ++iDst) {
3691                DimensionRegion* dstDimRgn = tempRgn->pDimensionRegions[iDst];
3692                if (!dstDimRgn) continue;
3693                std::map<dimension_t,int> dimCase;
3694                bool isValidZone = true;
3695                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3696                    const int dstBits = tempRgn->pDimensionDefinitions[d].bits;
3697                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3698                        (iDst >> baseBits) & ((1 << dstBits) - 1);
3699                    baseBits += dstBits;
3700                    // there are also DimensionRegion objects of unused zones, skip them
3701                    if (dimCase[tempRgn->pDimensionDefinitions[d].dimension] >= tempRgn->pDimensionDefinitions[d].zones) {
3702                        isValidZone = false;
3703                        break;
3704                    }
3705                }
3706                if (!isValidZone) continue;
3707                // a bit paranoid: cope with the chance that the dimensions would
3708                // have different order in source and destination regions
3709                const bool isLastZone = (dimCase[type] == newZoneSize - 1);
3710                if (dimCase[type] >= zone) dimCase[type]++;
3711                DimensionRegion* srcDimRgn = GetDimensionRegionByBit(dimCase);
3712                dstDimRgn->CopyAssign(srcDimRgn);
3713                // if this is the upper most zone of the dimension passed to this
3714                // method, then correct (raise) its upper limit to 127
3715                if (newDef.split_type == split_type_normal && isLastZone)
3716                    dstDimRgn->DimensionUpperLimits[tempReducedDimensionIndex] = 127;
3717            }
3718    
3719            // now tempRegion's dimensions and DimensionRegions basically reflect
3720            // what we wanted to get for this actual Region here, so we now just
3721            // delete and recreate the dimension in question with the new amount
3722            // zones and then copy back from tempRegion      
3723            DeleteDimension(oldDef);
3724            AddDimension(&newDef);
3725            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3726                DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
3727                if (!srcDimRgn) continue;
3728                std::map<dimension_t,int> dimCase;
3729                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3730                    const int srcBits = tempRgn->pDimensionDefinitions[d].bits;
3731                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3732                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3733                    baseBits += srcBits;
3734                }
3735                // a bit paranoid: cope with the chance that the dimensions would
3736                // have different order in source and destination regions
3737                DimensionRegion* dstDimRgn = GetDimensionRegionByBit(dimCase);
3738                if (!dstDimRgn) continue;
3739                dstDimRgn->CopyAssign(srcDimRgn);
3740            }
3741    
3742            // delete temporary region
3743            delete tempRgn;
3744    
3745            UpdateVelocityTable();
3746        }
3747    
3748        /** @brief Divide split zone of a dimension in two (increment zone amount).
3749         *
3750         * This will increment the amount of zones for the dimension (given by
3751         * @a type) by one. It will do so by dividing the zone (given by @a zone)
3752         * in the middle of its zone range in two. So the two zones resulting from
3753         * the zone being splitted, will be an equivalent copy regarding all their
3754         * articulation informations and sample reference. The two zones will only
3755         * differ in their zone's upper limit
3756         * (DimensionRegion::DimensionUpperLimits).
3757         *
3758         * @param type - identifies the dimension where a zone shall be splitted
3759         * @param zone - index of the dimension split zone that shall be splitted
3760         * @throws gig::Exception if requested zone could not be splitted
3761         */
3762        void Region::SplitDimensionZone(dimension_t type, int zone) {
3763            dimension_def_t* oldDef = GetDimensionDefinition(type);
3764            if (!oldDef)
3765                throw gig::Exception("Could not split dimension zone, no such dimension of given type");
3766            if (zone < 0 || zone >= oldDef->zones)
3767                throw gig::Exception("Could not split dimension zone, requested zone index out of bounds.");
3768    
3769            const int newZoneSize = oldDef->zones + 1;
3770    
3771            // create a temporary Region which just acts as a temporary copy
3772            // container and will be deleted at the end of this function and will
3773            // also not be visible through the API during this process
3774            gig::Region* tempRgn = NULL;
3775            {
3776                // adding these temporary chunks is probably not even necessary
3777                Instrument* instr = static_cast<Instrument*>(GetParent());
3778                RIFF::List* pCkInstrument = instr->pCkInstrument;
3779                RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
3780                if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3781                RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3782                tempRgn = new Region(instr, rgn);
3783            }
3784    
3785            // copy this region's dimensions (with already the dimension split size
3786            // requested by the arguments of this method call) to the temporary
3787            // region, and don't use Region::CopyAssign() here for this task, since
3788            // it would also alter fast lookup helper variables here and there
3789            dimension_def_t newDef;
3790            for (int i = 0; i < Dimensions; ++i) {
3791                dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3792                // is this the dimension requested by the method arguments? ...
3793                if (def.dimension == type) { // ... if yes, increment zone amount by one
3794                    def.zones = newZoneSize;
3795                    if ((1 << oldDef->bits) < newZoneSize) def.bits++;
3796                    newDef = def;
3797                }
3798                tempRgn->AddDimension(&def);
3799            }
3800    
3801            // find the dimension index in the tempRegion which is the dimension
3802            // type passed to this method (paranoidly expecting different order)
3803            int tempIncreasedDimensionIndex = -1;
3804            for (int d = 0; d < tempRgn->Dimensions; ++d) {
3805                if (tempRgn->pDimensionDefinitions[d].dimension == type) {
3806                    tempIncreasedDimensionIndex = d;
3807                    break;
3808                }
3809            }
3810    
3811            // copy dimension regions from this region to the temporary region
3812            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3813                DimensionRegion* srcDimRgn = pDimensionRegions[iSrc];
3814                if (!srcDimRgn) continue;
3815                std::map<dimension_t,int> dimCase;
3816                bool isValidZone = true;
3817                for (int d = 0, baseBits = 0; d < Dimensions; ++d) {
3818                    const int srcBits = pDimensionDefinitions[d].bits;
3819                    dimCase[pDimensionDefinitions[d].dimension] =
3820                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3821                    // there are also DimensionRegion objects for unused zones, skip them
3822                    if (dimCase[pDimensionDefinitions[d].dimension] >= pDimensionDefinitions[d].zones) {
3823                        isValidZone = false;
3824                        break;
3825                    }
3826                    baseBits += srcBits;
3827                }
3828                if (!isValidZone) continue;
3829                // a bit paranoid: cope with the chance that the dimensions would
3830                // have different order in source and destination regions            
3831                if (dimCase[type] > zone) dimCase[type]++;
3832                DimensionRegion* dstDimRgn = tempRgn->GetDimensionRegionByBit(dimCase);
3833                dstDimRgn->CopyAssign(srcDimRgn);
3834                // if this is the requested zone to be splitted, then also copy
3835                // the source DimensionRegion to the newly created target zone
3836                // and set the old zones upper limit lower
3837                if (dimCase[type] == zone) {
3838                    // lower old zones upper limit
3839                    if (newDef.split_type == split_type_normal) {
3840                        const int high =
3841                            dstDimRgn->DimensionUpperLimits[tempIncreasedDimensionIndex];
3842                        int low = 0;
3843                        if (zone > 0) {
3844                            std::map<dimension_t,int> lowerCase = dimCase;
3845                            lowerCase[type]--;
3846                            DimensionRegion* dstDimRgnLow = tempRgn->GetDimensionRegionByBit(lowerCase);
3847                            low = dstDimRgnLow->DimensionUpperLimits[tempIncreasedDimensionIndex];
3848                        }
3849                        dstDimRgn->DimensionUpperLimits[tempIncreasedDimensionIndex] = low + (high - low) / 2;
3850                    }
3851                    // fill the newly created zone of the divided zone as well
3852                    dimCase[type]++;
3853                    dstDimRgn = tempRgn->GetDimensionRegionByBit(dimCase);
3854                    dstDimRgn->CopyAssign(srcDimRgn);
3855                }
3856            }
3857    
3858            // now tempRegion's dimensions and DimensionRegions basically reflect
3859            // what we wanted to get for this actual Region here, so we now just
3860            // delete and recreate the dimension in question with the new amount
3861            // zones and then copy back from tempRegion      
3862            DeleteDimension(oldDef);
3863            AddDimension(&newDef);
3864            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3865                DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
3866                if (!srcDimRgn) continue;
3867                std::map<dimension_t,int> dimCase;
3868                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3869                    const int srcBits = tempRgn->pDimensionDefinitions[d].bits;
3870                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3871                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3872                    baseBits += srcBits;
3873                }
3874                // a bit paranoid: cope with the chance that the dimensions would
3875                // have different order in source and destination regions
3876                DimensionRegion* dstDimRgn = GetDimensionRegionByBit(dimCase);
3877                if (!dstDimRgn) continue;
3878                dstDimRgn->CopyAssign(srcDimRgn);
3879            }
3880    
3881            // delete temporary region
3882            delete tempRgn;
3883    
3884            UpdateVelocityTable();
3885        }
3886    
3887        /** @brief Change type of an existing dimension.
3888         *
3889         * Alters the dimension type of a dimension already existing on this
3890         * region. If there is currently no dimension on this Region with type
3891         * @a oldType, then this call with throw an Exception. Likewise there are
3892         * cases where the requested dimension type cannot be performed. For example
3893         * if the new dimension type shall be gig::dimension_samplechannel, and the
3894         * current dimension has more than 2 zones. In such cases an Exception is
3895         * thrown as well.
3896         *
3897         * @param oldType - identifies the existing dimension to be changed
3898         * @param newType - to which dimension type it should be changed to
3899         * @throws gig::Exception if requested change cannot be performed
3900         */
3901        void Region::SetDimensionType(dimension_t oldType, dimension_t newType) {
3902            if (oldType == newType) return;
3903            dimension_def_t* def = GetDimensionDefinition(oldType);
3904            if (!def)
3905                throw gig::Exception("No dimension with provided old dimension type exists on this region");
3906            if (newType == dimension_samplechannel && def->zones != 2)
3907                throw gig::Exception("Cannot change to dimension type 'sample channel', because existing dimension does not have 2 zones");
3908            if (GetDimensionDefinition(newType))
3909                throw gig::Exception("There is already a dimension with requested new dimension type on this region");
3910            def->dimension  = newType;
3911            def->split_type = __resolveSplitType(newType);
3912        }
3913    
3914        DimensionRegion* Region::GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase) {
3915            uint8_t bits[8] = {};
3916            for (std::map<dimension_t,int>::const_iterator it = DimCase.begin();
3917                 it != DimCase.end(); ++it)
3918            {
3919                for (int d = 0; d < Dimensions; ++d) {
3920                    if (pDimensionDefinitions[d].dimension == it->first) {
3921                        bits[d] = it->second;
3922                        goto nextDimCaseSlice;
3923                    }
3924                }
3925                assert(false); // do crash ... too harsh maybe ? ignore it instead ?
3926                nextDimCaseSlice:
3927                ; // noop
3928            }
3929            return GetDimensionRegionByBit(bits);
3930        }
3931    
3932        /**
3933         * Searches in the current Region for a dimension of the given dimension
3934         * type and returns the precise configuration of that dimension in this
3935         * Region.
3936         *
3937         * @param type - dimension type of the sought dimension
3938         * @returns dimension definition or NULL if there is no dimension with
3939         *          sought type in this Region.
3940         */
3941        dimension_def_t* Region::GetDimensionDefinition(dimension_t type) {
3942            for (int i = 0; i < Dimensions; ++i)
3943                if (pDimensionDefinitions[i].dimension == type)
3944                    return &pDimensionDefinitions[i];
3945            return NULL;
3946        }
3947    
3948      Region::~Region() {      Region::~Region() {
3949          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
3950              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
# Line 2833  namespace { Line 3972  namespace {
3972      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
3973          uint8_t bits;          uint8_t bits;
3974          int veldim = -1;          int veldim = -1;
3975          int velbitpos;          int velbitpos = 0;
3976          int bitpos = 0;          int bitpos = 0;
3977          int dimregidx = 0;          int dimregidx = 0;
3978          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
# Line 2863  namespace { Line 4002  namespace {
4002              }              }
4003              bitpos += pDimensionDefinitions[i].bits;              bitpos += pDimensionDefinitions[i].bits;
4004          }          }
4005          DimensionRegion* dimreg = pDimensionRegions[dimregidx];          DimensionRegion* dimreg = pDimensionRegions[dimregidx & 255];
4006            if (!dimreg) return NULL;
4007          if (veldim != -1) {          if (veldim != -1) {
4008              // (dimreg is now the dimension region for the lowest velocity)              // (dimreg is now the dimension region for the lowest velocity)
4009              if (dimreg->VelocityTable) // custom defined zone ranges              if (dimreg->VelocityTable) // custom defined zone ranges
4010                  bits = dimreg->VelocityTable[DimValues[veldim]];                  bits = dimreg->VelocityTable[DimValues[veldim] & 127];
4011              else // normal split type              else // normal split type
4012                  bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);                  bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
4013    
4014              dimregidx |= bits << velbitpos;              const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
4015              dimreg = pDimensionRegions[dimregidx];              dimregidx |= (bits & limiter_mask) << velbitpos;
4016                dimreg = pDimensionRegions[dimregidx & 255];
4017          }          }
4018          return dimreg;          return dimreg;
4019      }      }
4020    
4021        int Region::GetDimensionRegionIndexByValue(const uint DimValues[8]) {
4022            uint8_t bits;
4023            int veldim = -1;
4024            int velbitpos = 0;
4025            int bitpos = 0;
4026            int dimregidx = 0;
4027            for (uint i = 0; i < Dimensions; i++) {
4028                if (pDimensionDefinitions[i].dimension == dimension_velocity) {
4029                    // the velocity dimension must be handled after the other dimensions
4030                    veldim = i;
4031                    velbitpos = bitpos;
4032                } else {
4033                    switch (pDimensionDefinitions[i].split_type) {
4034                        case split_type_normal:
4035                            if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
4036                                // gig3: all normal dimensions (not just the velocity dimension) have custom zone ranges
4037                                for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
4038                                    if (DimValues[i] <= pDimensionRegions[bits << bitpos]->DimensionUpperLimits[i]) break;
4039                                }
4040                            } else {
4041                                // gig2: evenly sized zones
4042                                bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
4043                            }
4044                            break;
4045                        case split_type_bit: // the value is already the sought dimension bit number
4046                            const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
4047                            bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
4048                            break;
4049                    }
4050                    dimregidx |= bits << bitpos;
4051                }
4052                bitpos += pDimensionDefinitions[i].bits;
4053            }
4054            dimregidx &= 255;
4055            DimensionRegion* dimreg = pDimensionRegions[dimregidx];
4056            if (!dimreg) return -1;
4057            if (veldim != -1) {
4058                // (dimreg is now the dimension region for the lowest velocity)
4059                if (dimreg->VelocityTable) // custom defined zone ranges
4060                    bits = dimreg->VelocityTable[DimValues[veldim] & 127];
4061                else // normal split type
4062                    bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
4063    
4064                const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
4065                dimregidx |= (bits & limiter_mask) << velbitpos;
4066                dimregidx &= 255;
4067            }
4068            return dimregidx;
4069        }
4070    
4071      /**      /**
4072       * Returns the appropriate DimensionRegion for the given dimension bit       * Returns the appropriate DimensionRegion for the given dimension bit
4073       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>
# Line 2915  namespace { Line 4106  namespace {
4106          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
4107          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
4108          if (!file->pWavePoolTable) return NULL;          if (!file->pWavePoolTable) return NULL;
4109          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          // for new files or files >= 2 GB use 64 bit wave pool offsets
4110          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];          if (file->pRIFF->IsNew() || (file->pRIFF->GetCurrentFileSize() >> 31)) {
4111          Sample* sample = file->GetFirstSample(pProgress);              // use 64 bit wave pool offsets (treating this as large file)
4112          while (sample) {              uint64_t soughtoffset =
4113              if (sample->ulWavePoolOffset == soughtoffset &&                  uint64_t(file->pWavePoolTable[WavePoolTableIndex]) |
4114                  sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);                  uint64_t(file->pWavePoolTableHi[WavePoolTableIndex]) << 32;
4115              sample = file->GetNextSample();              Sample* sample = file->GetFirstSample(pProgress);
4116                while (sample) {
4117                    if (sample->ullWavePoolOffset == soughtoffset)
4118                        return static_cast<gig::Sample*>(sample);
4119                    sample = file->GetNextSample();
4120                }
4121            } else {
4122                // use extension files and 32 bit wave pool offsets
4123                file_offset_t soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
4124                file_offset_t soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
4125                Sample* sample = file->GetFirstSample(pProgress);
4126                while (sample) {
4127                    if (sample->ullWavePoolOffset == soughtoffset &&
4128                        sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
4129                    sample = file->GetNextSample();
4130                }
4131          }          }
4132          return NULL;          return NULL;
4133      }      }
4134        
4135        /**
4136         * Make a (semi) deep copy of the Region object given by @a orig
4137         * and assign it to this object.
4138         *
4139         * Note that all sample pointers referenced by @a orig are simply copied as
4140         * memory address. Thus the respective samples are shared, not duplicated!
4141         *
4142         * @param orig - original Region object to be copied from
4143         */
4144        void Region::CopyAssign(const Region* orig) {
4145            CopyAssign(orig, NULL);
4146        }
4147        
4148        /**
4149         * Make a (semi) deep copy of the Region object given by @a orig and
4150         * assign it to this object
4151         *
4152         * @param mSamples - crosslink map between the foreign file's samples and
4153         *                   this file's samples
4154         */
4155        void Region::CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples) {
4156            // handle base classes
4157            DLS::Region::CopyAssign(orig);
4158            
4159            if (mSamples && mSamples->count((gig::Sample*)orig->pSample)) {
4160                pSample = mSamples->find((gig::Sample*)orig->pSample)->second;
4161            }
4162            
4163            // handle own member variables
4164            for (int i = Dimensions - 1; i >= 0; --i) {
4165                DeleteDimension(&pDimensionDefinitions[i]);
4166            }
4167            Layers = 0; // just to be sure
4168            for (int i = 0; i < orig->Dimensions; i++) {
4169                // we need to copy the dim definition here, to avoid the compiler
4170                // complaining about const-ness issue
4171                dimension_def_t def = orig->pDimensionDefinitions[i];
4172                AddDimension(&def);
4173            }
4174            for (int i = 0; i < 256; i++) {
4175                if (pDimensionRegions[i] && orig->pDimensionRegions[i]) {
4176                    pDimensionRegions[i]->CopyAssign(
4177                        orig->pDimensionRegions[i],
4178                        mSamples
4179                    );
4180                }
4181            }
4182            Layers = orig->Layers;
4183        }
4184    
4185    
4186  // *************** MidiRule ***************  // *************** MidiRule ***************
4187  // *  // *
4188    
4189  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg) {      MidiRuleCtrlTrigger::MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg) {
4190      _3ewg->SetPos(36);          _3ewg->SetPos(36);
4191      Triggers = _3ewg->ReadUint8();          Triggers = _3ewg->ReadUint8();
4192      _3ewg->SetPos(40);          _3ewg->SetPos(40);
4193      ControllerNumber = _3ewg->ReadUint8();          ControllerNumber = _3ewg->ReadUint8();
4194      _3ewg->SetPos(46);          _3ewg->SetPos(46);
4195      for (int i = 0 ; i < Triggers ; i++) {          for (int i = 0 ; i < Triggers ; i++) {
4196          pTriggers[i].TriggerPoint = _3ewg->ReadUint8();              pTriggers[i].TriggerPoint = _3ewg->ReadUint8();
4197          pTriggers[i].Descending = _3ewg->ReadUint8();              pTriggers[i].Descending = _3ewg->ReadUint8();
4198          pTriggers[i].VelSensitivity = _3ewg->ReadUint8();              pTriggers[i].VelSensitivity = _3ewg->ReadUint8();
4199          pTriggers[i].Key = _3ewg->ReadUint8();              pTriggers[i].Key = _3ewg->ReadUint8();
4200          pTriggers[i].NoteOff = _3ewg->ReadUint8();              pTriggers[i].NoteOff = _3ewg->ReadUint8();
4201          pTriggers[i].Velocity = _3ewg->ReadUint8();              pTriggers[i].Velocity = _3ewg->ReadUint8();
4202          pTriggers[i].OverridePedal = _3ewg->ReadUint8();              pTriggers[i].OverridePedal = _3ewg->ReadUint8();
4203          _3ewg->ReadUint8();              _3ewg->ReadUint8();
4204            }
4205        }
4206    
4207        MidiRuleCtrlTrigger::MidiRuleCtrlTrigger() :
4208            ControllerNumber(0),
4209            Triggers(0) {
4210        }
4211    
4212        void MidiRuleCtrlTrigger::UpdateChunks(uint8_t* pData) const {
4213            pData[32] = 4;
4214            pData[33] = 16;
4215            pData[36] = Triggers;
4216            pData[40] = ControllerNumber;
4217            for (int i = 0 ; i < Triggers ; i++) {
4218                pData[46 + i * 8] = pTriggers[i].TriggerPoint;
4219                pData[47 + i * 8] = pTriggers[i].Descending;
4220                pData[48 + i * 8] = pTriggers[i].VelSensitivity;
4221                pData[49 + i * 8] = pTriggers[i].Key;
4222                pData[50 + i * 8] = pTriggers[i].NoteOff;
4223                pData[51 + i * 8] = pTriggers[i].Velocity;
4224                pData[52 + i * 8] = pTriggers[i].OverridePedal;
4225            }
4226        }
4227    
4228        MidiRuleLegato::MidiRuleLegato(RIFF::Chunk* _3ewg) {
4229            _3ewg->SetPos(36);
4230            LegatoSamples = _3ewg->ReadUint8(); // always 12
4231            _3ewg->SetPos(40);
4232            BypassUseController = _3ewg->ReadUint8();
4233            BypassKey = _3ewg->ReadUint8();
4234            BypassController = _3ewg->ReadUint8();
4235            ThresholdTime = _3ewg->ReadUint16();
4236            _3ewg->ReadInt16();
4237            ReleaseTime = _3ewg->ReadUint16();
4238            _3ewg->ReadInt16();
4239            KeyRange.low = _3ewg->ReadUint8();
4240            KeyRange.high = _3ewg->ReadUint8();
4241            _3ewg->SetPos(64);
4242            ReleaseTriggerKey = _3ewg->ReadUint8();
4243            AltSustain1Key = _3ewg->ReadUint8();
4244            AltSustain2Key = _3ewg->ReadUint8();
4245        }
4246    
4247        MidiRuleLegato::MidiRuleLegato() :
4248            LegatoSamples(12),
4249            BypassUseController(false),
4250            BypassKey(0),
4251            BypassController(1),
4252            ThresholdTime(20),
4253            ReleaseTime(20),
4254            ReleaseTriggerKey(0),
4255            AltSustain1Key(0),
4256            AltSustain2Key(0)
4257        {
4258            KeyRange.low = KeyRange.high = 0;
4259        }
4260    
4261        void MidiRuleLegato::UpdateChunks(uint8_t* pData) const {
4262            pData[32] = 0;
4263            pData[33] = 16;
4264            pData[36] = LegatoSamples;
4265            pData[40] = BypassUseController;
4266            pData[41] = BypassKey;
4267            pData[42] = BypassController;
4268            store16(&pData[43], ThresholdTime);
4269            store16(&pData[47], ReleaseTime);
4270            pData[51] = KeyRange.low;
4271            pData[52] = KeyRange.high;
4272            pData[64] = ReleaseTriggerKey;
4273            pData[65] = AltSustain1Key;
4274            pData[66] = AltSustain2Key;
4275        }
4276    
4277        MidiRuleAlternator::MidiRuleAlternator(RIFF::Chunk* _3ewg) {
4278            _3ewg->SetPos(36);
4279            Articulations = _3ewg->ReadUint8();
4280            int flags = _3ewg->ReadUint8();
4281            Polyphonic = flags & 8;
4282            Chained = flags & 4;
4283            Selector = (flags & 2) ? selector_controller :
4284                (flags & 1) ? selector_key_switch : selector_none;
4285            Patterns = _3ewg->ReadUint8();
4286            _3ewg->ReadUint8(); // chosen row
4287            _3ewg->ReadUint8(); // unknown
4288            _3ewg->ReadUint8(); // unknown
4289            _3ewg->ReadUint8(); // unknown
4290            KeySwitchRange.low = _3ewg->ReadUint8();
4291            KeySwitchRange.high = _3ewg->ReadUint8();
4292            Controller = _3ewg->ReadUint8();
4293            PlayRange.low = _3ewg->ReadUint8();
4294            PlayRange.high = _3ewg->ReadUint8();
4295    
4296            int n = std::min(int(Articulations), 32);
4297            for (int i = 0 ; i < n ; i++) {
4298                _3ewg->ReadString(pArticulations[i], 32);
4299            }
4300            _3ewg->SetPos(1072);
4301            n = std::min(int(Patterns), 32);
4302            for (int i = 0 ; i < n ; i++) {
4303                _3ewg->ReadString(pPatterns[i].Name, 16);
4304                pPatterns[i].Size = _3ewg->ReadUint8();
4305                _3ewg->Read(&pPatterns[i][0], 1, 32);
4306            }
4307        }
4308    
4309        MidiRuleAlternator::MidiRuleAlternator() :
4310            Articulations(0),
4311            Patterns(0),
4312            Selector(selector_none),
4313            Controller(0),
4314            Polyphonic(false),
4315            Chained(false)
4316        {
4317            PlayRange.low = PlayRange.high = 0;
4318            KeySwitchRange.low = KeySwitchRange.high = 0;
4319        }
4320    
4321        void MidiRuleAlternator::UpdateChunks(uint8_t* pData) const {
4322            pData[32] = 3;
4323            pData[33] = 16;
4324            pData[36] = Articulations;
4325            pData[37] = (Polyphonic ? 8 : 0) | (Chained ? 4 : 0) |
4326                (Selector == selector_controller ? 2 :
4327                 (Selector == selector_key_switch ? 1 : 0));
4328            pData[38] = Patterns;
4329    
4330            pData[43] = KeySwitchRange.low;
4331            pData[44] = KeySwitchRange.high;
4332            pData[45] = Controller;
4333            pData[46] = PlayRange.low;
4334            pData[47] = PlayRange.high;
4335    
4336            char* str = reinterpret_cast<char*>(pData);
4337            int pos = 48;
4338            int n = std::min(int(Articulations), 32);
4339            for (int i = 0 ; i < n ; i++, pos += 32) {
4340                strncpy(&str[pos], pArticulations[i].c_str(), 32);
4341            }
4342    
4343            pos = 1072;
4344            n = std::min(int(Patterns), 32);
4345            for (int i = 0 ; i < n ; i++, pos += 49) {
4346                strncpy(&str[pos], pPatterns[i].Name.c_str(), 16);
4347                pData[pos + 16] = pPatterns[i].Size;
4348                memcpy(&pData[pos + 16], &(pPatterns[i][0]), 32);
4349            }
4350        }
4351    
4352    // *************** Script ***************
4353    // *
4354    
4355        Script::Script(ScriptGroup* group, RIFF::Chunk* ckScri) {
4356            pGroup = group;
4357            pChunk = ckScri;
4358            if (ckScri) { // object is loaded from file ...
4359                // read header
4360                uint32_t headerSize = ckScri->ReadUint32();
4361                Compression = (Compression_t) ckScri->ReadUint32();
4362                Encoding    = (Encoding_t) ckScri->ReadUint32();
4363                Language    = (Language_t) ckScri->ReadUint32();
4364                Bypass      = (Language_t) ckScri->ReadUint32() & 1;
4365                crc         = ckScri->ReadUint32();
4366                uint32_t nameSize = ckScri->ReadUint32();
4367                Name.resize(nameSize, ' ');
4368                for (int i = 0; i < nameSize; ++i)
4369                    Name[i] = ckScri->ReadUint8();
4370                // to handle potential future extensions of the header
4371                ckScri->SetPos(sizeof(int32_t) + headerSize);
4372                // read actual script data
4373                uint32_t scriptSize = uint32_t(ckScri->GetSize() - ckScri->GetPos());
4374                data.resize(scriptSize);
4375                for (int i = 0; i < scriptSize; ++i)
4376                    data[i] = ckScri->ReadUint8();
4377            } else { // this is a new script object, so just initialize it as such ...
4378                Compression = COMPRESSION_NONE;
4379                Encoding = ENCODING_ASCII;
4380                Language = LANGUAGE_NKSP;
4381                Bypass   = false;
4382                crc      = 0;
4383                Name     = "Unnamed Script";
4384            }
4385        }
4386    
4387        Script::~Script() {
4388        }
4389    
4390        /**
4391         * Returns the current script (i.e. as source code) in text format.
4392         */
4393        String Script::GetScriptAsText() {
4394            String s;
4395            s.resize(data.size(), ' ');
4396            memcpy(&s[0], &data[0], data.size());
4397            return s;
4398        }
4399    
4400        /**
4401         * Replaces the current script with the new script source code text given
4402         * by @a text.
4403         *
4404         * @param text - new script source code
4405         */
4406        void Script::SetScriptAsText(const String& text) {
4407            data.resize(text.size());
4408            memcpy(&data[0], &text[0], text.size());
4409        }
4410    
4411        /**
4412         * Apply this script to the respective RIFF chunks. You have to call
4413         * File::Save() to make changes persistent.
4414         *
4415         * Usually there is absolutely no need to call this method explicitly.
4416         * It will be called automatically when File::Save() was called.
4417         *
4418         * @param pProgress - callback function for progress notification
4419         */
4420        void Script::UpdateChunks(progress_t* pProgress) {
4421            // recalculate CRC32 check sum
4422            __resetCRC(crc);
4423            __calculateCRC(&data[0], data.size(), crc);
4424            __finalizeCRC(crc);
4425            // make sure chunk exists and has the required size
4426            const file_offset_t chunkSize = (file_offset_t) 7*sizeof(int32_t) + Name.size() + data.size();
4427            if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);
4428            else pChunk->Resize(chunkSize);
4429            // fill the chunk data to be written to disk
4430            uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();
4431            int pos = 0;
4432            store32(&pData[pos], uint32_t(6*sizeof(int32_t) + Name.size())); // total header size
4433            pos += sizeof(int32_t);
4434            store32(&pData[pos], Compression);
4435            pos += sizeof(int32_t);
4436            store32(&pData[pos], Encoding);
4437            pos += sizeof(int32_t);
4438            store32(&pData[pos], Language);
4439            pos += sizeof(int32_t);
4440            store32(&pData[pos], Bypass ? 1 : 0);
4441            pos += sizeof(int32_t);
4442            store32(&pData[pos], crc);
4443            pos += sizeof(int32_t);
4444            store32(&pData[pos], (uint32_t) Name.size());
4445            pos += sizeof(int32_t);
4446            for (int i = 0; i < Name.size(); ++i, ++pos)
4447                pData[pos] = Name[i];
4448            for (int i = 0; i < data.size(); ++i, ++pos)
4449                pData[pos] = data[i];
4450        }
4451    
4452        /**
4453         * Move this script from its current ScriptGroup to another ScriptGroup
4454         * given by @a pGroup.
4455         *
4456         * @param pGroup - script's new group
4457         */
4458        void Script::SetGroup(ScriptGroup* pGroup) {
4459            if (this->pGroup == pGroup) return;
4460            if (pChunk)
4461                pChunk->GetParent()->MoveSubChunk(pChunk, pGroup->pList);
4462            this->pGroup = pGroup;
4463        }
4464    
4465        /**
4466         * Returns the script group this script currently belongs to. Each script
4467         * is a member of exactly one ScriptGroup.
4468         *
4469         * @returns current script group
4470         */
4471        ScriptGroup* Script::GetGroup() const {
4472            return pGroup;
4473        }
4474    
4475        /**
4476         * Make a (semi) deep copy of the Script object given by @a orig
4477         * and assign it to this object. Note: the ScriptGroup this Script
4478         * object belongs to remains untouched by this call.
4479         *
4480         * @param orig - original Script object to be copied from
4481         */
4482        void Script::CopyAssign(const Script* orig) {
4483            Name        = orig->Name;
4484            Compression = orig->Compression;
4485            Encoding    = orig->Encoding;
4486            Language    = orig->Language;
4487            Bypass      = orig->Bypass;
4488            data        = orig->data;
4489      }      }
 }  
4490    
4491        void Script::RemoveAllScriptReferences() {
4492            File* pFile = pGroup->pFile;
4493            for (int i = 0; pFile->GetInstrument(i); ++i) {
4494                Instrument* instr = pFile->GetInstrument(i);
4495                instr->RemoveScript(this);
4496            }
4497        }
4498    
4499    // *************** ScriptGroup ***************
4500    // *
4501    
4502        ScriptGroup::ScriptGroup(File* file, RIFF::List* lstRTIS) {
4503            pFile = file;
4504            pList = lstRTIS;
4505            pScripts = NULL;
4506            if (lstRTIS) {
4507                RIFF::Chunk* ckName = lstRTIS->GetSubChunk(CHUNK_ID_LSNM);
4508                ::LoadString(ckName, Name);
4509            } else {
4510                Name = "Default Group";
4511            }
4512        }
4513    
4514        ScriptGroup::~ScriptGroup() {
4515            if (pScripts) {
4516                std::list<Script*>::iterator iter = pScripts->begin();
4517                std::list<Script*>::iterator end  = pScripts->end();
4518                while (iter != end) {
4519                    delete *iter;
4520                    ++iter;
4521                }
4522                delete pScripts;
4523            }
4524        }
4525    
4526        /**
4527         * Apply this script group to the respective RIFF chunks. You have to call
4528         * File::Save() to make changes persistent.
4529         *
4530         * Usually there is absolutely no need to call this method explicitly.
4531         * It will be called automatically when File::Save() was called.
4532         *
4533         * @param pProgress - callback function for progress notification
4534         */
4535        void ScriptGroup::UpdateChunks(progress_t* pProgress) {
4536            if (pScripts) {
4537                if (!pList)
4538                    pList = pFile->pRIFF->GetSubList(LIST_TYPE_3LS)->AddSubList(LIST_TYPE_RTIS);
4539    
4540                // now store the name of this group as <LSNM> chunk as subchunk of the <RTIS> list chunk
4541                ::SaveString(CHUNK_ID_LSNM, NULL, pList, Name, String("Unnamed Group"), true, 64);
4542    
4543                for (std::list<Script*>::iterator it = pScripts->begin();
4544                     it != pScripts->end(); ++it)
4545                {
4546                    (*it)->UpdateChunks(pProgress);
4547                }
4548            }
4549        }
4550    
4551        /** @brief Get instrument script.
4552         *
4553         * Returns the real-time instrument script with the given index.
4554         *
4555         * @param index - number of the sought script (0..n)
4556         * @returns sought script or NULL if there's no such script
4557         */
4558        Script* ScriptGroup::GetScript(uint index) {
4559            if (!pScripts) LoadScripts();
4560            std::list<Script*>::iterator it = pScripts->begin();
4561            for (uint i = 0; it != pScripts->end(); ++i, ++it)
4562                if (i == index) return *it;
4563            return NULL;
4564        }
4565    
4566        /** @brief Add new instrument script.
4567         *
4568         * Adds a new real-time instrument script to the file. The script is not
4569         * actually used / executed unless it is referenced by an instrument to be
4570         * used. This is similar to samples, which you can add to a file, without
4571         * an instrument necessarily actually using it.
4572         *
4573         * You have to call Save() to make this persistent to the file.
4574         *
4575         * @return new empty script object
4576         */
4577        Script* ScriptGroup::AddScript() {
4578            if (!pScripts) LoadScripts();
4579            Script* pScript = new Script(this, NULL);
4580            pScripts->push_back(pScript);
4581            return pScript;
4582        }
4583    
4584        /** @brief Delete an instrument script.
4585         *
4586         * This will delete the given real-time instrument script. References of
4587         * instruments that are using that script will be removed accordingly.
4588         *
4589         * You have to call Save() to make this persistent to the file.
4590         *
4591         * @param pScript - script to delete
4592         * @throws gig::Exception if given script could not be found
4593         */
4594        void ScriptGroup::DeleteScript(Script* pScript) {
4595            if (!pScripts) LoadScripts();
4596            std::list<Script*>::iterator iter =
4597                find(pScripts->begin(), pScripts->end(), pScript);
4598            if (iter == pScripts->end())
4599                throw gig::Exception("Could not delete script, could not find given script");
4600            pScripts->erase(iter);
4601            pScript->RemoveAllScriptReferences();
4602            if (pScript->pChunk)
4603                pScript->pChunk->GetParent()->DeleteSubChunk(pScript->pChunk);
4604            delete pScript;
4605        }
4606    
4607        void ScriptGroup::LoadScripts() {
4608            if (pScripts) return;
4609            pScripts = new std::list<Script*>;
4610            if (!pList) return;
4611    
4612            for (RIFF::Chunk* ck = pList->GetFirstSubChunk(); ck;
4613                 ck = pList->GetNextSubChunk())
4614            {
4615                if (ck->GetChunkID() == CHUNK_ID_SCRI) {
4616                    pScripts->push_back(new Script(this, ck));
4617                }
4618            }
4619        }
4620    
4621  // *************** Instrument ***************  // *************** Instrument ***************
4622  // *  // *
# Line 2965  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4634  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4634          EffectSend = 0;          EffectSend = 0;
4635          Attenuation = 0;          Attenuation = 0;
4636          FineTune = 0;          FineTune = 0;
4637          PitchbendRange = 0;          PitchbendRange = 2;
4638          PianoReleaseMode = false;          PianoReleaseMode = false;
4639          DimensionKeyRange.low = 0;          DimensionKeyRange.low = 0;
4640          DimensionKeyRange.high = 0;          DimensionKeyRange.high = 0;
4641          pMidiRules = new MidiRule*[3];          pMidiRules = new MidiRule*[3];
4642          pMidiRules[0] = NULL;          pMidiRules[0] = NULL;
4643            pScriptRefs = NULL;
4644    
4645          // Loading          // Loading
4646          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
# Line 2993  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4663  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4663                      uint8_t id1 = _3ewg->ReadUint8();                      uint8_t id1 = _3ewg->ReadUint8();
4664                      uint8_t id2 = _3ewg->ReadUint8();                      uint8_t id2 = _3ewg->ReadUint8();
4665    
4666                      if (id1 == 4 && id2 == 16) {                      if (id2 == 16) {
4667                          pMidiRules[i++] = new MidiRuleCtrlTrigger(_3ewg);                          if (id1 == 4) {
4668                                pMidiRules[i++] = new MidiRuleCtrlTrigger(_3ewg);
4669                            } else if (id1 == 0) {
4670                                pMidiRules[i++] = new MidiRuleLegato(_3ewg);
4671                            } else if (id1 == 3) {
4672                                pMidiRules[i++] = new MidiRuleAlternator(_3ewg);
4673                            } else {
4674                                pMidiRules[i++] = new MidiRuleUnknown;
4675                            }
4676                        }
4677                        else if (id1 != 0 || id2 != 0) {
4678                            pMidiRules[i++] = new MidiRuleUnknown;
4679                      }                      }
4680                      //TODO: all the other types of rules                      //TODO: all the other types of rules
4681    
# Line 3020  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4701  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4701              }              }
4702          }          }
4703    
4704            // own gig format extensions
4705            RIFF::List* lst3LS = insList->GetSubList(LIST_TYPE_3LS);
4706            if (lst3LS) {
4707                RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4708                if (ckSCSL) {
4709                    int headerSize = ckSCSL->ReadUint32();
4710                    int slotCount  = ckSCSL->ReadUint32();
4711                    if (slotCount) {
4712                        int slotSize  = ckSCSL->ReadUint32();
4713                        ckSCSL->SetPos(headerSize); // in case of future header extensions
4714                        int unknownSpace = slotSize - 2*sizeof(uint32_t); // in case of future slot extensions
4715                        for (int i = 0; i < slotCount; ++i) {
4716                            _ScriptPooolEntry e;
4717                            e.fileOffset = ckSCSL->ReadUint32();
4718                            e.bypass     = ckSCSL->ReadUint32() & 1;
4719                            if (unknownSpace) ckSCSL->SetPos(unknownSpace, RIFF::stream_curpos); // in case of future extensions
4720                            scriptPoolFileOffsets.push_back(e);
4721                        }
4722                    }
4723                }
4724            }
4725    
4726          __notify_progress(pProgress, 1.0f); // notify done          __notify_progress(pProgress, 1.0f); // notify done
4727      }      }
4728    
# Line 3036  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4739  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4739      }      }
4740    
4741      Instrument::~Instrument() {      Instrument::~Instrument() {
4742            for (int i = 0 ; pMidiRules[i] ; i++) {
4743                delete pMidiRules[i];
4744            }
4745          delete[] pMidiRules;          delete[] pMidiRules;
4746            if (pScriptRefs) delete pScriptRefs;
4747      }      }
4748    
4749      /**      /**
# Line 3046  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4753  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4753       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
4754       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
4755       *       *
4756         * @param pProgress - callback function for progress notification
4757       * @throws gig::Exception if samples cannot be dereferenced       * @throws gig::Exception if samples cannot be dereferenced
4758       */       */
4759      void Instrument::UpdateChunks() {      void Instrument::UpdateChunks(progress_t* pProgress) {
4760          // first update base classes' chunks          // first update base classes' chunks
4761          DLS::Instrument::UpdateChunks();          DLS::Instrument::UpdateChunks(pProgress);
4762    
4763          // update Regions' chunks          // update Regions' chunks
4764          {          {
4765              RegionList::iterator iter = pRegions->begin();              RegionList::iterator iter = pRegions->begin();
4766              RegionList::iterator end  = pRegions->end();              RegionList::iterator end  = pRegions->end();
4767              for (; iter != end; ++iter)              for (; iter != end; ++iter)
4768                  (*iter)->UpdateChunks();                  (*iter)->UpdateChunks(pProgress);
4769          }          }
4770    
4771          // make sure 'lart' RIFF list chunk exists          // make sure 'lart' RIFF list chunk exists
# Line 3083  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4791  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4791                                      DimensionKeyRange.low << 1;                                      DimensionKeyRange.low << 1;
4792          pData[10] = dimkeystart;          pData[10] = dimkeystart;
4793          pData[11] = DimensionKeyRange.high;          pData[11] = DimensionKeyRange.high;
4794    
4795            if (pMidiRules[0] == 0 && _3ewg->GetSize() >= 34) {
4796                pData[32] = 0;
4797                pData[33] = 0;
4798            } else {
4799                for (int i = 0 ; pMidiRules[i] ; i++) {
4800                    pMidiRules[i]->UpdateChunks(pData);
4801                }
4802            }
4803    
4804            // own gig format extensions
4805           if (ScriptSlotCount()) {
4806               // make sure we have converted the original loaded script file
4807               // offsets into valid Script object pointers
4808               LoadScripts();
4809    
4810               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4811               if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);
4812               const int slotCount = (int) pScriptRefs->size();
4813               const int headerSize = 3 * sizeof(uint32_t);
4814               const int slotSize  = 2 * sizeof(uint32_t);
4815               const int totalChunkSize = headerSize + slotCount * slotSize;
4816               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4817               if (!ckSCSL) ckSCSL = lst3LS->AddSubChunk(CHUNK_ID_SCSL, totalChunkSize);
4818               else ckSCSL->Resize(totalChunkSize);
4819               uint8_t* pData = (uint8_t*) ckSCSL->LoadChunkData();
4820               int pos = 0;
4821               store32(&pData[pos], headerSize);
4822               pos += sizeof(uint32_t);
4823               store32(&pData[pos], slotCount);
4824               pos += sizeof(uint32_t);
4825               store32(&pData[pos], slotSize);
4826               pos += sizeof(uint32_t);
4827               for (int i = 0; i < slotCount; ++i) {
4828                   // arbitrary value, the actual file offset will be updated in
4829                   // UpdateScriptFileOffsets() after the file has been resized
4830                   int bogusFileOffset = 0;
4831                   store32(&pData[pos], bogusFileOffset);
4832                   pos += sizeof(uint32_t);
4833                   store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0);
4834                   pos += sizeof(uint32_t);
4835               }
4836           } else {
4837               // no script slots, so get rid of any LS custom RIFF chunks (if any)
4838               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4839               if (lst3LS) pCkInstrument->DeleteSubChunk(lst3LS);
4840           }
4841        }
4842    
4843        void Instrument::UpdateScriptFileOffsets() {
4844           // own gig format extensions
4845           if (pScriptRefs && pScriptRefs->size() > 0) {
4846               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4847               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4848               const int slotCount = (int) pScriptRefs->size();
4849               const int headerSize = 3 * sizeof(uint32_t);
4850               ckSCSL->SetPos(headerSize);
4851               for (int i = 0; i < slotCount; ++i) {
4852                   uint32_t fileOffset = uint32_t(
4853                        (*pScriptRefs)[i].script->pChunk->GetFilePos() -
4854                        (*pScriptRefs)[i].script->pChunk->GetPos() -
4855                        CHUNK_HEADER_SIZE(ckSCSL->GetFile()->GetFileOffsetSize())
4856                   );
4857                   ckSCSL->WriteUint32(&fileOffset);
4858                   // jump over flags entry (containing the bypass flag)
4859                   ckSCSL->SetPos(sizeof(uint32_t), RIFF::stream_curpos);
4860               }
4861           }        
4862      }      }
4863    
4864      /**      /**
# Line 3137  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4913  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4913          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
4914          Region* pNewRegion = new Region(this, rgn);          Region* pNewRegion = new Region(this, rgn);
4915          pRegions->push_back(pNewRegion);          pRegions->push_back(pNewRegion);
4916          Regions = pRegions->size();          Regions = (uint32_t) pRegions->size();
4917          // update Region key table for fast lookup          // update Region key table for fast lookup
4918          UpdateRegionKeyTable();          UpdateRegionKeyTable();
4919          // done          // done
# Line 3152  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4928  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4928      }      }
4929    
4930      /**      /**
4931         * Move this instrument at the position before @arg dst.
4932         *
4933         * This method can be used to reorder the sequence of instruments in a
4934         * .gig file. This might be helpful especially on large .gig files which
4935         * contain a large number of instruments within the same .gig file. So
4936         * grouping such instruments to similar ones, can help to keep track of them
4937         * when working with such complex .gig files.
4938         *
4939         * When calling this method, this instrument will be removed from in its
4940         * current position in the instruments list and moved to the requested
4941         * target position provided by @param dst. You may also pass NULL as
4942         * argument to this method, in that case this intrument will be moved to the
4943         * very end of the .gig file's instrument list.
4944         *
4945         * You have to call Save() to make the order change persistent to the .gig
4946         * file.
4947         *
4948         * Currently this method is limited to moving the instrument within the same
4949         * .gig file. Trying to move it to another .gig file by calling this method
4950         * will throw an exception.
4951         *
4952         * @param dst - destination instrument at which this instrument will be
4953         *              moved to, or pass NULL for moving to end of list
4954         * @throw gig::Exception if this instrument and target instrument are not
4955         *                       part of the same file
4956         */
4957        void Instrument::MoveTo(Instrument* dst) {
4958            if (dst && GetParent() != dst->GetParent())
4959                throw Exception(
4960                    "gig::Instrument::MoveTo() can only be used for moving within "
4961                    "the same gig file."
4962                );
4963    
4964            File* pFile = (File*) GetParent();
4965    
4966            // move this instrument within the instrument list
4967            {
4968                File::InstrumentList& list = *pFile->pInstruments;
4969    
4970                File::InstrumentList::iterator itFrom =
4971                    std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(this));
4972    
4973                File::InstrumentList::iterator itTo =
4974                    std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(dst));
4975    
4976                list.splice(itTo, list, itFrom);
4977            }
4978    
4979            // move the instrument's actual list RIFF chunk appropriately
4980            RIFF::List* lstCkInstruments = pFile->pRIFF->GetSubList(LIST_TYPE_LINS);
4981            lstCkInstruments->MoveSubChunk(
4982                this->pCkInstrument,
4983                (RIFF::Chunk*) ((dst) ? dst->pCkInstrument : NULL)
4984            );
4985        }
4986    
4987        /**
4988       * Returns a MIDI rule of the instrument.       * Returns a MIDI rule of the instrument.
4989       *       *
4990       * 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 3165  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4998  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4998          return pMidiRules[i];          return pMidiRules[i];
4999      }      }
5000    
5001        /**
5002         * Adds the "controller trigger" MIDI rule to the instrument.
5003         *
5004         * @returns the new MIDI rule
5005         */
5006        MidiRuleCtrlTrigger* Instrument::AddMidiRuleCtrlTrigger() {
5007            delete pMidiRules[0];
5008            MidiRuleCtrlTrigger* r = new MidiRuleCtrlTrigger;
5009            pMidiRules[0] = r;
5010            pMidiRules[1] = 0;
5011            return r;
5012        }
5013    
5014        /**
5015         * Adds the legato MIDI rule to the instrument.
5016         *
5017         * @returns the new MIDI rule
5018         */
5019        MidiRuleLegato* Instrument::AddMidiRuleLegato() {
5020            delete pMidiRules[0];
5021            MidiRuleLegato* r = new MidiRuleLegato;
5022            pMidiRules[0] = r;
5023            pMidiRules[1] = 0;
5024            return r;
5025        }
5026    
5027        /**
5028         * Adds the alternator MIDI rule to the instrument.
5029         *
5030         * @returns the new MIDI rule
5031         */
5032        MidiRuleAlternator* Instrument::AddMidiRuleAlternator() {
5033            delete pMidiRules[0];
5034            MidiRuleAlternator* r = new MidiRuleAlternator;
5035            pMidiRules[0] = r;
5036            pMidiRules[1] = 0;
5037            return r;
5038        }
5039    
5040        /**
5041         * Deletes a MIDI rule from the instrument.
5042         *
5043         * @param i - MIDI rule number
5044         */
5045        void Instrument::DeleteMidiRule(int i) {
5046            delete pMidiRules[i];
5047            pMidiRules[i] = 0;
5048        }
5049    
5050        void Instrument::LoadScripts() {
5051            if (pScriptRefs) return;
5052            pScriptRefs = new std::vector<_ScriptPooolRef>;
5053            if (scriptPoolFileOffsets.empty()) return;
5054            File* pFile = (File*) GetParent();
5055            for (uint k = 0; k < scriptPoolFileOffsets.size(); ++k) {
5056                uint32_t soughtOffset = scriptPoolFileOffsets[k].fileOffset;
5057                for (uint i = 0; pFile->GetScriptGroup(i); ++i) {
5058                    ScriptGroup* group = pFile->GetScriptGroup(i);
5059                    for (uint s = 0; group->GetScript(s); ++s) {
5060                        Script* script = group->GetScript(s);
5061                        if (script->pChunk) {
5062                            uint32_t offset = uint32_t(
5063                                script->pChunk->GetFilePos() -
5064                                script->pChunk->GetPos() -
5065                                CHUNK_HEADER_SIZE(script->pChunk->GetFile()->GetFileOffsetSize())
5066                            );
5067                            if (offset == soughtOffset)
5068                            {
5069                                _ScriptPooolRef ref;
5070                                ref.script = script;
5071                                ref.bypass = scriptPoolFileOffsets[k].bypass;
5072                                pScriptRefs->push_back(ref);
5073                                break;
5074                            }
5075                        }
5076                    }
5077                }
5078            }
5079            // we don't need that anymore
5080            scriptPoolFileOffsets.clear();
5081        }
5082    
5083        /** @brief Get instrument script (gig format extension).
5084         *
5085         * Returns the real-time instrument script of instrument script slot
5086         * @a index.
5087         *
5088         * @note This is an own format extension which did not exist i.e. in the
5089         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5090         * gigedit.
5091         *
5092         * @param index - instrument script slot index
5093         * @returns script or NULL if index is out of bounds
5094         */
5095        Script* Instrument::GetScriptOfSlot(uint index) {
5096            LoadScripts();
5097            if (index >= pScriptRefs->size()) return NULL;
5098            return pScriptRefs->at(index).script;
5099        }
5100    
5101        /** @brief Add new instrument script slot (gig format extension).
5102         *
5103         * Add the given real-time instrument script reference to this instrument,
5104         * which shall be executed by the sampler for for this instrument. The
5105         * script will be added to the end of the script list of this instrument.
5106         * The positions of the scripts in the Instrument's Script list are
5107         * relevant, because they define in which order they shall be executed by
5108         * the sampler. For this reason it is also legal to add the same script
5109         * twice to an instrument, for example you might have a script called
5110         * "MyFilter" which performs an event filter task, and you might have
5111         * another script called "MyNoteTrigger" which triggers new notes, then you
5112         * might for example have the following list of scripts on the instrument:
5113         *
5114         * 1. Script "MyFilter"
5115         * 2. Script "MyNoteTrigger"
5116         * 3. Script "MyFilter"
5117         *
5118         * Which would make sense, because the 2nd script launched new events, which
5119         * you might need to filter as well.
5120         *
5121         * There are two ways to disable / "bypass" scripts. You can either disable
5122         * a script locally for the respective script slot on an instrument (i.e. by
5123         * passing @c false to the 2nd argument of this method, or by calling
5124         * SetScriptBypassed()). Or you can disable a script globally for all slots
5125         * and all instruments by setting Script::Bypass.
5126         *
5127         * @note This is an own format extension which did not exist i.e. in the
5128         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5129         * gigedit.
5130         *
5131         * @param pScript - script that shall be executed for this instrument
5132         * @param bypass  - if enabled, the sampler shall skip executing this
5133         *                  script (in the respective list position)
5134         * @see SetScriptBypassed()
5135         */
5136        void Instrument::AddScriptSlot(Script* pScript, bool bypass) {
5137            LoadScripts();
5138            _ScriptPooolRef ref = { pScript, bypass };
5139            pScriptRefs->push_back(ref);
5140        }
5141    
5142        /** @brief Flip two script slots with each other (gig format extension).
5143         *
5144         * Swaps the position of the two given scripts in the Instrument's Script
5145         * list. The positions of the scripts in the Instrument's Script list are
5146         * relevant, because they define in which order they shall be executed by
5147         * the sampler.
5148         *
5149         * @note This is an own format extension which did not exist i.e. in the
5150         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5151         * gigedit.
5152         *
5153         * @param index1 - index of the first script slot to swap
5154         * @param index2 - index of the second script slot to swap
5155         */
5156        void Instrument::SwapScriptSlots(uint index1, uint index2) {
5157            LoadScripts();
5158            if (index1 >= pScriptRefs->size() || index2 >= pScriptRefs->size())
5159                return;
5160            _ScriptPooolRef tmp = (*pScriptRefs)[index1];
5161            (*pScriptRefs)[index1] = (*pScriptRefs)[index2];
5162            (*pScriptRefs)[index2] = tmp;
5163        }
5164    
5165        /** @brief Remove script slot.
5166         *
5167         * Removes the script slot with the given slot index.
5168         *
5169         * @param index - index of script slot to remove
5170         */
5171        void Instrument::RemoveScriptSlot(uint index) {
5172            LoadScripts();
5173            if (index >= pScriptRefs->size()) return;
5174            pScriptRefs->erase( pScriptRefs->begin() + index );
5175        }
5176    
5177        /** @brief Remove reference to given Script (gig format extension).
5178         *
5179         * This will remove all script slots on the instrument which are referencing
5180         * the given script.
5181         *
5182         * @note This is an own format extension which did not exist i.e. in the
5183         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5184         * gigedit.
5185         *
5186         * @param pScript - script reference to remove from this instrument
5187         * @see RemoveScriptSlot()
5188         */
5189        void Instrument::RemoveScript(Script* pScript) {
5190            LoadScripts();
5191            for (ssize_t i = pScriptRefs->size() - 1; i >= 0; --i) {
5192                if ((*pScriptRefs)[i].script == pScript) {
5193                    pScriptRefs->erase( pScriptRefs->begin() + i );
5194                }
5195            }
5196        }
5197    
5198        /** @brief Instrument's amount of script slots.
5199         *
5200         * This method returns the amount of script slots this instrument currently
5201         * uses.
5202         *
5203         * A script slot is a reference of a real-time instrument script to be
5204         * executed by the sampler. The scripts will be executed by the sampler in
5205         * sequence of the slots. One (same) script may be referenced multiple
5206         * times in different slots.
5207         *
5208         * @note This is an own format extension which did not exist i.e. in the
5209         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5210         * gigedit.
5211         */
5212        uint Instrument::ScriptSlotCount() const {
5213            return uint(pScriptRefs ? pScriptRefs->size() : scriptPoolFileOffsets.size());
5214        }
5215    
5216        /** @brief Whether script execution shall be skipped.
5217         *
5218         * Defines locally for the Script reference slot in the Instrument's Script
5219         * list, whether the script shall be skipped by the sampler regarding
5220         * execution.
5221         *
5222         * It is also possible to ignore exeuction of the script globally, for all
5223         * slots and for all instruments by setting Script::Bypass.
5224         *
5225         * @note This is an own format extension which did not exist i.e. in the
5226         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5227         * gigedit.
5228         *
5229         * @param index - index of the script slot on this instrument
5230         * @see Script::Bypass
5231         */
5232        bool Instrument::IsScriptSlotBypassed(uint index) {
5233            if (index >= ScriptSlotCount()) return false;
5234            return pScriptRefs ? pScriptRefs->at(index).bypass
5235                               : scriptPoolFileOffsets.at(index).bypass;
5236            
5237        }
5238    
5239        /** @brief Defines whether execution shall be skipped.
5240         *
5241         * You can call this method to define locally whether or whether not the
5242         * given script slot shall be executed by the sampler.
5243         *
5244         * @note This is an own format extension which did not exist i.e. in the
5245         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5246         * gigedit.
5247         *
5248         * @param index - script slot index on this instrument
5249         * @param bBypass - if true, the script slot will be skipped by the sampler
5250         * @see Script::Bypass
5251         */
5252        void Instrument::SetScriptSlotBypassed(uint index, bool bBypass) {
5253            if (index >= ScriptSlotCount()) return;
5254            if (pScriptRefs)
5255                pScriptRefs->at(index).bypass = bBypass;
5256            else
5257                scriptPoolFileOffsets.at(index).bypass = bBypass;
5258        }
5259    
5260        /**
5261         * Make a (semi) deep copy of the Instrument object given by @a orig
5262         * and assign it to this object.
5263         *
5264         * Note that all sample pointers referenced by @a orig are simply copied as
5265         * memory address. Thus the respective samples are shared, not duplicated!
5266         *
5267         * @param orig - original Instrument object to be copied from
5268         */
5269        void Instrument::CopyAssign(const Instrument* orig) {
5270            CopyAssign(orig, NULL);
5271        }
5272            
5273        /**
5274         * Make a (semi) deep copy of the Instrument object given by @a orig
5275         * and assign it to this object.
5276         *
5277         * @param orig - original Instrument object to be copied from
5278         * @param mSamples - crosslink map between the foreign file's samples and
5279         *                   this file's samples
5280         */
5281        void Instrument::CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples) {
5282            // handle base class
5283            // (without copying DLS region stuff)
5284            DLS::Instrument::CopyAssignCore(orig);
5285            
5286            // handle own member variables
5287            Attenuation = orig->Attenuation;
5288            EffectSend = orig->EffectSend;
5289            FineTune = orig->FineTune;
5290            PitchbendRange = orig->PitchbendRange;
5291            PianoReleaseMode = orig->PianoReleaseMode;
5292            DimensionKeyRange = orig->DimensionKeyRange;
5293            scriptPoolFileOffsets = orig->scriptPoolFileOffsets;
5294            pScriptRefs = orig->pScriptRefs;
5295            
5296            // free old midi rules
5297            for (int i = 0 ; pMidiRules[i] ; i++) {
5298                delete pMidiRules[i];
5299            }
5300            //TODO: MIDI rule copying
5301            pMidiRules[0] = NULL;
5302            
5303            // delete all old regions
5304            while (Regions) DeleteRegion(GetFirstRegion());
5305            // create new regions and copy them from original
5306            {
5307                RegionList::const_iterator it = orig->pRegions->begin();
5308                for (int i = 0; i < orig->Regions; ++i, ++it) {
5309                    Region* dstRgn = AddRegion();
5310                    //NOTE: Region does semi-deep copy !
5311                    dstRgn->CopyAssign(
5312                        static_cast<gig::Region*>(*it),
5313                        mSamples
5314                    );
5315                }
5316            }
5317    
5318            UpdateRegionKeyTable();
5319        }
5320    
5321    
5322  // *************** Group ***************  // *************** Group ***************
5323  // *  // *
# Line 3193  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5346  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5346       *       *
5347       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
5348       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
5349         *
5350         * @param pProgress - callback function for progress notification
5351       */       */
5352      void Group::UpdateChunks() {      void Group::UpdateChunks(progress_t* pProgress) {
5353          // make sure <3gri> and <3gnl> list chunks exist          // make sure <3gri> and <3gnl> list chunks exist
5354          RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);          RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);
5355          if (!_3gri) {          if (!_3gri) {
# Line 3324  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5479  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5479          bAutoLoad = true;          bAutoLoad = true;
5480          *pVersion = VERSION_3;          *pVersion = VERSION_3;
5481          pGroups = NULL;          pGroups = NULL;
5482            pScriptGroups = NULL;
5483          pInfo->SetFixedStringLengths(_FileFixedStringLengths);          pInfo->SetFixedStringLengths(_FileFixedStringLengths);
5484          pInfo->ArchivalLocation = String(256, ' ');          pInfo->ArchivalLocation = String(256, ' ');
5485    
# Line 3339  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5495  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5495      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
5496          bAutoLoad = true;          bAutoLoad = true;
5497          pGroups = NULL;          pGroups = NULL;
5498            pScriptGroups = NULL;
5499          pInfo->SetFixedStringLengths(_FileFixedStringLengths);          pInfo->SetFixedStringLengths(_FileFixedStringLengths);
5500      }      }
5501    
# Line 3352  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5509  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5509              }              }
5510              delete pGroups;              delete pGroups;
5511          }          }
5512            if (pScriptGroups) {
5513                std::list<ScriptGroup*>::iterator iter = pScriptGroups->begin();
5514                std::list<ScriptGroup*>::iterator end  = pScriptGroups->end();
5515                while (iter != end) {
5516                    delete *iter;
5517                    ++iter;
5518                }
5519                delete pScriptGroups;
5520            }
5521      }      }
5522    
5523      Sample* File::GetFirstSample(progress_t* pProgress) {      Sample* File::GetFirstSample(progress_t* pProgress) {
# Line 3366  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5532  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5532          SamplesIterator++;          SamplesIterator++;
5533          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
5534      }      }
5535        
5536        /**
5537         * Returns Sample object of @a index.
5538         *
5539         * @returns sample object or NULL if index is out of bounds
5540         */
5541        Sample* File::GetSample(uint index) {
5542            if (!pSamples) LoadSamples();
5543            if (!pSamples) return NULL;
5544            DLS::File::SampleList::iterator it = pSamples->begin();
5545            for (int i = 0; i < index; ++i) {
5546                ++it;
5547                if (it == pSamples->end()) return NULL;
5548            }
5549            if (it == pSamples->end()) return NULL;
5550            return static_cast<gig::Sample*>( *it );
5551        }
5552    
5553      /** @brief Add a new sample.      /** @brief Add a new sample.
5554       *       *
# Line 3443  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5626  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5626          int iTotalSamples = WavePoolCount;          int iTotalSamples = WavePoolCount;
5627    
5628          // check if samples should be loaded from extension files          // check if samples should be loaded from extension files
5629            // (only for old gig files < 2 GB)
5630          int lastFileNo = 0;          int lastFileNo = 0;
5631          for (int i = 0 ; i < WavePoolCount ; i++) {          if (!file->IsNew() && !(file->GetCurrentFileSize() >> 31)) {
5632              if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];              for (int i = 0 ; i < WavePoolCount ; i++) {
5633                    if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];
5634                }
5635          }          }
5636          String name(pRIFF->GetFileName());          String name(pRIFF->GetFileName());
5637          int nameLen = name.length();          int nameLen = (int) name.length();
5638          char suffix[6];          char suffix[6];
5639          if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;          if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;
5640    
5641          for (int fileNo = 0 ; ; ) {          for (int fileNo = 0 ; ; ) {
5642              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
5643              if (wvpl) {              if (wvpl) {
5644                  unsigned long wvplFileOffset = wvpl->GetFilePos();                  file_offset_t wvplFileOffset = wvpl->GetFilePos();
5645                  RIFF::List* wave = wvpl->GetFirstSubList();                  RIFF::List* wave = wvpl->GetFirstSubList();
5646                  while (wave) {                  while (wave) {
5647                      if (wave->GetListType() == LIST_TYPE_WAVE) {                      if (wave->GetListType() == LIST_TYPE_WAVE) {
# Line 3463  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5649  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5649                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
5650                          __notify_progress(pProgress, subprogress);                          __notify_progress(pProgress, subprogress);
5651    
5652                          unsigned long waveFileOffset = wave->GetFilePos();                          file_offset_t waveFileOffset = wave->GetFilePos();
5653                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo, iSampleIndex));
5654    
5655                          iSampleIndex++;                          iSampleIndex++;
5656                      }                      }
# Line 3563  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5749  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5749         pInstruments->push_back(pInstrument);         pInstruments->push_back(pInstrument);
5750         return pInstrument;         return pInstrument;
5751      }      }
5752        
5753        /** @brief Add a duplicate of an existing instrument.
5754         *
5755         * Duplicates the instrument definition given by @a orig and adds it
5756         * to this file. This allows in an instrument editor application to
5757         * easily create variations of an instrument, which will be stored in
5758         * the same .gig file, sharing i.e. the same samples.
5759         *
5760         * Note that all sample pointers referenced by @a orig are simply copied as
5761         * memory address. Thus the respective samples are shared, not duplicated!
5762         *
5763         * You have to call Save() to make this persistent to the file.
5764         *
5765         * @param orig - original instrument to be copied
5766         * @returns duplicated copy of the given instrument
5767         */
5768        Instrument* File::AddDuplicateInstrument(const Instrument* orig) {
5769            Instrument* instr = AddInstrument();
5770            instr->CopyAssign(orig);
5771            return instr;
5772        }
5773        
5774        /** @brief Add content of another existing file.
5775         *
5776         * Duplicates the samples, groups and instruments of the original file
5777         * given by @a pFile and adds them to @c this File. In case @c this File is
5778         * a new one that you haven't saved before, then you have to call
5779         * SetFileName() before calling AddContentOf(), because this method will
5780         * automatically save this file during operation, which is required for
5781         * writing the sample waveform data by disk streaming.
5782         *
5783         * @param pFile - original file whose's content shall be copied from
5784         */
5785        void File::AddContentOf(File* pFile) {
5786            static int iCallCount = -1;
5787            iCallCount++;
5788            std::map<Group*,Group*> mGroups;
5789            std::map<Sample*,Sample*> mSamples;
5790            
5791            // clone sample groups
5792            for (int i = 0; pFile->GetGroup(i); ++i) {
5793                Group* g = AddGroup();
5794                g->Name =
5795                    "COPY" + ToString(iCallCount) + "_" + pFile->GetGroup(i)->Name;
5796                mGroups[pFile->GetGroup(i)] = g;
5797            }
5798            
5799            // clone samples (not waveform data here yet)
5800            for (int i = 0; pFile->GetSample(i); ++i) {
5801                Sample* s = AddSample();
5802                s->CopyAssignMeta(pFile->GetSample(i));
5803                mGroups[pFile->GetSample(i)->GetGroup()]->AddSample(s);
5804                mSamples[pFile->GetSample(i)] = s;
5805            }
5806    
5807            // clone script groups and their scripts
5808            for (int iGroup = 0; pFile->GetScriptGroup(iGroup); ++iGroup) {
5809                ScriptGroup* sg = pFile->GetScriptGroup(iGroup);
5810                ScriptGroup* dg = AddScriptGroup();
5811                dg->Name = "COPY" + ToString(iCallCount) + "_" + sg->Name;
5812                for (int iScript = 0; sg->GetScript(iScript); ++iScript) {
5813                    Script* ss = sg->GetScript(iScript);
5814                    Script* ds = dg->AddScript();
5815                    ds->CopyAssign(ss);
5816                }
5817            }
5818    
5819            //BUG: For some reason this method only works with this additional
5820            //     Save() call in between here.
5821            //
5822            // Important: The correct one of the 2 Save() methods has to be called
5823            // here, depending on whether the file is completely new or has been
5824            // saved to disk already, otherwise it will result in data corruption.
5825            if (pRIFF->IsNew())
5826                Save(GetFileName());
5827            else
5828                Save();
5829            
5830            // clone instruments
5831            // (passing the crosslink table here for the cloned samples)
5832            for (int i = 0; pFile->GetInstrument(i); ++i) {
5833                Instrument* instr = AddInstrument();
5834                instr->CopyAssign(pFile->GetInstrument(i), &mSamples);
5835            }
5836            
5837            // Mandatory: file needs to be saved to disk at this point, so this
5838            // file has the correct size and data layout for writing the samples'
5839            // waveform data to disk.
5840            Save();
5841            
5842            // clone samples' waveform data
5843            // (using direct read & write disk streaming)
5844            for (int i = 0; pFile->GetSample(i); ++i) {
5845                mSamples[pFile->GetSample(i)]->CopyAssignWave(pFile->GetSample(i));
5846            }
5847        }
5848    
5849      /** @brief Delete an instrument.      /** @brief Delete an instrument.
5850       *       *
# Line 3618  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5900  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5900          if (!_3crc) return;          if (!_3crc) return;
5901    
5902          // get the index of the sample          // get the index of the sample
5903          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;  
             }  
         }  
5904          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");
5905    
5906          // write the CRC-32 checksum to disk          // write the CRC-32 checksum to disk
5907          _3crc->SetPos(iWaveIndex * 8);          _3crc->SetPos(iWaveIndex * 8);
5908          uint32_t tmp = 1;          uint32_t one = 1;
5909          _3crc->WriteUint32(&tmp); // unknown, always 1?          _3crc->WriteUint32(&one); // always 1
5910          _3crc->WriteUint32(&crc);          _3crc->WriteUint32(&crc);
5911      }      }
5912    
5913        uint32_t File::GetSampleChecksum(Sample* pSample) {
5914            // get the index of the sample
5915            int iWaveIndex = GetWaveTableIndexOf(pSample);
5916            if (iWaveIndex < 0) throw gig::Exception("Could not retrieve reference crc of sample, could not resolve sample's wave table index");
5917    
5918            return GetSampleChecksumByIndex(iWaveIndex);
5919        }
5920    
5921        uint32_t File::GetSampleChecksumByIndex(int index) {
5922            if (index < 0) throw gig::Exception("Could not retrieve reference crc of sample, invalid wave pool index of sample");
5923    
5924            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
5925            if (!_3crc) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
5926            uint8_t* pData = (uint8_t*) _3crc->LoadChunkData();
5927            if (!pData) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
5928    
5929            // read the CRC-32 checksum directly from disk
5930            size_t pos = index * 8;
5931            if (pos + 8 > _3crc->GetNewSize())
5932                throw gig::Exception("Could not retrieve reference crc of sample, could not seek to required position in crc chunk");
5933    
5934            uint32_t one = load32(&pData[pos]); // always 1
5935            if (one != 1)
5936                throw gig::Exception("Could not retrieve reference crc of sample, because reference checksum table is damaged");
5937    
5938            return load32(&pData[pos+4]);
5939        }
5940    
5941        int File::GetWaveTableIndexOf(gig::Sample* pSample) {
5942            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
5943            File::SampleList::iterator iter = pSamples->begin();
5944            File::SampleList::iterator end  = pSamples->end();
5945            for (int index = 0; iter != end; ++iter, ++index)
5946                if (*iter == pSample)
5947                    return index;
5948            return -1;
5949        }
5950    
5951        /**
5952         * Checks whether the file's "3CRC" chunk was damaged. This chunk contains
5953         * the CRC32 check sums of all samples' raw wave data.
5954         *
5955         * @return true if 3CRC chunk is OK, or false if 3CRC chunk is damaged
5956         */
5957        bool File::VerifySampleChecksumTable() {
5958            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
5959            if (!_3crc) return false;
5960            if (_3crc->GetNewSize() <= 0) return false;
5961            if (_3crc->GetNewSize() % 8) return false;
5962            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
5963            if (_3crc->GetNewSize() != pSamples->size() * 8) return false;
5964    
5965            const file_offset_t n = _3crc->GetNewSize() / 8;
5966    
5967            uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
5968            if (!pData) return false;
5969    
5970            for (file_offset_t i = 0; i < n; ++i) {
5971                uint32_t one = pData[i*2];
5972                if (one != 1) return false;
5973            }
5974    
5975            return true;
5976        }
5977    
5978        /**
5979         * Recalculates CRC32 checksums for all samples and rebuilds this gig
5980         * file's checksum table with those new checksums. This might usually
5981         * just be necessary if the checksum table was damaged.
5982         *
5983         * @e IMPORTANT: The current implementation of this method only works
5984         * with files that have not been modified since it was loaded, because
5985         * it expects that no externally caused file structure changes are
5986         * required!
5987         *
5988         * Due to the expectation above, this method is currently protected
5989         * and actually only used by the command line tool "gigdump" yet.
5990         *
5991         * @returns true if Save() is required to be called after this call,
5992         *          false if no further action is required
5993         */
5994        bool File::RebuildSampleChecksumTable() {
5995            // make sure sample chunks were scanned
5996            if (!pSamples) GetFirstSample();
5997    
5998            bool bRequiresSave = false;
5999    
6000            // make sure "3CRC" chunk exists with required size
6001            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6002            if (!_3crc) {
6003                _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
6004                // the order of einf and 3crc is not the same in v2 and v3
6005                RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
6006                if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
6007                bRequiresSave = true;
6008            } else if (_3crc->GetNewSize() != pSamples->size() * 8) {
6009                _3crc->Resize(pSamples->size() * 8);
6010                bRequiresSave = true;
6011            }
6012    
6013            if (bRequiresSave) { // refill CRC table for all samples in RAM ...
6014                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6015                {
6016                    File::SampleList::iterator iter = pSamples->begin();
6017                    File::SampleList::iterator end  = pSamples->end();
6018                    for (; iter != end; ++iter) {
6019                        gig::Sample* pSample = (gig::Sample*) *iter;
6020                        int index = GetWaveTableIndexOf(pSample);
6021                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6022                        pData[index*2]   = 1; // always 1
6023                        pData[index*2+1] = pSample->CalculateWaveDataChecksum();
6024                    }
6025                }
6026            } else { // no file structure changes necessary, so directly write to disk and we are done ...
6027                // make sure file is in write mode
6028                pRIFF->SetMode(RIFF::stream_mode_read_write);
6029                {
6030                    File::SampleList::iterator iter = pSamples->begin();
6031                    File::SampleList::iterator end  = pSamples->end();
6032                    for (; iter != end; ++iter) {
6033                        gig::Sample* pSample = (gig::Sample*) *iter;
6034                        int index = GetWaveTableIndexOf(pSample);
6035                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6036                        pSample->crc  = pSample->CalculateWaveDataChecksum();
6037                        SetSampleChecksum(pSample, pSample->crc);
6038                    }
6039                }
6040            }
6041    
6042            return bRequiresSave;
6043        }
6044    
6045      Group* File::GetFirstGroup() {      Group* File::GetFirstGroup() {
6046          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6047          // there must always be at least one group          // there must always be at least one group
# Line 3665  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6071  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6071          return NULL;          return NULL;
6072      }      }
6073    
6074        /**
6075         * Returns the group with the given group name.
6076         *
6077         * Note: group names don't have to be unique in the gig format! So there
6078         * can be multiple groups with the same name. This method will simply
6079         * return the first group found with the given name.
6080         *
6081         * @param name - name of the sought group
6082         * @returns sought group or NULL if there's no group with that name
6083         */
6084        Group* File::GetGroup(String name) {
6085            if (!pGroups) LoadGroups();
6086            GroupsIterator = pGroups->begin();
6087            for (uint i = 0; GroupsIterator != pGroups->end(); ++GroupsIterator, ++i)
6088                if ((*GroupsIterator)->Name == name) return *GroupsIterator;
6089            return NULL;
6090        }
6091    
6092      Group* File::AddGroup() {      Group* File::AddGroup() {
6093          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6094          // there must always be at least one group          // there must always be at least one group
# Line 3745  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6169  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6169          }          }
6170      }      }
6171    
6172        /** @brief Get instrument script group (by index).
6173         *
6174         * Returns the real-time instrument script group with the given index.
6175         *
6176         * @param index - number of the sought group (0..n)
6177         * @returns sought script group or NULL if there's no such group
6178         */
6179        ScriptGroup* File::GetScriptGroup(uint index) {
6180            if (!pScriptGroups) LoadScriptGroups();
6181            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
6182            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
6183                if (i == index) return *it;
6184            return NULL;
6185        }
6186    
6187        /** @brief Get instrument script group (by name).
6188         *
6189         * Returns the first real-time instrument script group found with the given
6190         * group name. Note that group names may not necessarily be unique.
6191         *
6192         * @param name - name of the sought script group
6193         * @returns sought script group or NULL if there's no such group
6194         */
6195        ScriptGroup* File::GetScriptGroup(const String& name) {
6196            if (!pScriptGroups) LoadScriptGroups();
6197            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
6198            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
6199                if ((*it)->Name == name) return *it;
6200            return NULL;
6201        }
6202    
6203        /** @brief Add new instrument script group.
6204         *
6205         * Adds a new, empty real-time instrument script group to the file.
6206         *
6207         * You have to call Save() to make this persistent to the file.
6208         *
6209         * @return new empty script group
6210         */
6211        ScriptGroup* File::AddScriptGroup() {
6212            if (!pScriptGroups) LoadScriptGroups();
6213            ScriptGroup* pScriptGroup = new ScriptGroup(this, NULL);
6214            pScriptGroups->push_back(pScriptGroup);
6215            return pScriptGroup;
6216        }
6217    
6218        /** @brief Delete an instrument script group.
6219         *
6220         * This will delete the given real-time instrument script group and all its
6221         * instrument scripts it contains. References inside instruments that are
6222         * using the deleted scripts will be removed from the respective instruments
6223         * accordingly.
6224         *
6225         * You have to call Save() to make this persistent to the file.
6226         *
6227         * @param pScriptGroup - script group to delete
6228         * @throws gig::Exception if given script group could not be found
6229         */
6230        void File::DeleteScriptGroup(ScriptGroup* pScriptGroup) {
6231            if (!pScriptGroups) LoadScriptGroups();
6232            std::list<ScriptGroup*>::iterator iter =
6233                find(pScriptGroups->begin(), pScriptGroups->end(), pScriptGroup);
6234            if (iter == pScriptGroups->end())
6235                throw gig::Exception("Could not delete script group, could not find given script group");
6236            pScriptGroups->erase(iter);
6237            for (int i = 0; pScriptGroup->GetScript(i); ++i)
6238                pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));
6239            if (pScriptGroup->pList)
6240                pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);
6241            delete pScriptGroup;
6242        }
6243    
6244        void File::LoadScriptGroups() {
6245            if (pScriptGroups) return;
6246            pScriptGroups = new std::list<ScriptGroup*>;
6247            RIFF::List* lstLS = pRIFF->GetSubList(LIST_TYPE_3LS);
6248            if (lstLS) {
6249                for (RIFF::List* lst = lstLS->GetFirstSubList(); lst;
6250                     lst = lstLS->GetNextSubList())
6251                {
6252                    if (lst->GetListType() == LIST_TYPE_RTIS) {
6253                        pScriptGroups->push_back(new ScriptGroup(this, lst));
6254                    }
6255                }
6256            }
6257        }
6258    
6259      /**      /**
6260       * Apply all the gig file's current instruments, samples, groups and settings       * Apply all the gig file's current instruments, samples, groups and settings
6261       * 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 3753  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6264  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6264       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
6265       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
6266       *       *
6267         * @param pProgress - callback function for progress notification
6268       * @throws Exception - on errors       * @throws Exception - on errors
6269       */       */
6270      void File::UpdateChunks() {      void File::UpdateChunks(progress_t* pProgress) {
6271          bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;          bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;
6272    
6273          b64BitWavePoolOffsets = pVersion && pVersion->major == 3;          // update own gig format extension chunks
6274            // (not part of the GigaStudio 4 format)
6275            RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);
6276            if (!lst3LS) {
6277                lst3LS = pRIFF->AddSubList(LIST_TYPE_3LS);
6278            }
6279            // Make sure <3LS > chunk is placed before <ptbl> chunk. The precise
6280            // location of <3LS > is irrelevant, however it should be located
6281            // before  the actual wave data
6282            RIFF::Chunk* ckPTBL = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
6283            pRIFF->MoveSubChunk(lst3LS, ckPTBL);
6284    
6285            // This must be performed before writing the chunks for instruments,
6286            // because the instruments' script slots will write the file offsets
6287            // of the respective instrument script chunk as reference.
6288            if (pScriptGroups) {
6289                // Update instrument script (group) chunks.
6290                for (std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
6291                     it != pScriptGroups->end(); ++it)
6292                {
6293                    (*it)->UpdateChunks(pProgress);
6294                }
6295            }
6296    
6297            // in case no libgig custom format data was added, then remove the
6298            // custom "3LS " chunk again
6299            if (!lst3LS->CountSubChunks()) {
6300                pRIFF->DeleteSubChunk(lst3LS);
6301                lst3LS = NULL;
6302            }
6303    
6304          // first update base class's chunks          // first update base class's chunks
6305          DLS::File::UpdateChunks();          DLS::File::UpdateChunks(pProgress);
6306    
6307          if (newFile) {          if (newFile) {
6308              // INFO was added by Resource::UpdateChunks - make sure it              // INFO was added by Resource::UpdateChunks - make sure it
# Line 3775  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6316  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6316    
6317          // update group's chunks          // update group's chunks
6318          if (pGroups) {          if (pGroups) {
6319              std::list<Group*>::iterator iter = pGroups->begin();              // make sure '3gri' and '3gnl' list chunks exist
6320              std::list<Group*>::iterator end  = pGroups->end();              // (before updating the Group chunks)
6321              for (; iter != end; ++iter) {              RIFF::List* _3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
6322                  (*iter)->UpdateChunks();              if (!_3gri) {
6323                    _3gri = pRIFF->AddSubList(LIST_TYPE_3GRI);
6324                    pRIFF->MoveSubChunk(_3gri, pRIFF->GetSubChunk(CHUNK_ID_PTBL));
6325              }              }
6326                RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
6327                if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
6328    
6329              // v3: make sure the file has 128 3gnm chunks              // v3: make sure the file has 128 3gnm chunks
6330                // (before updating the Group chunks)
6331              if (pVersion && pVersion->major == 3) {              if (pVersion && pVersion->major == 3) {
                 RIFF::List* _3gnl = pRIFF->GetSubList(LIST_TYPE_3GRI)->GetSubList(LIST_TYPE_3GNL);  
6332                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
6333                  for (int i = 0 ; i < 128 ; i++) {                  for (int i = 0 ; i < 128 ; i++) {
6334                      if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);                      if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
6335                      if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();                      if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();
6336                  }                  }
6337              }              }
6338    
6339                std::list<Group*>::iterator iter = pGroups->begin();
6340                std::list<Group*>::iterator end  = pGroups->end();
6341                for (; iter != end; ++iter) {
6342                    (*iter)->UpdateChunks(pProgress);
6343                }
6344          }          }
6345    
6346          // update einf chunk          // update einf chunk
# Line 3808  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6359  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6359          // Note that there are several fields with unknown use. These          // Note that there are several fields with unknown use. These
6360          // are set to zero.          // are set to zero.
6361    
6362          int sublen = pSamples->size() / 8 + 49;          int sublen = int(pSamples->size() / 8 + 49);
6363          int einfSize = (Instruments + 1) * sublen;          int einfSize = (Instruments + 1) * sublen;
6364    
6365          RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);          RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
# Line 3881  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6432  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6432                  store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);                  store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);
6433                  // next 8 bytes unknown                  // next 8 bytes unknown
6434                  store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);                  store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);
6435                  store32(&pData[(instrumentIdx + 1) * sublen + 40], pSamples->size());                  store32(&pData[(instrumentIdx + 1) * sublen + 40], (uint32_t) pSamples->size());
6436                  // next 4 bytes unknown                  // next 4 bytes unknown
6437    
6438                  totnbregions += instrument->Regions;                  totnbregions += instrument->Regions;
# Line 3899  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6450  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6450              store32(&pData[24], totnbloops);              store32(&pData[24], totnbloops);
6451              // next 8 bytes unknown              // next 8 bytes unknown
6452              // next 4 bytes unknown, not always 0              // next 4 bytes unknown, not always 0
6453              store32(&pData[40], pSamples->size());              store32(&pData[40], (uint32_t) pSamples->size());
6454              // next 4 bytes unknown              // next 4 bytes unknown
6455          }          }
6456    
6457          // update 3crc chunk          // update 3crc chunk
6458    
6459          // The 3crc chunk contains CRC-32 checksums for the          // The 3crc chunk contains CRC-32 checksums for the
6460          // samples. The actual checksum values will be filled in          // samples. When saving a gig file to disk, we first update the 3CRC
6461          // later, by Sample::Write.          // chunk here (in RAM) with the old crc values which we read from the
6462            // 3CRC chunk when we opened the file (available with gig::Sample::crc
6463            // member variable). This step is required, because samples might have
6464            // been deleted by the user since the file was opened, which in turn
6465            // changes the order of the (i.e. old) checksums within the 3crc chunk.
6466            // If a sample was conciously modified by the user (that is if
6467            // Sample::Write() was called later on) then Sample::Write() will just
6468            // update the respective individual checksum(s) directly on disk and
6469            // leaves all other sample checksums untouched.
6470    
6471          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6472          if (_3crc) {          if (_3crc) {
6473              _3crc->Resize(pSamples->size() * 8);              _3crc->Resize(pSamples->size() * 8);
6474          } else if (newFile) {          } else /*if (newFile)*/ {
6475              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
             _3crc->LoadChunkData();  
   
6476              // 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
6477              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
6478          }          }
6479            { // must be performed in RAM here ...
6480                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6481                if (pData) {
6482                    File::SampleList::iterator iter = pSamples->begin();
6483                    File::SampleList::iterator end  = pSamples->end();
6484                    for (int index = 0; iter != end; ++iter, ++index) {
6485                        gig::Sample* pSample = (gig::Sample*) *iter;
6486                        pData[index*2]   = 1; // always 1
6487                        pData[index*2+1] = pSample->crc;
6488                    }
6489                }
6490            }
6491        }
6492        
6493        void File::UpdateFileOffsets() {
6494            DLS::File::UpdateFileOffsets();
6495    
6496            for (Instrument* instrument = GetFirstInstrument(); instrument;
6497                 instrument = GetNextInstrument())
6498            {
6499                instrument->UpdateScriptFileOffsets();
6500            }
6501      }      }
6502    
6503      /**      /**
# Line 3953  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 6532  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
6532  // *************** Exception ***************  // *************** Exception ***************
6533  // *  // *
6534    
6535      Exception::Exception(String Message) : DLS::Exception(Message) {      Exception::Exception() : DLS::Exception() {
6536        }
6537    
6538        Exception::Exception(String format, ...) : DLS::Exception() {
6539            va_list arg;
6540            va_start(arg, format);
6541            Message = assemble(format, arg);
6542            va_end(arg);
6543        }
6544    
6545        Exception::Exception(String format, va_list arg) : DLS::Exception() {
6546            Message = assemble(format, arg);
6547      }      }
6548    
6549      void Exception::PrintMessage() {      void Exception::PrintMessage() {

Legend:
Removed from v.1875  
changed lines
  Added in v.3324

  ViewVC Help
Powered by ViewVC