/[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 1316 by schoenebeck, Fri Aug 31 19:09:13 2007 UTC revision 3731 by schoenebeck, Sat Feb 1 15:35:07 2020 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file access library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2007 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2020 by Christian Schoenebeck                      *
6   *                              <cuse@users.sourceforge.net>               *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   This library is free software; you can redistribute it and/or modify  *
# Line 24  Line 24 
24  #include "gig.h"  #include "gig.h"
25    
26  #include "helper.h"  #include "helper.h"
27    #include "Serialization.h"
28    
29    #include <algorithm>
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 49  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 121  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 158  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 255  namespace { Line 233  namespace {
233    
234    
235    
236    // *************** Internal CRC-32 (Cyclic Redundancy Check) functions  ***************
237    // *
238    
239        static uint32_t* __initCRCTable() {
240            static uint32_t res[256];
241    
242            for (int i = 0 ; i < 256 ; i++) {
243                uint32_t c = i;
244                for (int j = 0 ; j < 8 ; j++) {
245                    c = (c & 1) ? 0xedb88320 ^ (c >> 1) : c >> 1;
246                }
247                res[i] = c;
248            }
249            return res;
250        }
251    
252        static const uint32_t* __CRCTable = __initCRCTable();
253    
254        /**
255         * Initialize a CRC variable.
256         *
257         * @param crc - variable to be initialized
258         */
259        inline static void __resetCRC(uint32_t& crc) {
260            crc = 0xffffffff;
261        }
262    
263        /**
264         * Used to calculate checksums of the sample data in a gig file. The
265         * checksums are stored in the 3crc chunk of the gig file and
266         * automatically updated when a sample is written with Sample::Write().
267         *
268         * One should call __resetCRC() to initialize the CRC variable to be
269         * used before calling this function the first time.
270         *
271         * After initializing the CRC variable one can call this function
272         * arbitrary times, i.e. to split the overall CRC calculation into
273         * steps.
274         *
275         * Once the whole data was processed by __calculateCRC(), one should
276         * call __finalizeCRC() to get the final CRC result.
277         *
278         * @param buf     - pointer to data the CRC shall be calculated of
279         * @param bufSize - size of the data to be processed
280         * @param crc     - variable the CRC sum shall be stored to
281         */
282        static void __calculateCRC(unsigned char* buf, size_t bufSize, uint32_t& crc) {
283            for (size_t i = 0 ; i < bufSize ; i++) {
284                crc = __CRCTable[(crc ^ buf[i]) & 0xff] ^ (crc >> 8);
285            }
286        }
287    
288        /**
289         * Returns the final CRC result.
290         *
291         * @param crc - variable previously passed to __calculateCRC()
292         */
293        inline static void __finalizeCRC(uint32_t& crc) {
294            crc ^= 0xffffffff;
295        }
296    
297    
298    
299  // *************** Other Internal functions  ***************  // *************** Other Internal functions  ***************
300  // *  // *
301    
# Line 278  namespace { Line 319  namespace {
319    
320    
321    
322  // *************** CRC ***************  // *************** leverage_ctrl_t ***************
323  // *  // *
324    
325      const uint32_t* CRC::table(initTable());      void leverage_ctrl_t::serialize(Serialization::Archive* archive) {
326            SRLZ(type);
327            SRLZ(controller_number);
328        }
329    
     uint32_t* CRC::initTable() {  
         uint32_t* res = new uint32_t[256];  
330    
331          for (int i = 0 ; i < 256 ; i++) {  
332              uint32_t c = i;  // *************** crossfade_t ***************
333              for (int j = 0 ; j < 8 ; j++) {  // *
334                  c = (c & 1) ? 0xedb88320 ^ (c >> 1) : c >> 1;  
335              }      void crossfade_t::serialize(Serialization::Archive* archive) {
336              res[i] = c;          SRLZ(in_start);
337          }          SRLZ(in_end);
338          return res;          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    
# Line 301  namespace { Line 365  namespace {
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 321  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          static const DLS::Info::FixedStringLength fixedStringLengths[] = {          : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset)
392        {
393            static const DLS::Info::string_length_t fixedStringLengths[] = {
394              { CHUNK_ID_INAM, 64 },              { CHUNK_ID_INAM, 64 },
395              { 0, 0 }              { 0, 0 }
396          };          };
397          pInfo->FixedStringLengths = fixedStringLengths;          pInfo->SetFixedStringLengths(fixedStringLengths);
398          Instances++;          Instances++;
399          FileNo = fileNo;          FileNo = fileNo;
400    
401            __resetCRC(crc);
402            // if this is not a new sample, try to get the sample's already existing
403            // CRC32 checksum from disk, this checksum will reflect the sample's CRC32
404            // checksum of the time when the sample was consciously modified by the
405            // user for the last time (by calling Sample::Write() that is).
406            if (index >= 0) { // not a new file ...
407                try {
408                    uint32_t crc = pFile->GetSampleChecksumByIndex(index);
409                    this->crc = crc;
410                } catch (...) {}
411            }
412    
413          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
414          if (pCk3gix) {          if (pCk3gix) {
415                pCk3gix->SetPos(0);
416    
417              uint16_t iSampleGroup = pCk3gix->ReadInt16();              uint16_t iSampleGroup = pCk3gix->ReadInt16();
418              pGroup = pFile->GetGroup(iSampleGroup);              pGroup = pFile->GetGroup(iSampleGroup);
419          } else { // '3gix' chunk missing          } else { // '3gix' chunk missing
# Line 342  namespace { Line 423  namespace {
423    
424          pCkSmpl = waveList->GetSubChunk(CHUNK_ID_SMPL);          pCkSmpl = waveList->GetSubChunk(CHUNK_ID_SMPL);
425          if (pCkSmpl) {          if (pCkSmpl) {
426                pCkSmpl->SetPos(0);
427    
428              Manufacturer  = pCkSmpl->ReadInt32();              Manufacturer  = pCkSmpl->ReadInt32();
429              Product       = pCkSmpl->ReadInt32();              Product       = pCkSmpl->ReadInt32();
430              SamplePeriod  = pCkSmpl->ReadInt32();              SamplePeriod  = pCkSmpl->ReadInt32();
# Line 388  namespace { Line 471  namespace {
471          Dithered          = false;          Dithered          = false;
472          TruncatedBits     = 0;          TruncatedBits     = 0;
473          if (Compressed) {          if (Compressed) {
474                ewav->SetPos(0);
475    
476              uint32_t version = ewav->ReadInt32();              uint32_t version = ewav->ReadInt32();
477              if (version == 3 && BitDepth == 24) {              if (version > 2 && BitDepth == 24) {
478                  Dithered = ewav->ReadInt32();                  Dithered = ewav->ReadInt32();
479                  ewav->SetPos(Channels == 2 ? 84 : 64);                  ewav->SetPos(Channels == 2 ? 84 : 64);
480                  TruncatedBits = ewav->ReadInt32();                  TruncatedBits = ewav->ReadInt32();
# Line 408  namespace { Line 493  namespace {
493      }      }
494    
495      /**      /**
496         * Make a (semi) deep copy of the Sample object given by @a orig (without
497         * the actual waveform data) and assign it to this object.
498         *
499         * Discussion: copying .gig samples is a bit tricky. It requires three
500         * steps:
501         * 1. Copy sample's meta informations (done by CopyAssignMeta()) including
502         *    its new sample waveform data size.
503         * 2. Saving the file (done by File::Save()) so that it gains correct size
504         *    and layout for writing the actual wave form data directly to disc
505         *    in next step.
506         * 3. Copy the waveform data with disk streaming (done by CopyAssignWave()).
507         *
508         * @param orig - original Sample object to be copied from
509         */
510        void Sample::CopyAssignMeta(const Sample* orig) {
511            // handle base classes
512            DLS::Sample::CopyAssignCore(orig);
513            
514            // handle actual own attributes of this class
515            Manufacturer = orig->Manufacturer;
516            Product = orig->Product;
517            SamplePeriod = orig->SamplePeriod;
518            MIDIUnityNote = orig->MIDIUnityNote;
519            FineTune = orig->FineTune;
520            SMPTEFormat = orig->SMPTEFormat;
521            SMPTEOffset = orig->SMPTEOffset;
522            Loops = orig->Loops;
523            LoopID = orig->LoopID;
524            LoopType = orig->LoopType;
525            LoopStart = orig->LoopStart;
526            LoopEnd = orig->LoopEnd;
527            LoopSize = orig->LoopSize;
528            LoopFraction = orig->LoopFraction;
529            LoopPlayCount = orig->LoopPlayCount;
530            
531            // schedule resizing this sample to the given sample's size
532            Resize(orig->GetSize());
533        }
534    
535        /**
536         * Should be called after CopyAssignMeta() and File::Save() sequence.
537         * Read more about it in the discussion of CopyAssignMeta(). This method
538         * copies the actual waveform data by disk streaming.
539         *
540         * @e CAUTION: this method is currently not thread safe! During this
541         * operation the sample must not be used for other purposes by other
542         * threads!
543         *
544         * @param orig - original Sample object to be copied from
545         */
546        void Sample::CopyAssignWave(const Sample* orig) {
547            const int iReadAtOnce = 32*1024;
548            char* buf = new char[iReadAtOnce * orig->FrameSize];
549            Sample* pOrig = (Sample*) orig; //HACK: remove constness for now
550            file_offset_t restorePos = pOrig->GetPos();
551            pOrig->SetPos(0);
552            SetPos(0);
553            for (file_offset_t n = pOrig->Read(buf, iReadAtOnce); n;
554                               n = pOrig->Read(buf, iReadAtOnce))
555            {
556                Write(buf, n);
557            }
558            pOrig->SetPos(restorePos);
559            delete [] buf;
560        }
561    
562        /**
563       * Apply sample and its settings to the respective RIFF chunks. You have       * Apply sample and its settings to the respective RIFF chunks. You have
564       * to call File::Save() to make changes persistent.       * to call File::Save() to make changes persistent.
565       *       *
566       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
567       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
568       *       *
569         * @param pProgress - callback function for progress notification
570       * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data       * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data
571       *                        was provided yet       *                        was provided yet
572       * @throws gig::Exception if there is any invalid sample setting       * @throws gig::Exception if there is any invalid sample setting
573       */       */
574      void Sample::UpdateChunks() {      void Sample::UpdateChunks(progress_t* pProgress) {
575          // first update base class's chunks          // first update base class's chunks
576          DLS::Sample::UpdateChunks();          DLS::Sample::UpdateChunks(pProgress);
577    
578          // make sure 'smpl' chunk exists          // make sure 'smpl' chunk exists
579          pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);          pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);
# Line 468  namespace { Line 621  namespace {
621          // update '3gix' chunk          // update '3gix' chunk
622          pData = (uint8_t*) pCk3gix->LoadChunkData();          pData = (uint8_t*) pCk3gix->LoadChunkData();
623          store16(&pData[0], iSampleGroup);          store16(&pData[0], iSampleGroup);
624    
625            // if the library user toggled the "Compressed" attribute from true to
626            // false, then the EWAV chunk associated with compressed samples needs
627            // to be deleted
628            RIFF::Chunk* ewav = pWaveList->GetSubChunk(CHUNK_ID_EWAV);
629            if (ewav && !Compressed) {
630                pWaveList->DeleteSubChunk(ewav);
631            }
632      }      }
633    
634      /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).      /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).
635      void Sample::ScanCompressedSample() {      void Sample::ScanCompressedSample() {
636          //TODO: we have to add some more scans here (e.g. determine compression rate)          //TODO: we have to add some more scans here (e.g. determine compression rate)
637          this->SamplesTotal = 0;          this->SamplesTotal = 0;
638          std::list<unsigned long> frameOffsets;          std::list<file_offset_t> frameOffsets;
639    
640          SamplesPerFrame = BitDepth == 24 ? 256 : 2048;          SamplesPerFrame = BitDepth == 24 ? 256 : 2048;
641          WorstCaseFrameSize = SamplesPerFrame * FrameSize + Channels; // +Channels for compression flag          WorstCaseFrameSize = SamplesPerFrame * FrameSize + Channels; // +Channels for compression flag
# Line 490  namespace { Line 651  namespace {
651                  const int mode_l = pCkData->ReadUint8();                  const int mode_l = pCkData->ReadUint8();
652                  const int mode_r = pCkData->ReadUint8();                  const int mode_r = pCkData->ReadUint8();
653                  if (mode_l > 5 || mode_r > 5) throw gig::Exception("Unknown compression mode");                  if (mode_l > 5 || mode_r > 5) throw gig::Exception("Unknown compression mode");
654                  const unsigned long frameSize = bytesPerFrame[mode_l] + bytesPerFrame[mode_r];                  const file_offset_t frameSize = bytesPerFrame[mode_l] + bytesPerFrame[mode_r];
655    
656                  if (pCkData->RemainingBytes() <= frameSize) {                  if (pCkData->RemainingBytes() <= frameSize) {
657                      SamplesInLastFrame =                      SamplesInLastFrame =
# Line 509  namespace { Line 670  namespace {
670    
671                  const int mode = pCkData->ReadUint8();                  const int mode = pCkData->ReadUint8();
672                  if (mode > 5) throw gig::Exception("Unknown compression mode");                  if (mode > 5) throw gig::Exception("Unknown compression mode");
673                  const unsigned long frameSize = bytesPerFrame[mode];                  const file_offset_t frameSize = bytesPerFrame[mode];
674    
675                  if (pCkData->RemainingBytes() <= frameSize) {                  if (pCkData->RemainingBytes() <= frameSize) {
676                      SamplesInLastFrame =                      SamplesInLastFrame =
# Line 525  namespace { Line 686  namespace {
686    
687          // Build the frames table (which is used for fast resolving of a frame's chunk offset)          // Build the frames table (which is used for fast resolving of a frame's chunk offset)
688          if (FrameTable) delete[] FrameTable;          if (FrameTable) delete[] FrameTable;
689          FrameTable = new unsigned long[frameOffsets.size()];          FrameTable = new file_offset_t[frameOffsets.size()];
690          std::list<unsigned long>::iterator end  = frameOffsets.end();          std::list<file_offset_t>::iterator end  = frameOffsets.end();
691          std::list<unsigned long>::iterator iter = frameOffsets.begin();          std::list<file_offset_t>::iterator iter = frameOffsets.begin();
692          for (int i = 0; iter != end; i++, iter++) {          for (int i = 0; iter != end; i++, iter++) {
693              FrameTable[i] = *iter;              FrameTable[i] = *iter;
694          }          }
# Line 568  namespace { Line 729  namespace {
729       *                      the cached sample data in bytes       *                      the cached sample data in bytes
730       * @see                 ReleaseSampleData(), Read(), SetPos()       * @see                 ReleaseSampleData(), Read(), SetPos()
731       */       */
732      buffer_t Sample::LoadSampleData(unsigned long SampleCount) {      buffer_t Sample::LoadSampleData(file_offset_t SampleCount) {
733          return LoadSampleDataWithNullSamplesExtension(SampleCount, 0); // 0 amount of NullSamples          return LoadSampleDataWithNullSamplesExtension(SampleCount, 0); // 0 amount of NullSamples
734      }      }
735    
# Line 627  namespace { Line 788  namespace {
788       *                           size of the cached sample data in bytes       *                           size of the cached sample data in bytes
789       * @see                      ReleaseSampleData(), Read(), SetPos()       * @see                      ReleaseSampleData(), Read(), SetPos()
790       */       */
791      buffer_t Sample::LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount) {      buffer_t Sample::LoadSampleDataWithNullSamplesExtension(file_offset_t SampleCount, uint NullSamplesCount) {
792          if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;          if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;
793          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
794          unsigned long allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;          file_offset_t allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;
795            SetPos(0); // reset read position to begin of sample
796          RAMCache.pStart            = new int8_t[allocationsize];          RAMCache.pStart            = new int8_t[allocationsize];
797          RAMCache.Size              = Read(RAMCache.pStart, SampleCount) * this->FrameSize;          RAMCache.Size              = Read(RAMCache.pStart, SampleCount) * this->FrameSize;
798          RAMCache.NullExtensionSize = allocationsize - RAMCache.Size;          RAMCache.NullExtensionSize = allocationsize - RAMCache.Size;
# Line 668  namespace { Line 830  namespace {
830          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
831          RAMCache.pStart = NULL;          RAMCache.pStart = NULL;
832          RAMCache.Size   = 0;          RAMCache.Size   = 0;
833            RAMCache.NullExtensionSize = 0;
834      }      }
835    
836      /** @brief Resize sample.      /** @brief Resize sample.
# Line 692  namespace { Line 855  namespace {
855       * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with       * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with
856       * other formats will fail!       * other formats will fail!
857       *       *
858       * @param iNewSize - new sample wave data size in sample points (must be       * @param NewSize - new sample wave data size in sample points (must be
859       *                   greater than zero)       *                  greater than zero)
860       * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM       * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM
861       *                         or if \a iNewSize is less than 1       * @throws DLS::Exception if \a NewSize is less than 1 or unrealistic large
862       * @throws gig::Exception if existing sample is compressed       * @throws gig::Exception if existing sample is compressed
863       * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,       * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,
864       *      DLS::Sample::FormatTag, File::Save()       *      DLS::Sample::FormatTag, File::Save()
865       */       */
866      void Sample::Resize(int iNewSize) {      void Sample::Resize(file_offset_t NewSize) {
867          if (Compressed) throw gig::Exception("There is no support for modifying compressed samples (yet)");          if (Compressed) throw gig::Exception("There is no support for modifying compressed samples (yet)");
868          DLS::Sample::Resize(iNewSize);          DLS::Sample::Resize(NewSize);
869      }      }
870    
871      /**      /**
# Line 726  namespace { Line 889  namespace {
889       * @returns            the new sample position       * @returns            the new sample position
890       * @see                Read()       * @see                Read()
891       */       */
892      unsigned long Sample::SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence) {      file_offset_t Sample::SetPos(file_offset_t SampleCount, RIFF::stream_whence_t Whence) {
893          if (Compressed) {          if (Compressed) {
894              switch (Whence) {              switch (Whence) {
895                  case RIFF::stream_curpos:                  case RIFF::stream_curpos:
# Line 744  namespace { Line 907  namespace {
907              }              }
908              if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;              if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;
909    
910              unsigned long frame = this->SamplePos / 2048; // to which frame to jump              file_offset_t frame = this->SamplePos / 2048; // to which frame to jump
911              this->FrameOffset   = this->SamplePos % 2048; // offset (in sample points) within that frame              this->FrameOffset   = this->SamplePos % 2048; // offset (in sample points) within that frame
912              pCkData->SetPos(FrameTable[frame]);           // set chunk pointer to the start of sought frame              pCkData->SetPos(FrameTable[frame]);           // set chunk pointer to the start of sought frame
913              return this->SamplePos;              return this->SamplePos;
914          }          }
915          else { // not compressed          else { // not compressed
916              unsigned long orderedBytes = SampleCount * this->FrameSize;              file_offset_t orderedBytes = SampleCount * this->FrameSize;
917              unsigned long result = pCkData->SetPos(orderedBytes, Whence);              file_offset_t result = pCkData->SetPos(orderedBytes, Whence);
918              return (result == orderedBytes) ? SampleCount              return (result == orderedBytes) ? SampleCount
919                                              : result / this->FrameSize;                                              : result / this->FrameSize;
920          }          }
# Line 760  namespace { Line 923  namespace {
923      /**      /**
924       * Returns the current position in the sample (in sample points).       * Returns the current position in the sample (in sample points).
925       */       */
926      unsigned long Sample::GetPos() {      file_offset_t Sample::GetPos() const {
927          if (Compressed) return SamplePos;          if (Compressed) return SamplePos;
928          else            return pCkData->GetPos() / FrameSize;          else            return pCkData->GetPos() / FrameSize;
929      }      }
# Line 799  namespace { Line 962  namespace {
962       * @returns                number of successfully read sample points       * @returns                number of successfully read sample points
963       * @see                    CreateDecompressionBuffer()       * @see                    CreateDecompressionBuffer()
964       */       */
965      unsigned long Sample::ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState,      file_offset_t Sample::ReadAndLoop(void* pBuffer, file_offset_t SampleCount, playback_state_t* pPlaybackState,
966                                        DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {                                        DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {
967          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;          file_offset_t samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;
968          uint8_t* pDst = (uint8_t*) pBuffer;          uint8_t* pDst = (uint8_t*) pBuffer;
969    
970          SetPos(pPlaybackState->position); // recover position from the last time          SetPos(pPlaybackState->position); // recover position from the last time
# Line 839  namespace { Line 1002  namespace {
1002                                  // reading, swap all sample frames so it reflects                                  // reading, swap all sample frames so it reflects
1003                                  // backward playback                                  // backward playback
1004    
1005                                  unsigned long swapareastart       = totalreadsamples;                                  file_offset_t swapareastart       = totalreadsamples;
1006                                  unsigned long loopoffset          = GetPos() - loop.LoopStart;                                  file_offset_t loopoffset          = GetPos() - loop.LoopStart;
1007                                  unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);                                  file_offset_t samplestoreadinloop = Min(samplestoread, loopoffset);
1008                                  unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;                                  file_offset_t reverseplaybackend  = GetPos() - samplestoreadinloop;
1009    
1010                                  SetPos(reverseplaybackend);                                  SetPos(reverseplaybackend);
1011    
# Line 862  namespace { Line 1025  namespace {
1025                                  }                                  }
1026    
1027                                  // reverse the sample frames for backward playback                                  // reverse the sample frames for backward playback
1028                                  SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);                                  if (totalreadsamples > swapareastart) //FIXME: this if() is just a crash workaround for now (#102), but totalreadsamples <= swapareastart should never be the case, so there's probably still a bug above!
1029                                        SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
1030                              }                              }
1031                          } while (samplestoread && readsamples);                          } while (samplestoread && readsamples);
1032                          break;                          break;
# Line 889  namespace { Line 1053  namespace {
1053                          // reading, swap all sample frames so it reflects                          // reading, swap all sample frames so it reflects
1054                          // backward playback                          // backward playback
1055    
1056                          unsigned long swapareastart       = totalreadsamples;                          file_offset_t swapareastart       = totalreadsamples;
1057                          unsigned long loopoffset          = GetPos() - loop.LoopStart;                          file_offset_t loopoffset          = GetPos() - loop.LoopStart;
1058                          unsigned long samplestoreadinloop = (this->LoopPlayCount) ? Min(samplestoread, pPlaybackState->loop_cycles_left * loop.LoopLength - loopoffset)                          file_offset_t samplestoreadinloop = (this->LoopPlayCount) ? Min(samplestoread, pPlaybackState->loop_cycles_left * loop.LoopLength - loopoffset)
1059                                                                                    : samplestoread;                                                                                    : samplestoread;
1060                          unsigned long reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);                          file_offset_t reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);
1061    
1062                          SetPos(reverseplaybackend);                          SetPos(reverseplaybackend);
1063    
# Line 973  namespace { Line 1137  namespace {
1137       * @returns            number of successfully read sample points       * @returns            number of successfully read sample points
1138       * @see                SetPos(), CreateDecompressionBuffer()       * @see                SetPos(), CreateDecompressionBuffer()
1139       */       */
1140      unsigned long Sample::Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer) {      file_offset_t Sample::Read(void* pBuffer, file_offset_t SampleCount, buffer_t* pExternalDecompressionBuffer) {
1141          if (SampleCount == 0) return 0;          if (SampleCount == 0) return 0;
1142          if (!Compressed) {          if (!Compressed) {
1143              if (BitDepth == 24) {              if (BitDepth == 24) {
# Line 988  namespace { Line 1152  namespace {
1152          else {          else {
1153              if (this->SamplePos >= this->SamplesTotal) return 0;              if (this->SamplePos >= this->SamplesTotal) return 0;
1154              //TODO: efficiency: maybe we should test for an average compression rate              //TODO: efficiency: maybe we should test for an average compression rate
1155              unsigned long assumedsize      = GuessSize(SampleCount),              file_offset_t assumedsize      = GuessSize(SampleCount),
1156                            remainingbytes   = 0,           // remaining bytes in the local buffer                            remainingbytes   = 0,           // remaining bytes in the local buffer
1157                            remainingsamples = SampleCount,                            remainingsamples = SampleCount,
1158                            copysamples, skipsamples,                            copysamples, skipsamples,
# Line 1011  namespace { Line 1175  namespace {
1175              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);
1176    
1177              while (remainingsamples && remainingbytes) {              while (remainingsamples && remainingbytes) {
1178                  unsigned long framesamples = SamplesPerFrame;                  file_offset_t framesamples = SamplesPerFrame;
1179                  unsigned long framebytes, rightChannelOffset = 0, nextFrameOffset;                  file_offset_t framebytes, rightChannelOffset = 0, nextFrameOffset;
1180    
1181                  int mode_l = *pSrc++, mode_r = 0;                  int mode_l = *pSrc++, mode_r = 0;
1182    
# Line 1162  namespace { Line 1326  namespace {
1326       * @throws gig::Exception if sample is compressed       * @throws gig::Exception if sample is compressed
1327       * @see DLS::LoadSampleData()       * @see DLS::LoadSampleData()
1328       */       */
1329      unsigned long Sample::Write(void* pBuffer, unsigned long SampleCount) {      file_offset_t Sample::Write(void* pBuffer, file_offset_t SampleCount) {
1330          if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");          if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");
1331    
1332          // if this is the first write in this sample, reset the          // if this is the first write in this sample, reset the
1333          // checksum calculator          // checksum calculator
1334          if (pCkData->GetPos() == 0) {          if (pCkData->GetPos() == 0) {
1335              crc.reset();              __resetCRC(crc);
1336          }          }
1337          if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");          if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");
1338          unsigned long res;          file_offset_t res;
1339          if (BitDepth == 24) {          if (BitDepth == 24) {
1340              res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;              res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
1341          } else { // 16 bit          } else { // 16 bit
1342              res = Channels == 2 ? pCkData->Write(pBuffer, SampleCount << 1, 2) >> 1              res = Channels == 2 ? pCkData->Write(pBuffer, SampleCount << 1, 2) >> 1
1343                                  : pCkData->Write(pBuffer, SampleCount, 2);                                  : pCkData->Write(pBuffer, SampleCount, 2);
1344          }          }
1345          crc.update((unsigned char *)pBuffer, SampleCount * FrameSize);          __calculateCRC((unsigned char *)pBuffer, SampleCount * FrameSize, crc);
1346    
1347          // if this is the last write, update the checksum chunk in the          // if this is the last write, update the checksum chunk in the
1348          // file          // file
1349          if (pCkData->GetPos() == pCkData->GetSize()) {          if (pCkData->GetPos() == pCkData->GetSize()) {
1350                __finalizeCRC(crc);
1351              File* pFile = static_cast<File*>(GetParent());              File* pFile = static_cast<File*>(GetParent());
1352              pFile->SetSampleChecksum(this, crc.getValue());              pFile->SetSampleChecksum(this, crc);
1353          }          }
1354          return res;          return res;
1355      }      }
# Line 1205  namespace { Line 1370  namespace {
1370       * @returns allocated decompression buffer       * @returns allocated decompression buffer
1371       * @see DestroyDecompressionBuffer()       * @see DestroyDecompressionBuffer()
1372       */       */
1373      buffer_t Sample::CreateDecompressionBuffer(unsigned long MaxReadSize) {      buffer_t Sample::CreateDecompressionBuffer(file_offset_t MaxReadSize) {
1374          buffer_t result;          buffer_t result;
1375          const double worstCaseHeaderOverhead =          const double worstCaseHeaderOverhead =
1376                  (256.0 /*frame size*/ + 12.0 /*header*/ + 2.0 /*compression type flag (stereo)*/) / 256.0;                  (256.0 /*frame size*/ + 12.0 /*header*/ + 2.0 /*compression type flag (stereo)*/) / 256.0;
1377          result.Size              = (unsigned long) (double(MaxReadSize) * 3.0 /*(24 Bit)*/ * 2.0 /*stereo*/ * worstCaseHeaderOverhead);          result.Size              = (file_offset_t) (double(MaxReadSize) * 3.0 /*(24 Bit)*/ * 2.0 /*stereo*/ * worstCaseHeaderOverhead);
1378          result.pStart            = new int8_t[result.Size];          result.pStart            = new int8_t[result.Size];
1379          result.NullExtensionSize = 0;          result.NullExtensionSize = 0;
1380          return result;          return result;
# Line 1243  namespace { Line 1408  namespace {
1408          return pGroup;          return pGroup;
1409      }      }
1410    
1411        /**
1412         * Returns the CRC-32 checksum of the sample's raw wave form data at the
1413         * time when this sample's wave form data was modified for the last time
1414         * by calling Write(). This checksum only covers the raw wave form data,
1415         * not any meta informations like i.e. bit depth or loop points. Since
1416         * this method just returns the checksum stored for this sample i.e. when
1417         * the gig file was loaded, this method returns immediately. So it does no
1418         * recalcuation of the checksum with the currently available sample wave
1419         * form data.
1420         *
1421         * @see VerifyWaveData()
1422         */
1423        uint32_t Sample::GetWaveDataCRC32Checksum() {
1424            return crc;
1425        }
1426    
1427        /**
1428         * Checks the integrity of this sample's raw audio wave data. Whenever a
1429         * Sample's raw wave data is intentionally modified (i.e. by calling
1430         * Write() and supplying the new raw audio wave form data) a CRC32 checksum
1431         * is calculated and stored/updated for this sample, along to the sample's
1432         * meta informations.
1433         *
1434         * Now by calling this method the current raw audio wave data is checked
1435         * against the already stored CRC32 check sum in order to check whether the
1436         * sample data had been damaged unintentionally for some reason. Since by
1437         * calling this method always the entire raw audio wave data has to be
1438         * read, verifying all samples this way may take a long time accordingly.
1439         * And that's also the reason why the sample integrity is not checked by
1440         * default whenever a gig file is loaded. So this method must be called
1441         * explicitly to fulfill this task.
1442         *
1443         * @param pActually - (optional) if provided, will be set to the actually
1444         *                    calculated checksum of the current raw wave form data,
1445         *                    you can get the expected checksum instead by calling
1446         *                    GetWaveDataCRC32Checksum()
1447         * @returns true if sample is OK or false if the sample is damaged
1448         * @throws Exception if no checksum had been stored to disk for this
1449         *         sample yet, or on I/O issues
1450         * @see GetWaveDataCRC32Checksum()
1451         */
1452        bool Sample::VerifyWaveData(uint32_t* pActually) {
1453            //File* pFile = static_cast<File*>(GetParent());
1454            uint32_t crc = CalculateWaveDataChecksum();
1455            if (pActually) *pActually = crc;
1456            return crc == this->crc;
1457        }
1458    
1459        uint32_t Sample::CalculateWaveDataChecksum() {
1460            const size_t sz = 20*1024; // 20kB buffer size
1461            std::vector<uint8_t> buffer(sz);
1462            buffer.resize(sz);
1463    
1464            const size_t n = sz / FrameSize;
1465            SetPos(0);
1466            uint32_t crc = 0;
1467            __resetCRC(crc);
1468            while (true) {
1469                file_offset_t nRead = Read(&buffer[0], n);
1470                if (nRead <= 0) break;
1471                __calculateCRC(&buffer[0], nRead * FrameSize, crc);
1472            }
1473            __finalizeCRC(crc);
1474            return crc;
1475        }
1476    
1477      Sample::~Sample() {      Sample::~Sample() {
1478          Instances--;          Instances--;
1479          if (!Instances && InternalDecompressionBuffer.Size) {          if (!Instances && InternalDecompressionBuffer.Size) {
# Line 1259  namespace { Line 1490  namespace {
1490  // *************** DimensionRegion ***************  // *************** DimensionRegion ***************
1491  // *  // *
1492    
1493      uint                               DimensionRegion::Instances       = 0;      size_t                             DimensionRegion::Instances       = 0;
1494      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;
1495    
1496      DimensionRegion::DimensionRegion(Region* pParent, RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(Region* pParent, RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
# Line 1275  namespace { Line 1506  namespace {
1506    
1507          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);
1508          if (_3ewa) { // if '3ewa' chunk exists          if (_3ewa) { // if '3ewa' chunk exists
1509                _3ewa->SetPos(0);
1510    
1511              _3ewa->ReadInt32(); // unknown, always == chunk size ?              _3ewa->ReadInt32(); // unknown, always == chunk size ?
1512              LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1513              EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
# Line 1384  namespace { Line 1617  namespace {
1617                                                          : vcf_res_ctrl_none;                                                          : vcf_res_ctrl_none;
1618              uint16_t eg3depth = _3ewa->ReadUint16();              uint16_t eg3depth = _3ewa->ReadUint16();
1619              EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */              EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */
1620                                          : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */                                          : (-1) * (int16_t) ((eg3depth ^ 0xfff) + 1); /* binary complementary for negatives */
1621              _3ewa->ReadInt16(); // unknown              _3ewa->ReadInt16(); // unknown
1622              ChannelOffset = _3ewa->ReadUint8() / 4;              ChannelOffset = _3ewa->ReadUint8() / 4;
1623              uint8_t regoptions = _3ewa->ReadUint8();              uint8_t regoptions = _3ewa->ReadUint8();
# Line 1453  namespace { Line 1686  namespace {
1686              EG2Attack                       = 0.0;              EG2Attack                       = 0.0;
1687              EG2Decay1                       = 0.005;              EG2Decay1                       = 0.005;
1688              EG2Sustain                      = 1000;              EG2Sustain                      = 1000;
1689              EG2Release                      = 0.3;              EG2Release                      = 60;
1690              LFO2ControlDepth                = 0;              LFO2ControlDepth                = 0;
1691              LFO2Frequency                   = 1.0;              LFO2Frequency                   = 1.0;
1692              LFO2InternalDepth               = 0;              LFO2InternalDepth               = 0;
# Line 1508  namespace { Line 1741  namespace {
1741              memset(DimensionUpperLimits, 127, 8);              memset(DimensionUpperLimits, 127, 8);
1742          }          }
1743    
1744            // chunk for own format extensions, these will *NOT* work with Gigasampler/GigaStudio !
1745            RIFF::Chunk* lsde = _3ewl->GetSubChunk(CHUNK_ID_LSDE);
1746            if (lsde) { // format extension for EG behavior options
1747                lsde->SetPos(0);
1748    
1749                eg_opt_t* pEGOpts[2] = { &EG1Options, &EG2Options };
1750                for (int i = 0; i < 2; ++i) { // NOTE: we reserved a 3rd byte for a potential future EG3 option
1751                    unsigned char byte = lsde->ReadUint8();
1752                    pEGOpts[i]->AttackCancel     = byte & 1;
1753                    pEGOpts[i]->AttackHoldCancel = byte & (1 << 1);
1754                    pEGOpts[i]->Decay1Cancel     = byte & (1 << 2);
1755                    pEGOpts[i]->Decay2Cancel     = byte & (1 << 3);
1756                    pEGOpts[i]->ReleaseCancel    = byte & (1 << 4);
1757                }
1758            }
1759            // format extension for sustain pedal up effect on release trigger samples
1760            if (lsde && lsde->GetSize() > 3) { // NOTE: we reserved the 3rd byte for a potential future EG3 option
1761                lsde->SetPos(3);
1762                uint8_t byte = lsde->ReadUint8();
1763                SustainReleaseTrigger   = static_cast<sust_rel_trg_t>(byte & 0x03);
1764                NoNoteOffReleaseTrigger = byte >> 7;
1765            } else {
1766                SustainReleaseTrigger   = sust_rel_trg_none;
1767                NoNoteOffReleaseTrigger = false;
1768            }
1769            // format extension for LFOs' wave form, phase displacement and for
1770            // LFO3's flip phase
1771            if (lsde && lsde->GetSize() > 4) {
1772                lsde->SetPos(4);
1773                LFO1WaveForm = static_cast<lfo_wave_t>( lsde->ReadUint16() );
1774                LFO2WaveForm = static_cast<lfo_wave_t>( lsde->ReadUint16() );
1775                LFO3WaveForm = static_cast<lfo_wave_t>( lsde->ReadUint16() );
1776                lsde->ReadUint16(); // unused 16 bits, reserved for potential future use
1777                LFO1Phase = (double) GIG_EXP_DECODE( lsde->ReadInt32() );
1778                LFO2Phase = (double) GIG_EXP_DECODE( lsde->ReadInt32() );
1779                LFO3Phase = (double) GIG_EXP_DECODE( lsde->ReadInt32() );
1780                const uint32_t flags = lsde->ReadInt32();
1781                LFO3FlipPhase = flags & 1;
1782            } else {
1783                LFO1WaveForm = lfo_wave_sine;
1784                LFO2WaveForm = lfo_wave_sine;
1785                LFO3WaveForm = lfo_wave_sine;
1786                LFO1Phase = 0.0;
1787                LFO2Phase = 0.0;
1788                LFO3Phase = 0.0;
1789                LFO3FlipPhase = false;
1790            }
1791    
1792          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
1793                                                       VelocityResponseDepth,                                                       VelocityResponseDepth,
1794                                                       VelocityResponseCurveScaling);                                                       VelocityResponseCurveScaling);
1795    
1796          curve_type_t curveType = ReleaseVelocityResponseCurve;          pVelocityReleaseTable = GetReleaseVelocityTable(
1797          uint8_t depth = ReleaseVelocityResponseDepth;                                      ReleaseVelocityResponseCurve,
1798                                        ReleaseVelocityResponseDepth
1799          // this models a strange behaviour or bug in GSt: two of the                                  );
1800          // velocity response curves for release time are not used even  
1801          // if specified, instead another curve is chosen.          pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve,
1802          if ((curveType == curve_type_nonlinear && depth == 0) ||                                                        VCFVelocityDynamicRange,
1803              (curveType == curve_type_special   && depth == 4)) {                                                        VCFVelocityScale,
1804              curveType = curve_type_nonlinear;                                                        VCFCutoffController);
             depth = 3;  
         }  
         pVelocityReleaseTable = GetVelocityTable(curveType, depth, 0);  
   
         curveType = VCFVelocityCurve;  
         depth = VCFVelocityDynamicRange;  
   
         // even stranger GSt: two of the velocity response curves for  
         // filter cutoff are not used, instead another special curve  
         // is chosen. This curve is not used anywhere else.  
         if ((curveType == curve_type_nonlinear && depth == 0) ||  
             (curveType == curve_type_special   && depth == 4)) {  
             curveType = curve_type_special;  
             depth = 5;  
         }  
         pVelocityCutoffTable = GetVelocityTable(curveType, depth,  
                                                 VCFCutoffController <= vcf_cutoff_ctrl_none2 ? VCFVelocityScale : 0);  
1805    
1806          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1807          VelocityTable = 0;          VelocityTable = 0;
# Line 1549  namespace { Line 1813  namespace {
1813       */       */
1814      DimensionRegion::DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src) : DLS::Sampler(_3ewl) {
1815          Instances++;          Instances++;
1816            //NOTE: I think we cannot call CopyAssign() here (in a constructor) as long as its a virtual method
1817          *this = src; // default memberwise shallow copy of all parameters          *this = src; // default memberwise shallow copy of all parameters
1818          pParentList = _3ewl; // restore the chunk pointer          pParentList = _3ewl; // restore the chunk pointer
1819    
# Line 1564  namespace { Line 1829  namespace {
1829                  pSampleLoops[k] = src.pSampleLoops[k];                  pSampleLoops[k] = src.pSampleLoops[k];
1830          }          }
1831      }      }
1832        
1833        /**
1834         * Make a (semi) deep copy of the DimensionRegion object given by @a orig
1835         * and assign it to this object.
1836         *
1837         * Note that all sample pointers referenced by @a orig are simply copied as
1838         * memory address. Thus the respective samples are shared, not duplicated!
1839         *
1840         * @param orig - original DimensionRegion object to be copied from
1841         */
1842        void DimensionRegion::CopyAssign(const DimensionRegion* orig) {
1843            CopyAssign(orig, NULL);
1844        }
1845    
1846        /**
1847         * Make a (semi) deep copy of the DimensionRegion object given by @a orig
1848         * and assign it to this object.
1849         *
1850         * @param orig - original DimensionRegion object to be copied from
1851         * @param mSamples - crosslink map between the foreign file's samples and
1852         *                   this file's samples
1853         */
1854        void DimensionRegion::CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples) {
1855            // delete all allocated data first
1856            if (VelocityTable) delete [] VelocityTable;
1857            if (pSampleLoops) delete [] pSampleLoops;
1858            
1859            // backup parent list pointer
1860            RIFF::List* p = pParentList;
1861            
1862            gig::Sample* pOriginalSample = pSample;
1863            gig::Region* pOriginalRegion = pRegion;
1864            
1865            //NOTE: copy code copied from assignment constructor above, see comment there as well
1866            
1867            *this = *orig; // default memberwise shallow copy of all parameters
1868            
1869            // restore members that shall not be altered
1870            pParentList = p; // restore the chunk pointer
1871            pRegion = pOriginalRegion;
1872            
1873            // only take the raw sample reference reference if the
1874            // two DimensionRegion objects are part of the same file
1875            if (pOriginalRegion->GetParent()->GetParent() != orig->pRegion->GetParent()->GetParent()) {
1876                pSample = pOriginalSample;
1877            }
1878            
1879            if (mSamples && mSamples->count(orig->pSample)) {
1880                pSample = mSamples->find(orig->pSample)->second;
1881            }
1882    
1883            // deep copy of owned structures
1884            if (orig->VelocityTable) {
1885                VelocityTable = new uint8_t[128];
1886                for (int k = 0 ; k < 128 ; k++)
1887                    VelocityTable[k] = orig->VelocityTable[k];
1888            }
1889            if (orig->pSampleLoops) {
1890                pSampleLoops = new DLS::sample_loop_t[orig->SampleLoops];
1891                for (int k = 0 ; k < orig->SampleLoops ; k++)
1892                    pSampleLoops[k] = orig->pSampleLoops[k];
1893            }
1894        }
1895    
1896        void DimensionRegion::serialize(Serialization::Archive* archive) {
1897            // in case this class will become backward incompatible one day,
1898            // then set a version and minimum version for this class like:
1899            //archive->setVersion(*this, 2);
1900            //archive->setMinVersion(*this, 1);
1901    
1902            SRLZ(VelocityUpperLimit);
1903            SRLZ(EG1PreAttack);
1904            SRLZ(EG1Attack);
1905            SRLZ(EG1Decay1);
1906            SRLZ(EG1Decay2);
1907            SRLZ(EG1InfiniteSustain);
1908            SRLZ(EG1Sustain);
1909            SRLZ(EG1Release);
1910            SRLZ(EG1Hold);
1911            SRLZ(EG1Controller);
1912            SRLZ(EG1ControllerInvert);
1913            SRLZ(EG1ControllerAttackInfluence);
1914            SRLZ(EG1ControllerDecayInfluence);
1915            SRLZ(EG1ControllerReleaseInfluence);
1916            SRLZ(LFO1WaveForm);
1917            SRLZ(LFO1Frequency);
1918            SRLZ(LFO1Phase);
1919            SRLZ(LFO1InternalDepth);
1920            SRLZ(LFO1ControlDepth);
1921            SRLZ(LFO1Controller);
1922            SRLZ(LFO1FlipPhase);
1923            SRLZ(LFO1Sync);
1924            SRLZ(EG2PreAttack);
1925            SRLZ(EG2Attack);
1926            SRLZ(EG2Decay1);
1927            SRLZ(EG2Decay2);
1928            SRLZ(EG2InfiniteSustain);
1929            SRLZ(EG2Sustain);
1930            SRLZ(EG2Release);
1931            SRLZ(EG2Controller);
1932            SRLZ(EG2ControllerInvert);
1933            SRLZ(EG2ControllerAttackInfluence);
1934            SRLZ(EG2ControllerDecayInfluence);
1935            SRLZ(EG2ControllerReleaseInfluence);
1936            SRLZ(LFO2WaveForm);
1937            SRLZ(LFO2Frequency);
1938            SRLZ(LFO2Phase);
1939            SRLZ(LFO2InternalDepth);
1940            SRLZ(LFO2ControlDepth);
1941            SRLZ(LFO2Controller);
1942            SRLZ(LFO2FlipPhase);
1943            SRLZ(LFO2Sync);
1944            SRLZ(EG3Attack);
1945            SRLZ(EG3Depth);
1946            SRLZ(LFO3WaveForm);
1947            SRLZ(LFO3Frequency);
1948            SRLZ(LFO3Phase);
1949            SRLZ(LFO3InternalDepth);
1950            SRLZ(LFO3ControlDepth);
1951            SRLZ(LFO3Controller);
1952            SRLZ(LFO3FlipPhase);
1953            SRLZ(LFO3Sync);
1954            SRLZ(VCFEnabled);
1955            SRLZ(VCFType);
1956            SRLZ(VCFCutoffController);
1957            SRLZ(VCFCutoffControllerInvert);
1958            SRLZ(VCFCutoff);
1959            SRLZ(VCFVelocityCurve);
1960            SRLZ(VCFVelocityScale);
1961            SRLZ(VCFVelocityDynamicRange);
1962            SRLZ(VCFResonance);
1963            SRLZ(VCFResonanceDynamic);
1964            SRLZ(VCFResonanceController);
1965            SRLZ(VCFKeyboardTracking);
1966            SRLZ(VCFKeyboardTrackingBreakpoint);
1967            SRLZ(VelocityResponseCurve);
1968            SRLZ(VelocityResponseDepth);
1969            SRLZ(VelocityResponseCurveScaling);
1970            SRLZ(ReleaseVelocityResponseCurve);
1971            SRLZ(ReleaseVelocityResponseDepth);
1972            SRLZ(ReleaseTriggerDecay);
1973            SRLZ(Crossfade);
1974            SRLZ(PitchTrack);
1975            SRLZ(DimensionBypass);
1976            SRLZ(Pan);
1977            SRLZ(SelfMask);
1978            SRLZ(AttenuationController);
1979            SRLZ(InvertAttenuationController);
1980            SRLZ(AttenuationControllerThreshold);
1981            SRLZ(ChannelOffset);
1982            SRLZ(SustainDefeat);
1983            SRLZ(MSDecode);
1984            //SRLZ(SampleStartOffset);
1985            SRLZ(SampleAttenuation);
1986            SRLZ(EG1Options);
1987            SRLZ(EG2Options);
1988            SRLZ(SustainReleaseTrigger);
1989            SRLZ(NoNoteOffReleaseTrigger);
1990    
1991            // derived attributes from DLS::Sampler
1992            SRLZ(FineTune);
1993            SRLZ(Gain);
1994        }
1995    
1996        /**
1997         * Updates the respective member variable and updates @c SampleAttenuation
1998         * which depends on this value.
1999         */
2000        void DimensionRegion::SetGain(int32_t gain) {
2001            DLS::Sampler::SetGain(gain);
2002            SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
2003        }
2004    
2005      /**      /**
2006       * Apply dimension region settings to the respective RIFF chunks. You       * Apply dimension region settings to the respective RIFF chunks. You
# Line 1571  namespace { Line 2008  namespace {
2008       *       *
2009       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
2010       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
2011         *
2012         * @param pProgress - callback function for progress notification
2013       */       */
2014      void DimensionRegion::UpdateChunks() {      void DimensionRegion::UpdateChunks(progress_t* pProgress) {
         // check if wsmp is going to be created by  
         // DLS::Sampler::UpdateChunks  
         bool wsmp_created = !pParentList->GetSubChunk(CHUNK_ID_WSMP);  
   
2015          // first update base class's chunk          // first update base class's chunk
2016          DLS::Sampler::UpdateChunks();          DLS::Sampler::UpdateChunks(pProgress);
2017    
2018          RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);          RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);
2019          uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();          uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();
# Line 1589  namespace { Line 2024  namespace {
2024    
2025          // make sure '3ewa' chunk exists          // make sure '3ewa' chunk exists
2026          RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);
2027          if (!_3ewa)  _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, 140);          if (!_3ewa) {
2028          else if (wsmp_created) {              File* pFile = (File*) GetParent()->GetParent()->GetParent();
2029              // make sure the chunk order is: wsmp, 3ewa              bool versiongt2 = pFile->pVersion && pFile->pVersion->major > 2;
2030              pParentList->MoveSubChunk(_3ewa, 0);              _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, versiongt2 ? 148 : 140);
2031          }          }
2032          pData = (uint8_t*) _3ewa->LoadChunkData();          pData = (uint8_t*) _3ewa->LoadChunkData();
2033    
2034          // update '3ewa' chunk with DimensionRegion's current settings          // update '3ewa' chunk with DimensionRegion's current settings
2035    
2036          const uint32_t chunksize = _3ewa->GetNewSize();          const uint32_t chunksize = (uint32_t) _3ewa->GetNewSize();
2037          store32(&pData[0], chunksize); // unknown, always chunk size?          store32(&pData[0], chunksize); // unknown, always chunk size?
2038    
2039          const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);          const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);
# Line 1800  namespace { Line 2235  namespace {
2235          }          }
2236    
2237          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
2238                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xfff); /* binary complementary for negatives */
2239          pData[116] = eg3depth;          store16(&pData[116], eg3depth);
2240    
2241          // next 2 bytes unknown          // next 2 bytes unknown
2242    
# Line 1848  namespace { Line 2283  namespace {
2283                                        (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */                                        (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */
2284          pData[137] = vcfbreakpoint;          pData[137] = vcfbreakpoint;
2285    
2286          const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |          const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 +
2287                                      VCFVelocityCurve * 5;                                      VCFVelocityCurve * 5;
2288          pData[138] = vcfvelocity;          pData[138] = vcfvelocity;
2289    
# Line 1858  namespace { Line 2293  namespace {
2293          if (chunksize >= 148) {          if (chunksize >= 148) {
2294              memcpy(&pData[140], DimensionUpperLimits, 8);              memcpy(&pData[140], DimensionUpperLimits, 8);
2295          }          }
2296    
2297            // chunk for own format extensions, these will *NOT* work with
2298            // Gigasampler/GigaStudio !
2299            RIFF::Chunk* lsde = pParentList->GetSubChunk(CHUNK_ID_LSDE);
2300            const int lsdeSize =
2301                3 /* EG cancel options */ +
2302                1 /* sustain pedal up on release trigger option */ +
2303                8 /* LFOs' wave forms */ + 12 /* LFOs' phase */ + 4 /* flags (LFO3FlipPhase) */;
2304            if (!lsde && UsesAnyGigFormatExtension()) {
2305                // only add this "LSDE" chunk if there is some (format extension)
2306                // setting effective that would require our "LSDE" format extension
2307                // chunk to be stored
2308                lsde = pParentList->AddSubChunk(CHUNK_ID_LSDE, lsdeSize);
2309                // move LSDE chunk to the end of parent list
2310                pParentList->MoveSubChunk(lsde, (RIFF::Chunk*)NULL);
2311            }
2312            if (lsde) {
2313                if (lsde->GetNewSize() < lsdeSize)
2314                    lsde->Resize(lsdeSize);
2315                // format extension for EG behavior options
2316                unsigned char* pData = (unsigned char*) lsde->LoadChunkData();
2317                eg_opt_t* pEGOpts[2] = { &EG1Options, &EG2Options };
2318                for (int i = 0; i < 2; ++i) { // NOTE: we reserved the 3rd byte for a potential future EG3 option
2319                    pData[i] =
2320                        (pEGOpts[i]->AttackCancel     ? 1 : 0) |
2321                        (pEGOpts[i]->AttackHoldCancel ? (1<<1) : 0) |
2322                        (pEGOpts[i]->Decay1Cancel     ? (1<<2) : 0) |
2323                        (pEGOpts[i]->Decay2Cancel     ? (1<<3) : 0) |
2324                        (pEGOpts[i]->ReleaseCancel    ? (1<<4) : 0);
2325                }
2326                // format extension for release trigger options
2327                pData[3] = static_cast<uint8_t>(SustainReleaseTrigger) | (NoNoteOffReleaseTrigger ? (1<<7) : 0);
2328                // format extension for LFOs' wave form, phase displacement and for
2329                // LFO3's flip phase
2330                store16(&pData[4], LFO1WaveForm);
2331                store16(&pData[6], LFO2WaveForm);
2332                store16(&pData[8], LFO3WaveForm);
2333                //NOTE: 16 bits reserved here for potential future use !
2334                const int32_t lfo1Phase = (int32_t) GIG_EXP_ENCODE(LFO1Phase);
2335                const int32_t lfo2Phase = (int32_t) GIG_EXP_ENCODE(LFO2Phase);
2336                const int32_t lfo3Phase = (int32_t) GIG_EXP_ENCODE(LFO3Phase);
2337                store32(&pData[12], lfo1Phase);
2338                store32(&pData[16], lfo2Phase);
2339                store32(&pData[20], lfo3Phase);
2340                const int32_t flags = LFO3FlipPhase ? 1 : 0;
2341                store32(&pData[24], flags);
2342    
2343                // compile time sanity check: is our last store access here
2344                // consistent with the initial lsdeSize value assignment?
2345                static_assert(lsdeSize == 28, "Inconsistency in assumed 'LSDE' RIFF chunk size");
2346            }
2347        }
2348    
2349        /**
2350         * Returns @c true in case this DimensionRegion object uses any gig format
2351         * extension, that is whether this DimensionRegion object currently has any
2352         * setting effective that would require our "LSDE" RIFF chunk to be stored
2353         * to the gig file.
2354         *
2355         * Right now this is a private method. It is considerable though this method
2356         * to become (in slightly modified form) a public API method in future, i.e.
2357         * to allow instrument editors to visualize and/or warn the user of any
2358         * format extension being used. Right now this method really just serves to
2359         * answer the question whether an LSDE chunk is required, for the public API
2360         * purpose this method would also need to check whether any other setting
2361         * stored to the regular value '3ewa' chunk, is actually a format extension
2362         * as well.
2363         */
2364        bool DimensionRegion::UsesAnyGigFormatExtension() const {
2365            eg_opt_t defaultOpt;
2366            return memcmp(&EG1Options, &defaultOpt, sizeof(eg_opt_t)) ||
2367                   memcmp(&EG2Options, &defaultOpt, sizeof(eg_opt_t)) ||
2368                   SustainReleaseTrigger || NoNoteOffReleaseTrigger ||
2369                   LFO1WaveForm || LFO2WaveForm || LFO3WaveForm ||
2370                   LFO1Phase || LFO2Phase || LFO3Phase ||
2371                   LFO3FlipPhase;
2372        }
2373    
2374        double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {
2375            curve_type_t curveType = releaseVelocityResponseCurve;
2376            uint8_t depth = releaseVelocityResponseDepth;
2377            // this models a strange behaviour or bug in GSt: two of the
2378            // velocity response curves for release time are not used even
2379            // if specified, instead another curve is chosen.
2380            if ((curveType == curve_type_nonlinear && depth == 0) ||
2381                (curveType == curve_type_special   && depth == 4)) {
2382                curveType = curve_type_nonlinear;
2383                depth = 3;
2384            }
2385            return GetVelocityTable(curveType, depth, 0);
2386        }
2387    
2388        double* DimensionRegion::GetCutoffVelocityTable(curve_type_t vcfVelocityCurve,
2389                                                        uint8_t vcfVelocityDynamicRange,
2390                                                        uint8_t vcfVelocityScale,
2391                                                        vcf_cutoff_ctrl_t vcfCutoffController)
2392        {
2393            curve_type_t curveType = vcfVelocityCurve;
2394            uint8_t depth = vcfVelocityDynamicRange;
2395            // even stranger GSt: two of the velocity response curves for
2396            // filter cutoff are not used, instead another special curve
2397            // is chosen. This curve is not used anywhere else.
2398            if ((curveType == curve_type_nonlinear && depth == 0) ||
2399                (curveType == curve_type_special   && depth == 4)) {
2400                curveType = curve_type_special;
2401                depth = 5;
2402            }
2403            return GetVelocityTable(curveType, depth,
2404                                    (vcfCutoffController <= vcf_cutoff_ctrl_none2)
2405                                        ? vcfVelocityScale : 0);
2406      }      }
2407    
2408      // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet      // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet
2409      double* DimensionRegion::GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling)      double* DimensionRegion::GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling)
2410      {      {
2411            // sanity check input parameters
2412            // (fallback to some default parameters on ill input)
2413            switch (curveType) {
2414                case curve_type_nonlinear:
2415                case curve_type_linear:
2416                    if (depth > 4) {
2417                        printf("Warning: Invalid depth (0x%x) for velocity curve type (0x%x).\n", depth, curveType);
2418                        depth   = 0;
2419                        scaling = 0;
2420                    }
2421                    break;
2422                case curve_type_special:
2423                    if (depth > 5) {
2424                        printf("Warning: Invalid depth (0x%x) for velocity curve type 'special'.\n", depth);
2425                        depth   = 0;
2426                        scaling = 0;
2427                    }
2428                    break;
2429                case curve_type_unknown:
2430                default:
2431                    printf("Warning: Unknown velocity curve type (0x%x).\n", curveType);
2432                    curveType = curve_type_linear;
2433                    depth     = 0;
2434                    scaling   = 0;
2435                    break;
2436            }
2437    
2438          double* table;          double* table;
2439          uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;          uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;
2440          if (pVelocityTables->count(tableKey)) { // if key exists          if (pVelocityTables->count(tableKey)) { // if key exists
# Line 1879  namespace { Line 2451  namespace {
2451          return pRegion;          return pRegion;
2452      }      }
2453    
2454    // show error if some _lev_ctrl_* enum entry is not listed in the following function
2455    // (commented out for now, because "diagnostic push" not supported prior GCC 4.6)
2456    // TODO: uncomment and add a GCC version check (see also commented "#pragma GCC diagnostic pop" below)
2457    //#pragma GCC diagnostic push
2458    //#pragma GCC diagnostic error "-Wswitch"
2459    
2460      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {
2461          leverage_ctrl_t decodedcontroller;          leverage_ctrl_t decodedcontroller;
2462          switch (EncodedController) {          switch (EncodedController) {
# Line 1990  namespace { Line 2568  namespace {
2568                  decodedcontroller.controller_number = 95;                  decodedcontroller.controller_number = 95;
2569                  break;                  break;
2570    
2571                // format extension (these controllers are so far only supported by
2572                // LinuxSampler & gigedit) they will *NOT* work with
2573                // Gigasampler/GigaStudio !
2574                case _lev_ctrl_CC3_EXT:
2575                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2576                    decodedcontroller.controller_number = 3;
2577                    break;
2578                case _lev_ctrl_CC6_EXT:
2579                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2580                    decodedcontroller.controller_number = 6;
2581                    break;
2582                case _lev_ctrl_CC7_EXT:
2583                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2584                    decodedcontroller.controller_number = 7;
2585                    break;
2586                case _lev_ctrl_CC8_EXT:
2587                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2588                    decodedcontroller.controller_number = 8;
2589                    break;
2590                case _lev_ctrl_CC9_EXT:
2591                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2592                    decodedcontroller.controller_number = 9;
2593                    break;
2594                case _lev_ctrl_CC10_EXT:
2595                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2596                    decodedcontroller.controller_number = 10;
2597                    break;
2598                case _lev_ctrl_CC11_EXT:
2599                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2600                    decodedcontroller.controller_number = 11;
2601                    break;
2602                case _lev_ctrl_CC14_EXT:
2603                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2604                    decodedcontroller.controller_number = 14;
2605                    break;
2606                case _lev_ctrl_CC15_EXT:
2607                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2608                    decodedcontroller.controller_number = 15;
2609                    break;
2610                case _lev_ctrl_CC20_EXT:
2611                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2612                    decodedcontroller.controller_number = 20;
2613                    break;
2614                case _lev_ctrl_CC21_EXT:
2615                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2616                    decodedcontroller.controller_number = 21;
2617                    break;
2618                case _lev_ctrl_CC22_EXT:
2619                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2620                    decodedcontroller.controller_number = 22;
2621                    break;
2622                case _lev_ctrl_CC23_EXT:
2623                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2624                    decodedcontroller.controller_number = 23;
2625                    break;
2626                case _lev_ctrl_CC24_EXT:
2627                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2628                    decodedcontroller.controller_number = 24;
2629                    break;
2630                case _lev_ctrl_CC25_EXT:
2631                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2632                    decodedcontroller.controller_number = 25;
2633                    break;
2634                case _lev_ctrl_CC26_EXT:
2635                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2636                    decodedcontroller.controller_number = 26;
2637                    break;
2638                case _lev_ctrl_CC27_EXT:
2639                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2640                    decodedcontroller.controller_number = 27;
2641                    break;
2642                case _lev_ctrl_CC28_EXT:
2643                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2644                    decodedcontroller.controller_number = 28;
2645                    break;
2646                case _lev_ctrl_CC29_EXT:
2647                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2648                    decodedcontroller.controller_number = 29;
2649                    break;
2650                case _lev_ctrl_CC30_EXT:
2651                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2652                    decodedcontroller.controller_number = 30;
2653                    break;
2654                case _lev_ctrl_CC31_EXT:
2655                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2656                    decodedcontroller.controller_number = 31;
2657                    break;
2658                case _lev_ctrl_CC68_EXT:
2659                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2660                    decodedcontroller.controller_number = 68;
2661                    break;
2662                case _lev_ctrl_CC69_EXT:
2663                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2664                    decodedcontroller.controller_number = 69;
2665                    break;
2666                case _lev_ctrl_CC70_EXT:
2667                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2668                    decodedcontroller.controller_number = 70;
2669                    break;
2670                case _lev_ctrl_CC71_EXT:
2671                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2672                    decodedcontroller.controller_number = 71;
2673                    break;
2674                case _lev_ctrl_CC72_EXT:
2675                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2676                    decodedcontroller.controller_number = 72;
2677                    break;
2678                case _lev_ctrl_CC73_EXT:
2679                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2680                    decodedcontroller.controller_number = 73;
2681                    break;
2682                case _lev_ctrl_CC74_EXT:
2683                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2684                    decodedcontroller.controller_number = 74;
2685                    break;
2686                case _lev_ctrl_CC75_EXT:
2687                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2688                    decodedcontroller.controller_number = 75;
2689                    break;
2690                case _lev_ctrl_CC76_EXT:
2691                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2692                    decodedcontroller.controller_number = 76;
2693                    break;
2694                case _lev_ctrl_CC77_EXT:
2695                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2696                    decodedcontroller.controller_number = 77;
2697                    break;
2698                case _lev_ctrl_CC78_EXT:
2699                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2700                    decodedcontroller.controller_number = 78;
2701                    break;
2702                case _lev_ctrl_CC79_EXT:
2703                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2704                    decodedcontroller.controller_number = 79;
2705                    break;
2706                case _lev_ctrl_CC84_EXT:
2707                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2708                    decodedcontroller.controller_number = 84;
2709                    break;
2710                case _lev_ctrl_CC85_EXT:
2711                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2712                    decodedcontroller.controller_number = 85;
2713                    break;
2714                case _lev_ctrl_CC86_EXT:
2715                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2716                    decodedcontroller.controller_number = 86;
2717                    break;
2718                case _lev_ctrl_CC87_EXT:
2719                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2720                    decodedcontroller.controller_number = 87;
2721                    break;
2722                case _lev_ctrl_CC89_EXT:
2723                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2724                    decodedcontroller.controller_number = 89;
2725                    break;
2726                case _lev_ctrl_CC90_EXT:
2727                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2728                    decodedcontroller.controller_number = 90;
2729                    break;
2730                case _lev_ctrl_CC96_EXT:
2731                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2732                    decodedcontroller.controller_number = 96;
2733                    break;
2734                case _lev_ctrl_CC97_EXT:
2735                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2736                    decodedcontroller.controller_number = 97;
2737                    break;
2738                case _lev_ctrl_CC102_EXT:
2739                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2740                    decodedcontroller.controller_number = 102;
2741                    break;
2742                case _lev_ctrl_CC103_EXT:
2743                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2744                    decodedcontroller.controller_number = 103;
2745                    break;
2746                case _lev_ctrl_CC104_EXT:
2747                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2748                    decodedcontroller.controller_number = 104;
2749                    break;
2750                case _lev_ctrl_CC105_EXT:
2751                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2752                    decodedcontroller.controller_number = 105;
2753                    break;
2754                case _lev_ctrl_CC106_EXT:
2755                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2756                    decodedcontroller.controller_number = 106;
2757                    break;
2758                case _lev_ctrl_CC107_EXT:
2759                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2760                    decodedcontroller.controller_number = 107;
2761                    break;
2762                case _lev_ctrl_CC108_EXT:
2763                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2764                    decodedcontroller.controller_number = 108;
2765                    break;
2766                case _lev_ctrl_CC109_EXT:
2767                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2768                    decodedcontroller.controller_number = 109;
2769                    break;
2770                case _lev_ctrl_CC110_EXT:
2771                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2772                    decodedcontroller.controller_number = 110;
2773                    break;
2774                case _lev_ctrl_CC111_EXT:
2775                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2776                    decodedcontroller.controller_number = 111;
2777                    break;
2778                case _lev_ctrl_CC112_EXT:
2779                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2780                    decodedcontroller.controller_number = 112;
2781                    break;
2782                case _lev_ctrl_CC113_EXT:
2783                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2784                    decodedcontroller.controller_number = 113;
2785                    break;
2786                case _lev_ctrl_CC114_EXT:
2787                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2788                    decodedcontroller.controller_number = 114;
2789                    break;
2790                case _lev_ctrl_CC115_EXT:
2791                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2792                    decodedcontroller.controller_number = 115;
2793                    break;
2794                case _lev_ctrl_CC116_EXT:
2795                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2796                    decodedcontroller.controller_number = 116;
2797                    break;
2798                case _lev_ctrl_CC117_EXT:
2799                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2800                    decodedcontroller.controller_number = 117;
2801                    break;
2802                case _lev_ctrl_CC118_EXT:
2803                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2804                    decodedcontroller.controller_number = 118;
2805                    break;
2806                case _lev_ctrl_CC119_EXT:
2807                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2808                    decodedcontroller.controller_number = 119;
2809                    break;
2810    
2811              // unknown controller type              // unknown controller type
2812              default:              default:
2813                  throw gig::Exception("Unknown leverage controller type.");                  decodedcontroller.type = leverage_ctrl_t::type_none;
2814                    decodedcontroller.controller_number = 0;
2815                    printf("Warning: Unknown leverage controller type (0x%x).\n", EncodedController);
2816                    break;
2817          }          }
2818          return decodedcontroller;          return decodedcontroller;
2819      }      }
2820        
2821    // see above (diagnostic push not supported prior GCC 4.6)
2822    //#pragma GCC diagnostic pop
2823    
2824      DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {      DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {
2825          _lev_ctrl_t encodedcontroller;          _lev_ctrl_t encodedcontroller;
# Line 2083  namespace { Line 2907  namespace {
2907                      case 95:                      case 95:
2908                          encodedcontroller = _lev_ctrl_effect5depth;                          encodedcontroller = _lev_ctrl_effect5depth;
2909                          break;                          break;
2910    
2911                        // format extension (these controllers are so far only
2912                        // supported by LinuxSampler & gigedit) they will *NOT*
2913                        // work with Gigasampler/GigaStudio !
2914                        case 3:
2915                            encodedcontroller = _lev_ctrl_CC3_EXT;
2916                            break;
2917                        case 6:
2918                            encodedcontroller = _lev_ctrl_CC6_EXT;
2919                            break;
2920                        case 7:
2921                            encodedcontroller = _lev_ctrl_CC7_EXT;
2922                            break;
2923                        case 8:
2924                            encodedcontroller = _lev_ctrl_CC8_EXT;
2925                            break;
2926                        case 9:
2927                            encodedcontroller = _lev_ctrl_CC9_EXT;
2928                            break;
2929                        case 10:
2930                            encodedcontroller = _lev_ctrl_CC10_EXT;
2931                            break;
2932                        case 11:
2933                            encodedcontroller = _lev_ctrl_CC11_EXT;
2934                            break;
2935                        case 14:
2936                            encodedcontroller = _lev_ctrl_CC14_EXT;
2937                            break;
2938                        case 15:
2939                            encodedcontroller = _lev_ctrl_CC15_EXT;
2940                            break;
2941                        case 20:
2942                            encodedcontroller = _lev_ctrl_CC20_EXT;
2943                            break;
2944                        case 21:
2945                            encodedcontroller = _lev_ctrl_CC21_EXT;
2946                            break;
2947                        case 22:
2948                            encodedcontroller = _lev_ctrl_CC22_EXT;
2949                            break;
2950                        case 23:
2951                            encodedcontroller = _lev_ctrl_CC23_EXT;
2952                            break;
2953                        case 24:
2954                            encodedcontroller = _lev_ctrl_CC24_EXT;
2955                            break;
2956                        case 25:
2957                            encodedcontroller = _lev_ctrl_CC25_EXT;
2958                            break;
2959                        case 26:
2960                            encodedcontroller = _lev_ctrl_CC26_EXT;
2961                            break;
2962                        case 27:
2963                            encodedcontroller = _lev_ctrl_CC27_EXT;
2964                            break;
2965                        case 28:
2966                            encodedcontroller = _lev_ctrl_CC28_EXT;
2967                            break;
2968                        case 29:
2969                            encodedcontroller = _lev_ctrl_CC29_EXT;
2970                            break;
2971                        case 30:
2972                            encodedcontroller = _lev_ctrl_CC30_EXT;
2973                            break;
2974                        case 31:
2975                            encodedcontroller = _lev_ctrl_CC31_EXT;
2976                            break;
2977                        case 68:
2978                            encodedcontroller = _lev_ctrl_CC68_EXT;
2979                            break;
2980                        case 69:
2981                            encodedcontroller = _lev_ctrl_CC69_EXT;
2982                            break;
2983                        case 70:
2984                            encodedcontroller = _lev_ctrl_CC70_EXT;
2985                            break;
2986                        case 71:
2987                            encodedcontroller = _lev_ctrl_CC71_EXT;
2988                            break;
2989                        case 72:
2990                            encodedcontroller = _lev_ctrl_CC72_EXT;
2991                            break;
2992                        case 73:
2993                            encodedcontroller = _lev_ctrl_CC73_EXT;
2994                            break;
2995                        case 74:
2996                            encodedcontroller = _lev_ctrl_CC74_EXT;
2997                            break;
2998                        case 75:
2999                            encodedcontroller = _lev_ctrl_CC75_EXT;
3000                            break;
3001                        case 76:
3002                            encodedcontroller = _lev_ctrl_CC76_EXT;
3003                            break;
3004                        case 77:
3005                            encodedcontroller = _lev_ctrl_CC77_EXT;
3006                            break;
3007                        case 78:
3008                            encodedcontroller = _lev_ctrl_CC78_EXT;
3009                            break;
3010                        case 79:
3011                            encodedcontroller = _lev_ctrl_CC79_EXT;
3012                            break;
3013                        case 84:
3014                            encodedcontroller = _lev_ctrl_CC84_EXT;
3015                            break;
3016                        case 85:
3017                            encodedcontroller = _lev_ctrl_CC85_EXT;
3018                            break;
3019                        case 86:
3020                            encodedcontroller = _lev_ctrl_CC86_EXT;
3021                            break;
3022                        case 87:
3023                            encodedcontroller = _lev_ctrl_CC87_EXT;
3024                            break;
3025                        case 89:
3026                            encodedcontroller = _lev_ctrl_CC89_EXT;
3027                            break;
3028                        case 90:
3029                            encodedcontroller = _lev_ctrl_CC90_EXT;
3030                            break;
3031                        case 96:
3032                            encodedcontroller = _lev_ctrl_CC96_EXT;
3033                            break;
3034                        case 97:
3035                            encodedcontroller = _lev_ctrl_CC97_EXT;
3036                            break;
3037                        case 102:
3038                            encodedcontroller = _lev_ctrl_CC102_EXT;
3039                            break;
3040                        case 103:
3041                            encodedcontroller = _lev_ctrl_CC103_EXT;
3042                            break;
3043                        case 104:
3044                            encodedcontroller = _lev_ctrl_CC104_EXT;
3045                            break;
3046                        case 105:
3047                            encodedcontroller = _lev_ctrl_CC105_EXT;
3048                            break;
3049                        case 106:
3050                            encodedcontroller = _lev_ctrl_CC106_EXT;
3051                            break;
3052                        case 107:
3053                            encodedcontroller = _lev_ctrl_CC107_EXT;
3054                            break;
3055                        case 108:
3056                            encodedcontroller = _lev_ctrl_CC108_EXT;
3057                            break;
3058                        case 109:
3059                            encodedcontroller = _lev_ctrl_CC109_EXT;
3060                            break;
3061                        case 110:
3062                            encodedcontroller = _lev_ctrl_CC110_EXT;
3063                            break;
3064                        case 111:
3065                            encodedcontroller = _lev_ctrl_CC111_EXT;
3066                            break;
3067                        case 112:
3068                            encodedcontroller = _lev_ctrl_CC112_EXT;
3069                            break;
3070                        case 113:
3071                            encodedcontroller = _lev_ctrl_CC113_EXT;
3072                            break;
3073                        case 114:
3074                            encodedcontroller = _lev_ctrl_CC114_EXT;
3075                            break;
3076                        case 115:
3077                            encodedcontroller = _lev_ctrl_CC115_EXT;
3078                            break;
3079                        case 116:
3080                            encodedcontroller = _lev_ctrl_CC116_EXT;
3081                            break;
3082                        case 117:
3083                            encodedcontroller = _lev_ctrl_CC117_EXT;
3084                            break;
3085                        case 118:
3086                            encodedcontroller = _lev_ctrl_CC118_EXT;
3087                            break;
3088                        case 119:
3089                            encodedcontroller = _lev_ctrl_CC119_EXT;
3090                            break;
3091    
3092                      default:                      default:
3093                          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");
3094                  }                  }
# Line 2132  namespace { Line 3138  namespace {
3138          return pVelocityCutoffTable[MIDIKeyVelocity];          return pVelocityCutoffTable[MIDIKeyVelocity];
3139      }      }
3140    
3141        /**
3142         * Updates the respective member variable and the lookup table / cache
3143         * that depends on this value.
3144         */
3145        void DimensionRegion::SetVelocityResponseCurve(curve_type_t curve) {
3146            pVelocityAttenuationTable =
3147                GetVelocityTable(
3148                    curve, VelocityResponseDepth, VelocityResponseCurveScaling
3149                );
3150            VelocityResponseCurve = curve;
3151        }
3152    
3153        /**
3154         * Updates the respective member variable and the lookup table / cache
3155         * that depends on this value.
3156         */
3157        void DimensionRegion::SetVelocityResponseDepth(uint8_t depth) {
3158            pVelocityAttenuationTable =
3159                GetVelocityTable(
3160                    VelocityResponseCurve, depth, VelocityResponseCurveScaling
3161                );
3162            VelocityResponseDepth = depth;
3163        }
3164    
3165        /**
3166         * Updates the respective member variable and the lookup table / cache
3167         * that depends on this value.
3168         */
3169        void DimensionRegion::SetVelocityResponseCurveScaling(uint8_t scaling) {
3170            pVelocityAttenuationTable =
3171                GetVelocityTable(
3172                    VelocityResponseCurve, VelocityResponseDepth, scaling
3173                );
3174            VelocityResponseCurveScaling = scaling;
3175        }
3176    
3177        /**
3178         * Updates the respective member variable and the lookup table / cache
3179         * that depends on this value.
3180         */
3181        void DimensionRegion::SetReleaseVelocityResponseCurve(curve_type_t curve) {
3182            pVelocityReleaseTable = GetReleaseVelocityTable(curve, ReleaseVelocityResponseDepth);
3183            ReleaseVelocityResponseCurve = curve;
3184        }
3185    
3186        /**
3187         * Updates the respective member variable and the lookup table / cache
3188         * that depends on this value.
3189         */
3190        void DimensionRegion::SetReleaseVelocityResponseDepth(uint8_t depth) {
3191            pVelocityReleaseTable = GetReleaseVelocityTable(ReleaseVelocityResponseCurve, depth);
3192            ReleaseVelocityResponseDepth = depth;
3193        }
3194    
3195        /**
3196         * Updates the respective member variable and the lookup table / cache
3197         * that depends on this value.
3198         */
3199        void DimensionRegion::SetVCFCutoffController(vcf_cutoff_ctrl_t controller) {
3200            pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, VCFVelocityDynamicRange, VCFVelocityScale, controller);
3201            VCFCutoffController = controller;
3202        }
3203    
3204        /**
3205         * Updates the respective member variable and the lookup table / cache
3206         * that depends on this value.
3207         */
3208        void DimensionRegion::SetVCFVelocityCurve(curve_type_t curve) {
3209            pVelocityCutoffTable = GetCutoffVelocityTable(curve, VCFVelocityDynamicRange, VCFVelocityScale, VCFCutoffController);
3210            VCFVelocityCurve = curve;
3211        }
3212    
3213        /**
3214         * Updates the respective member variable and the lookup table / cache
3215         * that depends on this value.
3216         */
3217        void DimensionRegion::SetVCFVelocityDynamicRange(uint8_t range) {
3218            pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, range, VCFVelocityScale, VCFCutoffController);
3219            VCFVelocityDynamicRange = range;
3220        }
3221    
3222        /**
3223         * Updates the respective member variable and the lookup table / cache
3224         * that depends on this value.
3225         */
3226        void DimensionRegion::SetVCFVelocityScale(uint8_t scaling) {
3227            pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, VCFVelocityDynamicRange, scaling, VCFCutoffController);
3228            VCFVelocityScale = scaling;
3229        }
3230    
3231      double* DimensionRegion::CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling) {      double* DimensionRegion::CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling) {
3232    
3233          // line-segment approximations of the 15 velocity curves          // line-segment approximations of the 15 velocity curves
# Line 2211  namespace { Line 3307  namespace {
3307          }          }
3308          Layers = 1;          Layers = 1;
3309          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
3310          int dimensionBits = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;          int dimensionBits = (file->pVersion && file->pVersion->major > 2) ? 8 : 5;
3311    
3312          // Actual Loading          // Actual Loading
3313    
3314            if (!file->GetAutoLoad()) return;
3315    
3316          LoadDimensionRegions(rgnList);          LoadDimensionRegions(rgnList);
3317    
3318          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);
3319          if (_3lnk) {          if (_3lnk) {
3320                _3lnk->SetPos(0);
3321    
3322              DimensionRegions = _3lnk->ReadUint32();              DimensionRegions = _3lnk->ReadUint32();
3323              for (int i = 0; i < dimensionBits; i++) {              for (int i = 0; i < dimensionBits; i++) {
3324                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());
# Line 2253  namespace { Line 3353  namespace {
3353              UpdateVelocityTable();              UpdateVelocityTable();
3354    
3355              // jump to start of the wave pool indices (if not already there)              // jump to start of the wave pool indices (if not already there)
3356              if (file->pVersion && file->pVersion->major == 3)              if (file->pVersion && file->pVersion->major > 2)
3357                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure
3358              else              else
3359                  _3lnk->SetPos(44);                  _3lnk->SetPos(44);
3360    
3361              // load sample references              // load sample references (if auto loading is enabled)
3362              for (uint i = 0; i < DimensionRegions; i++) {              if (file->GetAutoLoad()) {
3363                  uint32_t wavepoolindex = _3lnk->ReadUint32();                  for (uint i = 0; i < DimensionRegions; i++) {
3364                  if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);                      uint32_t wavepoolindex = _3lnk->ReadUint32();
3365                        if (file->pWavePoolTable && pDimensionRegions[i])
3366                            pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
3367                    }
3368                    GetSample(); // load global region sample reference
3369              }              }
             GetSample(); // load global region sample reference  
3370          } else {          } else {
3371              DimensionRegions = 0;              DimensionRegions = 0;
3372              for (int i = 0 ; i < 8 ; i++) {              for (int i = 0 ; i < 8 ; i++) {
# Line 2290  namespace { Line 3393  namespace {
3393       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
3394       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
3395       *       *
3396         * @param pProgress - callback function for progress notification
3397       * @throws gig::Exception if samples cannot be dereferenced       * @throws gig::Exception if samples cannot be dereferenced
3398       */       */
3399      void Region::UpdateChunks() {      void Region::UpdateChunks(progress_t* pProgress) {
3400          // in the gig format we don't care about the Region's sample reference          // in the gig format we don't care about the Region's sample reference
3401          // but we still have to provide some existing one to not corrupt the          // but we still have to provide some existing one to not corrupt the
3402          // file, so to avoid the latter we simply always assign the sample of          // file, so to avoid the latter we simply always assign the sample of
# Line 2300  namespace { Line 3404  namespace {
3404          pSample = pDimensionRegions[0]->pSample;          pSample = pDimensionRegions[0]->pSample;
3405    
3406          // first update base class's chunks          // first update base class's chunks
3407          DLS::Region::UpdateChunks();          DLS::Region::UpdateChunks(pProgress);
   
         File* pFile = (File*) GetParent()->GetParent();  
         bool version3 = pFile->pVersion && pFile->pVersion->major == 3;  
3408    
3409          // update dimension region's chunks          // update dimension region's chunks
3410          for (int i = 0; i < DimensionRegions; i++) {          for (int i = 0; i < DimensionRegions; i++) {
3411              DimensionRegion* d = pDimensionRegions[i];              pDimensionRegions[i]->UpdateChunks(pProgress);
   
             // make sure '3ewa' chunk exists (we need to this before  
             // calling DimensionRegion::UpdateChunks, as  
             // DimensionRegion doesn't know which file version it is)  
             RIFF::Chunk* _3ewa = d->pParentList->GetSubChunk(CHUNK_ID_3EWA);  
             if (!_3ewa) d->pParentList->AddSubChunk(CHUNK_ID_3EWA, version3 ? 148 : 140);  
   
             d->UpdateChunks();  
3412          }          }
3413    
3414          const int iMaxDimensions =  version3 ? 8 : 5;          File* pFile = (File*) GetParent()->GetParent();
3415          const int iMaxDimensionRegions = version3 ? 256 : 32;          const bool versiongt2 = pFile->pVersion && pFile->pVersion->major > 2;
3416            const int iMaxDimensions =  versiongt2 ? 8 : 5;
3417            const int iMaxDimensionRegions = versiongt2 ? 256 : 32;
3418    
3419          // make sure '3lnk' chunk exists          // make sure '3lnk' chunk exists
3420          RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);          RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);
3421          if (!_3lnk) {          if (!_3lnk) {
3422              const int _3lnkChunkSize = version3 ? 1092 : 172;              const int _3lnkChunkSize = versiongt2 ? 1092 : 172;
3423              _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);              _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);
3424              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
3425    
3426              // move 3prg to last position              // move 3prg to last position
3427              pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), 0);              pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), (RIFF::Chunk*)NULL);
3428          }          }
3429    
3430          // update dimension definitions in '3lnk' chunk          // update dimension definitions in '3lnk' chunk
# Line 2348  namespace { Line 3443  namespace {
3443          }          }
3444    
3445          // update wave pool table in '3lnk' chunk          // update wave pool table in '3lnk' chunk
3446          const int iWavePoolOffset = version3 ? 68 : 44;          const int iWavePoolOffset = versiongt2 ? 68 : 44;
3447          for (uint i = 0; i < iMaxDimensionRegions; i++) {          for (uint i = 0; i < iMaxDimensionRegions; i++) {
3448              int iWaveIndex = -1;              int iWaveIndex = -1;
3449              if (i < DimensionRegions) {              if (i < DimensionRegions) {
# Line 2364  namespace { Line 3459  namespace {
3459              }              }
3460              store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);              store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);
3461          }          }
3462    
3463            // The following chunks are just added for compatibility with the
3464            // GigaStudio software, which would show a warning if these were
3465            // missing. However currently these chunks don't cover any useful
3466            // data. So if this gig file uses any of our own gig format
3467            // extensions which would cause this gig file to be unloadable
3468            // with GSt software anyway, then just skip these GSt compatibility
3469            // chunks here as well.
3470            if (versiongt2 && !UsesAnyGigFormatExtension()) {
3471                // add 3dnm list which always seems to be empty
3472                RIFF::List* _3dnm = pCkRegion->GetSubList(LIST_TYPE_3DNM);
3473                if (!_3dnm) _3dnm = pCkRegion->AddSubList(LIST_TYPE_3DNM);
3474    
3475                // add 3ddp chunk which always seems to have 16 bytes of 0xFF
3476                RIFF::Chunk* _3ddp = pCkRegion->GetSubChunk(CHUNK_ID_3DDP);
3477                if (!_3ddp) _3ddp =  pCkRegion->AddSubChunk(CHUNK_ID_3DDP, 16);
3478                uint8_t* pData = (uint8_t*) _3ddp->LoadChunkData();
3479                for (int i = 0; i < 16; i += 4) {
3480                    store32(&pData[i], 0xFFFFFFFF);
3481                }
3482    
3483                // move 3dnm and 3ddp to the end of the region list
3484                pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3DNM), (RIFF::Chunk*)NULL);
3485                pCkRegion->MoveSubChunk(pCkRegion->GetSubChunk(CHUNK_ID_3DDP), (RIFF::Chunk*)NULL);
3486            } else {
3487                // this is intended for the user switching from GSt >= 3 version
3488                // back to an older format version, delete GSt3 chunks ...
3489                RIFF::List* _3dnm = pCkRegion->GetSubList(LIST_TYPE_3DNM);
3490                if (_3dnm) pCkRegion->DeleteSubChunk(_3dnm);
3491    
3492                RIFF::Chunk* _3ddp = pCkRegion->GetSubChunk(CHUNK_ID_3DDP);
3493                if (_3ddp) pCkRegion->DeleteSubChunk(_3ddp);
3494            }
3495      }      }
3496    
3497      void Region::LoadDimensionRegions(RIFF::List* rgn) {      void Region::LoadDimensionRegions(RIFF::List* rgn) {
# Line 2382  namespace { Line 3510  namespace {
3510          }          }
3511      }      }
3512    
3513        void Region::SetKeyRange(uint16_t Low, uint16_t High) {
3514            // update KeyRange struct and make sure regions are in correct order
3515            DLS::Region::SetKeyRange(Low, High);
3516            // update Region key table for fast lookup
3517            ((gig::Instrument*)GetParent())->UpdateRegionKeyTable();
3518        }
3519    
3520      void Region::UpdateVelocityTable() {      void Region::UpdateVelocityTable() {
3521          // get velocity dimension's index          // get velocity dimension's index
3522          int veldim = -1;          int veldim = -1;
# Line 2396  namespace { Line 3531  namespace {
3531          int step = 1;          int step = 1;
3532          for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;          for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
3533          int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;          int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
         int end = step * pDimensionDefinitions[veldim].zones;  
3534    
3535          // loop through all dimension regions for all dimensions except the velocity dimension          // loop through all dimension regions for all dimensions except the velocity dimension
3536          int dim[8] = { 0 };          int dim[8] = { 0 };
3537          for (int i = 0 ; i < DimensionRegions ; i++) {          for (int i = 0 ; i < DimensionRegions ; i++) {
3538                const int end = i + step * pDimensionDefinitions[veldim].zones;
3539    
3540                // create a velocity table for all cases where the velocity zone is zero
3541              if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||              if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||
3542                  pDimensionRegions[i]->VelocityUpperLimit) {                  pDimensionRegions[i]->VelocityUpperLimit) {
3543                  // create the velocity table                  // create the velocity table
# Line 2432  namespace { Line 3568  namespace {
3568                  }                  }
3569              }              }
3570    
3571                // jump to the next case where the velocity zone is zero
3572              int j;              int j;
3573              int shift = 0;              int shift = 0;
3574              for (j = 0 ; j < Dimensions ; j++) {              for (j = 0 ; j < Dimensions ; j++) {
# Line 2468  namespace { Line 3605  namespace {
3605       *                        dimension bits limit is violated       *                        dimension bits limit is violated
3606       */       */
3607      void Region::AddDimension(dimension_def_t* pDimDef) {      void Region::AddDimension(dimension_def_t* pDimDef) {
3608            // some initial sanity checks of the given dimension definition
3609            if (pDimDef->zones < 2)
3610                throw gig::Exception("Could not add new dimension, amount of requested zones must always be at least two");
3611            if (pDimDef->bits < 1)
3612                throw gig::Exception("Could not add new dimension, amount of requested requested zone bits must always be at least one");
3613            if (pDimDef->dimension == dimension_samplechannel) {
3614                if (pDimDef->zones != 2)
3615                    throw gig::Exception("Could not add new 'sample channel' dimensions, the requested amount of zones must always be 2 for this dimension type");
3616                if (pDimDef->bits != 1)
3617                    throw gig::Exception("Could not add new 'sample channel' dimensions, the requested amount of zone bits must always be 1 for this dimension type");
3618            }
3619    
3620          // check if max. amount of dimensions reached          // check if max. amount of dimensions reached
3621          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
3622          const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;          const int iMaxDimensions = (file->pVersion && file->pVersion->major > 2) ? 8 : 5;
3623          if (Dimensions >= iMaxDimensions)          if (Dimensions >= iMaxDimensions)
3624              throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimensions already reached");              throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimensions already reached");
3625          // check if max. amount of dimension bits reached          // check if max. amount of dimension bits reached
# Line 2643  namespace { Line 3792  namespace {
3792          if (pDimDef->dimension == dimension_layer) Layers = 1;          if (pDimDef->dimension == dimension_layer) Layers = 1;
3793      }      }
3794    
3795        /** @brief Delete one split zone of a dimension (decrement zone amount).
3796         *
3797         * Instead of deleting an entire dimensions, this method will only delete
3798         * one particular split zone given by @a zone of the Region's dimension
3799         * given by @a type. So this method will simply decrement the amount of
3800         * zones by one of the dimension in question. To be able to do that, the
3801         * respective dimension must exist on this Region and it must have at least
3802         * 3 zones. All DimensionRegion objects associated with the zone will be
3803         * deleted.
3804         *
3805         * @param type - identifies the dimension where a zone shall be deleted
3806         * @param zone - index of the dimension split zone that shall be deleted
3807         * @throws gig::Exception if requested zone could not be deleted
3808         */
3809        void Region::DeleteDimensionZone(dimension_t type, int zone) {
3810            dimension_def_t* oldDef = GetDimensionDefinition(type);
3811            if (!oldDef)
3812                throw gig::Exception("Could not delete dimension zone, no such dimension of given type");
3813            if (oldDef->zones <= 2)
3814                throw gig::Exception("Could not delete dimension zone, because it would end up with only one zone.");
3815            if (zone < 0 || zone >= oldDef->zones)
3816                throw gig::Exception("Could not delete dimension zone, requested zone index out of bounds.");
3817    
3818            const int newZoneSize = oldDef->zones - 1;
3819    
3820            // create a temporary Region which just acts as a temporary copy
3821            // container and will be deleted at the end of this function and will
3822            // also not be visible through the API during this process
3823            gig::Region* tempRgn = NULL;
3824            {
3825                // adding these temporary chunks is probably not even necessary
3826                Instrument* instr = static_cast<Instrument*>(GetParent());
3827                RIFF::List* pCkInstrument = instr->pCkInstrument;
3828                RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
3829                if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3830                RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3831                tempRgn = new Region(instr, rgn);
3832            }
3833    
3834            // copy this region's dimensions (with already the dimension split size
3835            // requested by the arguments of this method call) to the temporary
3836            // region, and don't use Region::CopyAssign() here for this task, since
3837            // it would also alter fast lookup helper variables here and there
3838            dimension_def_t newDef;
3839            for (int i = 0; i < Dimensions; ++i) {
3840                dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3841                // is this the dimension requested by the method arguments? ...
3842                if (def.dimension == type) { // ... if yes, decrement zone amount by one
3843                    def.zones = newZoneSize;
3844                    if ((1 << (def.bits - 1)) == def.zones) def.bits--;
3845                    newDef = def;
3846                }
3847                tempRgn->AddDimension(&def);
3848            }
3849    
3850            // find the dimension index in the tempRegion which is the dimension
3851            // type passed to this method (paranoidly expecting different order)
3852            int tempReducedDimensionIndex = -1;
3853            for (int d = 0; d < tempRgn->Dimensions; ++d) {
3854                if (tempRgn->pDimensionDefinitions[d].dimension == type) {
3855                    tempReducedDimensionIndex = d;
3856                    break;
3857                }
3858            }
3859    
3860            // copy dimension regions from this region to the temporary region
3861            for (int iDst = 0; iDst < 256; ++iDst) {
3862                DimensionRegion* dstDimRgn = tempRgn->pDimensionRegions[iDst];
3863                if (!dstDimRgn) continue;
3864                std::map<dimension_t,int> dimCase;
3865                bool isValidZone = true;
3866                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3867                    const int dstBits = tempRgn->pDimensionDefinitions[d].bits;
3868                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3869                        (iDst >> baseBits) & ((1 << dstBits) - 1);
3870                    baseBits += dstBits;
3871                    // there are also DimensionRegion objects of unused zones, skip them
3872                    if (dimCase[tempRgn->pDimensionDefinitions[d].dimension] >= tempRgn->pDimensionDefinitions[d].zones) {
3873                        isValidZone = false;
3874                        break;
3875                    }
3876                }
3877                if (!isValidZone) continue;
3878                // a bit paranoid: cope with the chance that the dimensions would
3879                // have different order in source and destination regions
3880                const bool isLastZone = (dimCase[type] == newZoneSize - 1);
3881                if (dimCase[type] >= zone) dimCase[type]++;
3882                DimensionRegion* srcDimRgn = GetDimensionRegionByBit(dimCase);
3883                dstDimRgn->CopyAssign(srcDimRgn);
3884                // if this is the upper most zone of the dimension passed to this
3885                // method, then correct (raise) its upper limit to 127
3886                if (newDef.split_type == split_type_normal && isLastZone)
3887                    dstDimRgn->DimensionUpperLimits[tempReducedDimensionIndex] = 127;
3888            }
3889    
3890            // now tempRegion's dimensions and DimensionRegions basically reflect
3891            // what we wanted to get for this actual Region here, so we now just
3892            // delete and recreate the dimension in question with the new amount
3893            // zones and then copy back from tempRegion. we're actually deleting and
3894            // recreating all dimensions here, to avoid altering the precise order
3895            // of the dimensions (which would not be an error per se, but it would
3896            // cause usability issues with instrument editors)
3897            {
3898                std::vector<dimension_def_t> oldDefs;
3899                for (int i = 0; i < Dimensions; ++i)
3900                    oldDefs.push_back(pDimensionDefinitions[i]); // copy, don't reference
3901                for (int i = Dimensions - 1; i >= 0; --i)
3902                    DeleteDimension(&pDimensionDefinitions[i]);
3903                for (int i = 0; i < oldDefs.size(); ++i) {
3904                    dimension_def_t& def = oldDefs[i];
3905                    AddDimension(
3906                        (def.dimension == newDef.dimension) ? &newDef : &def
3907                    );
3908                }
3909            }
3910            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3911                DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
3912                if (!srcDimRgn) continue;
3913                std::map<dimension_t,int> dimCase;
3914                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3915                    const int srcBits = tempRgn->pDimensionDefinitions[d].bits;
3916                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3917                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3918                    baseBits += srcBits;
3919                }
3920                // a bit paranoid: cope with the chance that the dimensions would
3921                // have different order in source and destination regions
3922                DimensionRegion* dstDimRgn = GetDimensionRegionByBit(dimCase);
3923                if (!dstDimRgn) continue;
3924                dstDimRgn->CopyAssign(srcDimRgn);
3925            }
3926    
3927            // delete temporary region
3928            tempRgn->DeleteChunks();
3929            delete tempRgn;
3930    
3931            UpdateVelocityTable();
3932        }
3933    
3934        /** @brief Divide split zone of a dimension in two (increment zone amount).
3935         *
3936         * This will increment the amount of zones for the dimension (given by
3937         * @a type) by one. It will do so by dividing the zone (given by @a zone)
3938         * in the middle of its zone range in two. So the two zones resulting from
3939         * the zone being splitted, will be an equivalent copy regarding all their
3940         * articulation informations and sample reference. The two zones will only
3941         * differ in their zone's upper limit
3942         * (DimensionRegion::DimensionUpperLimits).
3943         *
3944         * @param type - identifies the dimension where a zone shall be splitted
3945         * @param zone - index of the dimension split zone that shall be splitted
3946         * @throws gig::Exception if requested zone could not be splitted
3947         */
3948        void Region::SplitDimensionZone(dimension_t type, int zone) {
3949            dimension_def_t* oldDef = GetDimensionDefinition(type);
3950            if (!oldDef)
3951                throw gig::Exception("Could not split dimension zone, no such dimension of given type");
3952            if (zone < 0 || zone >= oldDef->zones)
3953                throw gig::Exception("Could not split dimension zone, requested zone index out of bounds.");
3954    
3955            const int newZoneSize = oldDef->zones + 1;
3956    
3957            // create a temporary Region which just acts as a temporary copy
3958            // container and will be deleted at the end of this function and will
3959            // also not be visible through the API during this process
3960            gig::Region* tempRgn = NULL;
3961            {
3962                // adding these temporary chunks is probably not even necessary
3963                Instrument* instr = static_cast<Instrument*>(GetParent());
3964                RIFF::List* pCkInstrument = instr->pCkInstrument;
3965                RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
3966                if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3967                RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3968                tempRgn = new Region(instr, rgn);
3969            }
3970    
3971            // copy this region's dimensions (with already the dimension split size
3972            // requested by the arguments of this method call) to the temporary
3973            // region, and don't use Region::CopyAssign() here for this task, since
3974            // it would also alter fast lookup helper variables here and there
3975            dimension_def_t newDef;
3976            for (int i = 0; i < Dimensions; ++i) {
3977                dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3978                // is this the dimension requested by the method arguments? ...
3979                if (def.dimension == type) { // ... if yes, increment zone amount by one
3980                    def.zones = newZoneSize;
3981                    if ((1 << oldDef->bits) < newZoneSize) def.bits++;
3982                    newDef = def;
3983                }
3984                tempRgn->AddDimension(&def);
3985            }
3986    
3987            // find the dimension index in the tempRegion which is the dimension
3988            // type passed to this method (paranoidly expecting different order)
3989            int tempIncreasedDimensionIndex = -1;
3990            for (int d = 0; d < tempRgn->Dimensions; ++d) {
3991                if (tempRgn->pDimensionDefinitions[d].dimension == type) {
3992                    tempIncreasedDimensionIndex = d;
3993                    break;
3994                }
3995            }
3996    
3997            // copy dimension regions from this region to the temporary region
3998            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3999                DimensionRegion* srcDimRgn = pDimensionRegions[iSrc];
4000                if (!srcDimRgn) continue;
4001                std::map<dimension_t,int> dimCase;
4002                bool isValidZone = true;
4003                for (int d = 0, baseBits = 0; d < Dimensions; ++d) {
4004                    const int srcBits = pDimensionDefinitions[d].bits;
4005                    dimCase[pDimensionDefinitions[d].dimension] =
4006                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
4007                    // there are also DimensionRegion objects for unused zones, skip them
4008                    if (dimCase[pDimensionDefinitions[d].dimension] >= pDimensionDefinitions[d].zones) {
4009                        isValidZone = false;
4010                        break;
4011                    }
4012                    baseBits += srcBits;
4013                }
4014                if (!isValidZone) continue;
4015                // a bit paranoid: cope with the chance that the dimensions would
4016                // have different order in source and destination regions            
4017                if (dimCase[type] > zone) dimCase[type]++;
4018                DimensionRegion* dstDimRgn = tempRgn->GetDimensionRegionByBit(dimCase);
4019                dstDimRgn->CopyAssign(srcDimRgn);
4020                // if this is the requested zone to be splitted, then also copy
4021                // the source DimensionRegion to the newly created target zone
4022                // and set the old zones upper limit lower
4023                if (dimCase[type] == zone) {
4024                    // lower old zones upper limit
4025                    if (newDef.split_type == split_type_normal) {
4026                        const int high =
4027                            dstDimRgn->DimensionUpperLimits[tempIncreasedDimensionIndex];
4028                        int low = 0;
4029                        if (zone > 0) {
4030                            std::map<dimension_t,int> lowerCase = dimCase;
4031                            lowerCase[type]--;
4032                            DimensionRegion* dstDimRgnLow = tempRgn->GetDimensionRegionByBit(lowerCase);
4033                            low = dstDimRgnLow->DimensionUpperLimits[tempIncreasedDimensionIndex];
4034                        }
4035                        dstDimRgn->DimensionUpperLimits[tempIncreasedDimensionIndex] = low + (high - low) / 2;
4036                    }
4037                    // fill the newly created zone of the divided zone as well
4038                    dimCase[type]++;
4039                    dstDimRgn = tempRgn->GetDimensionRegionByBit(dimCase);
4040                    dstDimRgn->CopyAssign(srcDimRgn);
4041                }
4042            }
4043    
4044            // now tempRegion's dimensions and DimensionRegions basically reflect
4045            // what we wanted to get for this actual Region here, so we now just
4046            // delete and recreate the dimension in question with the new amount
4047            // zones and then copy back from tempRegion. we're actually deleting and
4048            // recreating all dimensions here, to avoid altering the precise order
4049            // of the dimensions (which would not be an error per se, but it would
4050            // cause usability issues with instrument editors)
4051            {
4052                std::vector<dimension_def_t> oldDefs;
4053                for (int i = 0; i < Dimensions; ++i)
4054                    oldDefs.push_back(pDimensionDefinitions[i]); // copy, don't reference
4055                for (int i = Dimensions - 1; i >= 0; --i)
4056                    DeleteDimension(&pDimensionDefinitions[i]);
4057                for (int i = 0; i < oldDefs.size(); ++i) {
4058                    dimension_def_t& def = oldDefs[i];
4059                    AddDimension(
4060                        (def.dimension == newDef.dimension) ? &newDef : &def
4061                    );
4062                }
4063            }
4064            for (int iSrc = 0; iSrc < 256; ++iSrc) {
4065                DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
4066                if (!srcDimRgn) continue;
4067                std::map<dimension_t,int> dimCase;
4068                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
4069                    const int srcBits = tempRgn->pDimensionDefinitions[d].bits;
4070                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
4071                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
4072                    baseBits += srcBits;
4073                }
4074                // a bit paranoid: cope with the chance that the dimensions would
4075                // have different order in source and destination regions
4076                DimensionRegion* dstDimRgn = GetDimensionRegionByBit(dimCase);
4077                if (!dstDimRgn) continue;
4078                dstDimRgn->CopyAssign(srcDimRgn);
4079            }
4080    
4081            // delete temporary region
4082            tempRgn->DeleteChunks();
4083            delete tempRgn;
4084    
4085            UpdateVelocityTable();
4086        }
4087    
4088        /** @brief Change type of an existing dimension.
4089         *
4090         * Alters the dimension type of a dimension already existing on this
4091         * region. If there is currently no dimension on this Region with type
4092         * @a oldType, then this call with throw an Exception. Likewise there are
4093         * cases where the requested dimension type cannot be performed. For example
4094         * if the new dimension type shall be gig::dimension_samplechannel, and the
4095         * current dimension has more than 2 zones. In such cases an Exception is
4096         * thrown as well.
4097         *
4098         * @param oldType - identifies the existing dimension to be changed
4099         * @param newType - to which dimension type it should be changed to
4100         * @throws gig::Exception if requested change cannot be performed
4101         */
4102        void Region::SetDimensionType(dimension_t oldType, dimension_t newType) {
4103            if (oldType == newType) return;
4104            dimension_def_t* def = GetDimensionDefinition(oldType);
4105            if (!def)
4106                throw gig::Exception("No dimension with provided old dimension type exists on this region");
4107            if (newType == dimension_samplechannel && def->zones != 2)
4108                throw gig::Exception("Cannot change to dimension type 'sample channel', because existing dimension does not have 2 zones");
4109            if (GetDimensionDefinition(newType))
4110                throw gig::Exception("There is already a dimension with requested new dimension type on this region");
4111            def->dimension  = newType;
4112            def->split_type = __resolveSplitType(newType);
4113        }
4114    
4115        DimensionRegion* Region::GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase) {
4116            uint8_t bits[8] = {};
4117            for (std::map<dimension_t,int>::const_iterator it = DimCase.begin();
4118                 it != DimCase.end(); ++it)
4119            {
4120                for (int d = 0; d < Dimensions; ++d) {
4121                    if (pDimensionDefinitions[d].dimension == it->first) {
4122                        bits[d] = it->second;
4123                        goto nextDimCaseSlice;
4124                    }
4125                }
4126                assert(false); // do crash ... too harsh maybe ? ignore it instead ?
4127                nextDimCaseSlice:
4128                ; // noop
4129            }
4130            return GetDimensionRegionByBit(bits);
4131        }
4132    
4133        /**
4134         * Searches in the current Region for a dimension of the given dimension
4135         * type and returns the precise configuration of that dimension in this
4136         * Region.
4137         *
4138         * @param type - dimension type of the sought dimension
4139         * @returns dimension definition or NULL if there is no dimension with
4140         *          sought type in this Region.
4141         */
4142        dimension_def_t* Region::GetDimensionDefinition(dimension_t type) {
4143            for (int i = 0; i < Dimensions; ++i)
4144                if (pDimensionDefinitions[i].dimension == type)
4145                    return &pDimensionDefinitions[i];
4146            return NULL;
4147        }
4148    
4149      Region::~Region() {      Region::~Region() {
4150          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
4151              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
# Line 2670  namespace { Line 4173  namespace {
4173      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
4174          uint8_t bits;          uint8_t bits;
4175          int veldim = -1;          int veldim = -1;
4176          int velbitpos;          int velbitpos = 0;
4177          int bitpos = 0;          int bitpos = 0;
4178          int dimregidx = 0;          int dimregidx = 0;
4179          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
# Line 2700  namespace { Line 4203  namespace {
4203              }              }
4204              bitpos += pDimensionDefinitions[i].bits;              bitpos += pDimensionDefinitions[i].bits;
4205          }          }
4206          DimensionRegion* dimreg = pDimensionRegions[dimregidx];          DimensionRegion* dimreg = pDimensionRegions[dimregidx & 255];
4207            if (!dimreg) return NULL;
4208          if (veldim != -1) {          if (veldim != -1) {
4209              // (dimreg is now the dimension region for the lowest velocity)              // (dimreg is now the dimension region for the lowest velocity)
4210              if (dimreg->VelocityTable) // custom defined zone ranges              if (dimreg->VelocityTable) // custom defined zone ranges
4211                  bits = dimreg->VelocityTable[DimValues[veldim]];                  bits = dimreg->VelocityTable[DimValues[veldim] & 127];
4212              else // normal split type              else // normal split type
4213                  bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);                  bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
4214    
4215              dimregidx |= bits << velbitpos;              const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
4216              dimreg = pDimensionRegions[dimregidx];              dimregidx |= (bits & limiter_mask) << velbitpos;
4217                dimreg = pDimensionRegions[dimregidx & 255];
4218          }          }
4219          return dimreg;          return dimreg;
4220      }      }
4221    
4222        int Region::GetDimensionRegionIndexByValue(const uint DimValues[8]) {
4223            uint8_t bits;
4224            int veldim = -1;
4225            int velbitpos = 0;
4226            int bitpos = 0;
4227            int dimregidx = 0;
4228            for (uint i = 0; i < Dimensions; i++) {
4229                if (pDimensionDefinitions[i].dimension == dimension_velocity) {
4230                    // the velocity dimension must be handled after the other dimensions
4231                    veldim = i;
4232                    velbitpos = bitpos;
4233                } else {
4234                    switch (pDimensionDefinitions[i].split_type) {
4235                        case split_type_normal:
4236                            if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
4237                                // gig3: all normal dimensions (not just the velocity dimension) have custom zone ranges
4238                                for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
4239                                    if (DimValues[i] <= pDimensionRegions[bits << bitpos]->DimensionUpperLimits[i]) break;
4240                                }
4241                            } else {
4242                                // gig2: evenly sized zones
4243                                bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
4244                            }
4245                            break;
4246                        case split_type_bit: // the value is already the sought dimension bit number
4247                            const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
4248                            bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
4249                            break;
4250                    }
4251                    dimregidx |= bits << bitpos;
4252                }
4253                bitpos += pDimensionDefinitions[i].bits;
4254            }
4255            dimregidx &= 255;
4256            DimensionRegion* dimreg = pDimensionRegions[dimregidx];
4257            if (!dimreg) return -1;
4258            if (veldim != -1) {
4259                // (dimreg is now the dimension region for the lowest velocity)
4260                if (dimreg->VelocityTable) // custom defined zone ranges
4261                    bits = dimreg->VelocityTable[DimValues[veldim] & 127];
4262                else // normal split type
4263                    bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
4264    
4265                const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
4266                dimregidx |= (bits & limiter_mask) << velbitpos;
4267                dimregidx &= 255;
4268            }
4269            return dimregidx;
4270        }
4271    
4272      /**      /**
4273       * Returns the appropriate DimensionRegion for the given dimension bit       * Returns the appropriate DimensionRegion for the given dimension bit
4274       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>
# Line 2752  namespace { Line 4307  namespace {
4307          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
4308          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
4309          if (!file->pWavePoolTable) return NULL;          if (!file->pWavePoolTable) return NULL;
4310          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          if (WavePoolTableIndex + 1 > file->WavePoolCount) return NULL;
4311          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];          // for new files or files >= 2 GB use 64 bit wave pool offsets
4312          Sample* sample = file->GetFirstSample(pProgress);          if (file->pRIFF->IsNew() || (file->pRIFF->GetCurrentFileSize() >> 31)) {
4313          while (sample) {              // use 64 bit wave pool offsets (treating this as large file)
4314              if (sample->ulWavePoolOffset == soughtoffset &&              uint64_t soughtoffset =
4315                  sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);                  uint64_t(file->pWavePoolTable[WavePoolTableIndex]) |
4316              sample = file->GetNextSample();                  uint64_t(file->pWavePoolTableHi[WavePoolTableIndex]) << 32;
4317                Sample* sample = file->GetFirstSample(pProgress);
4318                while (sample) {
4319                    if (sample->ullWavePoolOffset == soughtoffset)
4320                        return static_cast<gig::Sample*>(sample);
4321                    sample = file->GetNextSample();
4322                }
4323            } else {
4324                // use extension files and 32 bit wave pool offsets
4325                file_offset_t soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
4326                file_offset_t soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
4327                Sample* sample = file->GetFirstSample(pProgress);
4328                while (sample) {
4329                    if (sample->ullWavePoolOffset == soughtoffset &&
4330                        sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
4331                    sample = file->GetNextSample();
4332                }
4333            }
4334            return NULL;
4335        }
4336        
4337        /**
4338         * Make a (semi) deep copy of the Region object given by @a orig
4339         * and assign it to this object.
4340         *
4341         * Note that all sample pointers referenced by @a orig are simply copied as
4342         * memory address. Thus the respective samples are shared, not duplicated!
4343         *
4344         * @param orig - original Region object to be copied from
4345         */
4346        void Region::CopyAssign(const Region* orig) {
4347            CopyAssign(orig, NULL);
4348        }
4349        
4350        /**
4351         * Make a (semi) deep copy of the Region object given by @a orig and
4352         * assign it to this object
4353         *
4354         * @param mSamples - crosslink map between the foreign file's samples and
4355         *                   this file's samples
4356         */
4357        void Region::CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples) {
4358            // handle base classes
4359            DLS::Region::CopyAssign(orig);
4360            
4361            if (mSamples && mSamples->count((gig::Sample*)orig->pSample)) {
4362                pSample = mSamples->find((gig::Sample*)orig->pSample)->second;
4363            }
4364            
4365            // handle own member variables
4366            for (int i = Dimensions - 1; i >= 0; --i) {
4367                DeleteDimension(&pDimensionDefinitions[i]);
4368            }
4369            Layers = 0; // just to be sure
4370            for (int i = 0; i < orig->Dimensions; i++) {
4371                // we need to copy the dim definition here, to avoid the compiler
4372                // complaining about const-ness issue
4373                dimension_def_t def = orig->pDimensionDefinitions[i];
4374                AddDimension(&def);
4375            }
4376            for (int i = 0; i < 256; i++) {
4377                if (pDimensionRegions[i] && orig->pDimensionRegions[i]) {
4378                    pDimensionRegions[i]->CopyAssign(
4379                        orig->pDimensionRegions[i],
4380                        mSamples
4381                    );
4382                }
4383            }
4384            Layers = orig->Layers;
4385        }
4386    
4387        /**
4388         * Returns @c true in case this Region object uses any gig format
4389         * extension, that is e.g. whether any DimensionRegion object currently
4390         * has any setting effective that would require our "LSDE" RIFF chunk to
4391         * be stored to the gig file.
4392         *
4393         * Right now this is a private method. It is considerable though this method
4394         * to become (in slightly modified form) a public API method in future, i.e.
4395         * to allow instrument editors to visualize and/or warn the user of any gig
4396         * format extension being used. See also comments on
4397         * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
4398         * potential public API change in future.
4399         */
4400        bool Region::UsesAnyGigFormatExtension() const {
4401            for (int i = 0; i < 256; i++) {
4402                if (pDimensionRegions[i]) {
4403                    if (pDimensionRegions[i]->UsesAnyGigFormatExtension())
4404                        return true;
4405                }
4406            }
4407            return false;
4408        }
4409    
4410    
4411    // *************** MidiRule ***************
4412    // *
4413    
4414        MidiRuleCtrlTrigger::MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg) {
4415            _3ewg->SetPos(36);
4416            Triggers = _3ewg->ReadUint8();
4417            _3ewg->SetPos(40);
4418            ControllerNumber = _3ewg->ReadUint8();
4419            _3ewg->SetPos(46);
4420            for (int i = 0 ; i < Triggers ; i++) {
4421                pTriggers[i].TriggerPoint = _3ewg->ReadUint8();
4422                pTriggers[i].Descending = _3ewg->ReadUint8();
4423                pTriggers[i].VelSensitivity = _3ewg->ReadUint8();
4424                pTriggers[i].Key = _3ewg->ReadUint8();
4425                pTriggers[i].NoteOff = _3ewg->ReadUint8();
4426                pTriggers[i].Velocity = _3ewg->ReadUint8();
4427                pTriggers[i].OverridePedal = _3ewg->ReadUint8();
4428                _3ewg->ReadUint8();
4429            }
4430        }
4431    
4432        MidiRuleCtrlTrigger::MidiRuleCtrlTrigger() :
4433            ControllerNumber(0),
4434            Triggers(0) {
4435        }
4436    
4437        void MidiRuleCtrlTrigger::UpdateChunks(uint8_t* pData) const {
4438            pData[32] = 4;
4439            pData[33] = 16;
4440            pData[36] = Triggers;
4441            pData[40] = ControllerNumber;
4442            for (int i = 0 ; i < Triggers ; i++) {
4443                pData[46 + i * 8] = pTriggers[i].TriggerPoint;
4444                pData[47 + i * 8] = pTriggers[i].Descending;
4445                pData[48 + i * 8] = pTriggers[i].VelSensitivity;
4446                pData[49 + i * 8] = pTriggers[i].Key;
4447                pData[50 + i * 8] = pTriggers[i].NoteOff;
4448                pData[51 + i * 8] = pTriggers[i].Velocity;
4449                pData[52 + i * 8] = pTriggers[i].OverridePedal;
4450            }
4451        }
4452    
4453        MidiRuleLegato::MidiRuleLegato(RIFF::Chunk* _3ewg) {
4454            _3ewg->SetPos(36);
4455            LegatoSamples = _3ewg->ReadUint8(); // always 12
4456            _3ewg->SetPos(40);
4457            BypassUseController = _3ewg->ReadUint8();
4458            BypassKey = _3ewg->ReadUint8();
4459            BypassController = _3ewg->ReadUint8();
4460            ThresholdTime = _3ewg->ReadUint16();
4461            _3ewg->ReadInt16();
4462            ReleaseTime = _3ewg->ReadUint16();
4463            _3ewg->ReadInt16();
4464            KeyRange.low = _3ewg->ReadUint8();
4465            KeyRange.high = _3ewg->ReadUint8();
4466            _3ewg->SetPos(64);
4467            ReleaseTriggerKey = _3ewg->ReadUint8();
4468            AltSustain1Key = _3ewg->ReadUint8();
4469            AltSustain2Key = _3ewg->ReadUint8();
4470        }
4471    
4472        MidiRuleLegato::MidiRuleLegato() :
4473            LegatoSamples(12),
4474            BypassUseController(false),
4475            BypassKey(0),
4476            BypassController(1),
4477            ThresholdTime(20),
4478            ReleaseTime(20),
4479            ReleaseTriggerKey(0),
4480            AltSustain1Key(0),
4481            AltSustain2Key(0)
4482        {
4483            KeyRange.low = KeyRange.high = 0;
4484        }
4485    
4486        void MidiRuleLegato::UpdateChunks(uint8_t* pData) const {
4487            pData[32] = 0;
4488            pData[33] = 16;
4489            pData[36] = LegatoSamples;
4490            pData[40] = BypassUseController;
4491            pData[41] = BypassKey;
4492            pData[42] = BypassController;
4493            store16(&pData[43], ThresholdTime);
4494            store16(&pData[47], ReleaseTime);
4495            pData[51] = KeyRange.low;
4496            pData[52] = KeyRange.high;
4497            pData[64] = ReleaseTriggerKey;
4498            pData[65] = AltSustain1Key;
4499            pData[66] = AltSustain2Key;
4500        }
4501    
4502        MidiRuleAlternator::MidiRuleAlternator(RIFF::Chunk* _3ewg) {
4503            _3ewg->SetPos(36);
4504            Articulations = _3ewg->ReadUint8();
4505            int flags = _3ewg->ReadUint8();
4506            Polyphonic = flags & 8;
4507            Chained = flags & 4;
4508            Selector = (flags & 2) ? selector_controller :
4509                (flags & 1) ? selector_key_switch : selector_none;
4510            Patterns = _3ewg->ReadUint8();
4511            _3ewg->ReadUint8(); // chosen row
4512            _3ewg->ReadUint8(); // unknown
4513            _3ewg->ReadUint8(); // unknown
4514            _3ewg->ReadUint8(); // unknown
4515            KeySwitchRange.low = _3ewg->ReadUint8();
4516            KeySwitchRange.high = _3ewg->ReadUint8();
4517            Controller = _3ewg->ReadUint8();
4518            PlayRange.low = _3ewg->ReadUint8();
4519            PlayRange.high = _3ewg->ReadUint8();
4520    
4521            int n = std::min(int(Articulations), 32);
4522            for (int i = 0 ; i < n ; i++) {
4523                _3ewg->ReadString(pArticulations[i], 32);
4524            }
4525            _3ewg->SetPos(1072);
4526            n = std::min(int(Patterns), 32);
4527            for (int i = 0 ; i < n ; i++) {
4528                _3ewg->ReadString(pPatterns[i].Name, 16);
4529                pPatterns[i].Size = _3ewg->ReadUint8();
4530                _3ewg->Read(&pPatterns[i][0], 1, 32);
4531            }
4532        }
4533    
4534        MidiRuleAlternator::MidiRuleAlternator() :
4535            Articulations(0),
4536            Patterns(0),
4537            Selector(selector_none),
4538            Controller(0),
4539            Polyphonic(false),
4540            Chained(false)
4541        {
4542            PlayRange.low = PlayRange.high = 0;
4543            KeySwitchRange.low = KeySwitchRange.high = 0;
4544        }
4545    
4546        void MidiRuleAlternator::UpdateChunks(uint8_t* pData) const {
4547            pData[32] = 3;
4548            pData[33] = 16;
4549            pData[36] = Articulations;
4550            pData[37] = (Polyphonic ? 8 : 0) | (Chained ? 4 : 0) |
4551                (Selector == selector_controller ? 2 :
4552                 (Selector == selector_key_switch ? 1 : 0));
4553            pData[38] = Patterns;
4554    
4555            pData[43] = KeySwitchRange.low;
4556            pData[44] = KeySwitchRange.high;
4557            pData[45] = Controller;
4558            pData[46] = PlayRange.low;
4559            pData[47] = PlayRange.high;
4560    
4561            char* str = reinterpret_cast<char*>(pData);
4562            int pos = 48;
4563            int n = std::min(int(Articulations), 32);
4564            for (int i = 0 ; i < n ; i++, pos += 32) {
4565                strncpy(&str[pos], pArticulations[i].c_str(), 32);
4566            }
4567    
4568            pos = 1072;
4569            n = std::min(int(Patterns), 32);
4570            for (int i = 0 ; i < n ; i++, pos += 49) {
4571                strncpy(&str[pos], pPatterns[i].Name.c_str(), 16);
4572                pData[pos + 16] = pPatterns[i].Size;
4573                memcpy(&pData[pos + 16], &(pPatterns[i][0]), 32);
4574            }
4575        }
4576    
4577    // *************** Script ***************
4578    // *
4579    
4580        Script::Script(ScriptGroup* group, RIFF::Chunk* ckScri) {
4581            pGroup = group;
4582            pChunk = ckScri;
4583            if (ckScri) { // object is loaded from file ...
4584                ckScri->SetPos(0);
4585    
4586                // read header
4587                uint32_t headerSize = ckScri->ReadUint32();
4588                Compression = (Compression_t) ckScri->ReadUint32();
4589                Encoding    = (Encoding_t) ckScri->ReadUint32();
4590                Language    = (Language_t) ckScri->ReadUint32();
4591                Bypass      = ckScri->ReadUint32() & 1;
4592                crc         = ckScri->ReadUint32();
4593                uint32_t nameSize = ckScri->ReadUint32();
4594                Name.resize(nameSize, ' ');
4595                for (int i = 0; i < nameSize; ++i)
4596                    Name[i] = ckScri->ReadUint8();
4597                // check if an uuid was already stored along with this script
4598                if (headerSize >= 6*sizeof(int32_t) + nameSize + 16) { // yes ...
4599                    for (uint i = 0; i < 16; ++i) {
4600                        Uuid[i] = ckScri->ReadUint8();
4601                    }
4602                } else { // no uuid yet, generate one now ...
4603                    GenerateUuid();
4604                }
4605                // to handle potential future extensions of the header
4606                ckScri->SetPos(sizeof(int32_t) + headerSize);
4607                // read actual script data
4608                uint32_t scriptSize = uint32_t(ckScri->GetSize() - ckScri->GetPos());
4609                data.resize(scriptSize);
4610                for (int i = 0; i < scriptSize; ++i)
4611                    data[i] = ckScri->ReadUint8();
4612            } else { // this is a new script object, so just initialize it as such ...
4613                Compression = COMPRESSION_NONE;
4614                Encoding = ENCODING_ASCII;
4615                Language = LANGUAGE_NKSP;
4616                Bypass   = false;
4617                crc      = 0;
4618                Name     = "Unnamed Script";
4619                GenerateUuid();
4620            }
4621        }
4622    
4623        Script::~Script() {
4624        }
4625    
4626        /**
4627         * Returns the current script (i.e. as source code) in text format.
4628         */
4629        String Script::GetScriptAsText() {
4630            String s;
4631            s.resize(data.size(), ' ');
4632            memcpy(&s[0], &data[0], data.size());
4633            return s;
4634        }
4635    
4636        /**
4637         * Replaces the current script with the new script source code text given
4638         * by @a text.
4639         *
4640         * @param text - new script source code
4641         */
4642        void Script::SetScriptAsText(const String& text) {
4643            data.resize(text.size());
4644            memcpy(&data[0], &text[0], text.size());
4645        }
4646    
4647        /** @brief Remove all RIFF chunks associated with this Script object.
4648         *
4649         * At the moment Script::DeleteChunks() does nothing. It is
4650         * recommended to call this method explicitly though from deriving classes's
4651         * own overridden implementation of this method to avoid potential future
4652         * compatiblity issues.
4653         *
4654         * See DLS::Storage::DeleteChunks() for details.
4655         */
4656        void Script::DeleteChunks() {
4657        }
4658    
4659        /**
4660         * Apply this script to the respective RIFF chunks. You have to call
4661         * File::Save() to make changes persistent.
4662         *
4663         * Usually there is absolutely no need to call this method explicitly.
4664         * It will be called automatically when File::Save() was called.
4665         *
4666         * @param pProgress - callback function for progress notification
4667         */
4668        void Script::UpdateChunks(progress_t* pProgress) {
4669            // recalculate CRC32 check sum
4670            __resetCRC(crc);
4671            __calculateCRC(&data[0], data.size(), crc);
4672            __finalizeCRC(crc);
4673            // make sure chunk exists and has the required size
4674            const file_offset_t chunkSize =
4675                (file_offset_t) 7*sizeof(int32_t) + Name.size() + 16 + data.size();
4676            if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);
4677            else pChunk->Resize(chunkSize);
4678            // fill the chunk data to be written to disk
4679            uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();
4680            int pos = 0;
4681            store32(&pData[pos], uint32_t(6*sizeof(int32_t) + Name.size() + 16)); // total header size
4682            pos += sizeof(int32_t);
4683            store32(&pData[pos], Compression);
4684            pos += sizeof(int32_t);
4685            store32(&pData[pos], Encoding);
4686            pos += sizeof(int32_t);
4687            store32(&pData[pos], Language);
4688            pos += sizeof(int32_t);
4689            store32(&pData[pos], Bypass ? 1 : 0);
4690            pos += sizeof(int32_t);
4691            store32(&pData[pos], crc);
4692            pos += sizeof(int32_t);
4693            store32(&pData[pos], (uint32_t) Name.size());
4694            pos += sizeof(int32_t);
4695            for (int i = 0; i < Name.size(); ++i, ++pos)
4696                pData[pos] = Name[i];
4697            for (int i = 0; i < 16; ++i, ++pos)
4698                pData[pos] = Uuid[i];
4699            for (int i = 0; i < data.size(); ++i, ++pos)
4700                pData[pos] = data[i];
4701        }
4702    
4703        /**
4704         * Generate a new Universally Unique Identifier (UUID) for this script.
4705         */
4706        void Script::GenerateUuid() {
4707            DLS::dlsid_t dlsid;
4708            DLS::Resource::GenerateDLSID(&dlsid);
4709            Uuid[0]  = dlsid.ulData1       & 0xff;
4710            Uuid[1]  = dlsid.ulData1 >>  8 & 0xff;
4711            Uuid[2]  = dlsid.ulData1 >> 16 & 0xff;
4712            Uuid[3]  = dlsid.ulData1 >> 24 & 0xff;
4713            Uuid[4]  = dlsid.usData2       & 0xff;
4714            Uuid[5]  = dlsid.usData2 >>  8 & 0xff;
4715            Uuid[6]  = dlsid.usData3       & 0xff;
4716            Uuid[7]  = dlsid.usData3 >>  8 & 0xff;
4717            Uuid[8]  = dlsid.abData[0];
4718            Uuid[9]  = dlsid.abData[1];
4719            Uuid[10] = dlsid.abData[2];
4720            Uuid[11] = dlsid.abData[3];
4721            Uuid[12] = dlsid.abData[4];
4722            Uuid[13] = dlsid.abData[5];
4723            Uuid[14] = dlsid.abData[6];
4724            Uuid[15] = dlsid.abData[7];
4725        }
4726    
4727        /**
4728         * Move this script from its current ScriptGroup to another ScriptGroup
4729         * given by @a pGroup.
4730         *
4731         * @param pGroup - script's new group
4732         */
4733        void Script::SetGroup(ScriptGroup* pGroup) {
4734            if (this->pGroup == pGroup) return;
4735            if (pChunk)
4736                pChunk->GetParent()->MoveSubChunk(pChunk, pGroup->pList);
4737            this->pGroup = pGroup;
4738        }
4739    
4740        /**
4741         * Returns the script group this script currently belongs to. Each script
4742         * is a member of exactly one ScriptGroup.
4743         *
4744         * @returns current script group
4745         */
4746        ScriptGroup* Script::GetGroup() const {
4747            return pGroup;
4748        }
4749    
4750        /**
4751         * Make a (semi) deep copy of the Script object given by @a orig
4752         * and assign it to this object. Note: the ScriptGroup this Script
4753         * object belongs to remains untouched by this call.
4754         *
4755         * @param orig - original Script object to be copied from
4756         */
4757        void Script::CopyAssign(const Script* orig) {
4758            Name        = orig->Name;
4759            Compression = orig->Compression;
4760            Encoding    = orig->Encoding;
4761            Language    = orig->Language;
4762            Bypass      = orig->Bypass;
4763            data        = orig->data;
4764        }
4765    
4766        void Script::RemoveAllScriptReferences() {
4767            File* pFile = pGroup->pFile;
4768            for (int i = 0; pFile->GetInstrument(i); ++i) {
4769                Instrument* instr = pFile->GetInstrument(i);
4770                instr->RemoveScript(this);
4771            }
4772        }
4773    
4774    // *************** ScriptGroup ***************
4775    // *
4776    
4777        ScriptGroup::ScriptGroup(File* file, RIFF::List* lstRTIS) {
4778            pFile = file;
4779            pList = lstRTIS;
4780            pScripts = NULL;
4781            if (lstRTIS) {
4782                RIFF::Chunk* ckName = lstRTIS->GetSubChunk(CHUNK_ID_LSNM);
4783                ::LoadString(ckName, Name);
4784            } else {
4785                Name = "Default Group";
4786            }
4787        }
4788    
4789        ScriptGroup::~ScriptGroup() {
4790            if (pScripts) {
4791                std::list<Script*>::iterator iter = pScripts->begin();
4792                std::list<Script*>::iterator end  = pScripts->end();
4793                while (iter != end) {
4794                    delete *iter;
4795                    ++iter;
4796                }
4797                delete pScripts;
4798            }
4799        }
4800    
4801        /** @brief Remove all RIFF chunks associated with this ScriptGroup object.
4802         *
4803         * At the moment ScriptGroup::DeleteChunks() does nothing. It is
4804         * recommended to call this method explicitly though from deriving classes's
4805         * own overridden implementation of this method to avoid potential future
4806         * compatiblity issues.
4807         *
4808         * See DLS::Storage::DeleteChunks() for details.
4809         */
4810        void ScriptGroup::DeleteChunks() {
4811        }
4812    
4813        /**
4814         * Apply this script group to the respective RIFF chunks. You have to call
4815         * File::Save() to make changes persistent.
4816         *
4817         * Usually there is absolutely no need to call this method explicitly.
4818         * It will be called automatically when File::Save() was called.
4819         *
4820         * @param pProgress - callback function for progress notification
4821         */
4822        void ScriptGroup::UpdateChunks(progress_t* pProgress) {
4823            if (pScripts) {
4824                if (!pList)
4825                    pList = pFile->pRIFF->GetSubList(LIST_TYPE_3LS)->AddSubList(LIST_TYPE_RTIS);
4826    
4827                // now store the name of this group as <LSNM> chunk as subchunk of the <RTIS> list chunk
4828                ::SaveString(CHUNK_ID_LSNM, NULL, pList, Name, String("Unnamed Group"), true, 64);
4829    
4830                for (std::list<Script*>::iterator it = pScripts->begin();
4831                     it != pScripts->end(); ++it)
4832                {
4833                    (*it)->UpdateChunks(pProgress);
4834                }
4835          }          }
4836        }
4837    
4838        /** @brief Get instrument script.
4839         *
4840         * Returns the real-time instrument script with the given index.
4841         *
4842         * @param index - number of the sought script (0..n)
4843         * @returns sought script or NULL if there's no such script
4844         */
4845        Script* ScriptGroup::GetScript(uint index) {
4846            if (!pScripts) LoadScripts();
4847            std::list<Script*>::iterator it = pScripts->begin();
4848            for (uint i = 0; it != pScripts->end(); ++i, ++it)
4849                if (i == index) return *it;
4850          return NULL;          return NULL;
4851      }      }
4852    
4853        /** @brief Add new instrument script.
4854         *
4855         * Adds a new real-time instrument script to the file. The script is not
4856         * actually used / executed unless it is referenced by an instrument to be
4857         * used. This is similar to samples, which you can add to a file, without
4858         * an instrument necessarily actually using it.
4859         *
4860         * You have to call Save() to make this persistent to the file.
4861         *
4862         * @return new empty script object
4863         */
4864        Script* ScriptGroup::AddScript() {
4865            if (!pScripts) LoadScripts();
4866            Script* pScript = new Script(this, NULL);
4867            pScripts->push_back(pScript);
4868            return pScript;
4869        }
4870    
4871        /** @brief Delete an instrument script.
4872         *
4873         * This will delete the given real-time instrument script. References of
4874         * instruments that are using that script will be removed accordingly.
4875         *
4876         * You have to call Save() to make this persistent to the file.
4877         *
4878         * @param pScript - script to delete
4879         * @throws gig::Exception if given script could not be found
4880         */
4881        void ScriptGroup::DeleteScript(Script* pScript) {
4882            if (!pScripts) LoadScripts();
4883            std::list<Script*>::iterator iter =
4884                find(pScripts->begin(), pScripts->end(), pScript);
4885            if (iter == pScripts->end())
4886                throw gig::Exception("Could not delete script, could not find given script");
4887            pScripts->erase(iter);
4888            pScript->RemoveAllScriptReferences();
4889            if (pScript->pChunk)
4890                pScript->pChunk->GetParent()->DeleteSubChunk(pScript->pChunk);
4891            delete pScript;
4892        }
4893    
4894        void ScriptGroup::LoadScripts() {
4895            if (pScripts) return;
4896            pScripts = new std::list<Script*>;
4897            if (!pList) return;
4898    
4899            for (RIFF::Chunk* ck = pList->GetFirstSubChunk(); ck;
4900                 ck = pList->GetNextSubChunk())
4901            {
4902                if (ck->GetChunkID() == CHUNK_ID_SCRI) {
4903                    pScripts->push_back(new Script(this, ck));
4904                }
4905            }
4906        }
4907    
4908  // *************** Instrument ***************  // *************** Instrument ***************
4909  // *  // *
4910    
4911      Instrument::Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress) : DLS::Instrument((DLS::File*)pFile, insList) {      Instrument::Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress) : DLS::Instrument((DLS::File*)pFile, insList) {
4912          static const DLS::Info::FixedStringLength fixedStringLengths[] = {          static const DLS::Info::string_length_t fixedStringLengths[] = {
4913              { CHUNK_ID_INAM, 64 },              { CHUNK_ID_INAM, 64 },
4914              { CHUNK_ID_ISFT, 12 },              { CHUNK_ID_ISFT, 12 },
4915              { 0, 0 }              { 0, 0 }
4916          };          };
4917          pInfo->FixedStringLengths = fixedStringLengths;          pInfo->SetFixedStringLengths(fixedStringLengths);
4918    
4919          // Initialization          // Initialization
4920          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
4921          EffectSend = 0;          EffectSend = 0;
4922          Attenuation = 0;          Attenuation = 0;
4923          FineTune = 0;          FineTune = 0;
4924          PitchbendRange = 0;          PitchbendRange = 2;
4925          PianoReleaseMode = false;          PianoReleaseMode = false;
4926          DimensionKeyRange.low = 0;          DimensionKeyRange.low = 0;
4927          DimensionKeyRange.high = 0;          DimensionKeyRange.high = 0;
4928            pMidiRules = new MidiRule*[3];
4929            pMidiRules[0] = NULL;
4930            pScriptRefs = NULL;
4931    
4932          // Loading          // Loading
4933          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
4934          if (lart) {          if (lart) {
4935              RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);              RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
4936              if (_3ewg) {              if (_3ewg) {
4937                    _3ewg->SetPos(0);
4938    
4939                  EffectSend             = _3ewg->ReadUint16();                  EffectSend             = _3ewg->ReadUint16();
4940                  Attenuation            = _3ewg->ReadInt32();                  Attenuation            = _3ewg->ReadInt32();
4941                  FineTune               = _3ewg->ReadInt16();                  FineTune               = _3ewg->ReadInt16();
# Line 2799  namespace { Line 4944  namespace {
4944                  PianoReleaseMode       = dimkeystart & 0x01;                  PianoReleaseMode       = dimkeystart & 0x01;
4945                  DimensionKeyRange.low  = dimkeystart >> 1;                  DimensionKeyRange.low  = dimkeystart >> 1;
4946                  DimensionKeyRange.high = _3ewg->ReadUint8();                  DimensionKeyRange.high = _3ewg->ReadUint8();
4947    
4948                    if (_3ewg->GetSize() > 32) {
4949                        // read MIDI rules
4950                        int i = 0;
4951                        _3ewg->SetPos(32);
4952                        uint8_t id1 = _3ewg->ReadUint8();
4953                        uint8_t id2 = _3ewg->ReadUint8();
4954    
4955                        if (id2 == 16) {
4956                            if (id1 == 4) {
4957                                pMidiRules[i++] = new MidiRuleCtrlTrigger(_3ewg);
4958                            } else if (id1 == 0) {
4959                                pMidiRules[i++] = new MidiRuleLegato(_3ewg);
4960                            } else if (id1 == 3) {
4961                                pMidiRules[i++] = new MidiRuleAlternator(_3ewg);
4962                            } else {
4963                                pMidiRules[i++] = new MidiRuleUnknown;
4964                            }
4965                        }
4966                        else if (id1 != 0 || id2 != 0) {
4967                            pMidiRules[i++] = new MidiRuleUnknown;
4968                        }
4969                        //TODO: all the other types of rules
4970    
4971                        pMidiRules[i] = NULL;
4972                    }
4973                }
4974            }
4975    
4976            if (pFile->GetAutoLoad()) {
4977                if (!pRegions) pRegions = new RegionList;
4978                RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
4979                if (lrgn) {
4980                    RIFF::List* rgn = lrgn->GetFirstSubList();
4981                    while (rgn) {
4982                        if (rgn->GetListType() == LIST_TYPE_RGN) {
4983                            if (pProgress)
4984                                __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
4985                            pRegions->push_back(new Region(this, rgn));
4986                        }
4987                        rgn = lrgn->GetNextSubList();
4988                    }
4989                    // Creating Region Key Table for fast lookup
4990                    UpdateRegionKeyTable();
4991              }              }
4992          }          }
4993    
4994          if (!pRegions) pRegions = new RegionList;          // own gig format extensions
4995          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);          RIFF::List* lst3LS = insList->GetSubList(LIST_TYPE_3LS);
4996          if (lrgn) {          if (lst3LS) {
4997              RIFF::List* rgn = lrgn->GetFirstSubList();              // script slots (that is references to instrument scripts)
4998              while (rgn) {              RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4999                  if (rgn->GetListType() == LIST_TYPE_RGN) {              if (ckSCSL) {
5000                      __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);                  ckSCSL->SetPos(0);
5001                      pRegions->push_back(new Region(this, rgn));  
5002                    int headerSize = ckSCSL->ReadUint32();
5003                    int slotCount  = ckSCSL->ReadUint32();
5004                    if (slotCount) {
5005                        int slotSize  = ckSCSL->ReadUint32();
5006                        ckSCSL->SetPos(headerSize); // in case of future header extensions
5007                        int unknownSpace = slotSize - 2*sizeof(uint32_t); // in case of future slot extensions
5008                        for (int i = 0; i < slotCount; ++i) {
5009                            _ScriptPooolEntry e;
5010                            e.fileOffset = ckSCSL->ReadUint32();
5011                            e.bypass     = ckSCSL->ReadUint32() & 1;
5012                            if (unknownSpace) ckSCSL->SetPos(unknownSpace, RIFF::stream_curpos); // in case of future extensions
5013                            scriptPoolFileOffsets.push_back(e);
5014                        }
5015                    }
5016                }
5017    
5018                // overridden script 'patch' variables
5019                RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV);
5020                if (ckSCPV) {
5021                    ckSCPV->SetPos(0);
5022    
5023                    int nScripts = ckSCPV->ReadUint32();
5024                    for (int iScript = 0; iScript < nScripts; ++iScript) {
5025                        _UUID uuid;
5026                        for (int i = 0; i < 16; ++i)
5027                            uuid[i] = ckSCPV->ReadUint8();
5028                        uint slot = ckSCPV->ReadUint32();
5029                        ckSCPV->ReadUint32(); // unused, reserved 32 bit
5030                        int nVars = ckSCPV->ReadUint32();
5031                        for (int iVar = 0; iVar < nVars; ++iVar) {
5032                            uint8_t type = ckSCPV->ReadUint8();
5033                            ckSCPV->ReadUint8();  // unused, reserved byte
5034                            int blobSize = ckSCPV->ReadUint16();
5035                            RIFF::file_offset_t pos = ckSCPV->GetPos();
5036                            // assuming 1st bit is set in 'type', otherwise blob not
5037                            // supported for decoding
5038                            if (type & 1) {
5039                                String name, value;
5040                                int len = ckSCPV->ReadUint16();
5041                                for (int i = 0; i < len; ++i)
5042                                    name += (char) ckSCPV->ReadUint8();
5043                                len = ckSCPV->ReadUint16();
5044                                for (int i = 0; i < len; ++i)
5045                                    value += (char) ckSCPV->ReadUint8();
5046                                if (!name.empty()) // 'name' should never be empty, but just to be sure
5047                                    scriptVars[uuid][slot][name] = value;
5048                            }
5049                            // also for potential future extensions: seek forward
5050                            // according to blob size
5051                            ckSCPV->SetPos(pos + blobSize);
5052                        }
5053                  }                  }
                 rgn = lrgn->GetNextSubList();  
5054              }              }
             // Creating Region Key Table for fast lookup  
             UpdateRegionKeyTable();  
5055          }          }
5056    
5057          __notify_progress(pProgress, 1.0f); // notify done          if (pProgress)
5058                __notify_progress(pProgress, 1.0f); // notify done
5059      }      }
5060    
5061      void Instrument::UpdateRegionKeyTable() {      void Instrument::UpdateRegionKeyTable() {
5062            for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
5063          RegionList::iterator iter = pRegions->begin();          RegionList::iterator iter = pRegions->begin();
5064          RegionList::iterator end  = pRegions->end();          RegionList::iterator end  = pRegions->end();
5065          for (; iter != end; ++iter) {          for (; iter != end; ++iter) {
5066              gig::Region* pRegion = static_cast<gig::Region*>(*iter);              gig::Region* pRegion = static_cast<gig::Region*>(*iter);
5067              for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {              const int low  = std::max(int(pRegion->KeyRange.low), 0);
5068                const int high = std::min(int(pRegion->KeyRange.high), 127);
5069                for (int iKey = low; iKey <= high; iKey++) {
5070                  RegionKeyTable[iKey] = pRegion;                  RegionKeyTable[iKey] = pRegion;
5071              }              }
5072          }          }
5073      }      }
5074    
5075      Instrument::~Instrument() {      Instrument::~Instrument() {
5076            for (int i = 0 ; pMidiRules[i] ; i++) {
5077                delete pMidiRules[i];
5078            }
5079            delete[] pMidiRules;
5080            if (pScriptRefs) delete pScriptRefs;
5081      }      }
5082    
5083      /**      /**
# Line 2841  namespace { Line 5087  namespace {
5087       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
5088       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
5089       *       *
5090         * @param pProgress - callback function for progress notification
5091       * @throws gig::Exception if samples cannot be dereferenced       * @throws gig::Exception if samples cannot be dereferenced
5092       */       */
5093      void Instrument::UpdateChunks() {      void Instrument::UpdateChunks(progress_t* pProgress) {
5094          // first update base classes' chunks          // first update base classes' chunks
5095          DLS::Instrument::UpdateChunks();          DLS::Instrument::UpdateChunks(pProgress);
5096    
5097          // update Regions' chunks          // update Regions' chunks
5098          {          {
5099              RegionList::iterator iter = pRegions->begin();              RegionList::iterator iter = pRegions->begin();
5100              RegionList::iterator end  = pRegions->end();              RegionList::iterator end  = pRegions->end();
5101              for (; iter != end; ++iter)              for (; iter != end; ++iter)
5102                  (*iter)->UpdateChunks();                  (*iter)->UpdateChunks(pProgress);
5103          }          }
5104    
5105          // make sure 'lart' RIFF list chunk exists          // make sure 'lart' RIFF list chunk exists
# Line 2864  namespace { Line 5111  namespace {
5111              File* pFile = (File*) GetParent();              File* pFile = (File*) GetParent();
5112    
5113              // 3ewg is bigger in gig3, as it includes the iMIDI rules              // 3ewg is bigger in gig3, as it includes the iMIDI rules
5114              int size = (pFile->pVersion && pFile->pVersion->major == 3) ? 16416 : 12;              int size = (pFile->pVersion && pFile->pVersion->major > 2) ? 16416 : 12;
5115              _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);              _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);
5116              memset(_3ewg->LoadChunkData(), 0, size);              memset(_3ewg->LoadChunkData(), 0, size);
5117          }          }
# Line 2878  namespace { Line 5125  namespace {
5125                                      DimensionKeyRange.low << 1;                                      DimensionKeyRange.low << 1;
5126          pData[10] = dimkeystart;          pData[10] = dimkeystart;
5127          pData[11] = DimensionKeyRange.high;          pData[11] = DimensionKeyRange.high;
5128    
5129            if (pMidiRules[0] == 0 && _3ewg->GetSize() >= 34) {
5130                pData[32] = 0;
5131                pData[33] = 0;
5132            } else {
5133                for (int i = 0 ; pMidiRules[i] ; i++) {
5134                    pMidiRules[i]->UpdateChunks(pData);
5135                }
5136            }
5137    
5138            // own gig format extensions
5139           if (ScriptSlotCount()) {
5140               // make sure we have converted the original loaded script file
5141               // offsets into valid Script object pointers
5142               LoadScripts();
5143    
5144               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
5145               if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);
5146    
5147               // save script slots (that is references to instrument scripts)
5148               const int slotCount = (int) pScriptRefs->size();
5149               const int headerSize = 3 * sizeof(uint32_t);
5150               const int slotSize  = 2 * sizeof(uint32_t);
5151               const int totalChunkSize = headerSize + slotCount * slotSize;
5152               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
5153               if (!ckSCSL) ckSCSL = lst3LS->AddSubChunk(CHUNK_ID_SCSL, totalChunkSize);
5154               else ckSCSL->Resize(totalChunkSize);
5155               uint8_t* pData = (uint8_t*) ckSCSL->LoadChunkData();
5156               int pos = 0;
5157               store32(&pData[pos], headerSize);
5158               pos += sizeof(uint32_t);
5159               store32(&pData[pos], slotCount);
5160               pos += sizeof(uint32_t);
5161               store32(&pData[pos], slotSize);
5162               pos += sizeof(uint32_t);
5163               for (int i = 0; i < slotCount; ++i) {
5164                   // arbitrary value, the actual file offset will be updated in
5165                   // UpdateScriptFileOffsets() after the file has been resized
5166                   int bogusFileOffset = 0;
5167                   store32(&pData[pos], bogusFileOffset);
5168                   pos += sizeof(uint32_t);
5169                   store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0);
5170                   pos += sizeof(uint32_t);
5171               }
5172    
5173               // save overridden script 'patch' variables ...
5174    
5175               // the actual 'scriptVars' member variable might contain variables of
5176               // scripts which are currently no longer assigned to any script slot
5177               // of this instrument, we need to get rid of these variables here to
5178               // prevent saving those persistently, however instead of touching the
5179               // member variable 'scriptVars' directly, rather strip a separate
5180               // copy such that the overridden values are not lost during an
5181               // instrument editor session (i.e. if script might be re-assigned)
5182               _VarsByScript vars = stripScriptVars();
5183               if (!vars.empty()) {
5184                   // determine total size required for 'SCPV' RIFF chunk, and the
5185                   // total amount of scripts being overridden (the latter is
5186                   // required because a script might be used on several script
5187                   // slots, hence vars.size() could then not be used here instead)
5188                   size_t totalChunkSize = 4;
5189                   size_t totalScriptsOverridden = 0;
5190                   for (const auto& script : vars) {
5191                       for (const auto& slot : script.second) {
5192                           totalScriptsOverridden++;
5193                           totalChunkSize += 16 + 4 + 4 + 4;
5194                           for (const auto& var : slot.second) {
5195                               totalChunkSize += 4 + 2 + var.first.length() +
5196                                                     2 + var.second.length();
5197                           }
5198                       }
5199                   }
5200    
5201                   // ensure 'SCPV' RIFF chunk exists (with required size)
5202                   RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV);
5203                   if (!ckSCPV) ckSCPV = lst3LS->AddSubChunk(CHUNK_ID_SCPV, totalChunkSize);
5204                   else ckSCPV->Resize(totalChunkSize);
5205    
5206                   // store the actual data to 'SCPV' RIFF chunk
5207                   uint8_t* pData = (uint8_t*) ckSCPV->LoadChunkData();
5208                   int pos = 0;
5209                   store32(&pData[pos], (uint32_t) totalScriptsOverridden); // scripts count
5210                   pos += 4;
5211                   for (const auto& script : vars) {
5212                       for (const auto& slot : script.second) {
5213                           for (int i = 0; i < 16; ++i)
5214                               pData[pos+i] = script.first[i]; // uuid
5215                           pos += 16;
5216                           store32(&pData[pos], (uint32_t) slot.first); // slot index
5217                           pos += 4;
5218                           store32(&pData[pos], (uint32_t) 0); // unused, reserved 32 bit
5219                           pos += 4;
5220                           store32(&pData[pos], (uint32_t) slot.second.size()); // variables count
5221                           pos += 4;
5222                           for (const auto& var : slot.second) {
5223                               pData[pos++] = 1; // type
5224                               pData[pos++] = 0; // reserved byte
5225                               store16(&pData[pos], 2 + var.first.size() + 2 + var.second.size()); // blob size
5226                               pos += 2;
5227                               store16(&pData[pos], var.first.size()); // variable name length
5228                               pos += 2;
5229                               for (int i = 0; i < var.first.size(); ++i)
5230                                   pData[pos++] = var.first[i];
5231                               store16(&pData[pos], var.second.size()); // variable value length
5232                               pos += 2;
5233                               for (int i = 0; i < var.second.size(); ++i)
5234                                   pData[pos++] = var.second[i];
5235                           }
5236                       }
5237                   }
5238               } else {
5239                   // no script variable overridden by this instrument, so get rid
5240                   // of 'SCPV' RIFF chunk (if any)
5241                   RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV);
5242                   if (ckSCPV) lst3LS->DeleteSubChunk(ckSCPV);
5243               }
5244           } else {
5245               // no script slots, so get rid of any LS custom RIFF chunks (if any)
5246               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
5247               if (lst3LS) pCkInstrument->DeleteSubChunk(lst3LS);
5248           }
5249        }
5250    
5251        void Instrument::UpdateScriptFileOffsets() {
5252           // own gig format extensions
5253           if (pScriptRefs && pScriptRefs->size() > 0) {
5254               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
5255               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
5256               const int slotCount = (int) pScriptRefs->size();
5257               const int headerSize = 3 * sizeof(uint32_t);
5258               ckSCSL->SetPos(headerSize);
5259               for (int i = 0; i < slotCount; ++i) {
5260                   uint32_t fileOffset = uint32_t(
5261                        (*pScriptRefs)[i].script->pChunk->GetFilePos() -
5262                        (*pScriptRefs)[i].script->pChunk->GetPos() -
5263                        CHUNK_HEADER_SIZE(ckSCSL->GetFile()->GetFileOffsetSize())
5264                   );
5265                   ckSCSL->WriteUint32(&fileOffset);
5266                   // jump over flags entry (containing the bypass flag)
5267                   ckSCSL->SetPos(sizeof(uint32_t), RIFF::stream_curpos);
5268               }
5269           }        
5270      }      }
5271    
5272      /**      /**
# Line 2888  namespace { Line 5277  namespace {
5277       *             there is no Region defined for the given \a Key       *             there is no Region defined for the given \a Key
5278       */       */
5279      Region* Instrument::GetRegion(unsigned int Key) {      Region* Instrument::GetRegion(unsigned int Key) {
5280          if (!pRegions || !pRegions->size() || Key > 127) return NULL;          if (!pRegions || pRegions->empty() || Key > 127) return NULL;
5281          return RegionKeyTable[Key];          return RegionKeyTable[Key];
5282    
5283          /*for (int i = 0; i < Regions; i++) {          /*for (int i = 0; i < Regions; i++) {
# Line 2932  namespace { Line 5321  namespace {
5321          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
5322          Region* pNewRegion = new Region(this, rgn);          Region* pNewRegion = new Region(this, rgn);
5323          pRegions->push_back(pNewRegion);          pRegions->push_back(pNewRegion);
5324          Regions = pRegions->size();          Regions = (uint32_t) pRegions->size();
5325          // update Region key table for fast lookup          // update Region key table for fast lookup
5326          UpdateRegionKeyTable();          UpdateRegionKeyTable();
5327          // done          // done
# Line 2946  namespace { Line 5335  namespace {
5335          UpdateRegionKeyTable();          UpdateRegionKeyTable();
5336      }      }
5337    
5338        /**
5339         * Move this instrument at the position before @arg dst.
5340         *
5341         * This method can be used to reorder the sequence of instruments in a
5342         * .gig file. This might be helpful especially on large .gig files which
5343         * contain a large number of instruments within the same .gig file. So
5344         * grouping such instruments to similar ones, can help to keep track of them
5345         * when working with such complex .gig files.
5346         *
5347         * When calling this method, this instrument will be removed from in its
5348         * current position in the instruments list and moved to the requested
5349         * target position provided by @param dst. You may also pass NULL as
5350         * argument to this method, in that case this intrument will be moved to the
5351         * very end of the .gig file's instrument list.
5352         *
5353         * You have to call Save() to make the order change persistent to the .gig
5354         * file.
5355         *
5356         * Currently this method is limited to moving the instrument within the same
5357         * .gig file. Trying to move it to another .gig file by calling this method
5358         * will throw an exception.
5359         *
5360         * @param dst - destination instrument at which this instrument will be
5361         *              moved to, or pass NULL for moving to end of list
5362         * @throw gig::Exception if this instrument and target instrument are not
5363         *                       part of the same file
5364         */
5365        void Instrument::MoveTo(Instrument* dst) {
5366            if (dst && GetParent() != dst->GetParent())
5367                throw Exception(
5368                    "gig::Instrument::MoveTo() can only be used for moving within "
5369                    "the same gig file."
5370                );
5371    
5372            File* pFile = (File*) GetParent();
5373    
5374            // move this instrument within the instrument list
5375            {
5376                File::InstrumentList& list = *pFile->pInstruments;
5377    
5378                File::InstrumentList::iterator itFrom =
5379                    std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(this));
5380    
5381                File::InstrumentList::iterator itTo =
5382                    std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(dst));
5383    
5384                list.splice(itTo, list, itFrom);
5385            }
5386    
5387            // move the instrument's actual list RIFF chunk appropriately
5388            RIFF::List* lstCkInstruments = pFile->pRIFF->GetSubList(LIST_TYPE_LINS);
5389            lstCkInstruments->MoveSubChunk(
5390                this->pCkInstrument,
5391                (RIFF::Chunk*) ((dst) ? dst->pCkInstrument : NULL)
5392            );
5393        }
5394    
5395        /**
5396         * Returns a MIDI rule of the instrument.
5397         *
5398         * The list of MIDI rules, at least in gig v3, always contains at
5399         * most two rules. The second rule can only be the DEF filter
5400         * (which currently isn't supported by libgig).
5401         *
5402         * @param i - MIDI rule number
5403         * @returns   pointer address to MIDI rule number i or NULL if there is none
5404         */
5405        MidiRule* Instrument::GetMidiRule(int i) {
5406            return pMidiRules[i];
5407        }
5408    
5409        /**
5410         * Adds the "controller trigger" MIDI rule to the instrument.
5411         *
5412         * @returns the new MIDI rule
5413         */
5414        MidiRuleCtrlTrigger* Instrument::AddMidiRuleCtrlTrigger() {
5415            delete pMidiRules[0];
5416            MidiRuleCtrlTrigger* r = new MidiRuleCtrlTrigger;
5417            pMidiRules[0] = r;
5418            pMidiRules[1] = 0;
5419            return r;
5420        }
5421    
5422        /**
5423         * Adds the legato MIDI rule to the instrument.
5424         *
5425         * @returns the new MIDI rule
5426         */
5427        MidiRuleLegato* Instrument::AddMidiRuleLegato() {
5428            delete pMidiRules[0];
5429            MidiRuleLegato* r = new MidiRuleLegato;
5430            pMidiRules[0] = r;
5431            pMidiRules[1] = 0;
5432            return r;
5433        }
5434    
5435        /**
5436         * Adds the alternator MIDI rule to the instrument.
5437         *
5438         * @returns the new MIDI rule
5439         */
5440        MidiRuleAlternator* Instrument::AddMidiRuleAlternator() {
5441            delete pMidiRules[0];
5442            MidiRuleAlternator* r = new MidiRuleAlternator;
5443            pMidiRules[0] = r;
5444            pMidiRules[1] = 0;
5445            return r;
5446        }
5447    
5448        /**
5449         * Deletes a MIDI rule from the instrument.
5450         *
5451         * @param i - MIDI rule number
5452         */
5453        void Instrument::DeleteMidiRule(int i) {
5454            delete pMidiRules[i];
5455            pMidiRules[i] = 0;
5456        }
5457    
5458        void Instrument::LoadScripts() {
5459            if (pScriptRefs) return;
5460            pScriptRefs = new std::vector<_ScriptPooolRef>;
5461            if (scriptPoolFileOffsets.empty()) return;
5462            File* pFile = (File*) GetParent();
5463            for (uint k = 0; k < scriptPoolFileOffsets.size(); ++k) {
5464                uint32_t soughtOffset = scriptPoolFileOffsets[k].fileOffset;
5465                for (uint i = 0; pFile->GetScriptGroup(i); ++i) {
5466                    ScriptGroup* group = pFile->GetScriptGroup(i);
5467                    for (uint s = 0; group->GetScript(s); ++s) {
5468                        Script* script = group->GetScript(s);
5469                        if (script->pChunk) {
5470                            uint32_t offset = uint32_t(
5471                                script->pChunk->GetFilePos() -
5472                                script->pChunk->GetPos() -
5473                                CHUNK_HEADER_SIZE(script->pChunk->GetFile()->GetFileOffsetSize())
5474                            );
5475                            if (offset == soughtOffset)
5476                            {
5477                                _ScriptPooolRef ref;
5478                                ref.script = script;
5479                                ref.bypass = scriptPoolFileOffsets[k].bypass;
5480                                pScriptRefs->push_back(ref);
5481                                break;
5482                            }
5483                        }
5484                    }
5485                }
5486            }
5487            // we don't need that anymore
5488            scriptPoolFileOffsets.clear();
5489        }
5490    
5491        /** @brief Get instrument script (gig format extension).
5492         *
5493         * Returns the real-time instrument script of instrument script slot
5494         * @a index.
5495         *
5496         * @note This is an own format extension which did not exist i.e. in the
5497         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5498         * gigedit.
5499         *
5500         * @param index - instrument script slot index
5501         * @returns script or NULL if index is out of bounds
5502         */
5503        Script* Instrument::GetScriptOfSlot(uint index) {
5504            LoadScripts();
5505            if (index >= pScriptRefs->size()) return NULL;
5506            return pScriptRefs->at(index).script;
5507        }
5508    
5509        /** @brief Add new instrument script slot (gig format extension).
5510         *
5511         * Add the given real-time instrument script reference to this instrument,
5512         * which shall be executed by the sampler for for this instrument. The
5513         * script will be added to the end of the script list of this instrument.
5514         * The positions of the scripts in the Instrument's Script list are
5515         * relevant, because they define in which order they shall be executed by
5516         * the sampler. For this reason it is also legal to add the same script
5517         * twice to an instrument, for example you might have a script called
5518         * "MyFilter" which performs an event filter task, and you might have
5519         * another script called "MyNoteTrigger" which triggers new notes, then you
5520         * might for example have the following list of scripts on the instrument:
5521         *
5522         * 1. Script "MyFilter"
5523         * 2. Script "MyNoteTrigger"
5524         * 3. Script "MyFilter"
5525         *
5526         * Which would make sense, because the 2nd script launched new events, which
5527         * you might need to filter as well.
5528         *
5529         * There are two ways to disable / "bypass" scripts. You can either disable
5530         * a script locally for the respective script slot on an instrument (i.e. by
5531         * passing @c false to the 2nd argument of this method, or by calling
5532         * SetScriptBypassed()). Or you can disable a script globally for all slots
5533         * and all instruments by setting Script::Bypass.
5534         *
5535         * @note This is an own format extension which did not exist i.e. in the
5536         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5537         * gigedit.
5538         *
5539         * @param pScript - script that shall be executed for this instrument
5540         * @param bypass  - if enabled, the sampler shall skip executing this
5541         *                  script (in the respective list position)
5542         * @see SetScriptBypassed()
5543         */
5544        void Instrument::AddScriptSlot(Script* pScript, bool bypass) {
5545            LoadScripts();
5546            _ScriptPooolRef ref = { pScript, bypass };
5547            pScriptRefs->push_back(ref);
5548        }
5549    
5550        /** @brief Flip two script slots with each other (gig format extension).
5551         *
5552         * Swaps the position of the two given scripts in the Instrument's Script
5553         * list. The positions of the scripts in the Instrument's Script list are
5554         * relevant, because they define in which order they shall be executed by
5555         * the sampler.
5556         *
5557         * @note This is an own format extension which did not exist i.e. in the
5558         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5559         * gigedit.
5560         *
5561         * @param index1 - index of the first script slot to swap
5562         * @param index2 - index of the second script slot to swap
5563         */
5564        void Instrument::SwapScriptSlots(uint index1, uint index2) {
5565            LoadScripts();
5566            if (index1 >= pScriptRefs->size() || index2 >= pScriptRefs->size())
5567                return;
5568            _ScriptPooolRef tmp = (*pScriptRefs)[index1];
5569            (*pScriptRefs)[index1] = (*pScriptRefs)[index2];
5570            (*pScriptRefs)[index2] = tmp;
5571        }
5572    
5573        /** @brief Remove script slot.
5574         *
5575         * Removes the script slot with the given slot index.
5576         *
5577         * @param index - index of script slot to remove
5578         */
5579        void Instrument::RemoveScriptSlot(uint index) {
5580            LoadScripts();
5581            if (index >= pScriptRefs->size()) return;
5582            pScriptRefs->erase( pScriptRefs->begin() + index );
5583        }
5584    
5585        /** @brief Remove reference to given Script (gig format extension).
5586         *
5587         * This will remove all script slots on the instrument which are referencing
5588         * the given script.
5589         *
5590         * @note This is an own format extension which did not exist i.e. in the
5591         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5592         * gigedit.
5593         *
5594         * @param pScript - script reference to remove from this instrument
5595         * @see RemoveScriptSlot()
5596         */
5597        void Instrument::RemoveScript(Script* pScript) {
5598            LoadScripts();
5599            for (ssize_t i = pScriptRefs->size() - 1; i >= 0; --i) {
5600                if ((*pScriptRefs)[i].script == pScript) {
5601                    pScriptRefs->erase( pScriptRefs->begin() + i );
5602                }
5603            }
5604        }
5605    
5606        /** @brief Instrument's amount of script slots.
5607         *
5608         * This method returns the amount of script slots this instrument currently
5609         * uses.
5610         *
5611         * A script slot is a reference of a real-time instrument script to be
5612         * executed by the sampler. The scripts will be executed by the sampler in
5613         * sequence of the slots. One (same) script may be referenced multiple
5614         * times in different slots.
5615         *
5616         * @note This is an own format extension which did not exist i.e. in the
5617         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5618         * gigedit.
5619         */
5620        uint Instrument::ScriptSlotCount() const {
5621            return uint(pScriptRefs ? pScriptRefs->size() : scriptPoolFileOffsets.size());
5622        }
5623    
5624        /** @brief Whether script execution shall be skipped.
5625         *
5626         * Defines locally for the Script reference slot in the Instrument's Script
5627         * list, whether the script shall be skipped by the sampler regarding
5628         * execution.
5629         *
5630         * It is also possible to ignore exeuction of the script globally, for all
5631         * slots and for all instruments by setting Script::Bypass.
5632         *
5633         * @note This is an own format extension which did not exist i.e. in the
5634         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5635         * gigedit.
5636         *
5637         * @param index - index of the script slot on this instrument
5638         * @see Script::Bypass
5639         */
5640        bool Instrument::IsScriptSlotBypassed(uint index) {
5641            if (index >= ScriptSlotCount()) return false;
5642            return pScriptRefs ? pScriptRefs->at(index).bypass
5643                               : scriptPoolFileOffsets.at(index).bypass;
5644            
5645        }
5646    
5647        /** @brief Defines whether execution shall be skipped.
5648         *
5649         * You can call this method to define locally whether or whether not the
5650         * given script slot shall be executed by the sampler.
5651         *
5652         * @note This is an own format extension which did not exist i.e. in the
5653         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5654         * gigedit.
5655         *
5656         * @param index - script slot index on this instrument
5657         * @param bBypass - if true, the script slot will be skipped by the sampler
5658         * @see Script::Bypass
5659         */
5660        void Instrument::SetScriptSlotBypassed(uint index, bool bBypass) {
5661            if (index >= ScriptSlotCount()) return;
5662            if (pScriptRefs)
5663                pScriptRefs->at(index).bypass = bBypass;
5664            else
5665                scriptPoolFileOffsets.at(index).bypass = bBypass;
5666        }
5667    
5668        /// type cast (by copy) uint8_t[16] -> std::array<uint8_t,16>
5669        inline std::array<uint8_t,16> _UUIDFromCArray(const uint8_t* pData) {
5670            std::array<uint8_t,16> uuid;
5671            memcpy(&uuid[0], pData, 16);
5672            return uuid;
5673        }
5674    
5675        /**
5676         * Returns true if this @c Instrument has any script slot which references
5677         * the @c Script identified by passed @p uuid.
5678         */
5679        bool Instrument::ReferencesScriptWithUuid(const _UUID& uuid) {
5680            const uint nSlots = ScriptSlotCount();
5681            for (uint iSlot = 0; iSlot < nSlots; ++iSlot)
5682                if (_UUIDFromCArray(&GetScriptOfSlot(iSlot)->Uuid[0]) == uuid)
5683                    return true;
5684            return false;
5685        }
5686    
5687        /** @brief Checks whether a certain script 'patch' variable value is set.
5688         *
5689         * Returns @c true if the initial value for the requested script variable is
5690         * currently overridden by this instrument.
5691         *
5692         * @remarks Real-time instrument scripts allow to declare special 'patch'
5693         * variables, which essentially behave like regular variables of their data
5694         * type, however their initial value may optionally be overridden on a per
5695         * instrument basis. That allows to share scripts between instruments while
5696         * still being able to fine tune certain aspects of the script for each
5697         * instrument individually.
5698         *
5699         * @param slot - script slot index of the variable to be retrieved
5700         * @param variable - name of the 'patch' variable in that script
5701         */
5702        bool Instrument::IsScriptPatchVariableSet(int slot, String variable) {
5703            if (variable.empty()) return false;
5704            Script* script = GetScriptOfSlot(slot);
5705            if (!script) return false;
5706            const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5707            if (!scriptVars.count(uuid)) return false;
5708            const _VarsBySlot& slots = scriptVars.find(uuid)->second;
5709            if (slots.empty()) return false;
5710            if (slots.count(slot))
5711                return slots.find(slot)->second.count(variable);
5712            else
5713                return slots.begin()->second.count(variable);
5714        }
5715    
5716        /** @brief Get all overridden script 'patch' variables.
5717         *
5718         * Returns map of key-value pairs reflecting all patch variables currently
5719         * being overridden by this instrument for the given script @p slot, where
5720         * key is the variable name and value is the hereby currently overridden
5721         * value for that variable.
5722         *
5723         * @remarks Real-time instrument scripts allow to declare special 'patch'
5724         * variables, which essentially behave like regular variables of their data
5725         * type, however their initial value may optionally be overridden on a per
5726         * instrument basis. That allows to share scripts between instruments while
5727         * still being able to fine tune certain aspects of the script for each
5728         * instrument individually.
5729         *
5730         * @param slot - script slot index of the variable to be retrieved
5731         */
5732        std::map<String,String> Instrument::GetScriptPatchVariables(int slot) {
5733            Script* script = GetScriptOfSlot(slot);
5734            if (!script) return std::map<String,String>();
5735            const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5736            if (!scriptVars.count(uuid)) return std::map<String,String>();
5737            const _VarsBySlot& slots = scriptVars.find(uuid)->second;
5738            if (slots.empty()) return std::map<String,String>();
5739            const _PatchVars& vars =
5740                (slots.count(slot)) ?
5741                    slots.find(slot)->second : slots.begin()->second;
5742            return vars;
5743        }
5744    
5745        /** @brief Get overridden initial value for 'patch' variable.
5746         *
5747         * Returns current initial value for the requested script variable being
5748         * overridden by this instrument.
5749         *
5750         * @remarks Real-time instrument scripts allow to declare special 'patch'
5751         * variables, which essentially behave like regular variables of their data
5752         * type, however their initial value may optionally be overridden on a per
5753         * instrument basis. That allows to share scripts between instruments while
5754         * still being able to fine tune certain aspects of the script for each
5755         * instrument individually.
5756         *
5757         * @param slot - script slot index of the variable to be retrieved
5758         * @param variable - name of the 'patch' variable in that script
5759         */
5760        String Instrument::GetScriptPatchVariable(int slot, String variable) {
5761            std::map<String,String> vars = GetScriptPatchVariables(slot);
5762            return (vars.count(variable)) ? vars.find(variable)->second : "";
5763        }
5764    
5765        /** @brief Override initial value for 'patch' variable.
5766         *
5767         * Overrides initial value for the requested script variable for this
5768         * instrument with the passed value.
5769         *
5770         * @remarks Real-time instrument scripts allow to declare special 'patch'
5771         * variables, which essentially behave like regular variables of their data
5772         * type, however their initial value may optionally be overridden on a per
5773         * instrument basis. That allows to share scripts between instruments while
5774         * still being able to fine tune certain aspects of the script for each
5775         * instrument individually.
5776         *
5777         * @param slot - script slot index of the variable to be set
5778         * @param variable - name of the 'patch' variable in that script
5779         * @param value - overridden initial value for that script variable
5780         * @throws gig::Exception if given script @p slot index is invalid or given
5781         *         @p variable name is empty
5782         */
5783        void Instrument::SetScriptPatchVariable(int slot, String variable, String value) {
5784            if (variable.empty())
5785                throw Exception("Variable name must not be empty");
5786            Script* script = GetScriptOfSlot(slot);
5787            if (!script)
5788                throw Exception("No script slot with index " + ToString(slot));
5789            const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5790            scriptVars[uuid][slot][variable] = value;
5791        }
5792    
5793        /** @brief Drop overridden initial value(s) for 'patch' variable(s).
5794         *
5795         * Reverts initial value(s) for requested script variable(s) back to their
5796         * default initial value(s) defined in the script itself.
5797         *
5798         * Both arguments of this method are optional. The most obvious use case of
5799         * this method would be passing a valid script @p slot index and a
5800         * (non-emtpy string as) @p variable name to this method, which would cause
5801         * that single variable to be unset for that specific script slot (on this
5802         * @c Instrument level).
5803         *
5804         * Not passing a value (or @c -1 for @p slot and/or empty string for
5805         * @p variable) means 'wildcard'. So accordingly absence of argument(s) will
5806         * cause all variables and/or for all script slots being unset. Hence this
5807         * method serves 2^2 = 4 possible use cases in total and accordingly covers
5808         * 4 different behaviours in one method.
5809         *
5810         * @remarks Real-time instrument scripts allow to declare special 'patch'
5811         * variables, which essentially behave like regular variables of their data
5812         * type, however their initial value may optionally be overridden on a per
5813         * instrument basis. That allows to share scripts between instruments while
5814         * still being able to fine tune certain aspects of the script for each
5815         * instrument individually.
5816         *
5817         * @param slot - script slot index of the variable to be unset
5818         * @param variable - name of the 'patch' variable in that script
5819         */
5820        void Instrument::UnsetScriptPatchVariable(int slot, String variable) {
5821            Script* script = GetScriptOfSlot(slot);
5822    
5823            // option 1: unset a particular variable of one particular script slot
5824            if (slot != -1 && !variable.empty()) {
5825                if (!script) return;
5826                const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5827                if (!scriptVars.count(uuid)) return;
5828                if (!scriptVars[uuid].count(slot)) return;
5829                if (scriptVars[uuid][slot].count(variable))
5830                    scriptVars[uuid][slot].erase(
5831                        scriptVars[uuid][slot].find(variable)
5832                    );
5833                if (scriptVars[uuid][slot].empty())
5834                    scriptVars[uuid].erase( scriptVars[uuid].find(slot) );
5835                if (scriptVars[uuid].empty())
5836                    scriptVars.erase( scriptVars.find(uuid) );
5837                return;
5838            }
5839    
5840            // option 2: unset all variables of all script slots
5841            if (slot == -1 && variable.empty()) {
5842                scriptVars.clear();
5843                return;
5844            }
5845    
5846            // option 3: unset all variables of one particular script slot only
5847            if (slot != -1) {
5848                if (!script) return;
5849                const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5850                if (scriptVars.count(uuid))
5851                    scriptVars.erase( scriptVars.find(uuid) );
5852                return;
5853            }
5854    
5855            // option 4: unset a particular variable of all script slots
5856            _VarsByScript::iterator itScript = scriptVars.begin();
5857            _VarsByScript::iterator endScript = scriptVars.end();
5858            while (itScript != endScript) {
5859                _VarsBySlot& slots = itScript->second;
5860                _VarsBySlot::iterator itSlot = slots.begin();
5861                _VarsBySlot::iterator endSlot = slots.end();
5862                while (itSlot != endSlot) {
5863                    _PatchVars& vars = itSlot->second;
5864                    if (vars.count(variable))
5865                        vars.erase( vars.find(variable) );
5866                    if (vars.empty())
5867                        slots.erase(itSlot++); // postfix increment to avoid iterator invalidation
5868                    else
5869                        ++itSlot;
5870                }
5871                if (slots.empty())
5872                    scriptVars.erase(itScript++); // postfix increment to avoid iterator invalidation
5873                else
5874                    ++itScript;
5875            }
5876        }
5877    
5878        /**
5879         * Returns stripped version of member variable @c scriptVars, where scripts
5880         * no longer referenced by this @c Instrument are filtered out, and so are
5881         * variables of meanwhile obsolete slots (i.e. a script still being
5882         * referenced, but previously overridden on a script slot which either no
5883         * longer exists or is hosting another script now).
5884         */
5885        Instrument::_VarsByScript Instrument::stripScriptVars() {
5886            _VarsByScript vars;
5887            _VarsByScript::const_iterator itScript = scriptVars.begin();
5888            _VarsByScript::const_iterator endScript = scriptVars.end();
5889            for (; itScript != endScript; ++itScript) {
5890                const _UUID& uuid = itScript->first;
5891                if (!ReferencesScriptWithUuid(uuid))
5892                    continue;
5893                const _VarsBySlot& slots = itScript->second;
5894                _VarsBySlot::const_iterator itSlot = slots.begin();
5895                _VarsBySlot::const_iterator endSlot = slots.end();
5896                for (; itSlot != endSlot; ++itSlot) {
5897                    Script* script = GetScriptOfSlot(itSlot->first);
5898                    if (!script) continue;
5899                    if (_UUIDFromCArray(&script->Uuid[0]) != uuid) continue;
5900                    if (itSlot->second.empty()) continue;
5901                    vars[uuid][itSlot->first] = itSlot->second;
5902                }
5903            }
5904            return vars;
5905        }
5906    
5907        /**
5908         * Make a (semi) deep copy of the Instrument object given by @a orig
5909         * and assign it to this object.
5910         *
5911         * Note that all sample pointers referenced by @a orig are simply copied as
5912         * memory address. Thus the respective samples are shared, not duplicated!
5913         *
5914         * @param orig - original Instrument object to be copied from
5915         */
5916        void Instrument::CopyAssign(const Instrument* orig) {
5917            CopyAssign(orig, NULL);
5918        }
5919            
5920        /**
5921         * Make a (semi) deep copy of the Instrument object given by @a orig
5922         * and assign it to this object.
5923         *
5924         * @param orig - original Instrument object to be copied from
5925         * @param mSamples - crosslink map between the foreign file's samples and
5926         *                   this file's samples
5927         */
5928        void Instrument::CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples) {
5929            // handle base class
5930            // (without copying DLS region stuff)
5931            DLS::Instrument::CopyAssignCore(orig);
5932            
5933            // handle own member variables
5934            Attenuation = orig->Attenuation;
5935            EffectSend = orig->EffectSend;
5936            FineTune = orig->FineTune;
5937            PitchbendRange = orig->PitchbendRange;
5938            PianoReleaseMode = orig->PianoReleaseMode;
5939            DimensionKeyRange = orig->DimensionKeyRange;
5940            scriptPoolFileOffsets = orig->scriptPoolFileOffsets;
5941            pScriptRefs = orig->pScriptRefs;
5942            scriptVars = orig->scriptVars;
5943            
5944            // free old midi rules
5945            for (int i = 0 ; pMidiRules[i] ; i++) {
5946                delete pMidiRules[i];
5947            }
5948            //TODO: MIDI rule copying
5949            pMidiRules[0] = NULL;
5950            
5951            // delete all old regions
5952            while (Regions) DeleteRegion(GetFirstRegion());
5953            // create new regions and copy them from original
5954            {
5955                RegionList::const_iterator it = orig->pRegions->begin();
5956                for (int i = 0; i < orig->Regions; ++i, ++it) {
5957                    Region* dstRgn = AddRegion();
5958                    //NOTE: Region does semi-deep copy !
5959                    dstRgn->CopyAssign(
5960                        static_cast<gig::Region*>(*it),
5961                        mSamples
5962                    );
5963                }
5964            }
5965    
5966            UpdateRegionKeyTable();
5967        }
5968    
5969        /**
5970         * Returns @c true in case this Instrument object uses any gig format
5971         * extension, that is e.g. whether any DimensionRegion object currently
5972         * has any setting effective that would require our "LSDE" RIFF chunk to
5973         * be stored to the gig file.
5974         *
5975         * Right now this is a private method. It is considerable though this method
5976         * to become (in slightly modified form) a public API method in future, i.e.
5977         * to allow instrument editors to visualize and/or warn the user of any gig
5978         * format extension being used. See also comments on
5979         * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
5980         * potential public API change in future.
5981         */
5982        bool Instrument::UsesAnyGigFormatExtension() const {
5983            if (!pRegions) return false;
5984            if (!scriptVars.empty()) return true;
5985            RegionList::const_iterator iter = pRegions->begin();
5986            RegionList::const_iterator end  = pRegions->end();
5987            for (; iter != end; ++iter) {
5988                gig::Region* rgn = static_cast<gig::Region*>(*iter);
5989                if (rgn->UsesAnyGigFormatExtension())
5990                    return true;
5991            }
5992            return false;
5993        }
5994    
5995    
5996  // *************** Group ***************  // *************** Group ***************
# Line 2963  namespace { Line 6008  namespace {
6008          ::LoadString(pNameChunk, Name);          ::LoadString(pNameChunk, Name);
6009      }      }
6010    
6011        /** @brief Destructor.
6012         *
6013         * Currently this destructor implementation does nothing.
6014         */
6015      Group::~Group() {      Group::~Group() {
6016          // remove the chunk associated with this group (if any)      }
6017          if (pNameChunk) pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);  
6018        /** @brief Remove all RIFF chunks associated with this Group object.
6019         *
6020         * See DLS::Storage::DeleteChunks() for details.
6021         */
6022        void Group::DeleteChunks() {
6023            // handle own RIFF chunks
6024            if (pNameChunk) {
6025                pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
6026                pNameChunk = NULL;
6027            }
6028      }      }
6029    
6030      /** @brief Update chunks with current group settings.      /** @brief Update chunks with current group settings.
# Line 2975  namespace { Line 6034  namespace {
6034       *       *
6035       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
6036       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
6037         *
6038         * @param pProgress - callback function for progress notification
6039       */       */
6040      void Group::UpdateChunks() {      void Group::UpdateChunks(progress_t* pProgress) {
6041          // make sure <3gri> and <3gnl> list chunks exist          // make sure <3gri> and <3gnl> list chunks exist
6042          RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);          RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);
6043          if (!_3gri) {          if (!_3gri) {
# Line 2986  namespace { Line 6047  namespace {
6047          RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);          RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
6048          if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);          if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
6049    
6050          if (!pNameChunk && pFile->pVersion && pFile->pVersion->major == 3) {          if (!pNameChunk && pFile->pVersion && pFile->pVersion->major > 2) {
6051              // v3 has a fixed list of 128 strings, find a free one              // v3 has a fixed list of 128 strings, find a free one
6052              for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {              for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {
6053                  if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {                  if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {
# Line 3071  namespace { Line 6132  namespace {
6132  // *************** File ***************  // *************** File ***************
6133  // *  // *
6134    
6135      // File version 2.0, 1998-06-28      /// Reflects Gigasampler file format version 2.0 (1998-06-28).
6136      const DLS::version_t File::VERSION_2 = {      const DLS::version_t File::VERSION_2 = {
6137          0, 2, 19980628 & 0xffff, 19980628 >> 16          0, 2, 19980628 & 0xffff, 19980628 >> 16
6138      };      };
6139    
6140      // File version 3.0, 2003-03-31      /// Reflects Gigasampler file format version 3.0 (2003-03-31).
6141      const DLS::version_t File::VERSION_3 = {      const DLS::version_t File::VERSION_3 = {
6142          0, 3, 20030331 & 0xffff, 20030331 >> 16          0, 3, 20030331 & 0xffff, 20030331 >> 16
6143      };      };
6144    
6145      const DLS::Info::FixedStringLength File::FixedStringLengths[] = {      /// Reflects Gigasampler file format version 4.0 (2007-10-12).
6146        const DLS::version_t File::VERSION_4 = {
6147            0, 4, 20071012 & 0xffff, 20071012 >> 16
6148        };
6149    
6150        static const DLS::Info::string_length_t _FileFixedStringLengths[] = {
6151          { CHUNK_ID_IARL, 256 },          { CHUNK_ID_IARL, 256 },
6152          { CHUNK_ID_IART, 128 },          { CHUNK_ID_IART, 128 },
6153          { CHUNK_ID_ICMS, 128 },          { CHUNK_ID_ICMS, 128 },
# Line 3103  namespace { Line 6169  namespace {
6169      };      };
6170    
6171      File::File() : DLS::File() {      File::File() : DLS::File() {
6172            bAutoLoad = true;
6173          *pVersion = VERSION_3;          *pVersion = VERSION_3;
6174          pGroups = NULL;          pGroups = NULL;
6175          pInfo->FixedStringLengths = FixedStringLengths;          pScriptGroups = NULL;
6176            pInfo->SetFixedStringLengths(_FileFixedStringLengths);
6177          pInfo->ArchivalLocation = String(256, ' ');          pInfo->ArchivalLocation = String(256, ' ');
6178    
6179          // add some mandatory chunks to get the file chunks in right          // add some mandatory chunks to get the file chunks in right
# Line 3118  namespace { Line 6186  namespace {
6186      }      }
6187    
6188      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
6189            bAutoLoad = true;
6190          pGroups = NULL;          pGroups = NULL;
6191          pInfo->FixedStringLengths = FixedStringLengths;          pScriptGroups = NULL;
6192            pInfo->SetFixedStringLengths(_FileFixedStringLengths);
6193      }      }
6194    
6195      File::~File() {      File::~File() {
# Line 3132  namespace { Line 6202  namespace {
6202              }              }
6203              delete pGroups;              delete pGroups;
6204          }          }
6205            if (pScriptGroups) {
6206                std::list<ScriptGroup*>::iterator iter = pScriptGroups->begin();
6207                std::list<ScriptGroup*>::iterator end  = pScriptGroups->end();
6208                while (iter != end) {
6209                    delete *iter;
6210                    ++iter;
6211                }
6212                delete pScriptGroups;
6213            }
6214      }      }
6215    
6216      Sample* File::GetFirstSample(progress_t* pProgress) {      Sample* File::GetFirstSample(progress_t* pProgress) {
# Line 3146  namespace { Line 6225  namespace {
6225          SamplesIterator++;          SamplesIterator++;
6226          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
6227      }      }
6228        
6229        /**
6230         * Returns Sample object of @a index.
6231         *
6232         * @returns sample object or NULL if index is out of bounds
6233         */
6234        Sample* File::GetSample(uint index) {
6235            if (!pSamples) LoadSamples();
6236            if (!pSamples) return NULL;
6237            DLS::File::SampleList::iterator it = pSamples->begin();
6238            for (int i = 0; i < index; ++i) {
6239                ++it;
6240                if (it == pSamples->end()) return NULL;
6241            }
6242            if (it == pSamples->end()) return NULL;
6243            return static_cast<gig::Sample*>( *it );
6244        }
6245    
6246        /**
6247         * Returns the total amount of samples of this gig file.
6248         *
6249         * Note that this method might block for a long time in case it is required
6250         * to load the sample info for the first time.
6251         *
6252         * @returns total amount of samples
6253         */
6254        size_t File::CountSamples() {
6255            if (!pSamples) LoadSamples();
6256            if (!pSamples) return 0;
6257            return pSamples->size();
6258        }
6259    
6260      /** @brief Add a new sample.      /** @brief Add a new sample.
6261       *       *
# Line 3185  namespace { Line 6295  namespace {
6295          if (iter == pSamples->end()) throw gig::Exception("Could not delete sample, could not find given sample");          if (iter == pSamples->end()) throw gig::Exception("Could not delete sample, could not find given sample");
6296          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
6297          pSamples->erase(iter);          pSamples->erase(iter);
6298            pSample->DeleteChunks();
6299          delete pSample;          delete pSample;
6300    
6301            SampleList::iterator tmp = SamplesIterator;
6302          // remove all references to the sample          // remove all references to the sample
6303          for (Instrument* instrument = GetFirstInstrument() ; instrument ;          for (Instrument* instrument = GetFirstInstrument() ; instrument ;
6304               instrument = GetNextInstrument()) {               instrument = GetNextInstrument()) {
# Line 3201  namespace { Line 6313  namespace {
6313                  }                  }
6314              }              }
6315          }          }
6316            SamplesIterator = tmp; // restore iterator
6317      }      }
6318    
6319      void File::LoadSamples() {      void File::LoadSamples() {
# Line 3220  namespace { Line 6333  namespace {
6333          int iSampleIndex  = 0;          int iSampleIndex  = 0;
6334          int iTotalSamples = WavePoolCount;          int iTotalSamples = WavePoolCount;
6335    
6336          // check if samples should be loaded from extension files          // just for assembling path of optional extension files to be read
6337          int lastFileNo = 0;          const std::string folder = parentPath(pRIFF->GetFileName());
6338          for (int i = 0 ; i < WavePoolCount ; i++) {          const std::string baseName = pathWithoutExtension(pRIFF->GetFileName());
6339              if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];  
6340          }          // the main gig file and the extension files (.gx01, ... , .gx98) may
6341          String name(pRIFF->GetFileName());          // contain wave data (wave pool)
6342          int nameLen = name.length();          std::vector<RIFF::File*> poolFiles;
6343          char suffix[6];          poolFiles.push_back(pRIFF);
6344          if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;  
6345            // get info about all extension files
6346          for (int fileNo = 0 ; ; ) {          RIFF::Chunk* ckXfil = pRIFF->GetSubChunk(CHUNK_ID_XFIL);
6347            if (ckXfil) { // there are extension files (.gx01, ... , .gx98) ...
6348                const uint32_t n = ckXfil->ReadInt32();
6349                for (int i = 0; i < n; i++) {
6350                    // read the filename and load the extension file
6351                    std::string name;
6352                    ckXfil->ReadString(name, 128);
6353                    std::string path = concatPath(folder, name);
6354                    RIFF::File* pExtFile = new RIFF::File(path);
6355                    // check that the dlsids match
6356                    RIFF::Chunk* ckDLSID = pExtFile->GetSubChunk(CHUNK_ID_DLID);
6357                    if (ckDLSID) {
6358                        ::DLS::dlsid_t idExpected;
6359                        idExpected.ulData1 = ckXfil->ReadInt32();
6360                        idExpected.usData2 = ckXfil->ReadInt16();
6361                        idExpected.usData3 = ckXfil->ReadInt16();
6362                        ckXfil->Read(idExpected.abData, 8, 1);
6363                        ::DLS::dlsid_t idFound;
6364                        ckDLSID->Read(&idFound.ulData1, 1, 4);
6365                        ckDLSID->Read(&idFound.usData2, 1, 2);
6366                        ckDLSID->Read(&idFound.usData3, 1, 2);
6367                        ckDLSID->Read(idFound.abData, 8, 1);
6368                        if (memcmp(&idExpected, &idFound, 16) != 0)
6369                            throw gig::Exception("dlsid mismatch for extension file: %s", path.c_str());
6370                    }
6371                    poolFiles.push_back(pExtFile);
6372                    ExtensionFiles.push_back(pExtFile);
6373                }
6374            }
6375    
6376            // check if a .gx99 (GigaPulse) file exists
6377            RIFF::Chunk* ckDoxf = pRIFF->GetSubChunk(CHUNK_ID_DOXF);
6378            if (ckDoxf) { // there is a .gx99 (GigaPulse) file ...
6379                std::string path = baseName + ".gx99";
6380                RIFF::File* pExtFile = new RIFF::File(path);
6381    
6382                // skip unused int and filename
6383                ckDoxf->SetPos(132, RIFF::stream_curpos);
6384    
6385                // check that the dlsids match
6386                RIFF::Chunk* ckDLSID = pExtFile->GetSubChunk(CHUNK_ID_DLID);
6387                if (ckDLSID) {
6388                    ::DLS::dlsid_t idExpected;
6389                    idExpected.ulData1 = ckDoxf->ReadInt32();
6390                    idExpected.usData2 = ckDoxf->ReadInt16();
6391                    idExpected.usData3 = ckDoxf->ReadInt16();
6392                    ckDoxf->Read(idExpected.abData, 8, 1);
6393                    ::DLS::dlsid_t idFound;
6394                    ckDLSID->Read(&idFound.ulData1, 1, 4);
6395                    ckDLSID->Read(&idFound.usData2, 1, 2);
6396                    ckDLSID->Read(&idFound.usData3, 1, 2);
6397                    ckDLSID->Read(idFound.abData, 8, 1);
6398                    if (memcmp(&idExpected, &idFound, 16) != 0)
6399                        throw gig::Exception("dlsid mismatch for GigaPulse file: %s", path.c_str());
6400                }
6401                poolFiles.push_back(pExtFile);
6402                ExtensionFiles.push_back(pExtFile);
6403            }
6404    
6405            // load samples from extension files (if required)
6406            for (int i = 0; i < poolFiles.size(); i++) {
6407                RIFF::File* file = poolFiles[i];
6408              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
6409              if (wvpl) {              if (wvpl) {
6410                  unsigned long wvplFileOffset = wvpl->GetFilePos();                  file_offset_t wvplFileOffset = wvpl->GetFilePos() -
6411                                                   wvpl->GetPos(); // should be zero, but just to be sure
6412                  RIFF::List* wave = wvpl->GetFirstSubList();                  RIFF::List* wave = wvpl->GetFirstSubList();
6413                  while (wave) {                  while (wave) {
6414                      if (wave->GetListType() == LIST_TYPE_WAVE) {                      if (wave->GetListType() == LIST_TYPE_WAVE) {
6415                          // notify current progress                          // notify current progress
6416                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;                          if (pProgress) {
6417                          __notify_progress(pProgress, subprogress);                              const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
6418                                __notify_progress(pProgress, subprogress);
6419                            }
6420    
6421                          unsigned long waveFileOffset = wave->GetFilePos();                          file_offset_t waveFileOffset = wave->GetFilePos();
6422                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, i, iSampleIndex));
6423    
6424                          iSampleIndex++;                          iSampleIndex++;
6425                      }                      }
6426                      wave = wvpl->GetNextSubList();                      wave = wvpl->GetNextSubList();
6427                  }                  }
6428                }
                 if (fileNo == lastFileNo) break;  
   
                 // open extension file (*.gx01, *.gx02, ...)  
                 fileNo++;  
                 sprintf(suffix, ".gx%02d", fileNo);  
                 name.replace(nameLen, 5, suffix);  
                 file = new RIFF::File(name);  
                 ExtensionFiles.push_back(file);  
             } else break;  
6429          }          }
6430    
6431          __notify_progress(pProgress, 1.0); // notify done          if (pProgress)
6432                __notify_progress(pProgress, 1.0); // notify done
6433      }      }
6434    
6435      Instrument* File::GetFirstInstrument() {      Instrument* File::GetFirstInstrument() {
# Line 3277  namespace { Line 6446  namespace {
6446      }      }
6447    
6448      /**      /**
6449         * Returns the total amount of instruments of this gig file.
6450         *
6451         * Note that this method might block for a long time in case it is required
6452         * to load the instruments info for the first time.
6453         *
6454         * @returns total amount of instruments
6455         */
6456        size_t File::CountInstruments() {
6457            if (!pInstruments) LoadInstruments();
6458            if (!pInstruments) return 0;
6459            return pInstruments->size();
6460        }
6461    
6462        /**
6463       * Returns the instrument with the given index.       * Returns the instrument with the given index.
6464       *       *
6465       * @param index     - number of the sought instrument (0..n)       * @param index     - number of the sought instrument (0..n)
# Line 3287  namespace { Line 6470  namespace {
6470          if (!pInstruments) {          if (!pInstruments) {
6471              // TODO: hack - we simply load ALL samples here, it would have been done in the Region constructor anyway (ATM)              // TODO: hack - we simply load ALL samples here, it would have been done in the Region constructor anyway (ATM)
6472    
6473              // sample loading subtask              if (pProgress) {
6474              progress_t subprogress;                  // sample loading subtask
6475              __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask                  progress_t subprogress;
6476              __notify_progress(&subprogress, 0.0f);                  __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
6477              GetFirstSample(&subprogress); // now force all samples to be loaded                  __notify_progress(&subprogress, 0.0f);
6478              __notify_progress(&subprogress, 1.0f);                  if (GetAutoLoad())
6479                        GetFirstSample(&subprogress); // now force all samples to be loaded
6480              // instrument loading subtask                  __notify_progress(&subprogress, 1.0f);
6481              if (pProgress && pProgress->callback) {  
6482                  subprogress.__range_min = subprogress.__range_max;                  // instrument loading subtask
6483                  subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask                  if (pProgress->callback) {
6484              }                      subprogress.__range_min = subprogress.__range_max;
6485              __notify_progress(&subprogress, 0.0f);                      subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask
6486              LoadInstruments(&subprogress);                  }
6487              __notify_progress(&subprogress, 1.0f);                  __notify_progress(&subprogress, 0.0f);
6488                    LoadInstruments(&subprogress);
6489                    __notify_progress(&subprogress, 1.0f);
6490                } else {
6491                    // sample loading subtask
6492                    if (GetAutoLoad())
6493                        GetFirstSample(); // now force all samples to be loaded
6494    
6495                    // instrument loading subtask
6496                    LoadInstruments();
6497                }
6498          }          }
6499          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
6500          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
# Line 3340  namespace { Line 6533  namespace {
6533         pInstruments->push_back(pInstrument);         pInstruments->push_back(pInstrument);
6534         return pInstrument;         return pInstrument;
6535      }      }
6536        
6537        /** @brief Add a duplicate of an existing instrument.
6538         *
6539         * Duplicates the instrument definition given by @a orig and adds it
6540         * to this file. This allows in an instrument editor application to
6541         * easily create variations of an instrument, which will be stored in
6542         * the same .gig file, sharing i.e. the same samples.
6543         *
6544         * Note that all sample pointers referenced by @a orig are simply copied as
6545         * memory address. Thus the respective samples are shared, not duplicated!
6546         *
6547         * You have to call Save() to make this persistent to the file.
6548         *
6549         * @param orig - original instrument to be copied
6550         * @returns duplicated copy of the given instrument
6551         */
6552        Instrument* File::AddDuplicateInstrument(const Instrument* orig) {
6553            Instrument* instr = AddInstrument();
6554            instr->CopyAssign(orig);
6555            return instr;
6556        }
6557        
6558        /** @brief Add content of another existing file.
6559         *
6560         * Duplicates the samples, groups and instruments of the original file
6561         * given by @a pFile and adds them to @c this File. In case @c this File is
6562         * a new one that you haven't saved before, then you have to call
6563         * SetFileName() before calling AddContentOf(), because this method will
6564         * automatically save this file during operation, which is required for
6565         * writing the sample waveform data by disk streaming.
6566         *
6567         * @param pFile - original file whose's content shall be copied from
6568         */
6569        void File::AddContentOf(File* pFile) {
6570            static int iCallCount = -1;
6571            iCallCount++;
6572            std::map<Group*,Group*> mGroups;
6573            std::map<Sample*,Sample*> mSamples;
6574            
6575            // clone sample groups
6576            for (int i = 0; pFile->GetGroup(i); ++i) {
6577                Group* g = AddGroup();
6578                g->Name =
6579                    "COPY" + ToString(iCallCount) + "_" + pFile->GetGroup(i)->Name;
6580                mGroups[pFile->GetGroup(i)] = g;
6581            }
6582            
6583            // clone samples (not waveform data here yet)
6584            for (int i = 0; pFile->GetSample(i); ++i) {
6585                Sample* s = AddSample();
6586                s->CopyAssignMeta(pFile->GetSample(i));
6587                mGroups[pFile->GetSample(i)->GetGroup()]->AddSample(s);
6588                mSamples[pFile->GetSample(i)] = s;
6589            }
6590    
6591            // clone script groups and their scripts
6592            for (int iGroup = 0; pFile->GetScriptGroup(iGroup); ++iGroup) {
6593                ScriptGroup* sg = pFile->GetScriptGroup(iGroup);
6594                ScriptGroup* dg = AddScriptGroup();
6595                dg->Name = "COPY" + ToString(iCallCount) + "_" + sg->Name;
6596                for (int iScript = 0; sg->GetScript(iScript); ++iScript) {
6597                    Script* ss = sg->GetScript(iScript);
6598                    Script* ds = dg->AddScript();
6599                    ds->CopyAssign(ss);
6600                }
6601            }
6602    
6603            //BUG: For some reason this method only works with this additional
6604            //     Save() call in between here.
6605            //
6606            // Important: The correct one of the 2 Save() methods has to be called
6607            // here, depending on whether the file is completely new or has been
6608            // saved to disk already, otherwise it will result in data corruption.
6609            if (pRIFF->IsNew())
6610                Save(GetFileName());
6611            else
6612                Save();
6613            
6614            // clone instruments
6615            // (passing the crosslink table here for the cloned samples)
6616            for (int i = 0; pFile->GetInstrument(i); ++i) {
6617                Instrument* instr = AddInstrument();
6618                instr->CopyAssign(pFile->GetInstrument(i), &mSamples);
6619            }
6620            
6621            // Mandatory: file needs to be saved to disk at this point, so this
6622            // file has the correct size and data layout for writing the samples'
6623            // waveform data to disk.
6624            Save();
6625            
6626            // clone samples' waveform data
6627            // (using direct read & write disk streaming)
6628            for (int i = 0; pFile->GetSample(i); ++i) {
6629                mSamples[pFile->GetSample(i)]->CopyAssignWave(pFile->GetSample(i));
6630            }
6631        }
6632    
6633      /** @brief Delete an instrument.      /** @brief Delete an instrument.
6634       *       *
# Line 3354  namespace { Line 6643  namespace {
6643          InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);          InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);
6644          if (iter == pInstruments->end()) throw gig::Exception("Could not delete instrument, could not find given instrument");          if (iter == pInstruments->end()) throw gig::Exception("Could not delete instrument, could not find given instrument");
6645          pInstruments->erase(iter);          pInstruments->erase(iter);
6646            pInstrument->DeleteChunks();
6647          delete pInstrument;          delete pInstrument;
6648      }      }
6649    
# Line 3369  namespace { Line 6659  namespace {
6659              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();
6660              while (lstInstr) {              while (lstInstr) {
6661                  if (lstInstr->GetListType() == LIST_TYPE_INS) {                  if (lstInstr->GetListType() == LIST_TYPE_INS) {
6662                      // notify current progress                      if (pProgress) {
6663                      const float localProgress = (float) iInstrumentIndex / (float) Instruments;                          // notify current progress
6664                      __notify_progress(pProgress, localProgress);                          const float localProgress = (float) iInstrumentIndex / (float) Instruments;
6665                            __notify_progress(pProgress, localProgress);
                     // divide local progress into subprogress for loading current Instrument  
                     progress_t subprogress;  
                     __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);  
6666    
6667                      pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));                          // divide local progress into subprogress for loading current Instrument
6668                            progress_t subprogress;
6669                            __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
6670    
6671                            pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
6672                        } else {
6673                            pInstruments->push_back(new Instrument(this, lstInstr));
6674                        }
6675    
6676                      iInstrumentIndex++;                      iInstrumentIndex++;
6677                  }                  }
6678                  lstInstr = lstInstruments->GetNextSubList();                  lstInstr = lstInstruments->GetNextSubList();
6679              }              }
6680              __notify_progress(pProgress, 1.0); // notify done              if (pProgress)
6681                    __notify_progress(pProgress, 1.0); // notify done
6682          }          }
6683      }      }
6684    
# Line 3395  namespace { Line 6690  namespace {
6690          if (!_3crc) return;          if (!_3crc) return;
6691    
6692          // get the index of the sample          // get the index of the sample
6693          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;  
             }  
         }  
6694          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");
6695    
6696          // write the CRC-32 checksum to disk          // write the CRC-32 checksum to disk
6697          _3crc->SetPos(iWaveIndex * 8);          _3crc->SetPos(iWaveIndex * 8);
6698          uint32_t tmp = 1;          uint32_t one = 1;
6699          _3crc->WriteUint32(&tmp); // unknown, always 1?          _3crc->WriteUint32(&one); // always 1
6700          _3crc->WriteUint32(&crc);          _3crc->WriteUint32(&crc);
6701      }      }
6702    
6703        uint32_t File::GetSampleChecksum(Sample* pSample) {
6704            // get the index of the sample
6705            int iWaveIndex = GetWaveTableIndexOf(pSample);
6706            if (iWaveIndex < 0) throw gig::Exception("Could not retrieve reference crc of sample, could not resolve sample's wave table index");
6707    
6708            return GetSampleChecksumByIndex(iWaveIndex);
6709        }
6710    
6711        uint32_t File::GetSampleChecksumByIndex(int index) {
6712            if (index < 0) throw gig::Exception("Could not retrieve reference crc of sample, invalid wave pool index of sample");
6713    
6714            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6715            if (!_3crc) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
6716            uint8_t* pData = (uint8_t*) _3crc->LoadChunkData();
6717            if (!pData) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
6718    
6719            // read the CRC-32 checksum directly from disk
6720            size_t pos = index * 8;
6721            if (pos + 8 > _3crc->GetNewSize())
6722                throw gig::Exception("Could not retrieve reference crc of sample, could not seek to required position in crc chunk");
6723    
6724            uint32_t one = load32(&pData[pos]); // always 1
6725            if (one != 1)
6726                throw gig::Exception("Could not retrieve reference crc of sample, because reference checksum table is damaged");
6727    
6728            return load32(&pData[pos+4]);
6729        }
6730    
6731        int File::GetWaveTableIndexOf(gig::Sample* pSample) {
6732            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
6733            File::SampleList::iterator iter = pSamples->begin();
6734            File::SampleList::iterator end  = pSamples->end();
6735            for (int index = 0; iter != end; ++iter, ++index)
6736                if (*iter == pSample)
6737                    return index;
6738            return -1;
6739        }
6740    
6741        /**
6742         * Checks whether the file's "3CRC" chunk was damaged. This chunk contains
6743         * the CRC32 check sums of all samples' raw wave data.
6744         *
6745         * @return true if 3CRC chunk is OK, or false if 3CRC chunk is damaged
6746         */
6747        bool File::VerifySampleChecksumTable() {
6748            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6749            if (!_3crc) return false;
6750            if (_3crc->GetNewSize() <= 0) return false;
6751            if (_3crc->GetNewSize() % 8) return false;
6752            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
6753            if (_3crc->GetNewSize() != pSamples->size() * 8) return false;
6754    
6755            const file_offset_t n = _3crc->GetNewSize() / 8;
6756    
6757            uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6758            if (!pData) return false;
6759    
6760            for (file_offset_t i = 0; i < n; ++i) {
6761                uint32_t one = pData[i*2];
6762                if (one != 1) return false;
6763            }
6764    
6765            return true;
6766        }
6767    
6768        /**
6769         * Recalculates CRC32 checksums for all samples and rebuilds this gig
6770         * file's checksum table with those new checksums. This might usually
6771         * just be necessary if the checksum table was damaged.
6772         *
6773         * @e IMPORTANT: The current implementation of this method only works
6774         * with files that have not been modified since it was loaded, because
6775         * it expects that no externally caused file structure changes are
6776         * required!
6777         *
6778         * Due to the expectation above, this method is currently protected
6779         * and actually only used by the command line tool "gigdump" yet.
6780         *
6781         * @returns true if Save() is required to be called after this call,
6782         *          false if no further action is required
6783         */
6784        bool File::RebuildSampleChecksumTable() {
6785            // make sure sample chunks were scanned
6786            if (!pSamples) GetFirstSample();
6787    
6788            bool bRequiresSave = false;
6789    
6790            // make sure "3CRC" chunk exists with required size
6791            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6792            if (!_3crc) {
6793                _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
6794                // the order of einf and 3crc is not the same in v2 and v3
6795                RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
6796                if (einf && pVersion && pVersion->major > 2) pRIFF->MoveSubChunk(_3crc, einf);
6797                bRequiresSave = true;
6798            } else if (_3crc->GetNewSize() != pSamples->size() * 8) {
6799                _3crc->Resize(pSamples->size() * 8);
6800                bRequiresSave = true;
6801            }
6802    
6803            if (bRequiresSave) { // refill CRC table for all samples in RAM ...
6804                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6805                {
6806                    File::SampleList::iterator iter = pSamples->begin();
6807                    File::SampleList::iterator end  = pSamples->end();
6808                    for (; iter != end; ++iter) {
6809                        gig::Sample* pSample = (gig::Sample*) *iter;
6810                        int index = GetWaveTableIndexOf(pSample);
6811                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6812                        pData[index*2]   = 1; // always 1
6813                        pData[index*2+1] = pSample->CalculateWaveDataChecksum();
6814                    }
6815                }
6816            } else { // no file structure changes necessary, so directly write to disk and we are done ...
6817                // make sure file is in write mode
6818                pRIFF->SetMode(RIFF::stream_mode_read_write);
6819                {
6820                    File::SampleList::iterator iter = pSamples->begin();
6821                    File::SampleList::iterator end  = pSamples->end();
6822                    for (; iter != end; ++iter) {
6823                        gig::Sample* pSample = (gig::Sample*) *iter;
6824                        int index = GetWaveTableIndexOf(pSample);
6825                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6826                        pSample->crc  = pSample->CalculateWaveDataChecksum();
6827                        SetSampleChecksum(pSample, pSample->crc);
6828                    }
6829                }
6830            }
6831    
6832            return bRequiresSave;
6833        }
6834    
6835      Group* File::GetFirstGroup() {      Group* File::GetFirstGroup() {
6836          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6837          // there must always be at least one group          // there must always be at least one group
# Line 3442  namespace { Line 6861  namespace {
6861          return NULL;          return NULL;
6862      }      }
6863    
6864        /**
6865         * Returns the group with the given group name.
6866         *
6867         * Note: group names don't have to be unique in the gig format! So there
6868         * can be multiple groups with the same name. This method will simply
6869         * return the first group found with the given name.
6870         *
6871         * @param name - name of the sought group
6872         * @returns sought group or NULL if there's no group with that name
6873         */
6874        Group* File::GetGroup(String name) {
6875            if (!pGroups) LoadGroups();
6876            GroupsIterator = pGroups->begin();
6877            for (uint i = 0; GroupsIterator != pGroups->end(); ++GroupsIterator, ++i)
6878                if ((*GroupsIterator)->Name == name) return *GroupsIterator;
6879            return NULL;
6880        }
6881    
6882      Group* File::AddGroup() {      Group* File::AddGroup() {
6883          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6884          // there must always be at least one group          // there must always be at least one group
# Line 3471  namespace { Line 6908  namespace {
6908          }          }
6909          // now delete this group object          // now delete this group object
6910          pGroups->erase(iter);          pGroups->erase(iter);
6911            pGroup->DeleteChunks();
6912          delete pGroup;          delete pGroup;
6913      }      }
6914    
# Line 3492  namespace { Line 6930  namespace {
6930          // move all members of this group to another group          // move all members of this group to another group
6931          pGroup->MoveAll();          pGroup->MoveAll();
6932          pGroups->erase(iter);          pGroups->erase(iter);
6933            pGroup->DeleteChunks();
6934          delete pGroup;          delete pGroup;
6935      }      }
6936    
# Line 3505  namespace { Line 6944  namespace {
6944                  RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();                  RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();
6945                  while (ck) {                  while (ck) {
6946                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {
6947                          if (pVersion && pVersion->major == 3 &&                          if (pVersion && pVersion->major > 2 &&
6948                              strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;                              strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;
6949    
6950                          pGroups->push_back(new Group(this, ck));                          pGroups->push_back(new Group(this, ck));
# Line 3522  namespace { Line 6961  namespace {
6961          }          }
6962      }      }
6963    
6964        /** @brief Get instrument script group (by index).
6965         *
6966         * Returns the real-time instrument script group with the given index.
6967         *
6968         * @param index - number of the sought group (0..n)
6969         * @returns sought script group or NULL if there's no such group
6970         */
6971        ScriptGroup* File::GetScriptGroup(uint index) {
6972            if (!pScriptGroups) LoadScriptGroups();
6973            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
6974            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
6975                if (i == index) return *it;
6976            return NULL;
6977        }
6978    
6979        /** @brief Get instrument script group (by name).
6980         *
6981         * Returns the first real-time instrument script group found with the given
6982         * group name. Note that group names may not necessarily be unique.
6983         *
6984         * @param name - name of the sought script group
6985         * @returns sought script group or NULL if there's no such group
6986         */
6987        ScriptGroup* File::GetScriptGroup(const String& name) {
6988            if (!pScriptGroups) LoadScriptGroups();
6989            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
6990            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
6991                if ((*it)->Name == name) return *it;
6992            return NULL;
6993        }
6994    
6995        /** @brief Add new instrument script group.
6996         *
6997         * Adds a new, empty real-time instrument script group to the file.
6998         *
6999         * You have to call Save() to make this persistent to the file.
7000         *
7001         * @return new empty script group
7002         */
7003        ScriptGroup* File::AddScriptGroup() {
7004            if (!pScriptGroups) LoadScriptGroups();
7005            ScriptGroup* pScriptGroup = new ScriptGroup(this, NULL);
7006            pScriptGroups->push_back(pScriptGroup);
7007            return pScriptGroup;
7008        }
7009    
7010        /** @brief Delete an instrument script group.
7011         *
7012         * This will delete the given real-time instrument script group and all its
7013         * instrument scripts it contains. References inside instruments that are
7014         * using the deleted scripts will be removed from the respective instruments
7015         * accordingly.
7016         *
7017         * You have to call Save() to make this persistent to the file.
7018         *
7019         * @param pScriptGroup - script group to delete
7020         * @throws gig::Exception if given script group could not be found
7021         */
7022        void File::DeleteScriptGroup(ScriptGroup* pScriptGroup) {
7023            if (!pScriptGroups) LoadScriptGroups();
7024            std::list<ScriptGroup*>::iterator iter =
7025                find(pScriptGroups->begin(), pScriptGroups->end(), pScriptGroup);
7026            if (iter == pScriptGroups->end())
7027                throw gig::Exception("Could not delete script group, could not find given script group");
7028            pScriptGroups->erase(iter);
7029            for (int i = 0; pScriptGroup->GetScript(i); ++i)
7030                pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));
7031            if (pScriptGroup->pList)
7032                pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);
7033            pScriptGroup->DeleteChunks();
7034            delete pScriptGroup;
7035        }
7036    
7037        void File::LoadScriptGroups() {
7038            if (pScriptGroups) return;
7039            pScriptGroups = new std::list<ScriptGroup*>;
7040            RIFF::List* lstLS = pRIFF->GetSubList(LIST_TYPE_3LS);
7041            if (lstLS) {
7042                for (RIFF::List* lst = lstLS->GetFirstSubList(); lst;
7043                     lst = lstLS->GetNextSubList())
7044                {
7045                    if (lst->GetListType() == LIST_TYPE_RTIS) {
7046                        pScriptGroups->push_back(new ScriptGroup(this, lst));
7047                    }
7048                }
7049            }
7050        }
7051    
7052      /**      /**
7053       * Apply all the gig file's current instruments, samples, groups and settings       * Apply all the gig file's current instruments, samples, groups and settings
7054       * 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 3530  namespace { Line 7057  namespace {
7057       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
7058       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
7059       *       *
7060         * @param pProgress - callback function for progress notification
7061       * @throws Exception - on errors       * @throws Exception - on errors
7062       */       */
7063      void File::UpdateChunks() {      void File::UpdateChunks(progress_t* pProgress) {
7064          bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;          bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;
7065    
7066          b64BitWavePoolOffsets = pVersion && pVersion->major == 3;          // update own gig format extension chunks
7067            // (not part of the GigaStudio 4 format)
7068            RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);
7069            if (!lst3LS) {
7070                lst3LS = pRIFF->AddSubList(LIST_TYPE_3LS);
7071            }
7072            // Make sure <3LS > chunk is placed before <ptbl> chunk. The precise
7073            // location of <3LS > is irrelevant, however it should be located
7074            // before  the actual wave data
7075            RIFF::Chunk* ckPTBL = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
7076            pRIFF->MoveSubChunk(lst3LS, ckPTBL);
7077    
7078            // This must be performed before writing the chunks for instruments,
7079            // because the instruments' script slots will write the file offsets
7080            // of the respective instrument script chunk as reference.
7081            if (pScriptGroups) {
7082                // Update instrument script (group) chunks.
7083                for (std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
7084                     it != pScriptGroups->end(); ++it)
7085                {
7086                    (*it)->UpdateChunks(pProgress);
7087                }
7088            }
7089    
7090            // in case no libgig custom format data was added, then remove the
7091            // custom "3LS " chunk again
7092            if (!lst3LS->CountSubChunks()) {
7093                pRIFF->DeleteSubChunk(lst3LS);
7094                lst3LS = NULL;
7095            }
7096    
7097          // first update base class's chunks          // first update base class's chunks
7098          DLS::File::UpdateChunks();          DLS::File::UpdateChunks(pProgress);
7099    
7100          if (newFile) {          if (newFile) {
7101              // INFO was added by Resource::UpdateChunks - make sure it              // INFO was added by Resource::UpdateChunks - make sure it
# Line 3552  namespace { Line 7109  namespace {
7109    
7110          // update group's chunks          // update group's chunks
7111          if (pGroups) {          if (pGroups) {
7112              std::list<Group*>::iterator iter = pGroups->begin();              // make sure '3gri' and '3gnl' list chunks exist
7113              std::list<Group*>::iterator end  = pGroups->end();              // (before updating the Group chunks)
7114              for (; iter != end; ++iter) {              RIFF::List* _3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
7115                  (*iter)->UpdateChunks();              if (!_3gri) {
7116                    _3gri = pRIFF->AddSubList(LIST_TYPE_3GRI);
7117                    pRIFF->MoveSubChunk(_3gri, pRIFF->GetSubChunk(CHUNK_ID_PTBL));
7118              }              }
7119                RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
7120                if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
7121    
7122              // v3: make sure the file has 128 3gnm chunks              // v3: make sure the file has 128 3gnm chunks
7123              if (pVersion && pVersion->major == 3) {              // (before updating the Group chunks)
7124                  RIFF::List* _3gnl = pRIFF->GetSubList(LIST_TYPE_3GRI)->GetSubList(LIST_TYPE_3GNL);              if (pVersion && pVersion->major > 2) {
7125                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
7126                  for (int i = 0 ; i < 128 ; i++) {                  for (int i = 0 ; i < 128 ; i++) {
7127                      if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);                      // create 128 empty placeholder strings which will either
7128                        // be filled by Group::UpdateChunks below or left empty.
7129                        ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
7130                      if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();                      if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();
7131                  }                  }
7132              }              }
7133    
7134                std::list<Group*>::iterator iter = pGroups->begin();
7135                std::list<Group*>::iterator end  = pGroups->end();
7136                for (; iter != end; ++iter) {
7137                    (*iter)->UpdateChunks(pProgress);
7138                }
7139          }          }
7140    
7141          // update einf chunk          // update einf chunk
# Line 3585  namespace { Line 7154  namespace {
7154          // Note that there are several fields with unknown use. These          // Note that there are several fields with unknown use. These
7155          // are set to zero.          // are set to zero.
7156    
7157          int sublen = pSamples->size() / 8 + 49;          int sublen = int(pSamples->size() / 8 + 49);
7158          int einfSize = (Instruments + 1) * sublen;          int einfSize = (Instruments + 1) * sublen;
7159    
7160          RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);          RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
# Line 3658  namespace { Line 7227  namespace {
7227                  store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);                  store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);
7228                  // next 8 bytes unknown                  // next 8 bytes unknown
7229                  store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);                  store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);
7230                  store32(&pData[(instrumentIdx + 1) * sublen + 40], pSamples->size());                  store32(&pData[(instrumentIdx + 1) * sublen + 40], (uint32_t) pSamples->size());
7231                  // next 4 bytes unknown                  // next 4 bytes unknown
7232    
7233                  totnbregions += instrument->Regions;                  totnbregions += instrument->Regions;
# Line 3676  namespace { Line 7245  namespace {
7245              store32(&pData[24], totnbloops);              store32(&pData[24], totnbloops);
7246              // next 8 bytes unknown              // next 8 bytes unknown
7247              // next 4 bytes unknown, not always 0              // next 4 bytes unknown, not always 0
7248              store32(&pData[40], pSamples->size());              store32(&pData[40], (uint32_t) pSamples->size());
7249              // next 4 bytes unknown              // next 4 bytes unknown
7250          }          }
7251    
7252          // update 3crc chunk          // update 3crc chunk
7253    
7254          // The 3crc chunk contains CRC-32 checksums for the          // The 3crc chunk contains CRC-32 checksums for the
7255          // samples. The actual checksum values will be filled in          // samples. When saving a gig file to disk, we first update the 3CRC
7256          // later, by Sample::Write.          // chunk here (in RAM) with the old crc values which we read from the
7257            // 3CRC chunk when we opened the file (available with gig::Sample::crc
7258            // member variable). This step is required, because samples might have
7259            // been deleted by the user since the file was opened, which in turn
7260            // changes the order of the (i.e. old) checksums within the 3crc chunk.
7261            // If a sample was conciously modified by the user (that is if
7262            // Sample::Write() was called later on) then Sample::Write() will just
7263            // update the respective individual checksum(s) directly on disk and
7264            // leaves all other sample checksums untouched.
7265    
7266          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
7267          if (_3crc) {          if (_3crc) {
7268              _3crc->Resize(pSamples->size() * 8);              _3crc->Resize(pSamples->size() * 8);
7269          } else if (newFile) {          } else /*if (newFile)*/ {
7270              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
             _3crc->LoadChunkData();  
   
7271              // 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
7272              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);              if (einf && pVersion && pVersion->major > 2) pRIFF->MoveSubChunk(_3crc, einf);
7273            }
7274            { // must be performed in RAM here ...
7275                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
7276                if (pData) {
7277                    File::SampleList::iterator iter = pSamples->begin();
7278                    File::SampleList::iterator end  = pSamples->end();
7279                    for (int index = 0; iter != end; ++iter, ++index) {
7280                        gig::Sample* pSample = (gig::Sample*) *iter;
7281                        pData[index*2]   = 1; // always 1
7282                        pData[index*2+1] = pSample->crc;
7283                    }
7284                }
7285          }          }
7286      }      }
7287        
7288        void File::UpdateFileOffsets() {
7289            DLS::File::UpdateFileOffsets();
7290    
7291            for (Instrument* instrument = GetFirstInstrument(); instrument;
7292                 instrument = GetNextInstrument())
7293            {
7294                instrument->UpdateScriptFileOffsets();
7295            }
7296        }
7297    
7298        /**
7299         * Enable / disable automatic loading. By default this property is
7300         * enabled and every information is loaded automatically. However
7301         * loading all Regions, DimensionRegions and especially samples might
7302         * take a long time for large .gig files, and sometimes one might only
7303         * be interested in retrieving very superficial informations like the
7304         * amount of instruments and their names. In this case one might disable
7305         * automatic loading to avoid very slow response times.
7306         *
7307         * @e CAUTION: by disabling this property many pointers (i.e. sample
7308         * references) and attributes will have invalid or even undefined
7309         * data! This feature is currently only intended for retrieving very
7310         * superficial information in a very fast way. Don't use it to retrieve
7311         * details like synthesis information or even to modify .gig files!
7312         */
7313        void File::SetAutoLoad(bool b) {
7314            bAutoLoad = b;
7315        }
7316    
7317        /**
7318         * Returns whether automatic loading is enabled.
7319         * @see SetAutoLoad()
7320         */
7321        bool File::GetAutoLoad() {
7322            return bAutoLoad;
7323        }
7324    
7325        /**
7326         * Returns @c true in case this gig File object uses any gig format
7327         * extension, that is e.g. whether any DimensionRegion object currently
7328         * has any setting effective that would require our "LSDE" RIFF chunk to
7329         * be stored to the gig file.
7330         *
7331         * Right now this is a private method. It is considerable though this method
7332         * to become (in slightly modified form) a public API method in future, i.e.
7333         * to allow instrument editors to visualize and/or warn the user of any gig
7334         * format extension being used. See also comments on
7335         * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
7336         * potential public API change in future.
7337         */
7338        bool File::UsesAnyGigFormatExtension() const {
7339            if (!pInstruments) return false;
7340            InstrumentList::iterator iter = pInstruments->begin();
7341            InstrumentList::iterator end  = pInstruments->end();
7342            for (; iter != end; ++iter) {
7343                Instrument* pInstrument = static_cast<gig::Instrument*>(*iter);
7344                if (pInstrument->UsesAnyGigFormatExtension())
7345                    return true;
7346            }
7347            return false;
7348        }
7349    
7350    
7351  // *************** Exception ***************  // *************** Exception ***************
7352  // *  // *
7353    
7354      Exception::Exception(String Message) : DLS::Exception(Message) {      Exception::Exception() : DLS::Exception() {
7355        }
7356    
7357        Exception::Exception(String format, ...) : DLS::Exception() {
7358            va_list arg;
7359            va_start(arg, format);
7360            Message = assemble(format, arg);
7361            va_end(arg);
7362        }
7363    
7364        Exception::Exception(String format, va_list arg) : DLS::Exception() {
7365            Message = assemble(format, arg);
7366      }      }
7367    
7368      void Exception::PrintMessage() {      void Exception::PrintMessage() {

Legend:
Removed from v.1316  
changed lines
  Added in v.3731

  ViewVC Help
Powered by ViewVC