/[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 1158 by schoenebeck, Fri Apr 13 16:41:18 2007 UTC revision 3903 by schoenebeck, Wed May 12 18:31:25 2021 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file access library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-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    // *************** leverage_ctrl_t ***************
323    // *
324    
325        void leverage_ctrl_t::serialize(Serialization::Archive* archive) {
326            SRLZ(type);
327            SRLZ(controller_number);
328        }
329    
330    
331    
332    // *************** crossfade_t ***************
333    // *
334    
335        void crossfade_t::serialize(Serialization::Archive* archive) {
336            SRLZ(in_start);
337            SRLZ(in_end);
338            SRLZ(out_start);
339            SRLZ(out_end);
340        }
341    
342    
343    
344    // *************** eg_opt_t ***************
345    // *
346    
347        eg_opt_t::eg_opt_t() {
348            AttackCancel     = true;
349            AttackHoldCancel = true;
350            Decay1Cancel     = true;
351            Decay2Cancel     = true;
352            ReleaseCancel    = true;
353        }
354    
355        void eg_opt_t::serialize(Serialization::Archive* archive) {
356            SRLZ(AttackCancel);
357            SRLZ(AttackHoldCancel);
358            SRLZ(Decay1Cancel);
359            SRLZ(Decay2Cancel);
360            SRLZ(ReleaseCancel);
361        }
362    
363    
364    
365  // *************** Sample ***************  // *************** Sample ***************
366  // *  // *
367    
368      unsigned int Sample::Instances = 0;      size_t       Sample::Instances = 0;
369      buffer_t     Sample::InternalDecompressionBuffer;      buffer_t     Sample::InternalDecompressionBuffer;
370    
371      /** @brief Constructor.      /** @brief Constructor.
# Line 301  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          pInfo->UseFixedLengthStrings = true;          : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset)
392        {
393            static const DLS::Info::string_length_t fixedStringLengths[] = {
394                { CHUNK_ID_INAM, 64 },
395                { 0, 0 }
396            };
397            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 318  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 338  namespace { Line 445  namespace {
445              Manufacturer  = 0;              Manufacturer  = 0;
446              Product       = 0;              Product       = 0;
447              SamplePeriod  = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);              SamplePeriod  = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
448              MIDIUnityNote = 64;              MIDIUnityNote = 60;
449              FineTune      = 0;              FineTune      = 0;
450                SMPTEFormat   = smpte_format_no_offset;
451              SMPTEOffset   = 0;              SMPTEOffset   = 0;
452              Loops         = 0;              Loops         = 0;
453              LoopID        = 0;              LoopID        = 0;
454                LoopType      = loop_type_normal;
455              LoopStart     = 0;              LoopStart     = 0;
456              LoopEnd       = 0;              LoopEnd       = 0;
457              LoopFraction  = 0;              LoopFraction  = 0;
# Line 362  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 382  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);
580          if (!pCkSmpl) pCkSmpl = pWaveList->AddSubChunk(CHUNK_ID_SMPL, 60);          if (!pCkSmpl) {
581                pCkSmpl = pWaveList->AddSubChunk(CHUNK_ID_SMPL, 60);
582                memset(pCkSmpl->LoadChunkData(), 0, 60);
583            }
584          // update 'smpl' chunk          // update 'smpl' chunk
585          uint8_t* pData = (uint8_t*) pCkSmpl->LoadChunkData();          uint8_t* pData = (uint8_t*) pCkSmpl->LoadChunkData();
586          SamplePeriod = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);          SamplePeriod = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
587          memcpy(&pData[0], &Manufacturer, 4);          store32(&pData[0], Manufacturer);
588          memcpy(&pData[4], &Product, 4);          store32(&pData[4], Product);
589          memcpy(&pData[8], &SamplePeriod, 4);          store32(&pData[8], SamplePeriod);
590          memcpy(&pData[12], &MIDIUnityNote, 4);          store32(&pData[12], MIDIUnityNote);
591          memcpy(&pData[16], &FineTune, 4);          store32(&pData[16], FineTune);
592          memcpy(&pData[20], &SMPTEFormat, 4);          store32(&pData[20], SMPTEFormat);
593          memcpy(&pData[24], &SMPTEOffset, 4);          store32(&pData[24], SMPTEOffset);
594          memcpy(&pData[28], &Loops, 4);          store32(&pData[28], Loops);
595    
596          // we skip 'manufByt' for now (4 bytes)          // we skip 'manufByt' for now (4 bytes)
597    
598          memcpy(&pData[36], &LoopID, 4);          store32(&pData[36], LoopID);
599          memcpy(&pData[40], &LoopType, 4);          store32(&pData[40], LoopType);
600          memcpy(&pData[44], &LoopStart, 4);          store32(&pData[44], LoopStart);
601          memcpy(&pData[48], &LoopEnd, 4);          store32(&pData[48], LoopEnd);
602          memcpy(&pData[52], &LoopFraction, 4);          store32(&pData[52], LoopFraction);
603          memcpy(&pData[56], &LoopPlayCount, 4);          store32(&pData[56], LoopPlayCount);
604    
605          // make sure '3gix' chunk exists          // make sure '3gix' chunk exists
606          pCk3gix = pWaveList->GetSubChunk(CHUNK_ID_3GIX);          pCk3gix = pWaveList->GetSubChunk(CHUNK_ID_3GIX);
# Line 438  namespace { Line 620  namespace {
620          }          }
621          // update '3gix' chunk          // update '3gix' chunk
622          pData = (uint8_t*) pCk3gix->LoadChunkData();          pData = (uint8_t*) pCk3gix->LoadChunkData();
623          memcpy(&pData[0], &iSampleGroup, 2);          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 461  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 480  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 496  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 539  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 598  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 639  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 663  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 697  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 715  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 731  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 770  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 810  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 833  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 860  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 944  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 959  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 982  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 1123  namespace { Line 1316  namespace {
1316       *       *
1317       * Note: there is currently no support for writing compressed samples.       * Note: there is currently no support for writing compressed samples.
1318       *       *
1319         * For 16 bit samples, the data in the source buffer should be
1320         * int16_t (using native endianness). For 24 bit, the buffer
1321         * should contain three bytes per sample, little-endian.
1322         *
1323       * @param pBuffer     - source buffer       * @param pBuffer     - source buffer
1324       * @param SampleCount - number of sample points to write       * @param SampleCount - number of sample points to write
1325       * @throws DLS::Exception if current sample size is too small       * @throws DLS::Exception if current sample size is too small
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          return DLS::Sample::Write(pBuffer, SampleCount);  
1332            // if this is the first write in this sample, reset the
1333            // checksum calculator
1334            if (pCkData->GetPos() == 0) {
1335                __resetCRC(crc);
1336            }
1337            if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");
1338            file_offset_t res;
1339            if (BitDepth == 24) {
1340                res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
1341            } else { // 16 bit
1342                res = Channels == 2 ? pCkData->Write(pBuffer, SampleCount << 1, 2) >> 1
1343                                    : pCkData->Write(pBuffer, SampleCount, 2);
1344            }
1345            __calculateCRC((unsigned char *)pBuffer, SampleCount * FrameSize, crc);
1346    
1347            // if this is the last write, update the checksum chunk in the
1348            // file
1349            if (pCkData->GetPos() == pCkData->GetSize()) {
1350                __finalizeCRC(crc);
1351                File* pFile = static_cast<File*>(GetParent());
1352                pFile->SetSampleChecksum(this, crc);
1353            }
1354            return res;
1355      }      }
1356    
1357      /**      /**
# Line 1150  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 1188  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 1204  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(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(Region* pParent, RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
1497          Instances++;          Instances++;
1498    
1499          pSample = NULL;          pSample = NULL;
1500            pRegion = pParent;
1501    
1502            if (_3ewl->GetSubChunk(CHUNK_ID_WSMP)) memcpy(&Crossfade, &SamplerOptions, 4);
1503            else memset(&Crossfade, 0, 4);
1504    
         memcpy(&Crossfade, &SamplerOptions, 4);  
1505          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;
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 1326  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 1376  namespace { Line 1667  namespace {
1667              LFO1ControlDepth                = 0;              LFO1ControlDepth                = 0;
1668              LFO3ControlDepth                = 0;              LFO3ControlDepth                = 0;
1669              EG1Attack                       = 0.0;              EG1Attack                       = 0.0;
1670              EG1Decay1                       = 0.0;              EG1Decay1                       = 0.005;
1671              EG1Sustain                      = 0;              EG1Sustain                      = 1000;
1672              EG1Release                      = 0.0;              EG1Release                      = 0.3;
1673              EG1Controller.type              = eg1_ctrl_t::type_none;              EG1Controller.type              = eg1_ctrl_t::type_none;
1674              EG1Controller.controller_number = 0;              EG1Controller.controller_number = 0;
1675              EG1ControllerInvert             = false;              EG1ControllerInvert             = false;
# Line 1393  namespace { Line 1684  namespace {
1684              EG2ControllerReleaseInfluence   = 0;              EG2ControllerReleaseInfluence   = 0;
1685              LFO1Frequency                   = 1.0;              LFO1Frequency                   = 1.0;
1686              EG2Attack                       = 0.0;              EG2Attack                       = 0.0;
1687              EG2Decay1                       = 0.0;              EG2Decay1                       = 0.005;
1688              EG2Sustain                      = 0;              EG2Sustain                      = 1000;
1689              EG2Release                      = 0.0;              EG2Release                      = 60;
1690              LFO2ControlDepth                = 0;              LFO2ControlDepth                = 0;
1691              LFO2Frequency                   = 1.0;              LFO2Frequency                   = 1.0;
1692              LFO2InternalDepth               = 0;              LFO2InternalDepth               = 0;
1693              EG1Decay2                       = 0.0;              EG1Decay2                       = 0.0;
1694              EG1InfiniteSustain              = false;              EG1InfiniteSustain              = true;
1695              EG1PreAttack                    = 1000;              EG1PreAttack                    = 0;
1696              EG2Decay2                       = 0.0;              EG2Decay2                       = 0.0;
1697              EG2InfiniteSustain              = false;              EG2InfiniteSustain              = true;
1698              EG2PreAttack                    = 1000;              EG2PreAttack                    = 0;
1699              VelocityResponseCurve           = curve_type_nonlinear;              VelocityResponseCurve           = curve_type_nonlinear;
1700              VelocityResponseDepth           = 3;              VelocityResponseDepth           = 3;
1701              ReleaseVelocityResponseCurve    = curve_type_nonlinear;              ReleaseVelocityResponseCurve    = curve_type_nonlinear;
# Line 1447  namespace { Line 1738  namespace {
1738              VCFVelocityDynamicRange         = 0x04;              VCFVelocityDynamicRange         = 0x04;
1739              VCFVelocityCurve                = curve_type_linear;              VCFVelocityCurve                = curve_type_linear;
1740              VCFType                         = vcf_type_lowpass;              VCFType                         = vcf_type_lowpass;
1741              memset(DimensionUpperLimits, 0, 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);  
1805    
1806          curveType = VCFVelocityCurve;          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1807          depth = VCFVelocityDynamicRange;          VelocityTable = 0;
1808        }
1809    
1810          // even stranger GSt: two of the velocity response curves for      /*
1811          // filter cutoff are not used, instead another special curve       * Constructs a DimensionRegion by copying all parameters from
1812          // is chosen. This curve is not used anywhere else.       * another DimensionRegion
1813          if ((curveType == curve_type_nonlinear && depth == 0) ||       */
1814              (curveType == curve_type_special   && depth == 4)) {      DimensionRegion::DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src) : DLS::Sampler(_3ewl) {
1815              curveType = curve_type_special;          Instances++;
1816              depth = 5;          //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
1818            pParentList = _3ewl; // restore the chunk pointer
1819    
1820            // deep copy of owned structures
1821            if (src.VelocityTable) {
1822                VelocityTable = new uint8_t[128];
1823                for (int k = 0 ; k < 128 ; k++)
1824                    VelocityTable[k] = src.VelocityTable[k];
1825            }
1826            if (src.pSampleLoops) {
1827                pSampleLoops = new DLS::sample_loop_t[src.SampleLoops];
1828                for (int k = 0 ; k < src.SampleLoops ; k++)
1829                    pSampleLoops[k] = src.pSampleLoops[k];
1830          }          }
1831          pVelocityCutoffTable = GetVelocityTable(curveType, depth,      }
1832                                                  VCFCutoffController <= vcf_cutoff_ctrl_none2 ? VCFVelocityScale : 0);      
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));          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
         VelocityTable = 0;  
2003      }      }
2004    
2005      /**      /**
# Line 1491  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) {
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);
2019            uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();
2020            pData[12] = Crossfade.in_start;
2021            pData[13] = Crossfade.in_end;
2022            pData[14] = Crossfade.out_start;
2023            pData[15] = Crossfade.out_end;
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          uint8_t* pData = (uint8_t*) _3ewa->LoadChunkData();              File* pFile = (File*) GetParent()->GetParent()->GetParent();
2029                bool versiongt2 = pFile->pVersion && pFile->pVersion->major > 2;
2030                _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, versiongt2 ? 148 : 140);
2031            }
2032            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->GetSize();          const uint32_t chunksize = (uint32_t) _3ewa->GetNewSize();
2037          memcpy(&pData[0], &chunksize, 4); // 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);
2040          memcpy(&pData[4], &lfo3freq, 4);          store32(&pData[4], lfo3freq);
2041    
2042          const int32_t eg3attack = (int32_t) GIG_EXP_ENCODE(EG3Attack);          const int32_t eg3attack = (int32_t) GIG_EXP_ENCODE(EG3Attack);
2043          memcpy(&pData[8], &eg3attack, 4);          store32(&pData[8], eg3attack);
2044    
2045          // next 2 bytes unknown          // next 2 bytes unknown
2046    
2047          memcpy(&pData[14], &LFO1InternalDepth, 2);          store16(&pData[14], LFO1InternalDepth);
2048    
2049          // next 2 bytes unknown          // next 2 bytes unknown
2050    
2051          memcpy(&pData[18], &LFO3InternalDepth, 2);          store16(&pData[18], LFO3InternalDepth);
2052    
2053          // next 2 bytes unknown          // next 2 bytes unknown
2054    
2055          memcpy(&pData[22], &LFO1ControlDepth, 2);          store16(&pData[22], LFO1ControlDepth);
2056    
2057          // next 2 bytes unknown          // next 2 bytes unknown
2058    
2059          memcpy(&pData[26], &LFO3ControlDepth, 2);          store16(&pData[26], LFO3ControlDepth);
2060    
2061          const int32_t eg1attack = (int32_t) GIG_EXP_ENCODE(EG1Attack);          const int32_t eg1attack = (int32_t) GIG_EXP_ENCODE(EG1Attack);
2062          memcpy(&pData[28], &eg1attack, 4);          store32(&pData[28], eg1attack);
2063    
2064          const int32_t eg1decay1 = (int32_t) GIG_EXP_ENCODE(EG1Decay1);          const int32_t eg1decay1 = (int32_t) GIG_EXP_ENCODE(EG1Decay1);
2065          memcpy(&pData[32], &eg1decay1, 4);          store32(&pData[32], eg1decay1);
2066    
2067          // next 2 bytes unknown          // next 2 bytes unknown
2068    
2069          memcpy(&pData[38], &EG1Sustain, 2);          store16(&pData[38], EG1Sustain);
2070    
2071          const int32_t eg1release = (int32_t) GIG_EXP_ENCODE(EG1Release);          const int32_t eg1release = (int32_t) GIG_EXP_ENCODE(EG1Release);
2072          memcpy(&pData[40], &eg1release, 4);          store32(&pData[40], eg1release);
2073    
2074          const uint8_t eg1ctl = (uint8_t) EncodeLeverageController(EG1Controller);          const uint8_t eg1ctl = (uint8_t) EncodeLeverageController(EG1Controller);
2075          memcpy(&pData[44], &eg1ctl, 1);          pData[44] = eg1ctl;
2076    
2077          const uint8_t eg1ctrloptions =          const uint8_t eg1ctrloptions =
2078              (EG1ControllerInvert) ? 0x01 : 0x00 |              (EG1ControllerInvert ? 0x01 : 0x00) |
2079              GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG1ControllerAttackInfluence) |              GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG1ControllerAttackInfluence) |
2080              GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG1ControllerDecayInfluence) |              GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG1ControllerDecayInfluence) |
2081              GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG1ControllerReleaseInfluence);              GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG1ControllerReleaseInfluence);
2082          memcpy(&pData[45], &eg1ctrloptions, 1);          pData[45] = eg1ctrloptions;
2083    
2084          const uint8_t eg2ctl = (uint8_t) EncodeLeverageController(EG2Controller);          const uint8_t eg2ctl = (uint8_t) EncodeLeverageController(EG2Controller);
2085          memcpy(&pData[46], &eg2ctl, 1);          pData[46] = eg2ctl;
2086    
2087          const uint8_t eg2ctrloptions =          const uint8_t eg2ctrloptions =
2088              (EG2ControllerInvert) ? 0x01 : 0x00 |              (EG2ControllerInvert ? 0x01 : 0x00) |
2089              GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG2ControllerAttackInfluence) |              GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG2ControllerAttackInfluence) |
2090              GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG2ControllerDecayInfluence) |              GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG2ControllerDecayInfluence) |
2091              GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG2ControllerReleaseInfluence);              GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG2ControllerReleaseInfluence);
2092          memcpy(&pData[47], &eg2ctrloptions, 1);          pData[47] = eg2ctrloptions;
2093    
2094          const int32_t lfo1freq = (int32_t) GIG_EXP_ENCODE(LFO1Frequency);          const int32_t lfo1freq = (int32_t) GIG_EXP_ENCODE(LFO1Frequency);
2095          memcpy(&pData[48], &lfo1freq, 4);          store32(&pData[48], lfo1freq);
2096    
2097          const int32_t eg2attack = (int32_t) GIG_EXP_ENCODE(EG2Attack);          const int32_t eg2attack = (int32_t) GIG_EXP_ENCODE(EG2Attack);
2098          memcpy(&pData[52], &eg2attack, 4);          store32(&pData[52], eg2attack);
2099    
2100          const int32_t eg2decay1 = (int32_t) GIG_EXP_ENCODE(EG2Decay1);          const int32_t eg2decay1 = (int32_t) GIG_EXP_ENCODE(EG2Decay1);
2101          memcpy(&pData[56], &eg2decay1, 4);          store32(&pData[56], eg2decay1);
2102    
2103          // next 2 bytes unknown          // next 2 bytes unknown
2104    
2105          memcpy(&pData[62], &EG2Sustain, 2);          store16(&pData[62], EG2Sustain);
2106    
2107          const int32_t eg2release = (int32_t) GIG_EXP_ENCODE(EG2Release);          const int32_t eg2release = (int32_t) GIG_EXP_ENCODE(EG2Release);
2108          memcpy(&pData[64], &eg2release, 4);          store32(&pData[64], eg2release);
2109    
2110          // next 2 bytes unknown          // next 2 bytes unknown
2111    
2112          memcpy(&pData[70], &LFO2ControlDepth, 2);          store16(&pData[70], LFO2ControlDepth);
2113    
2114          const int32_t lfo2freq = (int32_t) GIG_EXP_ENCODE(LFO2Frequency);          const int32_t lfo2freq = (int32_t) GIG_EXP_ENCODE(LFO2Frequency);
2115          memcpy(&pData[72], &lfo2freq, 4);          store32(&pData[72], lfo2freq);
2116    
2117          // next 2 bytes unknown          // next 2 bytes unknown
2118    
2119          memcpy(&pData[78], &LFO2InternalDepth, 2);          store16(&pData[78], LFO2InternalDepth);
2120    
2121          const int32_t eg1decay2 = (int32_t) (EG1InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG1Decay2);          const int32_t eg1decay2 = (int32_t) (EG1InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG1Decay2);
2122          memcpy(&pData[80], &eg1decay2, 4);          store32(&pData[80], eg1decay2);
2123    
2124          // next 2 bytes unknown          // next 2 bytes unknown
2125    
2126          memcpy(&pData[86], &EG1PreAttack, 2);          store16(&pData[86], EG1PreAttack);
2127    
2128          const int32_t eg2decay2 = (int32_t) (EG2InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG2Decay2);          const int32_t eg2decay2 = (int32_t) (EG2InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG2Decay2);
2129          memcpy(&pData[88], &eg2decay2, 4);          store32(&pData[88], eg2decay2);
2130    
2131          // next 2 bytes unknown          // next 2 bytes unknown
2132    
2133          memcpy(&pData[94], &EG2PreAttack, 2);          store16(&pData[94], EG2PreAttack);
2134    
2135          {          {
2136              if (VelocityResponseDepth > 4) throw Exception("VelocityResponseDepth must be between 0 and 4");              if (VelocityResponseDepth > 4) throw Exception("VelocityResponseDepth must be between 0 and 4");
# Line 1618  namespace { Line 2148  namespace {
2148                  default:                  default:
2149                      throw Exception("Could not update DimensionRegion's chunk, unknown VelocityResponseCurve selected");                      throw Exception("Could not update DimensionRegion's chunk, unknown VelocityResponseCurve selected");
2150              }              }
2151              memcpy(&pData[96], &velocityresponse, 1);              pData[96] = velocityresponse;
2152          }          }
2153    
2154          {          {
# Line 1637  namespace { Line 2167  namespace {
2167                  default:                  default:
2168                      throw Exception("Could not update DimensionRegion's chunk, unknown ReleaseVelocityResponseCurve selected");                      throw Exception("Could not update DimensionRegion's chunk, unknown ReleaseVelocityResponseCurve selected");
2169              }              }
2170              memcpy(&pData[97], &releasevelocityresponse, 1);              pData[97] = releasevelocityresponse;
2171          }          }
2172    
2173          memcpy(&pData[98], &VelocityResponseCurveScaling, 1);          pData[98] = VelocityResponseCurveScaling;
2174    
2175          memcpy(&pData[99], &AttenuationControllerThreshold, 1);          pData[99] = AttenuationControllerThreshold;
2176    
2177          // next 4 bytes unknown          // next 4 bytes unknown
2178    
2179          memcpy(&pData[104], &SampleStartOffset, 2);          store16(&pData[104], SampleStartOffset);
2180    
2181          // next 2 bytes unknown          // next 2 bytes unknown
2182    
# Line 1665  namespace { Line 2195  namespace {
2195                  default:                  default:
2196                      throw Exception("Could not update DimensionRegion's chunk, unknown DimensionBypass selected");                      throw Exception("Could not update DimensionRegion's chunk, unknown DimensionBypass selected");
2197              }              }
2198              memcpy(&pData[108], &pitchTrackDimensionBypass, 1);              pData[108] = pitchTrackDimensionBypass;
2199          }          }
2200    
2201          const uint8_t pan = (Pan >= 0) ? Pan : ((-Pan) + 63); // signed 8 bit -> signed 7 bit          const uint8_t pan = (Pan >= 0) ? Pan : ((-Pan) + 63); // signed 8 bit -> signed 7 bit
2202          memcpy(&pData[109], &pan, 1);          pData[109] = pan;
2203    
2204          const uint8_t selfmask = (SelfMask) ? 0x01 : 0x00;          const uint8_t selfmask = (SelfMask) ? 0x01 : 0x00;
2205          memcpy(&pData[110], &selfmask, 1);          pData[110] = selfmask;
2206    
2207          // next byte unknown          // next byte unknown
2208    
# Line 1681  namespace { Line 2211  namespace {
2211              if (LFO3Sync) lfo3ctrl |= 0x20; // bit 5              if (LFO3Sync) lfo3ctrl |= 0x20; // bit 5
2212              if (InvertAttenuationController) lfo3ctrl |= 0x80; // bit 7              if (InvertAttenuationController) lfo3ctrl |= 0x80; // bit 7
2213              if (VCFType == vcf_type_lowpassturbo) lfo3ctrl |= 0x40; // bit 6              if (VCFType == vcf_type_lowpassturbo) lfo3ctrl |= 0x40; // bit 6
2214              memcpy(&pData[112], &lfo3ctrl, 1);              pData[112] = lfo3ctrl;
2215          }          }
2216    
2217          const uint8_t attenctl = EncodeLeverageController(AttenuationController);          const uint8_t attenctl = EncodeLeverageController(AttenuationController);
2218          memcpy(&pData[113], &attenctl, 1);          pData[113] = attenctl;
2219    
2220          {          {
2221              uint8_t lfo2ctrl = LFO2Controller & 0x07; // lower 3 bits              uint8_t lfo2ctrl = LFO2Controller & 0x07; // lower 3 bits
2222              if (LFO2FlipPhase) lfo2ctrl |= 0x80; // bit 7              if (LFO2FlipPhase) lfo2ctrl |= 0x80; // bit 7
2223              if (LFO2Sync)      lfo2ctrl |= 0x20; // bit 5              if (LFO2Sync)      lfo2ctrl |= 0x20; // bit 5
2224              if (VCFResonanceController != vcf_res_ctrl_none) lfo2ctrl |= 0x40; // bit 6              if (VCFResonanceController != vcf_res_ctrl_none) lfo2ctrl |= 0x40; // bit 6
2225              memcpy(&pData[114], &lfo2ctrl, 1);              pData[114] = lfo2ctrl;
2226          }          }
2227    
2228          {          {
# Line 1701  namespace { Line 2231  namespace {
2231              if (LFO1Sync)      lfo1ctrl |= 0x40; // bit 6              if (LFO1Sync)      lfo1ctrl |= 0x40; // bit 6
2232              if (VCFResonanceController != vcf_res_ctrl_none)              if (VCFResonanceController != vcf_res_ctrl_none)
2233                  lfo1ctrl |= GIG_VCF_RESONANCE_CTRL_ENCODE(VCFResonanceController);                  lfo1ctrl |= GIG_VCF_RESONANCE_CTRL_ENCODE(VCFResonanceController);
2234              memcpy(&pData[115], &lfo1ctrl, 1);              pData[115] = lfo1ctrl;
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          memcpy(&pData[116], &eg3depth, 1);          store16(&pData[116], eg3depth);
2240    
2241          // next 2 bytes unknown          // next 2 bytes unknown
2242    
2243          const uint8_t channeloffset = ChannelOffset * 4;          const uint8_t channeloffset = ChannelOffset * 4;
2244          memcpy(&pData[120], &channeloffset, 1);          pData[120] = channeloffset;
2245    
2246          {          {
2247              uint8_t regoptions = 0;              uint8_t regoptions = 0;
2248              if (MSDecode)      regoptions |= 0x01; // bit 0              if (MSDecode)      regoptions |= 0x01; // bit 0
2249              if (SustainDefeat) regoptions |= 0x02; // bit 1              if (SustainDefeat) regoptions |= 0x02; // bit 1
2250              memcpy(&pData[121], &regoptions, 1);              pData[121] = regoptions;
2251          }          }
2252    
2253          // next 2 bytes unknown          // next 2 bytes unknown
2254    
2255          memcpy(&pData[124], &VelocityUpperLimit, 1);          pData[124] = VelocityUpperLimit;
2256    
2257          // next 3 bytes unknown          // next 3 bytes unknown
2258    
2259          memcpy(&pData[128], &ReleaseTriggerDecay, 1);          pData[128] = ReleaseTriggerDecay;
2260    
2261          // next 2 bytes unknown          // next 2 bytes unknown
2262    
2263          const uint8_t eg1hold = (EG1Hold) ? 0x80 : 0x00; // bit 7          const uint8_t eg1hold = (EG1Hold) ? 0x80 : 0x00; // bit 7
2264          memcpy(&pData[131], &eg1hold, 1);          pData[131] = eg1hold;
2265    
2266          const uint8_t vcfcutoff = (VCFEnabled) ? 0x80 : 0x00 |  /* bit 7 */          const uint8_t vcfcutoff = (VCFEnabled ? 0x80 : 0x00) |  /* bit 7 */
2267                                    (VCFCutoff & 0x7f);   /* lower 7 bits */                                    (VCFCutoff & 0x7f);   /* lower 7 bits */
2268          memcpy(&pData[132], &vcfcutoff, 1);          pData[132] = vcfcutoff;
2269    
2270          memcpy(&pData[133], &VCFCutoffController, 1);          pData[133] = VCFCutoffController;
2271    
2272          const uint8_t vcfvelscale = (VCFCutoffControllerInvert) ? 0x80 : 0x00 | /* bit 7 */          const uint8_t vcfvelscale = (VCFCutoffControllerInvert ? 0x80 : 0x00) | /* bit 7 */
2273                                      (VCFVelocityScale & 0x7f); /* lower 7 bits */                                      (VCFVelocityScale & 0x7f); /* lower 7 bits */
2274          memcpy(&pData[134], &vcfvelscale, 1);          pData[134] = vcfvelscale;
2275    
2276          // next byte unknown          // next byte unknown
2277    
2278          const uint8_t vcfresonance = (VCFResonanceDynamic) ? 0x00 : 0x80 | /* bit 7 */          const uint8_t vcfresonance = (VCFResonanceDynamic ? 0x00 : 0x80) | /* bit 7 */
2279                                       (VCFResonance & 0x7f); /* lower 7 bits */                                       (VCFResonance & 0x7f); /* lower 7 bits */
2280          memcpy(&pData[136], &vcfresonance, 1);          pData[136] = vcfresonance;
2281    
2282          const uint8_t vcfbreakpoint = (VCFKeyboardTracking) ? 0x80 : 0x00 | /* bit 7 */          const uint8_t vcfbreakpoint = (VCFKeyboardTracking ? 0x80 : 0x00) | /* bit 7 */
2283                                        (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */                                        (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */
2284          memcpy(&pData[137], &vcfbreakpoint, 1);          pData[137] = vcfbreakpoint;
2285    
2286          const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |          const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 +
2287                                      VCFVelocityCurve * 5;                                      VCFVelocityCurve * 5;
2288          memcpy(&pData[138], &vcfvelocity, 1);          pData[138] = vcfvelocity;
2289    
2290          const uint8_t vcftype = (VCFType == vcf_type_lowpassturbo) ? vcf_type_lowpass : VCFType;          const uint8_t vcftype = (VCFType == vcf_type_lowpassturbo) ? vcf_type_lowpass : VCFType;
2291          memcpy(&pData[139], &vcftype, 1);          pData[139] = vcftype;
2292    
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 1780  namespace { Line 2447  namespace {
2447          return table;          return table;
2448      }      }
2449    
2450        Region* DimensionRegion::GetParent() const {
2451            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 1891  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 1984  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                  }                  }
3095                    break;
3096              default:              default:
3097                  throw gig::Exception("Unknown leverage controller type.");                  throw gig::Exception("Unknown leverage controller type.");
3098          }          }
# Line 2032  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 2104  namespace { Line 3300  namespace {
3300  // *  // *
3301    
3302      Region::Region(Instrument* pInstrument, RIFF::List* rgnList) : DLS::Region((DLS::Instrument*) pInstrument, rgnList) {      Region::Region(Instrument* pInstrument, RIFF::List* rgnList) : DLS::Region((DLS::Instrument*) pInstrument, rgnList) {
         pInfo->UseFixedLengthStrings = true;  
   
3303          // Initialization          // Initialization
3304          Dimensions = 0;          Dimensions = 0;
3305          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
# Line 2113  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());
3325                  uint8_t     bits      = _3lnk->ReadUint8();                  uint8_t     bits      = _3lnk->ReadUint8();
3326                  _3lnk->ReadUint8(); // probably the position of the dimension                  _3lnk->ReadUint8(); // bit position of the dimension (bits[0] + bits[1] + ... + bits[i-1])
3327                  _3lnk->ReadUint8(); // unknown                  _3lnk->ReadUint8(); // (1 << bit position of next dimension) - (1 << bit position of this dimension)
3328                  uint8_t     zones     = _3lnk->ReadUint8(); // new for v3: number of zones doesn't have to be == pow(2,bits)                  uint8_t     zones     = _3lnk->ReadUint8(); // new for v3: number of zones doesn't have to be == pow(2,bits)
3329                  if (dimension == dimension_none) { // inactive dimension                  if (dimension == dimension_none) { // inactive dimension
3330                      pDimensionDefinitions[i].dimension  = dimension_none;                      pDimensionDefinitions[i].dimension  = dimension_none;
# Line 2155  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++) {
3373                    pDimensionDefinitions[i].dimension  = dimension_none;
3374                    pDimensionDefinitions[i].bits       = 0;
3375                    pDimensionDefinitions[i].zones      = 0;
3376                }
3377          }          }
3378    
3379          // make sure there is at least one dimension region          // make sure there is at least one dimension region
# Line 2175  namespace { Line 3381  namespace {
3381              RIFF::List* _3prg = rgnList->GetSubList(LIST_TYPE_3PRG);              RIFF::List* _3prg = rgnList->GetSubList(LIST_TYPE_3PRG);
3382              if (!_3prg) _3prg = rgnList->AddSubList(LIST_TYPE_3PRG);              if (!_3prg) _3prg = rgnList->AddSubList(LIST_TYPE_3PRG);
3383              RIFF::List* _3ewl = _3prg->AddSubList(LIST_TYPE_3EWL);              RIFF::List* _3ewl = _3prg->AddSubList(LIST_TYPE_3EWL);
3384              pDimensionRegions[0] = new DimensionRegion(_3ewl);              pDimensionRegions[0] = new DimensionRegion(this, _3ewl);
3385              DimensionRegions = 1;              DimensionRegions = 1;
3386          }          }
3387      }      }
# Line 2187  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 2197  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);
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              pDimensionRegions[i]->UpdateChunks();              pDimensionRegions[i]->UpdateChunks(pProgress);
3412          }          }
3413    
3414          File* pFile = (File*) GetParent()->GetParent();          File* pFile = (File*) GetParent()->GetParent();
3415          const int iMaxDimensions = (pFile->pVersion && pFile->pVersion->major == 3) ? 8 : 5;          const bool versiongt2 = pFile->pVersion && pFile->pVersion->major > 2;
3416          const int iMaxDimensionRegions = (pFile->pVersion && pFile->pVersion->major == 3) ? 256 : 32;          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 = (pFile->pVersion && pFile->pVersion->major == 3) ? 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);
3425    
3426                // move 3prg to last position
3427                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
3431          uint8_t* pData = (uint8_t*) _3lnk->LoadChunkData();          uint8_t* pData = (uint8_t*) _3lnk->LoadChunkData();
3432          memcpy(&pData[0], &DimensionRegions, 4);          store32(&pData[0], DimensionRegions);
3433            int shift = 0;
3434          for (int i = 0; i < iMaxDimensions; i++) {          for (int i = 0; i < iMaxDimensions; i++) {
3435              pData[4 + i * 8] = (uint8_t) pDimensionDefinitions[i].dimension;              pData[4 + i * 8] = (uint8_t) pDimensionDefinitions[i].dimension;
3436              pData[5 + i * 8] = pDimensionDefinitions[i].bits;              pData[5 + i * 8] = pDimensionDefinitions[i].bits;
3437              // next 2 bytes unknown              pData[6 + i * 8] = pDimensionDefinitions[i].dimension == dimension_none ? 0 : shift;
3438                pData[7 + i * 8] = (1 << (shift + pDimensionDefinitions[i].bits)) - (1 << shift);
3439              pData[8 + i * 8] = pDimensionDefinitions[i].zones;              pData[8 + i * 8] = pDimensionDefinitions[i].zones;
3440              // next 3 bytes unknown              // next 3 bytes unknown, always zero?
3441    
3442                shift += pDimensionDefinitions[i].bits;
3443          }          }
3444    
3445          // update wave pool table in '3lnk' chunk          // update wave pool table in '3lnk' chunk
3446          const int iWavePoolOffset = (pFile->pVersion && pFile->pVersion->major == 3) ? 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 2240  namespace { Line 3456  namespace {
3456                          break;                          break;
3457                      }                      }
3458                  }                  }
                 if (iWaveIndex < 0) throw gig::Exception("Could not update gig::Region, could not find DimensionRegion's sample");  
3459              }              }
3460              memcpy(&pData[iWavePoolOffset + i * 4], &iWaveIndex, 4);              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    
# Line 2253  namespace { Line 3501  namespace {
3501              RIFF::List* _3ewl = _3prg->GetFirstSubList();              RIFF::List* _3ewl = _3prg->GetFirstSubList();
3502              while (_3ewl) {              while (_3ewl) {
3503                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {
3504                      pDimensionRegions[dimensionRegionNr] = new DimensionRegion(_3ewl);                      pDimensionRegions[dimensionRegionNr] = new DimensionRegion(this, _3ewl);
3505                      dimensionRegionNr++;                      dimensionRegionNr++;
3506                  }                  }
3507                  _3ewl = _3prg->GetNextSubList();                  _3ewl = _3prg->GetNextSubList();
# Line 2262  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 2276  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 2312  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 2348  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 2367  namespace { Line 3636  namespace {
3636              if (pDimensionDefinitions[i].dimension == pDimDef->dimension)              if (pDimensionDefinitions[i].dimension == pDimDef->dimension)
3637                  throw gig::Exception("Could not add new dimension, there is already a dimension of the same type");                  throw gig::Exception("Could not add new dimension, there is already a dimension of the same type");
3638    
3639            // pos is where the new dimension should be placed, normally
3640            // last in list, except for the samplechannel dimension which
3641            // has to be first in list
3642            int pos = pDimDef->dimension == dimension_samplechannel ? 0 : Dimensions;
3643            int bitpos = 0;
3644            for (int i = 0 ; i < pos ; i++)
3645                bitpos += pDimensionDefinitions[i].bits;
3646    
3647            // make room for the new dimension
3648            for (int i = Dimensions ; i > pos ; i--) pDimensionDefinitions[i] = pDimensionDefinitions[i - 1];
3649            for (int i = 0 ; i < (1 << iCurrentBits) ; i++) {
3650                for (int j = Dimensions ; j > pos ; j--) {
3651                    pDimensionRegions[i]->DimensionUpperLimits[j] =
3652                        pDimensionRegions[i]->DimensionUpperLimits[j - 1];
3653                }
3654            }
3655    
3656          // assign definition of new dimension          // assign definition of new dimension
3657          pDimensionDefinitions[Dimensions] = *pDimDef;          pDimensionDefinitions[pos] = *pDimDef;
3658    
3659          // auto correct certain dimension definition fields (where possible)          // auto correct certain dimension definition fields (where possible)
3660          pDimensionDefinitions[Dimensions].split_type  =          pDimensionDefinitions[pos].split_type  =
3661              __resolveSplitType(pDimensionDefinitions[Dimensions].dimension);              __resolveSplitType(pDimensionDefinitions[pos].dimension);
3662          pDimensionDefinitions[Dimensions].zone_size =          pDimensionDefinitions[pos].zone_size =
3663              __resolveZoneSize(pDimensionDefinitions[Dimensions]);              __resolveZoneSize(pDimensionDefinitions[pos]);
3664    
3665          // create new dimension region(s) for this new dimension          // create new dimension region(s) for this new dimension, and make
3666          for (int i = 1 << iCurrentBits; i < 1 << iNewBits; i++) {          // sure that the dimension regions are placed correctly in both the
3667              //TODO: maybe we should copy existing dimension regions if possible instead of simply creating new ones with default values          // RIFF list and the pDimensionRegions array
3668              RIFF::List* pNewDimRgnListChunk = pCkRegion->AddSubList(LIST_TYPE_3EWL);          RIFF::Chunk* moveTo = NULL;
3669              pDimensionRegions[i] = new DimensionRegion(pNewDimRgnListChunk);          RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
3670              DimensionRegions++;          for (int i = (1 << iCurrentBits) - (1 << bitpos) ; i >= 0 ; i -= (1 << bitpos)) {
3671                for (int k = 0 ; k < (1 << bitpos) ; k++) {
3672                    pDimensionRegions[(i << pDimDef->bits) + k] = pDimensionRegions[i + k];
3673                }
3674                for (int j = 1 ; j < (1 << pDimDef->bits) ; j++) {
3675                    for (int k = 0 ; k < (1 << bitpos) ; k++) {
3676                        RIFF::List* pNewDimRgnListChunk = _3prg->AddSubList(LIST_TYPE_3EWL);
3677                        if (moveTo) _3prg->MoveSubChunk(pNewDimRgnListChunk, moveTo);
3678                        // create a new dimension region and copy all parameter values from
3679                        // an existing dimension region
3680                        pDimensionRegions[(i << pDimDef->bits) + (j << bitpos) + k] =
3681                            new DimensionRegion(pNewDimRgnListChunk, *pDimensionRegions[i + k]);
3682    
3683                        DimensionRegions++;
3684                    }
3685                }
3686                moveTo = pDimensionRegions[i]->pParentList;
3687            }
3688    
3689            // initialize the upper limits for this dimension
3690            int mask = (1 << bitpos) - 1;
3691            for (int z = 0 ; z < pDimDef->zones ; z++) {
3692                uint8_t upperLimit = uint8_t((z + 1) * 128.0 / pDimDef->zones - 1);
3693                for (int i = 0 ; i < 1 << iCurrentBits ; i++) {
3694                    pDimensionRegions[((i & ~mask) << pDimDef->bits) |
3695                                      (z << bitpos) |
3696                                      (i & mask)]->DimensionUpperLimits[pos] = upperLimit;
3697                }
3698          }          }
3699    
3700          Dimensions++;          Dimensions++;
# Line 2424  namespace { Line 3737  namespace {
3737          for (int i = iDimensionNr + 1; i < Dimensions; i++)          for (int i = iDimensionNr + 1; i < Dimensions; i++)
3738              iUpperBits += pDimensionDefinitions[i].bits;              iUpperBits += pDimensionDefinitions[i].bits;
3739    
3740            RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
3741    
3742          // delete dimension regions which belong to the given dimension          // delete dimension regions which belong to the given dimension
3743          // (that is where the dimension's bit > 0)          // (that is where the dimension's bit > 0)
3744          for (int iUpperBit = 0; iUpperBit < 1 << iUpperBits; iUpperBit++) {          for (int iUpperBit = 0; iUpperBit < 1 << iUpperBits; iUpperBit++) {
# Line 2432  namespace { Line 3747  namespace {
3747                      int iToDelete = iUpperBit    << (pDimensionDefinitions[iDimensionNr].bits + iLowerBits) |                      int iToDelete = iUpperBit    << (pDimensionDefinitions[iDimensionNr].bits + iLowerBits) |
3748                                      iObsoleteBit << iLowerBits |                                      iObsoleteBit << iLowerBits |
3749                                      iLowerBit;                                      iLowerBit;
3750    
3751                        _3prg->DeleteSubChunk(pDimensionRegions[iToDelete]->pParentList);
3752                      delete pDimensionRegions[iToDelete];                      delete pDimensionRegions[iToDelete];
3753                      pDimensionRegions[iToDelete] = NULL;                      pDimensionRegions[iToDelete] = NULL;
3754                      DimensionRegions--;                      DimensionRegions--;
# Line 2452  namespace { Line 3769  namespace {
3769              }              }
3770          }          }
3771    
3772            // remove the this dimension from the upper limits arrays
3773            for (int j = 0 ; j < 256 && pDimensionRegions[j] ; j++) {
3774                DimensionRegion* d = pDimensionRegions[j];
3775                for (int i = iDimensionNr + 1; i < Dimensions; i++) {
3776                    d->DimensionUpperLimits[i - 1] = d->DimensionUpperLimits[i];
3777                }
3778                d->DimensionUpperLimits[Dimensions - 1] = 127;
3779            }
3780    
3781          // 'remove' dimension definition          // 'remove' dimension definition
3782          for (int i = iDimensionNr + 1; i < Dimensions; i++) {          for (int i = iDimensionNr + 1; i < Dimensions; i++) {
3783              pDimensionDefinitions[i - 1] = pDimensionDefinitions[i];              pDimensionDefinitions[i - 1] = pDimensionDefinitions[i];
# Line 2466  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            if (!Dimensions)
3811                throw gig::Exception("Could not delete dimension zone, because there is no dimension at all.");
3812            dimension_def_t* oldDef = GetDimensionDefinition(type);
3813            if (!oldDef)
3814                throw gig::Exception("Could not delete dimension zone, no such dimension of given type");
3815            if (oldDef->zones <= 2)
3816                throw gig::Exception("Could not delete dimension zone, because it would end up with only one zone.");
3817            if (zone < 0 || zone >= oldDef->zones)
3818                throw gig::Exception("Could not delete dimension zone, requested zone index out of bounds.");
3819    
3820            const int newZoneSize = oldDef->zones - 1;
3821    
3822            // create a temporary Region which just acts as a temporary copy
3823            // container and will be deleted at the end of this function and will
3824            // also not be visible through the API during this process
3825            gig::Region* tempRgn = NULL;
3826            {
3827                // adding these temporary chunks is probably not even necessary
3828                Instrument* instr = static_cast<Instrument*>(GetParent());
3829                RIFF::List* pCkInstrument = instr->pCkInstrument;
3830                RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
3831                if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3832                RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3833                tempRgn = new Region(instr, rgn);
3834            }
3835    
3836            // copy this region's dimensions (with already the dimension split size
3837            // requested by the arguments of this method call) to the temporary
3838            // region, and don't use Region::CopyAssign() here for this task, since
3839            // it would also alter fast lookup helper variables here and there
3840            dimension_def_t newDef = {};
3841            for (int i = 0; i < Dimensions; ++i) {
3842                dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3843                // is this the dimension requested by the method arguments? ...
3844                if (def.dimension == type) { // ... if yes, decrement zone amount by one
3845                    def.zones = newZoneSize;
3846                    if ((1 << (def.bits - 1)) == def.zones) def.bits--;
3847                    newDef = def;
3848                }
3849                tempRgn->AddDimension(&def);
3850            }
3851            // silence clang sanitizer warning
3852            if (newDef.dimension == dimension_none)
3853                throw gig::Exception("Unexpected internal failure resolving dimension in DeleteDimensionZone() [this is a bug].");
3854    
3855            // find the dimension index in the tempRegion which is the dimension
3856            // type passed to this method (paranoidly expecting different order)
3857            int tempReducedDimensionIndex = -1;
3858            for (int d = 0; d < tempRgn->Dimensions; ++d) {
3859                if (tempRgn->pDimensionDefinitions[d].dimension == type) {
3860                    tempReducedDimensionIndex = d;
3861                    break;
3862                }
3863            }
3864    
3865            // copy dimension regions from this region to the temporary region
3866            for (int iDst = 0; iDst < 256; ++iDst) {
3867                DimensionRegion* dstDimRgn = tempRgn->pDimensionRegions[iDst];
3868                if (!dstDimRgn) continue;
3869                std::map<dimension_t,int> dimCase;
3870                bool isValidZone = true;
3871                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3872                    const int dstBits = tempRgn->pDimensionDefinitions[d].bits;
3873                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3874                        (iDst >> baseBits) & ((1 << dstBits) - 1);
3875                    baseBits += dstBits;
3876                    // there are also DimensionRegion objects of unused zones, skip them
3877                    if (dimCase[tempRgn->pDimensionDefinitions[d].dimension] >= tempRgn->pDimensionDefinitions[d].zones) {
3878                        isValidZone = false;
3879                        break;
3880                    }
3881                }
3882                if (!isValidZone) continue;
3883                // a bit paranoid: cope with the chance that the dimensions would
3884                // have different order in source and destination regions
3885                const bool isLastZone = (dimCase[type] == newZoneSize - 1);
3886                if (dimCase[type] >= zone) dimCase[type]++;
3887                DimensionRegion* srcDimRgn = GetDimensionRegionByBit(dimCase);
3888                dstDimRgn->CopyAssign(srcDimRgn);
3889                // if this is the upper most zone of the dimension passed to this
3890                // method, then correct (raise) its upper limit to 127
3891                if (newDef.split_type == split_type_normal && isLastZone)
3892                    dstDimRgn->DimensionUpperLimits[tempReducedDimensionIndex] = 127;
3893            }
3894    
3895            // now tempRegion's dimensions and DimensionRegions basically reflect
3896            // what we wanted to get for this actual Region here, so we now just
3897            // delete and recreate the dimension in question with the new amount
3898            // zones and then copy back from tempRegion. we're actually deleting and
3899            // recreating all dimensions here, to avoid altering the precise order
3900            // of the dimensions (which would not be an error per se, but it would
3901            // cause usability issues with instrument editors)
3902            {
3903                std::vector<dimension_def_t> oldDefs;
3904                for (int i = 0; i < Dimensions; ++i)
3905                    oldDefs.push_back(pDimensionDefinitions[i]); // copy, don't reference
3906                for (int i = Dimensions - 1; i >= 0; --i)
3907                    DeleteDimension(&pDimensionDefinitions[i]);
3908                for (int i = 0; i < oldDefs.size(); ++i) {
3909                    dimension_def_t& def = oldDefs[i];
3910                    AddDimension(
3911                        (def.dimension == newDef.dimension) ? &newDef : &def
3912                    );
3913                }
3914            }
3915            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3916                DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
3917                if (!srcDimRgn) continue;
3918                std::map<dimension_t,int> dimCase;
3919                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3920                    const int srcBits = tempRgn->pDimensionDefinitions[d].bits;
3921                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3922                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3923                    baseBits += srcBits;
3924                }
3925                // a bit paranoid: cope with the chance that the dimensions would
3926                // have different order in source and destination regions
3927                DimensionRegion* dstDimRgn = GetDimensionRegionByBit(dimCase);
3928                if (!dstDimRgn) continue;
3929                dstDimRgn->CopyAssign(srcDimRgn);
3930            }
3931    
3932            // delete temporary region
3933            tempRgn->DeleteChunks();
3934            delete tempRgn;
3935    
3936            UpdateVelocityTable();
3937        }
3938    
3939        /** @brief Divide split zone of a dimension in two (increment zone amount).
3940         *
3941         * This will increment the amount of zones for the dimension (given by
3942         * @a type) by one. It will do so by dividing the zone (given by @a zone)
3943         * in the middle of its zone range in two. So the two zones resulting from
3944         * the zone being splitted, will be an equivalent copy regarding all their
3945         * articulation informations and sample reference. The two zones will only
3946         * differ in their zone's upper limit
3947         * (DimensionRegion::DimensionUpperLimits).
3948         *
3949         * @param type - identifies the dimension where a zone shall be splitted
3950         * @param zone - index of the dimension split zone that shall be splitted
3951         * @throws gig::Exception if requested zone could not be splitted
3952         */
3953        void Region::SplitDimensionZone(dimension_t type, int zone) {
3954            dimension_def_t* oldDef = GetDimensionDefinition(type);
3955            if (!oldDef)
3956                throw gig::Exception("Could not split dimension zone, no such dimension of given type");
3957            if (zone < 0 || zone >= oldDef->zones)
3958                throw gig::Exception("Could not split dimension zone, requested zone index out of bounds.");
3959    
3960            const int newZoneSize = oldDef->zones + 1;
3961    
3962            // create a temporary Region which just acts as a temporary copy
3963            // container and will be deleted at the end of this function and will
3964            // also not be visible through the API during this process
3965            gig::Region* tempRgn = NULL;
3966            {
3967                // adding these temporary chunks is probably not even necessary
3968                Instrument* instr = static_cast<Instrument*>(GetParent());
3969                RIFF::List* pCkInstrument = instr->pCkInstrument;
3970                RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
3971                if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3972                RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3973                tempRgn = new Region(instr, rgn);
3974            }
3975    
3976            // copy this region's dimensions (with already the dimension split size
3977            // requested by the arguments of this method call) to the temporary
3978            // region, and don't use Region::CopyAssign() here for this task, since
3979            // it would also alter fast lookup helper variables here and there
3980            dimension_def_t newDef;
3981            for (int i = 0; i < Dimensions; ++i) {
3982                dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3983                // is this the dimension requested by the method arguments? ...
3984                if (def.dimension == type) { // ... if yes, increment zone amount by one
3985                    def.zones = newZoneSize;
3986                    if ((1 << oldDef->bits) < newZoneSize) def.bits++;
3987                    newDef = def;
3988                }
3989                tempRgn->AddDimension(&def);
3990            }
3991    
3992            // find the dimension index in the tempRegion which is the dimension
3993            // type passed to this method (paranoidly expecting different order)
3994            int tempIncreasedDimensionIndex = -1;
3995            for (int d = 0; d < tempRgn->Dimensions; ++d) {
3996                if (tempRgn->pDimensionDefinitions[d].dimension == type) {
3997                    tempIncreasedDimensionIndex = d;
3998                    break;
3999                }
4000            }
4001    
4002            // copy dimension regions from this region to the temporary region
4003            for (int iSrc = 0; iSrc < 256; ++iSrc) {
4004                DimensionRegion* srcDimRgn = pDimensionRegions[iSrc];
4005                if (!srcDimRgn) continue;
4006                std::map<dimension_t,int> dimCase;
4007                bool isValidZone = true;
4008                for (int d = 0, baseBits = 0; d < Dimensions; ++d) {
4009                    const int srcBits = pDimensionDefinitions[d].bits;
4010                    dimCase[pDimensionDefinitions[d].dimension] =
4011                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
4012                    // there are also DimensionRegion objects for unused zones, skip them
4013                    if (dimCase[pDimensionDefinitions[d].dimension] >= pDimensionDefinitions[d].zones) {
4014                        isValidZone = false;
4015                        break;
4016                    }
4017                    baseBits += srcBits;
4018                }
4019                if (!isValidZone) continue;
4020                // a bit paranoid: cope with the chance that the dimensions would
4021                // have different order in source and destination regions            
4022                if (dimCase[type] > zone) dimCase[type]++;
4023                DimensionRegion* dstDimRgn = tempRgn->GetDimensionRegionByBit(dimCase);
4024                dstDimRgn->CopyAssign(srcDimRgn);
4025                // if this is the requested zone to be splitted, then also copy
4026                // the source DimensionRegion to the newly created target zone
4027                // and set the old zones upper limit lower
4028                if (dimCase[type] == zone) {
4029                    // lower old zones upper limit
4030                    if (newDef.split_type == split_type_normal) {
4031                        const int high =
4032                            dstDimRgn->DimensionUpperLimits[tempIncreasedDimensionIndex];
4033                        int low = 0;
4034                        if (zone > 0) {
4035                            std::map<dimension_t,int> lowerCase = dimCase;
4036                            lowerCase[type]--;
4037                            DimensionRegion* dstDimRgnLow = tempRgn->GetDimensionRegionByBit(lowerCase);
4038                            low = dstDimRgnLow->DimensionUpperLimits[tempIncreasedDimensionIndex];
4039                        }
4040                        dstDimRgn->DimensionUpperLimits[tempIncreasedDimensionIndex] = low + (high - low) / 2;
4041                    }
4042                    // fill the newly created zone of the divided zone as well
4043                    dimCase[type]++;
4044                    dstDimRgn = tempRgn->GetDimensionRegionByBit(dimCase);
4045                    dstDimRgn->CopyAssign(srcDimRgn);
4046                }
4047            }
4048    
4049            // now tempRegion's dimensions and DimensionRegions basically reflect
4050            // what we wanted to get for this actual Region here, so we now just
4051            // delete and recreate the dimension in question with the new amount
4052            // zones and then copy back from tempRegion. we're actually deleting and
4053            // recreating all dimensions here, to avoid altering the precise order
4054            // of the dimensions (which would not be an error per se, but it would
4055            // cause usability issues with instrument editors)
4056            {
4057                std::vector<dimension_def_t> oldDefs;
4058                for (int i = 0; i < Dimensions; ++i)
4059                    oldDefs.push_back(pDimensionDefinitions[i]); // copy, don't reference
4060                for (int i = Dimensions - 1; i >= 0; --i)
4061                    DeleteDimension(&pDimensionDefinitions[i]);
4062                for (int i = 0; i < oldDefs.size(); ++i) {
4063                    dimension_def_t& def = oldDefs[i];
4064                    AddDimension(
4065                        (def.dimension == newDef.dimension) ? &newDef : &def
4066                    );
4067                }
4068            }
4069            for (int iSrc = 0; iSrc < 256; ++iSrc) {
4070                DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
4071                if (!srcDimRgn) continue;
4072                std::map<dimension_t,int> dimCase;
4073                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
4074                    const int srcBits = tempRgn->pDimensionDefinitions[d].bits;
4075                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
4076                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
4077                    baseBits += srcBits;
4078                }
4079                // a bit paranoid: cope with the chance that the dimensions would
4080                // have different order in source and destination regions
4081                DimensionRegion* dstDimRgn = GetDimensionRegionByBit(dimCase);
4082                if (!dstDimRgn) continue;
4083                dstDimRgn->CopyAssign(srcDimRgn);
4084            }
4085    
4086            // delete temporary region
4087            tempRgn->DeleteChunks();
4088            delete tempRgn;
4089    
4090            UpdateVelocityTable();
4091        }
4092    
4093        /** @brief Change type of an existing dimension.
4094         *
4095         * Alters the dimension type of a dimension already existing on this
4096         * region. If there is currently no dimension on this Region with type
4097         * @a oldType, then this call with throw an Exception. Likewise there are
4098         * cases where the requested dimension type cannot be performed. For example
4099         * if the new dimension type shall be gig::dimension_samplechannel, and the
4100         * current dimension has more than 2 zones. In such cases an Exception is
4101         * thrown as well.
4102         *
4103         * @param oldType - identifies the existing dimension to be changed
4104         * @param newType - to which dimension type it should be changed to
4105         * @throws gig::Exception if requested change cannot be performed
4106         */
4107        void Region::SetDimensionType(dimension_t oldType, dimension_t newType) {
4108            if (oldType == newType) return;
4109            dimension_def_t* def = GetDimensionDefinition(oldType);
4110            if (!def)
4111                throw gig::Exception("No dimension with provided old dimension type exists on this region");
4112            if (newType == dimension_samplechannel && def->zones != 2)
4113                throw gig::Exception("Cannot change to dimension type 'sample channel', because existing dimension does not have 2 zones");
4114            if (GetDimensionDefinition(newType))
4115                throw gig::Exception("There is already a dimension with requested new dimension type on this region");
4116            def->dimension  = newType;
4117            def->split_type = __resolveSplitType(newType);
4118        }
4119    
4120        DimensionRegion* Region::GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase) {
4121            uint8_t bits[8] = {};
4122            for (std::map<dimension_t,int>::const_iterator it = DimCase.begin();
4123                 it != DimCase.end(); ++it)
4124            {
4125                for (int d = 0; d < Dimensions; ++d) {
4126                    if (pDimensionDefinitions[d].dimension == it->first) {
4127                        bits[d] = it->second;
4128                        goto nextDimCaseSlice;
4129                    }
4130                }
4131                assert(false); // do crash ... too harsh maybe ? ignore it instead ?
4132                nextDimCaseSlice:
4133                ; // noop
4134            }
4135            return GetDimensionRegionByBit(bits);
4136        }
4137    
4138        /**
4139         * Searches in the current Region for a dimension of the given dimension
4140         * type and returns the precise configuration of that dimension in this
4141         * Region.
4142         *
4143         * @param type - dimension type of the sought dimension
4144         * @returns dimension definition or NULL if there is no dimension with
4145         *          sought type in this Region.
4146         */
4147        dimension_def_t* Region::GetDimensionDefinition(dimension_t type) {
4148            for (int i = 0; i < Dimensions; ++i)
4149                if (pDimensionDefinitions[i].dimension == type)
4150                    return &pDimensionDefinitions[i];
4151            return NULL;
4152        }
4153    
4154      Region::~Region() {      Region::~Region() {
4155          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
4156              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
# Line 2493  namespace { Line 4178  namespace {
4178      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
4179          uint8_t bits;          uint8_t bits;
4180          int veldim = -1;          int veldim = -1;
4181          int velbitpos;          int velbitpos = 0;
4182          int bitpos = 0;          int bitpos = 0;
4183          int dimregidx = 0;          int dimregidx = 0;
4184          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
# Line 2523  namespace { Line 4208  namespace {
4208              }              }
4209              bitpos += pDimensionDefinitions[i].bits;              bitpos += pDimensionDefinitions[i].bits;
4210          }          }
4211          DimensionRegion* dimreg = pDimensionRegions[dimregidx];          DimensionRegion* dimreg = pDimensionRegions[dimregidx & 255];
4212            if (!dimreg) return NULL;
4213          if (veldim != -1) {          if (veldim != -1) {
4214              // (dimreg is now the dimension region for the lowest velocity)              // (dimreg is now the dimension region for the lowest velocity)
4215              if (dimreg->VelocityTable) // custom defined zone ranges              if (dimreg->VelocityTable) // custom defined zone ranges
4216                  bits = dimreg->VelocityTable[DimValues[veldim]];                  bits = dimreg->VelocityTable[DimValues[veldim] & 127];
4217              else // normal split type              else // normal split type
4218                  bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);                  bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
4219    
4220              dimregidx |= bits << velbitpos;              const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
4221              dimreg = pDimensionRegions[dimregidx];              dimregidx |= (bits & limiter_mask) << velbitpos;
4222                dimreg = pDimensionRegions[dimregidx & 255];
4223          }          }
4224          return dimreg;          return dimreg;
4225      }      }
4226    
4227        int Region::GetDimensionRegionIndexByValue(const uint DimValues[8]) {
4228            uint8_t bits;
4229            int veldim = -1;
4230            int velbitpos = 0;
4231            int bitpos = 0;
4232            int dimregidx = 0;
4233            for (uint i = 0; i < Dimensions; i++) {
4234                if (pDimensionDefinitions[i].dimension == dimension_velocity) {
4235                    // the velocity dimension must be handled after the other dimensions
4236                    veldim = i;
4237                    velbitpos = bitpos;
4238                } else {
4239                    switch (pDimensionDefinitions[i].split_type) {
4240                        case split_type_normal:
4241                            if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
4242                                // gig3: all normal dimensions (not just the velocity dimension) have custom zone ranges
4243                                for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
4244                                    if (DimValues[i] <= pDimensionRegions[bits << bitpos]->DimensionUpperLimits[i]) break;
4245                                }
4246                            } else {
4247                                // gig2: evenly sized zones
4248                                bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
4249                            }
4250                            break;
4251                        case split_type_bit: // the value is already the sought dimension bit number
4252                            const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
4253                            bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
4254                            break;
4255                    }
4256                    dimregidx |= bits << bitpos;
4257                }
4258                bitpos += pDimensionDefinitions[i].bits;
4259            }
4260            dimregidx &= 255;
4261            DimensionRegion* dimreg = pDimensionRegions[dimregidx];
4262            if (!dimreg) return -1;
4263            if (veldim != -1) {
4264                // (dimreg is now the dimension region for the lowest velocity)
4265                if (dimreg->VelocityTable) // custom defined zone ranges
4266                    bits = dimreg->VelocityTable[DimValues[veldim] & 127];
4267                else // normal split type
4268                    bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
4269    
4270                const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
4271                dimregidx |= (bits & limiter_mask) << velbitpos;
4272                dimregidx &= 255;
4273            }
4274            return dimregidx;
4275        }
4276    
4277      /**      /**
4278       * Returns the appropriate DimensionRegion for the given dimension bit       * Returns the appropriate DimensionRegion for the given dimension bit
4279       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>
# Line 2575  namespace { Line 4312  namespace {
4312          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
4313          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
4314          if (!file->pWavePoolTable) return NULL;          if (!file->pWavePoolTable) return NULL;
4315          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          if (WavePoolTableIndex + 1 > file->WavePoolCount) return NULL;
4316          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];          // for new files or files >= 2 GB use 64 bit wave pool offsets
4317          Sample* sample = file->GetFirstSample(pProgress);          if (file->pRIFF->IsNew() || (file->pRIFF->GetCurrentFileSize() >> 31)) {
4318          while (sample) {              // use 64 bit wave pool offsets (treating this as large file)
4319              if (sample->ulWavePoolOffset == soughtoffset &&              uint64_t soughtoffset =
4320                  sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);                  uint64_t(file->pWavePoolTable[WavePoolTableIndex]) |
4321              sample = file->GetNextSample();                  uint64_t(file->pWavePoolTableHi[WavePoolTableIndex]) << 32;
4322                Sample* sample = file->GetFirstSample(pProgress);
4323                while (sample) {
4324                    if (sample->ullWavePoolOffset == soughtoffset)
4325                        return static_cast<gig::Sample*>(sample);
4326                    sample = file->GetNextSample();
4327                }
4328            } else {
4329                // use extension files and 32 bit wave pool offsets
4330                file_offset_t soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
4331                file_offset_t soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
4332                Sample* sample = file->GetFirstSample(pProgress);
4333                while (sample) {
4334                    if (sample->ullWavePoolOffset == soughtoffset &&
4335                        sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
4336                    sample = file->GetNextSample();
4337                }
4338          }          }
4339          return NULL;          return NULL;
4340      }      }
4341        
4342        /**
4343         * Make a (semi) deep copy of the Region object given by @a orig
4344         * and assign it to this object.
4345         *
4346         * Note that all sample pointers referenced by @a orig are simply copied as
4347         * memory address. Thus the respective samples are shared, not duplicated!
4348         *
4349         * @param orig - original Region object to be copied from
4350         */
4351        void Region::CopyAssign(const Region* orig) {
4352            CopyAssign(orig, NULL);
4353        }
4354        
4355        /**
4356         * Make a (semi) deep copy of the Region object given by @a orig and
4357         * assign it to this object
4358         *
4359         * @param mSamples - crosslink map between the foreign file's samples and
4360         *                   this file's samples
4361         */
4362        void Region::CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples) {
4363            // handle base classes
4364            DLS::Region::CopyAssign(orig);
4365            
4366            if (mSamples && mSamples->count((gig::Sample*)orig->pSample)) {
4367                pSample = mSamples->find((gig::Sample*)orig->pSample)->second;
4368            }
4369            
4370            // handle own member variables
4371            for (int i = Dimensions - 1; i >= 0; --i) {
4372                DeleteDimension(&pDimensionDefinitions[i]);
4373            }
4374            Layers = 0; // just to be sure
4375            for (int i = 0; i < orig->Dimensions; i++) {
4376                // we need to copy the dim definition here, to avoid the compiler
4377                // complaining about const-ness issue
4378                dimension_def_t def = orig->pDimensionDefinitions[i];
4379                AddDimension(&def);
4380            }
4381            for (int i = 0; i < 256; i++) {
4382                if (pDimensionRegions[i] && orig->pDimensionRegions[i]) {
4383                    pDimensionRegions[i]->CopyAssign(
4384                        orig->pDimensionRegions[i],
4385                        mSamples
4386                    );
4387                }
4388            }
4389            Layers = orig->Layers;
4390        }
4391    
4392        /**
4393         * Returns @c true in case this Region object uses any gig format
4394         * extension, that is e.g. whether any DimensionRegion object currently
4395         * has any setting effective that would require our "LSDE" RIFF chunk to
4396         * be stored to the gig file.
4397         *
4398         * Right now this is a private method. It is considerable though this method
4399         * to become (in slightly modified form) a public API method in future, i.e.
4400         * to allow instrument editors to visualize and/or warn the user of any gig
4401         * format extension being used. See also comments on
4402         * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
4403         * potential public API change in future.
4404         */
4405        bool Region::UsesAnyGigFormatExtension() const {
4406            for (int i = 0; i < 256; i++) {
4407                if (pDimensionRegions[i]) {
4408                    if (pDimensionRegions[i]->UsesAnyGigFormatExtension())
4409                        return true;
4410                }
4411            }
4412            return false;
4413        }
4414    
4415    
4416    // *************** MidiRule ***************
4417    // *
4418    
4419        MidiRuleCtrlTrigger::MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg) {
4420            _3ewg->SetPos(36);
4421            Triggers = _3ewg->ReadUint8();
4422            _3ewg->SetPos(40);
4423            ControllerNumber = _3ewg->ReadUint8();
4424            _3ewg->SetPos(46);
4425            for (int i = 0 ; i < Triggers ; i++) {
4426                pTriggers[i].TriggerPoint = _3ewg->ReadUint8();
4427                pTriggers[i].Descending = _3ewg->ReadUint8();
4428                pTriggers[i].VelSensitivity = _3ewg->ReadUint8();
4429                pTriggers[i].Key = _3ewg->ReadUint8();
4430                pTriggers[i].NoteOff = _3ewg->ReadUint8();
4431                pTriggers[i].Velocity = _3ewg->ReadUint8();
4432                pTriggers[i].OverridePedal = _3ewg->ReadUint8();
4433                _3ewg->ReadUint8();
4434            }
4435        }
4436    
4437        MidiRuleCtrlTrigger::MidiRuleCtrlTrigger() :
4438            ControllerNumber(0),
4439            Triggers(0) {
4440        }
4441    
4442        void MidiRuleCtrlTrigger::UpdateChunks(uint8_t* pData) const {
4443            pData[32] = 4;
4444            pData[33] = 16;
4445            pData[36] = Triggers;
4446            pData[40] = ControllerNumber;
4447            for (int i = 0 ; i < Triggers ; i++) {
4448                pData[46 + i * 8] = pTriggers[i].TriggerPoint;
4449                pData[47 + i * 8] = pTriggers[i].Descending;
4450                pData[48 + i * 8] = pTriggers[i].VelSensitivity;
4451                pData[49 + i * 8] = pTriggers[i].Key;
4452                pData[50 + i * 8] = pTriggers[i].NoteOff;
4453                pData[51 + i * 8] = pTriggers[i].Velocity;
4454                pData[52 + i * 8] = pTriggers[i].OverridePedal;
4455            }
4456        }
4457    
4458        MidiRuleLegato::MidiRuleLegato(RIFF::Chunk* _3ewg) {
4459            _3ewg->SetPos(36);
4460            LegatoSamples = _3ewg->ReadUint8(); // always 12
4461            _3ewg->SetPos(40);
4462            BypassUseController = _3ewg->ReadUint8();
4463            BypassKey = _3ewg->ReadUint8();
4464            BypassController = _3ewg->ReadUint8();
4465            ThresholdTime = _3ewg->ReadUint16();
4466            _3ewg->ReadInt16();
4467            ReleaseTime = _3ewg->ReadUint16();
4468            _3ewg->ReadInt16();
4469            KeyRange.low = _3ewg->ReadUint8();
4470            KeyRange.high = _3ewg->ReadUint8();
4471            _3ewg->SetPos(64);
4472            ReleaseTriggerKey = _3ewg->ReadUint8();
4473            AltSustain1Key = _3ewg->ReadUint8();
4474            AltSustain2Key = _3ewg->ReadUint8();
4475        }
4476    
4477        MidiRuleLegato::MidiRuleLegato() :
4478            LegatoSamples(12),
4479            BypassUseController(false),
4480            BypassKey(0),
4481            BypassController(1),
4482            ThresholdTime(20),
4483            ReleaseTime(20),
4484            ReleaseTriggerKey(0),
4485            AltSustain1Key(0),
4486            AltSustain2Key(0)
4487        {
4488            KeyRange.low = KeyRange.high = 0;
4489        }
4490    
4491        void MidiRuleLegato::UpdateChunks(uint8_t* pData) const {
4492            pData[32] = 0;
4493            pData[33] = 16;
4494            pData[36] = LegatoSamples;
4495            pData[40] = BypassUseController;
4496            pData[41] = BypassKey;
4497            pData[42] = BypassController;
4498            store16(&pData[43], ThresholdTime);
4499            store16(&pData[47], ReleaseTime);
4500            pData[51] = KeyRange.low;
4501            pData[52] = KeyRange.high;
4502            pData[64] = ReleaseTriggerKey;
4503            pData[65] = AltSustain1Key;
4504            pData[66] = AltSustain2Key;
4505        }
4506    
4507        MidiRuleAlternator::MidiRuleAlternator(RIFF::Chunk* _3ewg) {
4508            _3ewg->SetPos(36);
4509            Articulations = _3ewg->ReadUint8();
4510            int flags = _3ewg->ReadUint8();
4511            Polyphonic = flags & 8;
4512            Chained = flags & 4;
4513            Selector = (flags & 2) ? selector_controller :
4514                (flags & 1) ? selector_key_switch : selector_none;
4515            Patterns = _3ewg->ReadUint8();
4516            _3ewg->ReadUint8(); // chosen row
4517            _3ewg->ReadUint8(); // unknown
4518            _3ewg->ReadUint8(); // unknown
4519            _3ewg->ReadUint8(); // unknown
4520            KeySwitchRange.low = _3ewg->ReadUint8();
4521            KeySwitchRange.high = _3ewg->ReadUint8();
4522            Controller = _3ewg->ReadUint8();
4523            PlayRange.low = _3ewg->ReadUint8();
4524            PlayRange.high = _3ewg->ReadUint8();
4525    
4526            int n = std::min(int(Articulations), 32);
4527            for (int i = 0 ; i < n ; i++) {
4528                _3ewg->ReadString(pArticulations[i], 32);
4529            }
4530            _3ewg->SetPos(1072);
4531            n = std::min(int(Patterns), 32);
4532            for (int i = 0 ; i < n ; i++) {
4533                _3ewg->ReadString(pPatterns[i].Name, 16);
4534                pPatterns[i].Size = _3ewg->ReadUint8();
4535                _3ewg->Read(&pPatterns[i][0], 1, 32);
4536            }
4537        }
4538    
4539        MidiRuleAlternator::MidiRuleAlternator() :
4540            Articulations(0),
4541            Patterns(0),
4542            Selector(selector_none),
4543            Controller(0),
4544            Polyphonic(false),
4545            Chained(false)
4546        {
4547            PlayRange.low = PlayRange.high = 0;
4548            KeySwitchRange.low = KeySwitchRange.high = 0;
4549        }
4550    
4551        void MidiRuleAlternator::UpdateChunks(uint8_t* pData) const {
4552            pData[32] = 3;
4553            pData[33] = 16;
4554            pData[36] = Articulations;
4555            pData[37] = (Polyphonic ? 8 : 0) | (Chained ? 4 : 0) |
4556                (Selector == selector_controller ? 2 :
4557                 (Selector == selector_key_switch ? 1 : 0));
4558            pData[38] = Patterns;
4559    
4560            pData[43] = KeySwitchRange.low;
4561            pData[44] = KeySwitchRange.high;
4562            pData[45] = Controller;
4563            pData[46] = PlayRange.low;
4564            pData[47] = PlayRange.high;
4565    
4566            char* str = reinterpret_cast<char*>(pData);
4567            int pos = 48;
4568            int n = std::min(int(Articulations), 32);
4569            for (int i = 0 ; i < n ; i++, pos += 32) {
4570                strncpy(&str[pos], pArticulations[i].c_str(), 32);
4571            }
4572    
4573            pos = 1072;
4574            n = std::min(int(Patterns), 32);
4575            for (int i = 0 ; i < n ; i++, pos += 49) {
4576                strncpy(&str[pos], pPatterns[i].Name.c_str(), 16);
4577                pData[pos + 16] = pPatterns[i].Size;
4578                memcpy(&pData[pos + 16], &(pPatterns[i][0]), 32);
4579            }
4580        }
4581    
4582    // *************** Script ***************
4583    // *
4584    
4585        Script::Script(ScriptGroup* group, RIFF::Chunk* ckScri) {
4586            pGroup = group;
4587            pChunk = ckScri;
4588            if (ckScri) { // object is loaded from file ...
4589                ckScri->SetPos(0);
4590    
4591                // read header
4592                uint32_t headerSize = ckScri->ReadUint32();
4593                Compression = (Compression_t) ckScri->ReadUint32();
4594                Encoding    = (Encoding_t) ckScri->ReadUint32();
4595                Language    = (Language_t) ckScri->ReadUint32();
4596                Bypass      = ckScri->ReadUint32() & 1;
4597                crc         = ckScri->ReadUint32();
4598                uint32_t nameSize = ckScri->ReadUint32();
4599                Name.resize(nameSize, ' ');
4600                for (int i = 0; i < nameSize; ++i)
4601                    Name[i] = ckScri->ReadUint8();
4602                // check if an uuid was already stored along with this script
4603                if (headerSize >= 6*sizeof(int32_t) + nameSize + 16) { // yes ...
4604                    for (uint i = 0; i < 16; ++i) {
4605                        Uuid[i] = ckScri->ReadUint8();
4606                    }
4607                } else { // no uuid yet, generate one now ...
4608                    GenerateUuid();
4609                }
4610                // to handle potential future extensions of the header
4611                ckScri->SetPos(sizeof(int32_t) + headerSize);
4612                // read actual script data
4613                uint32_t scriptSize = uint32_t(ckScri->GetSize() - ckScri->GetPos());
4614                data.resize(scriptSize);
4615                for (int i = 0; i < scriptSize; ++i)
4616                    data[i] = ckScri->ReadUint8();
4617            } else { // this is a new script object, so just initialize it as such ...
4618                Compression = COMPRESSION_NONE;
4619                Encoding = ENCODING_ASCII;
4620                Language = LANGUAGE_NKSP;
4621                Bypass   = false;
4622                crc      = 0;
4623                Name     = "Unnamed Script";
4624                GenerateUuid();
4625            }
4626        }
4627    
4628        Script::~Script() {
4629        }
4630    
4631        /**
4632         * Returns the current script (i.e. as source code) in text format.
4633         */
4634        String Script::GetScriptAsText() {
4635            String s;
4636            s.resize(data.size(), ' ');
4637            memcpy(&s[0], &data[0], data.size());
4638            return s;
4639        }
4640    
4641        /**
4642         * Replaces the current script with the new script source code text given
4643         * by @a text.
4644         *
4645         * @param text - new script source code
4646         */
4647        void Script::SetScriptAsText(const String& text) {
4648            data.resize(text.size());
4649            memcpy(&data[0], &text[0], text.size());
4650        }
4651    
4652        /** @brief Remove all RIFF chunks associated with this Script object.
4653         *
4654         * At the moment Script::DeleteChunks() does nothing. It is
4655         * recommended to call this method explicitly though from deriving classes's
4656         * own overridden implementation of this method to avoid potential future
4657         * compatiblity issues.
4658         *
4659         * See DLS::Storage::DeleteChunks() for details.
4660         */
4661        void Script::DeleteChunks() {
4662        }
4663    
4664        /**
4665         * Apply this script to the respective RIFF chunks. You have to call
4666         * File::Save() to make changes persistent.
4667         *
4668         * Usually there is absolutely no need to call this method explicitly.
4669         * It will be called automatically when File::Save() was called.
4670         *
4671         * @param pProgress - callback function for progress notification
4672         */
4673        void Script::UpdateChunks(progress_t* pProgress) {
4674            // recalculate CRC32 check sum
4675            __resetCRC(crc);
4676            __calculateCRC(&data[0], data.size(), crc);
4677            __finalizeCRC(crc);
4678            // make sure chunk exists and has the required size
4679            const file_offset_t chunkSize =
4680                (file_offset_t) 7*sizeof(int32_t) + Name.size() + 16 + data.size();
4681            if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);
4682            else pChunk->Resize(chunkSize);
4683            // fill the chunk data to be written to disk
4684            uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();
4685            int pos = 0;
4686            store32(&pData[pos], uint32_t(6*sizeof(int32_t) + Name.size() + 16)); // total header size
4687            pos += sizeof(int32_t);
4688            store32(&pData[pos], Compression);
4689            pos += sizeof(int32_t);
4690            store32(&pData[pos], Encoding);
4691            pos += sizeof(int32_t);
4692            store32(&pData[pos], Language);
4693            pos += sizeof(int32_t);
4694            store32(&pData[pos], Bypass ? 1 : 0);
4695            pos += sizeof(int32_t);
4696            store32(&pData[pos], crc);
4697            pos += sizeof(int32_t);
4698            store32(&pData[pos], (uint32_t) Name.size());
4699            pos += sizeof(int32_t);
4700            for (int i = 0; i < Name.size(); ++i, ++pos)
4701                pData[pos] = Name[i];
4702            for (int i = 0; i < 16; ++i, ++pos)
4703                pData[pos] = Uuid[i];
4704            for (int i = 0; i < data.size(); ++i, ++pos)
4705                pData[pos] = data[i];
4706        }
4707    
4708        /**
4709         * Generate a new Universally Unique Identifier (UUID) for this script.
4710         */
4711        void Script::GenerateUuid() {
4712            DLS::dlsid_t dlsid;
4713            DLS::Resource::GenerateDLSID(&dlsid);
4714            Uuid[0]  = dlsid.ulData1       & 0xff;
4715            Uuid[1]  = dlsid.ulData1 >>  8 & 0xff;
4716            Uuid[2]  = dlsid.ulData1 >> 16 & 0xff;
4717            Uuid[3]  = dlsid.ulData1 >> 24 & 0xff;
4718            Uuid[4]  = dlsid.usData2       & 0xff;
4719            Uuid[5]  = dlsid.usData2 >>  8 & 0xff;
4720            Uuid[6]  = dlsid.usData3       & 0xff;
4721            Uuid[7]  = dlsid.usData3 >>  8 & 0xff;
4722            Uuid[8]  = dlsid.abData[0];
4723            Uuid[9]  = dlsid.abData[1];
4724            Uuid[10] = dlsid.abData[2];
4725            Uuid[11] = dlsid.abData[3];
4726            Uuid[12] = dlsid.abData[4];
4727            Uuid[13] = dlsid.abData[5];
4728            Uuid[14] = dlsid.abData[6];
4729            Uuid[15] = dlsid.abData[7];
4730        }
4731    
4732        /**
4733         * Move this script from its current ScriptGroup to another ScriptGroup
4734         * given by @a pGroup.
4735         *
4736         * @param pGroup - script's new group
4737         */
4738        void Script::SetGroup(ScriptGroup* pGroup) {
4739            if (this->pGroup == pGroup) return;
4740            if (pChunk)
4741                pChunk->GetParent()->MoveSubChunk(pChunk, pGroup->pList);
4742            this->pGroup = pGroup;
4743        }
4744    
4745        /**
4746         * Returns the script group this script currently belongs to. Each script
4747         * is a member of exactly one ScriptGroup.
4748         *
4749         * @returns current script group
4750         */
4751        ScriptGroup* Script::GetGroup() const {
4752            return pGroup;
4753        }
4754    
4755        /**
4756         * Make a (semi) deep copy of the Script object given by @a orig
4757         * and assign it to this object. Note: the ScriptGroup this Script
4758         * object belongs to remains untouched by this call.
4759         *
4760         * @param orig - original Script object to be copied from
4761         */
4762        void Script::CopyAssign(const Script* orig) {
4763            Name        = orig->Name;
4764            Compression = orig->Compression;
4765            Encoding    = orig->Encoding;
4766            Language    = orig->Language;
4767            Bypass      = orig->Bypass;
4768            data        = orig->data;
4769        }
4770    
4771        void Script::RemoveAllScriptReferences() {
4772            File* pFile = pGroup->pFile;
4773            for (int i = 0; pFile->GetInstrument(i); ++i) {
4774                Instrument* instr = pFile->GetInstrument(i);
4775                instr->RemoveScript(this);
4776            }
4777        }
4778    
4779    // *************** ScriptGroup ***************
4780    // *
4781    
4782        ScriptGroup::ScriptGroup(File* file, RIFF::List* lstRTIS) {
4783            pFile = file;
4784            pList = lstRTIS;
4785            pScripts = NULL;
4786            if (lstRTIS) {
4787                RIFF::Chunk* ckName = lstRTIS->GetSubChunk(CHUNK_ID_LSNM);
4788                ::LoadString(ckName, Name);
4789            } else {
4790                Name = "Default Group";
4791            }
4792        }
4793    
4794        ScriptGroup::~ScriptGroup() {
4795            if (pScripts) {
4796                std::list<Script*>::iterator iter = pScripts->begin();
4797                std::list<Script*>::iterator end  = pScripts->end();
4798                while (iter != end) {
4799                    delete *iter;
4800                    ++iter;
4801                }
4802                delete pScripts;
4803            }
4804        }
4805    
4806        /** @brief Remove all RIFF chunks associated with this ScriptGroup object.
4807         *
4808         * At the moment ScriptGroup::DeleteChunks() does nothing. It is
4809         * recommended to call this method explicitly though from deriving classes's
4810         * own overridden implementation of this method to avoid potential future
4811         * compatiblity issues.
4812         *
4813         * See DLS::Storage::DeleteChunks() for details.
4814         */
4815        void ScriptGroup::DeleteChunks() {
4816        }
4817    
4818        /**
4819         * Apply this script group to the respective RIFF chunks. You have to call
4820         * File::Save() to make changes persistent.
4821         *
4822         * Usually there is absolutely no need to call this method explicitly.
4823         * It will be called automatically when File::Save() was called.
4824         *
4825         * @param pProgress - callback function for progress notification
4826         */
4827        void ScriptGroup::UpdateChunks(progress_t* pProgress) {
4828            if (pScripts) {
4829                if (!pList)
4830                    pList = pFile->pRIFF->GetSubList(LIST_TYPE_3LS)->AddSubList(LIST_TYPE_RTIS);
4831    
4832                // now store the name of this group as <LSNM> chunk as subchunk of the <RTIS> list chunk
4833                ::SaveString(CHUNK_ID_LSNM, NULL, pList, Name, String("Unnamed Group"), true, 64);
4834    
4835                for (std::list<Script*>::iterator it = pScripts->begin();
4836                     it != pScripts->end(); ++it)
4837                {
4838                    (*it)->UpdateChunks(pProgress);
4839                }
4840            }
4841        }
4842    
4843        /** @brief Get instrument script.
4844         *
4845         * Returns the real-time instrument script with the given index.
4846         *
4847         * @param index - number of the sought script (0..n)
4848         * @returns sought script or NULL if there's no such script
4849         */
4850        Script* ScriptGroup::GetScript(uint index) {
4851            if (!pScripts) LoadScripts();
4852            std::list<Script*>::iterator it = pScripts->begin();
4853            for (uint i = 0; it != pScripts->end(); ++i, ++it)
4854                if (i == index) return *it;
4855            return NULL;
4856        }
4857    
4858        /** @brief Add new instrument script.
4859         *
4860         * Adds a new real-time instrument script to the file. The script is not
4861         * actually used / executed unless it is referenced by an instrument to be
4862         * used. This is similar to samples, which you can add to a file, without
4863         * an instrument necessarily actually using it.
4864         *
4865         * You have to call Save() to make this persistent to the file.
4866         *
4867         * @return new empty script object
4868         */
4869        Script* ScriptGroup::AddScript() {
4870            if (!pScripts) LoadScripts();
4871            Script* pScript = new Script(this, NULL);
4872            pScripts->push_back(pScript);
4873            return pScript;
4874        }
4875    
4876        /** @brief Delete an instrument script.
4877         *
4878         * This will delete the given real-time instrument script. References of
4879         * instruments that are using that script will be removed accordingly.
4880         *
4881         * You have to call Save() to make this persistent to the file.
4882         *
4883         * @param pScript - script to delete
4884         * @throws gig::Exception if given script could not be found
4885         */
4886        void ScriptGroup::DeleteScript(Script* pScript) {
4887            if (!pScripts) LoadScripts();
4888            std::list<Script*>::iterator iter =
4889                find(pScripts->begin(), pScripts->end(), pScript);
4890            if (iter == pScripts->end())
4891                throw gig::Exception("Could not delete script, could not find given script");
4892            pScripts->erase(iter);
4893            pScript->RemoveAllScriptReferences();
4894            if (pScript->pChunk)
4895                pScript->pChunk->GetParent()->DeleteSubChunk(pScript->pChunk);
4896            delete pScript;
4897        }
4898    
4899        void ScriptGroup::LoadScripts() {
4900            if (pScripts) return;
4901            pScripts = new std::list<Script*>;
4902            if (!pList) return;
4903    
4904            for (RIFF::Chunk* ck = pList->GetFirstSubChunk(); ck;
4905                 ck = pList->GetNextSubChunk())
4906            {
4907                if (ck->GetChunkID() == CHUNK_ID_SCRI) {
4908                    pScripts->push_back(new Script(this, ck));
4909                }
4910            }
4911        }
4912    
4913  // *************** Instrument ***************  // *************** Instrument ***************
4914  // *  // *
4915    
4916      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) {
4917          pInfo->UseFixedLengthStrings = true;          static const DLS::Info::string_length_t fixedStringLengths[] = {
4918                { CHUNK_ID_INAM, 64 },
4919                { CHUNK_ID_ISFT, 12 },
4920                { 0, 0 }
4921            };
4922            pInfo->SetFixedStringLengths(fixedStringLengths);
4923    
4924          // Initialization          // Initialization
4925          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
4926            EffectSend = 0;
4927            Attenuation = 0;
4928            FineTune = 0;
4929            PitchbendRange = 2;
4930            PianoReleaseMode = false;
4931            DimensionKeyRange.low = 0;
4932            DimensionKeyRange.high = 0;
4933            pMidiRules = new MidiRule*[3];
4934            pMidiRules[0] = NULL;
4935            pScriptRefs = NULL;
4936    
4937          // Loading          // Loading
4938          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
4939          if (lart) {          if (lart) {
4940              RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);              RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
4941              if (_3ewg) {              if (_3ewg) {
4942                    _3ewg->SetPos(0);
4943    
4944                  EffectSend             = _3ewg->ReadUint16();                  EffectSend             = _3ewg->ReadUint16();
4945                  Attenuation            = _3ewg->ReadInt32();                  Attenuation            = _3ewg->ReadInt32();
4946                  FineTune               = _3ewg->ReadInt16();                  FineTune               = _3ewg->ReadInt16();
# Line 2610  namespace { Line 4949  namespace {
4949                  PianoReleaseMode       = dimkeystart & 0x01;                  PianoReleaseMode       = dimkeystart & 0x01;
4950                  DimensionKeyRange.low  = dimkeystart >> 1;                  DimensionKeyRange.low  = dimkeystart >> 1;
4951                  DimensionKeyRange.high = _3ewg->ReadUint8();                  DimensionKeyRange.high = _3ewg->ReadUint8();
4952    
4953                    if (_3ewg->GetSize() > 32) {
4954                        // read MIDI rules
4955                        int i = 0;
4956                        _3ewg->SetPos(32);
4957                        uint8_t id1 = _3ewg->ReadUint8();
4958                        uint8_t id2 = _3ewg->ReadUint8();
4959    
4960                        if (id2 == 16) {
4961                            if (id1 == 4) {
4962                                pMidiRules[i++] = new MidiRuleCtrlTrigger(_3ewg);
4963                            } else if (id1 == 0) {
4964                                pMidiRules[i++] = new MidiRuleLegato(_3ewg);
4965                            } else if (id1 == 3) {
4966                                pMidiRules[i++] = new MidiRuleAlternator(_3ewg);
4967                            } else {
4968                                pMidiRules[i++] = new MidiRuleUnknown;
4969                            }
4970                        }
4971                        else if (id1 != 0 || id2 != 0) {
4972                            pMidiRules[i++] = new MidiRuleUnknown;
4973                        }
4974                        //TODO: all the other types of rules
4975    
4976                        pMidiRules[i] = NULL;
4977                    }
4978                }
4979            }
4980    
4981            if (pFile->GetAutoLoad()) {
4982                if (!pRegions) pRegions = new RegionList;
4983                RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
4984                if (lrgn) {
4985                    RIFF::List* rgn = lrgn->GetFirstSubList();
4986                    while (rgn) {
4987                        if (rgn->GetListType() == LIST_TYPE_RGN) {
4988                            if (pProgress)
4989                                __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
4990                            pRegions->push_back(new Region(this, rgn));
4991                        }
4992                        rgn = lrgn->GetNextSubList();
4993                    }
4994                    // Creating Region Key Table for fast lookup
4995                    UpdateRegionKeyTable();
4996              }              }
4997          }          }
4998    
4999          if (!pRegions) pRegions = new RegionList;          // own gig format extensions
5000          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);          RIFF::List* lst3LS = insList->GetSubList(LIST_TYPE_3LS);
5001          if (lrgn) {          if (lst3LS) {
5002              RIFF::List* rgn = lrgn->GetFirstSubList();              // script slots (that is references to instrument scripts)
5003              while (rgn) {              RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
5004                  if (rgn->GetListType() == LIST_TYPE_RGN) {              if (ckSCSL) {
5005                      __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);                  ckSCSL->SetPos(0);
5006                      pRegions->push_back(new Region(this, rgn));  
5007                    int headerSize = ckSCSL->ReadUint32();
5008                    int slotCount  = ckSCSL->ReadUint32();
5009                    if (slotCount) {
5010                        int slotSize  = ckSCSL->ReadUint32();
5011                        ckSCSL->SetPos(headerSize); // in case of future header extensions
5012                        int unknownSpace = slotSize - 2*sizeof(uint32_t); // in case of future slot extensions
5013                        for (int i = 0; i < slotCount; ++i) {
5014                            _ScriptPooolEntry e;
5015                            e.fileOffset = ckSCSL->ReadUint32();
5016                            e.bypass     = ckSCSL->ReadUint32() & 1;
5017                            if (unknownSpace) ckSCSL->SetPos(unknownSpace, RIFF::stream_curpos); // in case of future extensions
5018                            scriptPoolFileOffsets.push_back(e);
5019                        }
5020                    }
5021                }
5022    
5023                // overridden script 'patch' variables
5024                RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV);
5025                if (ckSCPV) {
5026                    ckSCPV->SetPos(0);
5027    
5028                    int nScripts = ckSCPV->ReadUint32();
5029                    for (int iScript = 0; iScript < nScripts; ++iScript) {
5030                        _UUID uuid;
5031                        for (int i = 0; i < 16; ++i)
5032                            uuid[i] = ckSCPV->ReadUint8();
5033                        uint slot = ckSCPV->ReadUint32();
5034                        ckSCPV->ReadUint32(); // unused, reserved 32 bit
5035                        int nVars = ckSCPV->ReadUint32();
5036                        for (int iVar = 0; iVar < nVars; ++iVar) {
5037                            uint8_t type = ckSCPV->ReadUint8();
5038                            ckSCPV->ReadUint8();  // unused, reserved byte
5039                            int blobSize = ckSCPV->ReadUint16();
5040                            RIFF::file_offset_t pos = ckSCPV->GetPos();
5041                            // assuming 1st bit is set in 'type', otherwise blob not
5042                            // supported for decoding
5043                            if (type & 1) {
5044                                String name, value;
5045                                int len = ckSCPV->ReadUint16();
5046                                for (int i = 0; i < len; ++i)
5047                                    name += (char) ckSCPV->ReadUint8();
5048                                len = ckSCPV->ReadUint16();
5049                                for (int i = 0; i < len; ++i)
5050                                    value += (char) ckSCPV->ReadUint8();
5051                                if (!name.empty()) // 'name' should never be empty, but just to be sure
5052                                    scriptVars[uuid][slot][name] = value;
5053                            }
5054                            // also for potential future extensions: seek forward
5055                            // according to blob size
5056                            ckSCPV->SetPos(pos + blobSize);
5057                        }
5058                  }                  }
                 rgn = lrgn->GetNextSubList();  
5059              }              }
             // Creating Region Key Table for fast lookup  
             UpdateRegionKeyTable();  
5060          }          }
5061    
5062          __notify_progress(pProgress, 1.0f); // notify done          if (pProgress)
5063                __notify_progress(pProgress, 1.0f); // notify done
5064      }      }
5065    
5066      void Instrument::UpdateRegionKeyTable() {      void Instrument::UpdateRegionKeyTable() {
5067            for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
5068          RegionList::iterator iter = pRegions->begin();          RegionList::iterator iter = pRegions->begin();
5069          RegionList::iterator end  = pRegions->end();          RegionList::iterator end  = pRegions->end();
5070          for (; iter != end; ++iter) {          for (; iter != end; ++iter) {
5071              gig::Region* pRegion = static_cast<gig::Region*>(*iter);              gig::Region* pRegion = static_cast<gig::Region*>(*iter);
5072              for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {              const int low  = std::max(int(pRegion->KeyRange.low), 0);
5073                const int high = std::min(int(pRegion->KeyRange.high), 127);
5074                for (int iKey = low; iKey <= high; iKey++) {
5075                  RegionKeyTable[iKey] = pRegion;                  RegionKeyTable[iKey] = pRegion;
5076              }              }
5077          }          }
5078      }      }
5079    
5080      Instrument::~Instrument() {      Instrument::~Instrument() {
5081            for (int i = 0 ; pMidiRules[i] ; i++) {
5082                delete pMidiRules[i];
5083            }
5084            delete[] pMidiRules;
5085            if (pScriptRefs) delete pScriptRefs;
5086      }      }
5087    
5088      /**      /**
# Line 2652  namespace { Line 5092  namespace {
5092       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
5093       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
5094       *       *
5095         * @param pProgress - callback function for progress notification
5096       * @throws gig::Exception if samples cannot be dereferenced       * @throws gig::Exception if samples cannot be dereferenced
5097       */       */
5098      void Instrument::UpdateChunks() {      void Instrument::UpdateChunks(progress_t* pProgress) {
5099          // first update base classes' chunks          // first update base classes' chunks
5100          DLS::Instrument::UpdateChunks();          DLS::Instrument::UpdateChunks(pProgress);
5101    
5102          // update Regions' chunks          // update Regions' chunks
5103          {          {
5104              RegionList::iterator iter = pRegions->begin();              RegionList::iterator iter = pRegions->begin();
5105              RegionList::iterator end  = pRegions->end();              RegionList::iterator end  = pRegions->end();
5106              for (; iter != end; ++iter)              for (; iter != end; ++iter)
5107                  (*iter)->UpdateChunks();                  (*iter)->UpdateChunks(pProgress);
5108          }          }
5109    
5110          // make sure 'lart' RIFF list chunk exists          // make sure 'lart' RIFF list chunk exists
# Line 2671  namespace { Line 5112  namespace {
5112          if (!lart)  lart = pCkInstrument->AddSubList(LIST_TYPE_LART);          if (!lart)  lart = pCkInstrument->AddSubList(LIST_TYPE_LART);
5113          // make sure '3ewg' RIFF chunk exists          // make sure '3ewg' RIFF chunk exists
5114          RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);          RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
5115          if (!_3ewg)  _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, 12);          if (!_3ewg)  {
5116                File* pFile = (File*) GetParent();
5117    
5118                // 3ewg is bigger in gig3, as it includes the iMIDI rules
5119                int size = (pFile->pVersion && pFile->pVersion->major > 2) ? 16416 : 12;
5120                _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);
5121                memset(_3ewg->LoadChunkData(), 0, size);
5122            }
5123          // update '3ewg' RIFF chunk          // update '3ewg' RIFF chunk
5124          uint8_t* pData = (uint8_t*) _3ewg->LoadChunkData();          uint8_t* pData = (uint8_t*) _3ewg->LoadChunkData();
5125          memcpy(&pData[0], &EffectSend, 2);          store16(&pData[0], EffectSend);
5126          memcpy(&pData[2], &Attenuation, 4);          store32(&pData[2], Attenuation);
5127          memcpy(&pData[6], &FineTune, 2);          store16(&pData[6], FineTune);
5128          memcpy(&pData[8], &PitchbendRange, 2);          store16(&pData[8], PitchbendRange);
5129          const uint8_t dimkeystart = (PianoReleaseMode) ? 0x01 : 0x00 |          const uint8_t dimkeystart = (PianoReleaseMode ? 0x01 : 0x00) |
5130                                      DimensionKeyRange.low << 1;                                      DimensionKeyRange.low << 1;
5131          memcpy(&pData[10], &dimkeystart, 1);          pData[10] = dimkeystart;
5132          memcpy(&pData[11], &DimensionKeyRange.high, 1);          pData[11] = DimensionKeyRange.high;
5133    
5134            if (pMidiRules[0] == 0 && _3ewg->GetSize() >= 34) {
5135                pData[32] = 0;
5136                pData[33] = 0;
5137            } else {
5138                for (int i = 0 ; pMidiRules[i] ; i++) {
5139                    pMidiRules[i]->UpdateChunks(pData);
5140                }
5141            }
5142    
5143            // own gig format extensions
5144           if (ScriptSlotCount()) {
5145               // make sure we have converted the original loaded script file
5146               // offsets into valid Script object pointers
5147               LoadScripts();
5148    
5149               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
5150               if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);
5151    
5152               // save script slots (that is references to instrument scripts)
5153               const int slotCount = (int) pScriptRefs->size();
5154               const int headerSize = 3 * sizeof(uint32_t);
5155               const int slotSize  = 2 * sizeof(uint32_t);
5156               const int totalChunkSize = headerSize + slotCount * slotSize;
5157               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
5158               if (!ckSCSL) ckSCSL = lst3LS->AddSubChunk(CHUNK_ID_SCSL, totalChunkSize);
5159               else ckSCSL->Resize(totalChunkSize);
5160               uint8_t* pData = (uint8_t*) ckSCSL->LoadChunkData();
5161               int pos = 0;
5162               store32(&pData[pos], headerSize);
5163               pos += sizeof(uint32_t);
5164               store32(&pData[pos], slotCount);
5165               pos += sizeof(uint32_t);
5166               store32(&pData[pos], slotSize);
5167               pos += sizeof(uint32_t);
5168               for (int i = 0; i < slotCount; ++i) {
5169                   // arbitrary value, the actual file offset will be updated in
5170                   // UpdateScriptFileOffsets() after the file has been resized
5171                   int bogusFileOffset = 0;
5172                   store32(&pData[pos], bogusFileOffset);
5173                   pos += sizeof(uint32_t);
5174                   store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0);
5175                   pos += sizeof(uint32_t);
5176               }
5177    
5178               // save overridden script 'patch' variables ...
5179    
5180               // the actual 'scriptVars' member variable might contain variables of
5181               // scripts which are currently no longer assigned to any script slot
5182               // of this instrument, we need to get rid of these variables here to
5183               // prevent saving those persistently, however instead of touching the
5184               // member variable 'scriptVars' directly, rather strip a separate
5185               // copy such that the overridden values are not lost during an
5186               // instrument editor session (i.e. if script might be re-assigned)
5187               _VarsByScript vars = stripScriptVars();
5188               if (!vars.empty()) {
5189                   // determine total size required for 'SCPV' RIFF chunk, and the
5190                   // total amount of scripts being overridden (the latter is
5191                   // required because a script might be used on several script
5192                   // slots, hence vars.size() could then not be used here instead)
5193                   size_t totalChunkSize = 4;
5194                   size_t totalScriptsOverridden = 0;
5195                   for (const auto& script : vars) {
5196                       for (const auto& slot : script.second) {
5197                           totalScriptsOverridden++;
5198                           totalChunkSize += 16 + 4 + 4 + 4;
5199                           for (const auto& var : slot.second) {
5200                               totalChunkSize += 4 + 2 + var.first.length() +
5201                                                     2 + var.second.length();
5202                           }
5203                       }
5204                   }
5205    
5206                   // ensure 'SCPV' RIFF chunk exists (with required size)
5207                   RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV);
5208                   if (!ckSCPV) ckSCPV = lst3LS->AddSubChunk(CHUNK_ID_SCPV, totalChunkSize);
5209                   else ckSCPV->Resize(totalChunkSize);
5210    
5211                   // store the actual data to 'SCPV' RIFF chunk
5212                   uint8_t* pData = (uint8_t*) ckSCPV->LoadChunkData();
5213                   int pos = 0;
5214                   store32(&pData[pos], (uint32_t) totalScriptsOverridden); // scripts count
5215                   pos += 4;
5216                   for (const auto& script : vars) {
5217                       for (const auto& slot : script.second) {
5218                           for (int i = 0; i < 16; ++i)
5219                               pData[pos+i] = script.first[i]; // uuid
5220                           pos += 16;
5221                           store32(&pData[pos], (uint32_t) slot.first); // slot index
5222                           pos += 4;
5223                           store32(&pData[pos], (uint32_t) 0); // unused, reserved 32 bit
5224                           pos += 4;
5225                           store32(&pData[pos], (uint32_t) slot.second.size()); // variables count
5226                           pos += 4;
5227                           for (const auto& var : slot.second) {
5228                               pData[pos++] = 1; // type
5229                               pData[pos++] = 0; // reserved byte
5230                               store16(&pData[pos], 2 + var.first.size() + 2 + var.second.size()); // blob size
5231                               pos += 2;
5232                               store16(&pData[pos], var.first.size()); // variable name length
5233                               pos += 2;
5234                               for (int i = 0; i < var.first.size(); ++i)
5235                                   pData[pos++] = var.first[i];
5236                               store16(&pData[pos], var.second.size()); // variable value length
5237                               pos += 2;
5238                               for (int i = 0; i < var.second.size(); ++i)
5239                                   pData[pos++] = var.second[i];
5240                           }
5241                       }
5242                   }
5243               } else {
5244                   // no script variable overridden by this instrument, so get rid
5245                   // of 'SCPV' RIFF chunk (if any)
5246                   RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV);
5247                   if (ckSCPV) lst3LS->DeleteSubChunk(ckSCPV);
5248               }
5249           } else {
5250               // no script slots, so get rid of any LS custom RIFF chunks (if any)
5251               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
5252               if (lst3LS) pCkInstrument->DeleteSubChunk(lst3LS);
5253           }
5254        }
5255    
5256        void Instrument::UpdateScriptFileOffsets() {
5257           // own gig format extensions
5258           if (pScriptRefs && pScriptRefs->size() > 0) {
5259               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
5260               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
5261               const int slotCount = (int) pScriptRefs->size();
5262               const int headerSize = 3 * sizeof(uint32_t);
5263               ckSCSL->SetPos(headerSize);
5264               for (int i = 0; i < slotCount; ++i) {
5265                   uint32_t fileOffset = uint32_t(
5266                        (*pScriptRefs)[i].script->pChunk->GetFilePos() -
5267                        (*pScriptRefs)[i].script->pChunk->GetPos() -
5268                        CHUNK_HEADER_SIZE(ckSCSL->GetFile()->GetFileOffsetSize())
5269                   );
5270                   ckSCSL->WriteUint32(&fileOffset);
5271                   // jump over flags entry (containing the bypass flag)
5272                   ckSCSL->SetPos(sizeof(uint32_t), RIFF::stream_curpos);
5273               }
5274           }        
5275      }      }
5276    
5277      /**      /**
# Line 2692  namespace { Line 5282  namespace {
5282       *             there is no Region defined for the given \a Key       *             there is no Region defined for the given \a Key
5283       */       */
5284      Region* Instrument::GetRegion(unsigned int Key) {      Region* Instrument::GetRegion(unsigned int Key) {
5285          if (!pRegions || !pRegions->size() || Key > 127) return NULL;          if (!pRegions || pRegions->empty() || Key > 127) return NULL;
5286          return RegionKeyTable[Key];          return RegionKeyTable[Key];
5287    
5288          /*for (int i = 0; i < Regions; i++) {          /*for (int i = 0; i < Regions; i++) {
# Line 2736  namespace { Line 5326  namespace {
5326          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
5327          Region* pNewRegion = new Region(this, rgn);          Region* pNewRegion = new Region(this, rgn);
5328          pRegions->push_back(pNewRegion);          pRegions->push_back(pNewRegion);
5329          Regions = pRegions->size();          Regions = (uint32_t) pRegions->size();
5330          // update Region key table for fast lookup          // update Region key table for fast lookup
5331          UpdateRegionKeyTable();          UpdateRegionKeyTable();
5332          // done          // done
# Line 2750  namespace { Line 5340  namespace {
5340          UpdateRegionKeyTable();          UpdateRegionKeyTable();
5341      }      }
5342    
5343        /**
5344         * Move this instrument at the position before @arg dst.
5345         *
5346         * This method can be used to reorder the sequence of instruments in a
5347         * .gig file. This might be helpful especially on large .gig files which
5348         * contain a large number of instruments within the same .gig file. So
5349         * grouping such instruments to similar ones, can help to keep track of them
5350         * when working with such complex .gig files.
5351         *
5352         * When calling this method, this instrument will be removed from in its
5353         * current position in the instruments list and moved to the requested
5354         * target position provided by @param dst. You may also pass NULL as
5355         * argument to this method, in that case this intrument will be moved to the
5356         * very end of the .gig file's instrument list.
5357         *
5358         * You have to call Save() to make the order change persistent to the .gig
5359         * file.
5360         *
5361         * Currently this method is limited to moving the instrument within the same
5362         * .gig file. Trying to move it to another .gig file by calling this method
5363         * will throw an exception.
5364         *
5365         * @param dst - destination instrument at which this instrument will be
5366         *              moved to, or pass NULL for moving to end of list
5367         * @throw gig::Exception if this instrument and target instrument are not
5368         *                       part of the same file
5369         */
5370        void Instrument::MoveTo(Instrument* dst) {
5371            if (dst && GetParent() != dst->GetParent())
5372                throw Exception(
5373                    "gig::Instrument::MoveTo() can only be used for moving within "
5374                    "the same gig file."
5375                );
5376    
5377            File* pFile = (File*) GetParent();
5378    
5379            // move this instrument within the instrument list
5380            {
5381                File::InstrumentList& list = *pFile->pInstruments;
5382    
5383                File::InstrumentList::iterator itFrom =
5384                    std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(this));
5385    
5386                File::InstrumentList::iterator itTo =
5387                    std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(dst));
5388    
5389                list.splice(itTo, list, itFrom);
5390            }
5391    
5392            // move the instrument's actual list RIFF chunk appropriately
5393            RIFF::List* lstCkInstruments = pFile->pRIFF->GetSubList(LIST_TYPE_LINS);
5394            lstCkInstruments->MoveSubChunk(
5395                this->pCkInstrument,
5396                (RIFF::Chunk*) ((dst) ? dst->pCkInstrument : NULL)
5397            );
5398        }
5399    
5400        /**
5401         * Returns a MIDI rule of the instrument.
5402         *
5403         * The list of MIDI rules, at least in gig v3, always contains at
5404         * most two rules. The second rule can only be the DEF filter
5405         * (which currently isn't supported by libgig).
5406         *
5407         * @param i - MIDI rule number
5408         * @returns   pointer address to MIDI rule number i or NULL if there is none
5409         */
5410        MidiRule* Instrument::GetMidiRule(int i) {
5411            return pMidiRules[i];
5412        }
5413    
5414        /**
5415         * Adds the "controller trigger" MIDI rule to the instrument.
5416         *
5417         * @returns the new MIDI rule
5418         */
5419        MidiRuleCtrlTrigger* Instrument::AddMidiRuleCtrlTrigger() {
5420            delete pMidiRules[0];
5421            MidiRuleCtrlTrigger* r = new MidiRuleCtrlTrigger;
5422            pMidiRules[0] = r;
5423            pMidiRules[1] = 0;
5424            return r;
5425        }
5426    
5427        /**
5428         * Adds the legato MIDI rule to the instrument.
5429         *
5430         * @returns the new MIDI rule
5431         */
5432        MidiRuleLegato* Instrument::AddMidiRuleLegato() {
5433            delete pMidiRules[0];
5434            MidiRuleLegato* r = new MidiRuleLegato;
5435            pMidiRules[0] = r;
5436            pMidiRules[1] = 0;
5437            return r;
5438        }
5439    
5440        /**
5441         * Adds the alternator MIDI rule to the instrument.
5442         *
5443         * @returns the new MIDI rule
5444         */
5445        MidiRuleAlternator* Instrument::AddMidiRuleAlternator() {
5446            delete pMidiRules[0];
5447            MidiRuleAlternator* r = new MidiRuleAlternator;
5448            pMidiRules[0] = r;
5449            pMidiRules[1] = 0;
5450            return r;
5451        }
5452    
5453        /**
5454         * Deletes a MIDI rule from the instrument.
5455         *
5456         * @param i - MIDI rule number
5457         */
5458        void Instrument::DeleteMidiRule(int i) {
5459            delete pMidiRules[i];
5460            pMidiRules[i] = 0;
5461        }
5462    
5463        void Instrument::LoadScripts() {
5464            if (pScriptRefs) return;
5465            pScriptRefs = new std::vector<_ScriptPooolRef>;
5466            if (scriptPoolFileOffsets.empty()) return;
5467            File* pFile = (File*) GetParent();
5468            for (uint k = 0; k < scriptPoolFileOffsets.size(); ++k) {
5469                uint32_t soughtOffset = scriptPoolFileOffsets[k].fileOffset;
5470                for (uint i = 0; pFile->GetScriptGroup(i); ++i) {
5471                    ScriptGroup* group = pFile->GetScriptGroup(i);
5472                    for (uint s = 0; group->GetScript(s); ++s) {
5473                        Script* script = group->GetScript(s);
5474                        if (script->pChunk) {
5475                            uint32_t offset = uint32_t(
5476                                script->pChunk->GetFilePos() -
5477                                script->pChunk->GetPos() -
5478                                CHUNK_HEADER_SIZE(script->pChunk->GetFile()->GetFileOffsetSize())
5479                            );
5480                            if (offset == soughtOffset)
5481                            {
5482                                _ScriptPooolRef ref;
5483                                ref.script = script;
5484                                ref.bypass = scriptPoolFileOffsets[k].bypass;
5485                                pScriptRefs->push_back(ref);
5486                                break;
5487                            }
5488                        }
5489                    }
5490                }
5491            }
5492            // we don't need that anymore
5493            scriptPoolFileOffsets.clear();
5494        }
5495    
5496        /** @brief Get instrument script (gig format extension).
5497         *
5498         * Returns the real-time instrument script of instrument script slot
5499         * @a index.
5500         *
5501         * @note This is an own format extension which did not exist i.e. in the
5502         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5503         * gigedit.
5504         *
5505         * @param index - instrument script slot index
5506         * @returns script or NULL if index is out of bounds
5507         */
5508        Script* Instrument::GetScriptOfSlot(uint index) {
5509            LoadScripts();
5510            if (index >= pScriptRefs->size()) return NULL;
5511            return pScriptRefs->at(index).script;
5512        }
5513    
5514        /** @brief Add new instrument script slot (gig format extension).
5515         *
5516         * Add the given real-time instrument script reference to this instrument,
5517         * which shall be executed by the sampler for for this instrument. The
5518         * script will be added to the end of the script list of this instrument.
5519         * The positions of the scripts in the Instrument's Script list are
5520         * relevant, because they define in which order they shall be executed by
5521         * the sampler. For this reason it is also legal to add the same script
5522         * twice to an instrument, for example you might have a script called
5523         * "MyFilter" which performs an event filter task, and you might have
5524         * another script called "MyNoteTrigger" which triggers new notes, then you
5525         * might for example have the following list of scripts on the instrument:
5526         *
5527         * 1. Script "MyFilter"
5528         * 2. Script "MyNoteTrigger"
5529         * 3. Script "MyFilter"
5530         *
5531         * Which would make sense, because the 2nd script launched new events, which
5532         * you might need to filter as well.
5533         *
5534         * There are two ways to disable / "bypass" scripts. You can either disable
5535         * a script locally for the respective script slot on an instrument (i.e. by
5536         * passing @c false to the 2nd argument of this method, or by calling
5537         * SetScriptBypassed()). Or you can disable a script globally for all slots
5538         * and all instruments by setting Script::Bypass.
5539         *
5540         * @note This is an own format extension which did not exist i.e. in the
5541         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5542         * gigedit.
5543         *
5544         * @param pScript - script that shall be executed for this instrument
5545         * @param bypass  - if enabled, the sampler shall skip executing this
5546         *                  script (in the respective list position)
5547         * @see SetScriptBypassed()
5548         */
5549        void Instrument::AddScriptSlot(Script* pScript, bool bypass) {
5550            LoadScripts();
5551            _ScriptPooolRef ref = { pScript, bypass };
5552            pScriptRefs->push_back(ref);
5553        }
5554    
5555        /** @brief Flip two script slots with each other (gig format extension).
5556         *
5557         * Swaps the position of the two given scripts in the Instrument's Script
5558         * list. The positions of the scripts in the Instrument's Script list are
5559         * relevant, because they define in which order they shall be executed by
5560         * the sampler.
5561         *
5562         * @note This is an own format extension which did not exist i.e. in the
5563         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5564         * gigedit.
5565         *
5566         * @param index1 - index of the first script slot to swap
5567         * @param index2 - index of the second script slot to swap
5568         */
5569        void Instrument::SwapScriptSlots(uint index1, uint index2) {
5570            LoadScripts();
5571            if (index1 >= pScriptRefs->size() || index2 >= pScriptRefs->size())
5572                return;
5573            _ScriptPooolRef tmp = (*pScriptRefs)[index1];
5574            (*pScriptRefs)[index1] = (*pScriptRefs)[index2];
5575            (*pScriptRefs)[index2] = tmp;
5576        }
5577    
5578        /** @brief Remove script slot.
5579         *
5580         * Removes the script slot with the given slot index.
5581         *
5582         * @param index - index of script slot to remove
5583         */
5584        void Instrument::RemoveScriptSlot(uint index) {
5585            LoadScripts();
5586            if (index >= pScriptRefs->size()) return;
5587            pScriptRefs->erase( pScriptRefs->begin() + index );
5588        }
5589    
5590        /** @brief Remove reference to given Script (gig format extension).
5591         *
5592         * This will remove all script slots on the instrument which are referencing
5593         * the given script.
5594         *
5595         * @note This is an own format extension which did not exist i.e. in the
5596         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5597         * gigedit.
5598         *
5599         * @param pScript - script reference to remove from this instrument
5600         * @see RemoveScriptSlot()
5601         */
5602        void Instrument::RemoveScript(Script* pScript) {
5603            LoadScripts();
5604            for (ssize_t i = pScriptRefs->size() - 1; i >= 0; --i) {
5605                if ((*pScriptRefs)[i].script == pScript) {
5606                    pScriptRefs->erase( pScriptRefs->begin() + i );
5607                }
5608            }
5609        }
5610    
5611        /** @brief Instrument's amount of script slots.
5612         *
5613         * This method returns the amount of script slots this instrument currently
5614         * uses.
5615         *
5616         * A script slot is a reference of a real-time instrument script to be
5617         * executed by the sampler. The scripts will be executed by the sampler in
5618         * sequence of the slots. One (same) script may be referenced multiple
5619         * times in different slots.
5620         *
5621         * @note This is an own format extension which did not exist i.e. in the
5622         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5623         * gigedit.
5624         */
5625        uint Instrument::ScriptSlotCount() const {
5626            return uint(pScriptRefs ? pScriptRefs->size() : scriptPoolFileOffsets.size());
5627        }
5628    
5629        /** @brief Whether script execution shall be skipped.
5630         *
5631         * Defines locally for the Script reference slot in the Instrument's Script
5632         * list, whether the script shall be skipped by the sampler regarding
5633         * execution.
5634         *
5635         * It is also possible to ignore exeuction of the script globally, for all
5636         * slots and for all instruments by setting Script::Bypass.
5637         *
5638         * @note This is an own format extension which did not exist i.e. in the
5639         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5640         * gigedit.
5641         *
5642         * @param index - index of the script slot on this instrument
5643         * @see Script::Bypass
5644         */
5645        bool Instrument::IsScriptSlotBypassed(uint index) {
5646            if (index >= ScriptSlotCount()) return false;
5647            return pScriptRefs ? pScriptRefs->at(index).bypass
5648                               : scriptPoolFileOffsets.at(index).bypass;
5649            
5650        }
5651    
5652        /** @brief Defines whether execution shall be skipped.
5653         *
5654         * You can call this method to define locally whether or whether not the
5655         * given script slot shall be executed by the sampler.
5656         *
5657         * @note This is an own format extension which did not exist i.e. in the
5658         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5659         * gigedit.
5660         *
5661         * @param index - script slot index on this instrument
5662         * @param bBypass - if true, the script slot will be skipped by the sampler
5663         * @see Script::Bypass
5664         */
5665        void Instrument::SetScriptSlotBypassed(uint index, bool bBypass) {
5666            if (index >= ScriptSlotCount()) return;
5667            if (pScriptRefs)
5668                pScriptRefs->at(index).bypass = bBypass;
5669            else
5670                scriptPoolFileOffsets.at(index).bypass = bBypass;
5671        }
5672    
5673        /// type cast (by copy) uint8_t[16] -> std::array<uint8_t,16>
5674        inline std::array<uint8_t,16> _UUIDFromCArray(const uint8_t* pData) {
5675            std::array<uint8_t,16> uuid;
5676            memcpy(&uuid[0], pData, 16);
5677            return uuid;
5678        }
5679    
5680        /**
5681         * Returns true if this @c Instrument has any script slot which references
5682         * the @c Script identified by passed @p uuid.
5683         */
5684        bool Instrument::ReferencesScriptWithUuid(const _UUID& uuid) {
5685            const uint nSlots = ScriptSlotCount();
5686            for (uint iSlot = 0; iSlot < nSlots; ++iSlot)
5687                if (_UUIDFromCArray(&GetScriptOfSlot(iSlot)->Uuid[0]) == uuid)
5688                    return true;
5689            return false;
5690        }
5691    
5692        /** @brief Checks whether a certain script 'patch' variable value is set.
5693         *
5694         * Returns @c true if the initial value for the requested script variable is
5695         * currently overridden by this instrument.
5696         *
5697         * @remarks Real-time instrument scripts allow to declare special 'patch'
5698         * variables, which essentially behave like regular variables of their data
5699         * type, however their initial value may optionally be overridden on a per
5700         * instrument basis. That allows to share scripts between instruments while
5701         * still being able to fine tune certain aspects of the script for each
5702         * instrument individually.
5703         *
5704         * @note This is an own format extension which did not exist i.e. in the
5705         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5706         * Gigedit.
5707         *
5708         * @param slot - script slot index of the variable to be retrieved
5709         * @param variable - name of the 'patch' variable in that script
5710         */
5711        bool Instrument::IsScriptPatchVariableSet(int slot, String variable) {
5712            if (variable.empty()) return false;
5713            Script* script = GetScriptOfSlot(slot);
5714            if (!script) return false;
5715            const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5716            if (!scriptVars.count(uuid)) return false;
5717            const _VarsBySlot& slots = scriptVars.find(uuid)->second;
5718            if (slots.empty()) return false;
5719            if (slots.count(slot))
5720                return slots.find(slot)->second.count(variable);
5721            else
5722                return slots.begin()->second.count(variable);
5723        }
5724    
5725        /** @brief Get all overridden script 'patch' variables.
5726         *
5727         * Returns map of key-value pairs reflecting all patch variables currently
5728         * being overridden by this instrument for the given script @p slot, where
5729         * key is the variable name and value is the hereby currently overridden
5730         * value for that variable.
5731         *
5732         * @remarks Real-time instrument scripts allow to declare special 'patch'
5733         * variables, which essentially behave like regular variables of their data
5734         * type, however their initial value may optionally be overridden on a per
5735         * instrument basis. That allows to share scripts between instruments while
5736         * still being able to fine tune certain aspects of the script for each
5737         * instrument individually.
5738         *
5739         * @note This is an own format extension which did not exist i.e. in the
5740         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5741         * Gigedit.
5742         *
5743         * @param slot - script slot index of the variable to be retrieved
5744         */
5745        std::map<String,String> Instrument::GetScriptPatchVariables(int slot) {
5746            Script* script = GetScriptOfSlot(slot);
5747            if (!script) return std::map<String,String>();
5748            const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5749            if (!scriptVars.count(uuid)) return std::map<String,String>();
5750            const _VarsBySlot& slots = scriptVars.find(uuid)->second;
5751            if (slots.empty()) return std::map<String,String>();
5752            const _PatchVars& vars =
5753                (slots.count(slot)) ?
5754                    slots.find(slot)->second : slots.begin()->second;
5755            return vars;
5756        }
5757    
5758        /** @brief Get overridden initial value for 'patch' variable.
5759         *
5760         * Returns current initial value for the requested script variable being
5761         * overridden by this instrument.
5762         *
5763         * @remarks Real-time instrument scripts allow to declare special 'patch'
5764         * variables, which essentially behave like regular variables of their data
5765         * type, however their initial value may optionally be overridden on a per
5766         * instrument basis. That allows to share scripts between instruments while
5767         * still being able to fine tune certain aspects of the script for each
5768         * instrument individually.
5769         *
5770         * @note This is an own format extension which did not exist i.e. in the
5771         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5772         * Gigedit.
5773         *
5774         * @param slot - script slot index of the variable to be retrieved
5775         * @param variable - name of the 'patch' variable in that script
5776         */
5777        String Instrument::GetScriptPatchVariable(int slot, String variable) {
5778            std::map<String,String> vars = GetScriptPatchVariables(slot);
5779            return (vars.count(variable)) ? vars.find(variable)->second : "";
5780        }
5781    
5782        /** @brief Override initial value for 'patch' variable.
5783         *
5784         * Overrides initial value for the requested script variable for this
5785         * instrument with the passed value.
5786         *
5787         * @remarks Real-time instrument scripts allow to declare special 'patch'
5788         * variables, which essentially behave like regular variables of their data
5789         * type, however their initial value may optionally be overridden on a per
5790         * instrument basis. That allows to share scripts between instruments while
5791         * still being able to fine tune certain aspects of the script for each
5792         * instrument individually.
5793         *
5794         * @note This is an own format extension which did not exist i.e. in the
5795         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5796         * Gigedit.
5797         *
5798         * @param slot - script slot index of the variable to be set
5799         * @param variable - name of the 'patch' variable in that script
5800         * @param value - overridden initial value for that script variable
5801         * @throws gig::Exception if given script @p slot index is invalid or given
5802         *         @p variable name is empty
5803         */
5804        void Instrument::SetScriptPatchVariable(int slot, String variable, String value) {
5805            if (variable.empty())
5806                throw Exception("Variable name must not be empty");
5807            Script* script = GetScriptOfSlot(slot);
5808            if (!script)
5809                throw Exception("No script slot with index " + ToString(slot));
5810            const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5811            scriptVars[uuid][slot][variable] = value;
5812        }
5813    
5814        /** @brief Drop overridden initial value(s) for 'patch' variable(s).
5815         *
5816         * Reverts initial value(s) for requested script variable(s) back to their
5817         * default initial value(s) defined in the script itself.
5818         *
5819         * Both arguments of this method are optional. The most obvious use case of
5820         * this method would be passing a valid script @p slot index and a
5821         * (non-emtpy string as) @p variable name to this method, which would cause
5822         * that single variable to be unset for that specific script slot (on this
5823         * @c Instrument level).
5824         *
5825         * Not passing a value (or @c -1 for @p slot and/or empty string for
5826         * @p variable) means 'wildcard'. So accordingly absence of argument(s) will
5827         * cause all variables and/or for all script slots being unset. Hence this
5828         * method serves 2^2 = 4 possible use cases in total and accordingly covers
5829         * 4 different behaviours in one method.
5830         *
5831         * @remarks Real-time instrument scripts allow to declare special 'patch'
5832         * variables, which essentially behave like regular variables of their data
5833         * type, however their initial value may optionally be overridden on a per
5834         * instrument basis. That allows to share scripts between instruments while
5835         * still being able to fine tune certain aspects of the script for each
5836         * instrument individually.
5837         *
5838         * @note This is an own format extension which did not exist i.e. in the
5839         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5840         * Gigedit.
5841         *
5842         * @param slot - script slot index of the variable to be unset
5843         * @param variable - name of the 'patch' variable in that script
5844         */
5845        void Instrument::UnsetScriptPatchVariable(int slot, String variable) {
5846            Script* script = GetScriptOfSlot(slot);
5847    
5848            // option 1: unset a particular variable of one particular script slot
5849            if (slot != -1 && !variable.empty()) {
5850                if (!script) return;
5851                const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5852                if (!scriptVars.count(uuid)) return;
5853                if (!scriptVars[uuid].count(slot)) return;
5854                if (scriptVars[uuid][slot].count(variable))
5855                    scriptVars[uuid][slot].erase(
5856                        scriptVars[uuid][slot].find(variable)
5857                    );
5858                if (scriptVars[uuid][slot].empty())
5859                    scriptVars[uuid].erase( scriptVars[uuid].find(slot) );
5860                if (scriptVars[uuid].empty())
5861                    scriptVars.erase( scriptVars.find(uuid) );
5862                return;
5863            }
5864    
5865            // option 2: unset all variables of all script slots
5866            if (slot == -1 && variable.empty()) {
5867                scriptVars.clear();
5868                return;
5869            }
5870    
5871            // option 3: unset all variables of one particular script slot only
5872            if (slot != -1) {
5873                if (!script) return;
5874                const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5875                if (scriptVars.count(uuid))
5876                    scriptVars.erase( scriptVars.find(uuid) );
5877                return;
5878            }
5879    
5880            // option 4: unset a particular variable of all script slots
5881            _VarsByScript::iterator itScript = scriptVars.begin();
5882            _VarsByScript::iterator endScript = scriptVars.end();
5883            while (itScript != endScript) {
5884                _VarsBySlot& slots = itScript->second;
5885                _VarsBySlot::iterator itSlot = slots.begin();
5886                _VarsBySlot::iterator endSlot = slots.end();
5887                while (itSlot != endSlot) {
5888                    _PatchVars& vars = itSlot->second;
5889                    if (vars.count(variable))
5890                        vars.erase( vars.find(variable) );
5891                    if (vars.empty())
5892                        slots.erase(itSlot++); // postfix increment to avoid iterator invalidation
5893                    else
5894                        ++itSlot;
5895                }
5896                if (slots.empty())
5897                    scriptVars.erase(itScript++); // postfix increment to avoid iterator invalidation
5898                else
5899                    ++itScript;
5900            }
5901        }
5902    
5903        /**
5904         * Returns stripped version of member variable @c scriptVars, where scripts
5905         * no longer referenced by this @c Instrument are filtered out, and so are
5906         * variables of meanwhile obsolete slots (i.e. a script still being
5907         * referenced, but previously overridden on a script slot which either no
5908         * longer exists or is hosting another script now).
5909         */
5910        Instrument::_VarsByScript Instrument::stripScriptVars() {
5911            _VarsByScript vars;
5912            _VarsByScript::const_iterator itScript = scriptVars.begin();
5913            _VarsByScript::const_iterator endScript = scriptVars.end();
5914            for (; itScript != endScript; ++itScript) {
5915                const _UUID& uuid = itScript->first;
5916                if (!ReferencesScriptWithUuid(uuid))
5917                    continue;
5918                const _VarsBySlot& slots = itScript->second;
5919                _VarsBySlot::const_iterator itSlot = slots.begin();
5920                _VarsBySlot::const_iterator endSlot = slots.end();
5921                for (; itSlot != endSlot; ++itSlot) {
5922                    Script* script = GetScriptOfSlot(itSlot->first);
5923                    if (!script) continue;
5924                    if (_UUIDFromCArray(&script->Uuid[0]) != uuid) continue;
5925                    if (itSlot->second.empty()) continue;
5926                    vars[uuid][itSlot->first] = itSlot->second;
5927                }
5928            }
5929            return vars;
5930        }
5931    
5932        /**
5933         * Make a (semi) deep copy of the Instrument object given by @a orig
5934         * and assign it to this object.
5935         *
5936         * Note that all sample pointers referenced by @a orig are simply copied as
5937         * memory address. Thus the respective samples are shared, not duplicated!
5938         *
5939         * @param orig - original Instrument object to be copied from
5940         */
5941        void Instrument::CopyAssign(const Instrument* orig) {
5942            CopyAssign(orig, NULL);
5943        }
5944            
5945        /**
5946         * Make a (semi) deep copy of the Instrument object given by @a orig
5947         * and assign it to this object.
5948         *
5949         * @param orig - original Instrument object to be copied from
5950         * @param mSamples - crosslink map between the foreign file's samples and
5951         *                   this file's samples
5952         */
5953        void Instrument::CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples) {
5954            // handle base class
5955            // (without copying DLS region stuff)
5956            DLS::Instrument::CopyAssignCore(orig);
5957            
5958            // handle own member variables
5959            Attenuation = orig->Attenuation;
5960            EffectSend = orig->EffectSend;
5961            FineTune = orig->FineTune;
5962            PitchbendRange = orig->PitchbendRange;
5963            PianoReleaseMode = orig->PianoReleaseMode;
5964            DimensionKeyRange = orig->DimensionKeyRange;
5965            scriptPoolFileOffsets = orig->scriptPoolFileOffsets;
5966            // deep copy of pScriptRefs required (to avoid undefined behaviour)
5967            if (pScriptRefs) delete pScriptRefs;
5968            pScriptRefs = new std::vector<_ScriptPooolRef>;
5969            if (orig->pScriptRefs)
5970                *pScriptRefs = *orig->pScriptRefs;
5971            scriptVars = orig->scriptVars;
5972            
5973            // free old midi rules
5974            for (int i = 0 ; pMidiRules[i] ; i++) {
5975                delete pMidiRules[i];
5976            }
5977            //TODO: MIDI rule copying
5978            pMidiRules[0] = NULL;
5979            
5980            // delete all old regions
5981            while (Regions) DeleteRegion(GetFirstRegion());
5982            // create new regions and copy them from original
5983            {
5984                RegionList::const_iterator it = orig->pRegions->begin();
5985                for (int i = 0; i < orig->Regions; ++i, ++it) {
5986                    Region* dstRgn = AddRegion();
5987                    //NOTE: Region does semi-deep copy !
5988                    dstRgn->CopyAssign(
5989                        static_cast<gig::Region*>(*it),
5990                        mSamples
5991                    );
5992                }
5993            }
5994    
5995            UpdateRegionKeyTable();
5996        }
5997    
5998        /**
5999         * Returns @c true in case this Instrument object uses any gig format
6000         * extension, that is e.g. whether any DimensionRegion object currently
6001         * has any setting effective that would require our "LSDE" RIFF chunk to
6002         * be stored to the gig file.
6003         *
6004         * Right now this is a private method. It is considerable though this method
6005         * to become (in slightly modified form) a public API method in future, i.e.
6006         * to allow instrument editors to visualize and/or warn the user of any gig
6007         * format extension being used. See also comments on
6008         * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
6009         * potential public API change in future.
6010         */
6011        bool Instrument::UsesAnyGigFormatExtension() const {
6012            if (!pRegions) return false;
6013            if (!scriptVars.empty()) return true;
6014            RegionList::const_iterator iter = pRegions->begin();
6015            RegionList::const_iterator end  = pRegions->end();
6016            for (; iter != end; ++iter) {
6017                gig::Region* rgn = static_cast<gig::Region*>(*iter);
6018                if (rgn->UsesAnyGigFormatExtension())
6019                    return true;
6020            }
6021            return false;
6022        }
6023    
6024    
6025  // *************** Group ***************  // *************** Group ***************
# Line 2767  namespace { Line 6037  namespace {
6037          ::LoadString(pNameChunk, Name);          ::LoadString(pNameChunk, Name);
6038      }      }
6039    
6040        /** @brief Destructor.
6041         *
6042         * Currently this destructor implementation does nothing.
6043         */
6044      Group::~Group() {      Group::~Group() {
6045          // remove the chunk associated with this group (if any)      }
6046          if (pNameChunk) pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);  
6047        /** @brief Remove all RIFF chunks associated with this Group object.
6048         *
6049         * See DLS::Storage::DeleteChunks() for details.
6050         */
6051        void Group::DeleteChunks() {
6052            // handle own RIFF chunks
6053            if (pNameChunk) {
6054                pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
6055                pNameChunk = NULL;
6056            }
6057      }      }
6058    
6059      /** @brief Update chunks with current group settings.      /** @brief Update chunks with current group settings.
# Line 2779  namespace { Line 6063  namespace {
6063       *       *
6064       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
6065       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
6066         *
6067         * @param pProgress - callback function for progress notification
6068       */       */
6069      void Group::UpdateChunks() {      void Group::UpdateChunks(progress_t* pProgress) {
6070          // make sure <3gri> and <3gnl> list chunks exist          // make sure <3gri> and <3gnl> list chunks exist
6071          RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);          RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);
6072          if (!_3gri) _3gri = pFile->pRIFF->AddSubList(LIST_TYPE_3GRI);          if (!_3gri) {
6073                _3gri = pFile->pRIFF->AddSubList(LIST_TYPE_3GRI);
6074                pFile->pRIFF->MoveSubChunk(_3gri, pFile->pRIFF->GetSubChunk(CHUNK_ID_PTBL));
6075            }
6076          RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);          RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
6077          if (!_3gnl) _3gnl = pFile->pRIFF->AddSubList(LIST_TYPE_3GNL);          if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
6078    
6079            if (!pNameChunk && pFile->pVersion && pFile->pVersion->major > 2) {
6080                // v3 has a fixed list of 128 strings, find a free one
6081                for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {
6082                    if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {
6083                        pNameChunk = ck;
6084                        break;
6085                    }
6086                }
6087            }
6088    
6089          // now store the name of this group as <3gnm> chunk as subchunk of the <3gnl> list chunk          // now store the name of this group as <3gnm> chunk as subchunk of the <3gnl> list chunk
6090          ::SaveString(CHUNK_ID_3GNM, pNameChunk, _3gnl, Name, String("Unnamed Group"), true, 64);          ::SaveString(CHUNK_ID_3GNM, pNameChunk, _3gnl, Name, String("Unnamed Group"), true, 64);
6091      }      }
# Line 2861  namespace { Line 6161  namespace {
6161  // *************** File ***************  // *************** File ***************
6162  // *  // *
6163    
6164        /// Reflects Gigasampler file format version 2.0 (1998-06-28).
6165        const DLS::version_t File::VERSION_2 = {
6166            0, 2, 19980628 & 0xffff, 19980628 >> 16
6167        };
6168    
6169        /// Reflects Gigasampler file format version 3.0 (2003-03-31).
6170        const DLS::version_t File::VERSION_3 = {
6171            0, 3, 20030331 & 0xffff, 20030331 >> 16
6172        };
6173    
6174        /// Reflects Gigasampler file format version 4.0 (2007-10-12).
6175        const DLS::version_t File::VERSION_4 = {
6176            0, 4, 20071012 & 0xffff, 20071012 >> 16
6177        };
6178    
6179        static const DLS::Info::string_length_t _FileFixedStringLengths[] = {
6180            { CHUNK_ID_IARL, 256 },
6181            { CHUNK_ID_IART, 128 },
6182            { CHUNK_ID_ICMS, 128 },
6183            { CHUNK_ID_ICMT, 1024 },
6184            { CHUNK_ID_ICOP, 128 },
6185            { CHUNK_ID_ICRD, 128 },
6186            { CHUNK_ID_IENG, 128 },
6187            { CHUNK_ID_IGNR, 128 },
6188            { CHUNK_ID_IKEY, 128 },
6189            { CHUNK_ID_IMED, 128 },
6190            { CHUNK_ID_INAM, 128 },
6191            { CHUNK_ID_IPRD, 128 },
6192            { CHUNK_ID_ISBJ, 128 },
6193            { CHUNK_ID_ISFT, 128 },
6194            { CHUNK_ID_ISRC, 128 },
6195            { CHUNK_ID_ISRF, 128 },
6196            { CHUNK_ID_ITCH, 128 },
6197            { 0, 0 }
6198        };
6199    
6200      File::File() : DLS::File() {      File::File() : DLS::File() {
6201            bAutoLoad = true;
6202            *pVersion = VERSION_3;
6203          pGroups = NULL;          pGroups = NULL;
6204          pInfo->UseFixedLengthStrings = true;          pScriptGroups = NULL;
6205            pInfo->SetFixedStringLengths(_FileFixedStringLengths);
6206            pInfo->ArchivalLocation = String(256, ' ');
6207    
6208            // add some mandatory chunks to get the file chunks in right
6209            // order (INFO chunk will be moved to first position later)
6210            pRIFF->AddSubChunk(CHUNK_ID_VERS, 8);
6211            pRIFF->AddSubChunk(CHUNK_ID_COLH, 4);
6212            pRIFF->AddSubChunk(CHUNK_ID_DLID, 16);
6213    
6214            GenerateDLSID();
6215      }      }
6216    
6217      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
6218            bAutoLoad = true;
6219          pGroups = NULL;          pGroups = NULL;
6220          pInfo->UseFixedLengthStrings = true;          pScriptGroups = NULL;
6221            pInfo->SetFixedStringLengths(_FileFixedStringLengths);
6222      }      }
6223    
6224      File::~File() {      File::~File() {
# Line 2881  namespace { Line 6231  namespace {
6231              }              }
6232              delete pGroups;              delete pGroups;
6233          }          }
6234            if (pScriptGroups) {
6235                std::list<ScriptGroup*>::iterator iter = pScriptGroups->begin();
6236                std::list<ScriptGroup*>::iterator end  = pScriptGroups->end();
6237                while (iter != end) {
6238                    delete *iter;
6239                    ++iter;
6240                }
6241                delete pScriptGroups;
6242            }
6243      }      }
6244    
6245      Sample* File::GetFirstSample(progress_t* pProgress) {      Sample* File::GetFirstSample(progress_t* pProgress) {
# Line 2895  namespace { Line 6254  namespace {
6254          SamplesIterator++;          SamplesIterator++;
6255          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
6256      }      }
6257        
6258        /**
6259         * Returns Sample object of @a index.
6260         *
6261         * @returns sample object or NULL if index is out of bounds
6262         */
6263        Sample* File::GetSample(uint index) {
6264            if (!pSamples) LoadSamples();
6265            if (!pSamples) return NULL;
6266            DLS::File::SampleList::iterator it = pSamples->begin();
6267            for (int i = 0; i < index; ++i) {
6268                ++it;
6269                if (it == pSamples->end()) return NULL;
6270            }
6271            if (it == pSamples->end()) return NULL;
6272            return static_cast<gig::Sample*>( *it );
6273        }
6274    
6275        /**
6276         * Returns the total amount of samples of this gig file.
6277         *
6278         * Note that this method might block for a long time in case it is required
6279         * to load the sample info for the first time.
6280         *
6281         * @returns total amount of samples
6282         */
6283        size_t File::CountSamples() {
6284            if (!pSamples) LoadSamples();
6285            if (!pSamples) return 0;
6286            return pSamples->size();
6287        }
6288    
6289      /** @brief Add a new sample.      /** @brief Add a new sample.
6290       *       *
# Line 2910  namespace { Line 6300  namespace {
6300         // create new Sample object and its respective 'wave' list chunk         // create new Sample object and its respective 'wave' list chunk
6301         RIFF::List* wave = wvpl->AddSubList(LIST_TYPE_WAVE);         RIFF::List* wave = wvpl->AddSubList(LIST_TYPE_WAVE);
6302         Sample* pSample = new Sample(this, wave, 0 /*arbitrary value, we update offsets when we save*/);         Sample* pSample = new Sample(this, wave, 0 /*arbitrary value, we update offsets when we save*/);
6303    
6304           // add mandatory chunks to get the chunks in right order
6305           wave->AddSubChunk(CHUNK_ID_FMT, 16);
6306           wave->AddSubList(LIST_TYPE_INFO);
6307    
6308         pSamples->push_back(pSample);         pSamples->push_back(pSample);
6309         return pSample;         return pSample;
6310      }      }
6311    
6312      /** @brief Delete a sample.      /** @brief Delete a sample.
6313       *       *
6314       * This will delete the given Sample object from the gig file. You have       * This will delete the given Sample object from the gig file. Any
6315       * to call Save() to make this persistent to the file.       * references to this sample from Regions and DimensionRegions will be
6316         * removed. You have to call Save() to make this persistent to the file.
6317       *       *
6318       * @param pSample - sample to delete       * @param pSample - sample to delete
6319       * @throws gig::Exception if given sample could not be found       * @throws gig::Exception if given sample could not be found
# Line 2928  namespace { Line 6324  namespace {
6324          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");
6325          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
6326          pSamples->erase(iter);          pSamples->erase(iter);
6327            pSample->DeleteChunks();
6328          delete pSample;          delete pSample;
6329    
6330            SampleList::iterator tmp = SamplesIterator;
6331            // remove all references to the sample
6332            for (Instrument* instrument = GetFirstInstrument() ; instrument ;
6333                 instrument = GetNextInstrument()) {
6334                for (Region* region = instrument->GetFirstRegion() ; region ;
6335                     region = instrument->GetNextRegion()) {
6336    
6337                    if (region->GetSample() == pSample) region->SetSample(NULL);
6338    
6339                    for (int i = 0 ; i < region->DimensionRegions ; i++) {
6340                        gig::DimensionRegion *d = region->pDimensionRegions[i];
6341                        if (d->pSample == pSample) d->pSample = NULL;
6342                    }
6343                }
6344            }
6345            SamplesIterator = tmp; // restore iterator
6346      }      }
6347    
6348      void File::LoadSamples() {      void File::LoadSamples() {
# Line 2948  namespace { Line 6362  namespace {
6362          int iSampleIndex  = 0;          int iSampleIndex  = 0;
6363          int iTotalSamples = WavePoolCount;          int iTotalSamples = WavePoolCount;
6364    
6365          // check if samples should be loaded from extension files          // just for assembling path of optional extension files to be read
6366          int lastFileNo = 0;          const std::string folder = parentPath(pRIFF->GetFileName());
6367          for (int i = 0 ; i < WavePoolCount ; i++) {          const std::string baseName = pathWithoutExtension(pRIFF->GetFileName());
6368              if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];  
6369          }          // the main gig file and the extension files (.gx01, ... , .gx98) may
6370          String name(pRIFF->GetFileName());          // contain wave data (wave pool)
6371          int nameLen = name.length();          std::vector<RIFF::File*> poolFiles;
6372          char suffix[6];          poolFiles.push_back(pRIFF);
6373          if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;  
6374            // get info about all extension files
6375            RIFF::Chunk* ckXfil = pRIFF->GetSubChunk(CHUNK_ID_XFIL);
6376            if (ckXfil) { // there are extension files (.gx01, ... , .gx98) ...
6377                const uint32_t n = ckXfil->ReadInt32();
6378                for (int i = 0; i < n; i++) {
6379                    // read the filename and load the extension file
6380                    std::string name;
6381                    ckXfil->ReadString(name, 128);
6382                    std::string path = concatPath(folder, name);
6383                    RIFF::File* pExtFile = new RIFF::File(path);
6384                    // check that the dlsids match
6385                    RIFF::Chunk* ckDLSID = pExtFile->GetSubChunk(CHUNK_ID_DLID);
6386                    if (ckDLSID) {
6387                        ::DLS::dlsid_t idExpected;
6388                        idExpected.ulData1 = ckXfil->ReadInt32();
6389                        idExpected.usData2 = ckXfil->ReadInt16();
6390                        idExpected.usData3 = ckXfil->ReadInt16();
6391                        ckXfil->Read(idExpected.abData, 8, 1);
6392                        ::DLS::dlsid_t idFound;
6393                        ckDLSID->Read(&idFound.ulData1, 1, 4);
6394                        ckDLSID->Read(&idFound.usData2, 1, 2);
6395                        ckDLSID->Read(&idFound.usData3, 1, 2);
6396                        ckDLSID->Read(idFound.abData, 8, 1);
6397                        if (memcmp(&idExpected, &idFound, 16) != 0)
6398                            throw gig::Exception("dlsid mismatch for extension file: %s", path.c_str());
6399                    }
6400                    poolFiles.push_back(pExtFile);
6401                    ExtensionFiles.push_back(pExtFile);
6402                }
6403            }
6404    
6405            // check if a .gx99 (GigaPulse) file exists
6406            RIFF::Chunk* ckDoxf = pRIFF->GetSubChunk(CHUNK_ID_DOXF);
6407            if (ckDoxf) { // there is a .gx99 (GigaPulse) file ...
6408                std::string path = baseName + ".gx99";
6409                RIFF::File* pExtFile = new RIFF::File(path);
6410    
6411                // skip unused int and filename
6412                ckDoxf->SetPos(132, RIFF::stream_curpos);
6413    
6414                // check that the dlsids match
6415                RIFF::Chunk* ckDLSID = pExtFile->GetSubChunk(CHUNK_ID_DLID);
6416                if (ckDLSID) {
6417                    ::DLS::dlsid_t idExpected;
6418                    idExpected.ulData1 = ckDoxf->ReadInt32();
6419                    idExpected.usData2 = ckDoxf->ReadInt16();
6420                    idExpected.usData3 = ckDoxf->ReadInt16();
6421                    ckDoxf->Read(idExpected.abData, 8, 1);
6422                    ::DLS::dlsid_t idFound;
6423                    ckDLSID->Read(&idFound.ulData1, 1, 4);
6424                    ckDLSID->Read(&idFound.usData2, 1, 2);
6425                    ckDLSID->Read(&idFound.usData3, 1, 2);
6426                    ckDLSID->Read(idFound.abData, 8, 1);
6427                    if (memcmp(&idExpected, &idFound, 16) != 0)
6428                        throw gig::Exception("dlsid mismatch for GigaPulse file: %s", path.c_str());
6429                }
6430                poolFiles.push_back(pExtFile);
6431                ExtensionFiles.push_back(pExtFile);
6432            }
6433    
6434          for (int fileNo = 0 ; ; ) {          // load samples from extension files (if required)
6435            for (int i = 0; i < poolFiles.size(); i++) {
6436                RIFF::File* file = poolFiles[i];
6437              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
6438              if (wvpl) {              if (wvpl) {
6439                  unsigned long wvplFileOffset = wvpl->GetFilePos();                  file_offset_t wvplFileOffset = wvpl->GetFilePos() -
6440                                                   wvpl->GetPos(); // should be zero, but just to be sure
6441                  RIFF::List* wave = wvpl->GetFirstSubList();                  RIFF::List* wave = wvpl->GetFirstSubList();
6442                  while (wave) {                  while (wave) {
6443                      if (wave->GetListType() == LIST_TYPE_WAVE) {                      if (wave->GetListType() == LIST_TYPE_WAVE) {
6444                          // notify current progress                          // notify current progress
6445                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;                          if (pProgress) {
6446                          __notify_progress(pProgress, subprogress);                              const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
6447                                __notify_progress(pProgress, subprogress);
6448                            }
6449    
6450                          unsigned long waveFileOffset = wave->GetFilePos();                          file_offset_t waveFileOffset = wave->GetFilePos();
6451                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, i, iSampleIndex));
6452    
6453                          iSampleIndex++;                          iSampleIndex++;
6454                      }                      }
6455                      wave = wvpl->GetNextSubList();                      wave = wvpl->GetNextSubList();
6456                  }                  }
6457                }
                 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;  
6458          }          }
6459    
6460          __notify_progress(pProgress, 1.0); // notify done          if (pProgress)
6461                __notify_progress(pProgress, 1.0); // notify done
6462      }      }
6463    
6464      Instrument* File::GetFirstInstrument() {      Instrument* File::GetFirstInstrument() {
# Line 3005  namespace { Line 6475  namespace {
6475      }      }
6476    
6477      /**      /**
6478         * Returns the total amount of instruments of this gig file.
6479         *
6480         * Note that this method might block for a long time in case it is required
6481         * to load the instruments info for the first time.
6482         *
6483         * @returns total amount of instruments
6484         */
6485        size_t File::CountInstruments() {
6486            if (!pInstruments) LoadInstruments();
6487            if (!pInstruments) return 0;
6488            return pInstruments->size();
6489        }
6490    
6491        /**
6492       * Returns the instrument with the given index.       * Returns the instrument with the given index.
6493       *       *
6494       * @param index     - number of the sought instrument (0..n)       * @param index     - number of the sought instrument (0..n)
# Line 3015  namespace { Line 6499  namespace {
6499          if (!pInstruments) {          if (!pInstruments) {
6500              // 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)
6501    
6502              // sample loading subtask              if (pProgress) {
6503              progress_t subprogress;                  // sample loading subtask
6504              __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask                  progress_t subprogress;
6505              __notify_progress(&subprogress, 0.0f);                  __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
6506              GetFirstSample(&subprogress); // now force all samples to be loaded                  __notify_progress(&subprogress, 0.0f);
6507              __notify_progress(&subprogress, 1.0f);                  if (GetAutoLoad())
6508                        GetFirstSample(&subprogress); // now force all samples to be loaded
6509              // instrument loading subtask                  __notify_progress(&subprogress, 1.0f);
6510              if (pProgress && pProgress->callback) {  
6511                  subprogress.__range_min = subprogress.__range_max;                  // instrument loading subtask
6512                  subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask                  if (pProgress->callback) {
6513              }                      subprogress.__range_min = subprogress.__range_max;
6514              __notify_progress(&subprogress, 0.0f);                      subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask
6515              LoadInstruments(&subprogress);                  }
6516              __notify_progress(&subprogress, 1.0f);                  __notify_progress(&subprogress, 0.0f);
6517                    LoadInstruments(&subprogress);
6518                    __notify_progress(&subprogress, 1.0f);
6519                } else {
6520                    // sample loading subtask
6521                    if (GetAutoLoad())
6522                        GetFirstSample(); // now force all samples to be loaded
6523    
6524                    // instrument loading subtask
6525                    LoadInstruments();
6526                }
6527          }          }
6528          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
6529          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
# Line 3052  namespace { Line 6546  namespace {
6546         __ensureMandatoryChunksExist();         __ensureMandatoryChunksExist();
6547         RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);         RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
6548         RIFF::List* lstInstr = lstInstruments->AddSubList(LIST_TYPE_INS);         RIFF::List* lstInstr = lstInstruments->AddSubList(LIST_TYPE_INS);
6549    
6550           // add mandatory chunks to get the chunks in right order
6551           lstInstr->AddSubList(LIST_TYPE_INFO);
6552           lstInstr->AddSubChunk(CHUNK_ID_DLID, 16);
6553    
6554         Instrument* pInstrument = new Instrument(this, lstInstr);         Instrument* pInstrument = new Instrument(this, lstInstr);
6555           pInstrument->GenerateDLSID();
6556    
6557           lstInstr->AddSubChunk(CHUNK_ID_INSH, 12);
6558    
6559           // this string is needed for the gig to be loadable in GSt:
6560           pInstrument->pInfo->Software = "Endless Wave";
6561    
6562         pInstruments->push_back(pInstrument);         pInstruments->push_back(pInstrument);
6563         return pInstrument;         return pInstrument;
6564      }      }
6565        
6566        /** @brief Add a duplicate of an existing instrument.
6567         *
6568         * Duplicates the instrument definition given by @a orig and adds it
6569         * to this file. This allows in an instrument editor application to
6570         * easily create variations of an instrument, which will be stored in
6571         * the same .gig file, sharing i.e. the same samples.
6572         *
6573         * Note that all sample pointers referenced by @a orig are simply copied as
6574         * memory address. Thus the respective samples are shared, not duplicated!
6575         *
6576         * You have to call Save() to make this persistent to the file.
6577         *
6578         * @param orig - original instrument to be copied
6579         * @returns duplicated copy of the given instrument
6580         */
6581        Instrument* File::AddDuplicateInstrument(const Instrument* orig) {
6582            Instrument* instr = AddInstrument();
6583            instr->CopyAssign(orig);
6584            return instr;
6585        }
6586        
6587        /** @brief Add content of another existing file.
6588         *
6589         * Duplicates the samples, groups and instruments of the original file
6590         * given by @a pFile and adds them to @c this File. In case @c this File is
6591         * a new one that you haven't saved before, then you have to call
6592         * SetFileName() before calling AddContentOf(), because this method will
6593         * automatically save this file during operation, which is required for
6594         * writing the sample waveform data by disk streaming.
6595         *
6596         * @param pFile - original file whose's content shall be copied from
6597         */
6598        void File::AddContentOf(File* pFile) {
6599            static int iCallCount = -1;
6600            iCallCount++;
6601            std::map<Group*,Group*> mGroups;
6602            std::map<Sample*,Sample*> mSamples;
6603            
6604            // clone sample groups
6605            for (int i = 0; pFile->GetGroup(i); ++i) {
6606                Group* g = AddGroup();
6607                g->Name =
6608                    "COPY" + ToString(iCallCount) + "_" + pFile->GetGroup(i)->Name;
6609                mGroups[pFile->GetGroup(i)] = g;
6610            }
6611            
6612            // clone samples (not waveform data here yet)
6613            for (int i = 0; pFile->GetSample(i); ++i) {
6614                Sample* s = AddSample();
6615                s->CopyAssignMeta(pFile->GetSample(i));
6616                mGroups[pFile->GetSample(i)->GetGroup()]->AddSample(s);
6617                mSamples[pFile->GetSample(i)] = s;
6618            }
6619    
6620            // clone script groups and their scripts
6621            for (int iGroup = 0; pFile->GetScriptGroup(iGroup); ++iGroup) {
6622                ScriptGroup* sg = pFile->GetScriptGroup(iGroup);
6623                ScriptGroup* dg = AddScriptGroup();
6624                dg->Name = "COPY" + ToString(iCallCount) + "_" + sg->Name;
6625                for (int iScript = 0; sg->GetScript(iScript); ++iScript) {
6626                    Script* ss = sg->GetScript(iScript);
6627                    Script* ds = dg->AddScript();
6628                    ds->CopyAssign(ss);
6629                }
6630            }
6631    
6632            //BUG: For some reason this method only works with this additional
6633            //     Save() call in between here.
6634            //
6635            // Important: The correct one of the 2 Save() methods has to be called
6636            // here, depending on whether the file is completely new or has been
6637            // saved to disk already, otherwise it will result in data corruption.
6638            if (pRIFF->IsNew())
6639                Save(GetFileName());
6640            else
6641                Save();
6642            
6643            // clone instruments
6644            // (passing the crosslink table here for the cloned samples)
6645            for (int i = 0; pFile->GetInstrument(i); ++i) {
6646                Instrument* instr = AddInstrument();
6647                instr->CopyAssign(pFile->GetInstrument(i), &mSamples);
6648            }
6649            
6650            // Mandatory: file needs to be saved to disk at this point, so this
6651            // file has the correct size and data layout for writing the samples'
6652            // waveform data to disk.
6653            Save();
6654            
6655            // clone samples' waveform data
6656            // (using direct read & write disk streaming)
6657            for (int i = 0; pFile->GetSample(i); ++i) {
6658                mSamples[pFile->GetSample(i)]->CopyAssignWave(pFile->GetSample(i));
6659            }
6660        }
6661    
6662      /** @brief Delete an instrument.      /** @brief Delete an instrument.
6663       *       *
# Line 3070  namespace { Line 6672  namespace {
6672          InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);          InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);
6673          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");
6674          pInstruments->erase(iter);          pInstruments->erase(iter);
6675            pInstrument->DeleteChunks();
6676          delete pInstrument;          delete pInstrument;
6677      }      }
6678    
# Line 3085  namespace { Line 6688  namespace {
6688              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();
6689              while (lstInstr) {              while (lstInstr) {
6690                  if (lstInstr->GetListType() == LIST_TYPE_INS) {                  if (lstInstr->GetListType() == LIST_TYPE_INS) {
6691                      // notify current progress                      if (pProgress) {
6692                      const float localProgress = (float) iInstrumentIndex / (float) Instruments;                          // notify current progress
6693                      __notify_progress(pProgress, localProgress);                          const float localProgress = (float) iInstrumentIndex / (float) Instruments;
6694                            __notify_progress(pProgress, localProgress);
                     // divide local progress into subprogress for loading current Instrument  
                     progress_t subprogress;  
                     __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);  
6695    
6696                      pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));                          // divide local progress into subprogress for loading current Instrument
6697                            progress_t subprogress;
6698                            __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
6699    
6700                            pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
6701                        } else {
6702                            pInstruments->push_back(new Instrument(this, lstInstr));
6703                        }
6704    
6705                      iInstrumentIndex++;                      iInstrumentIndex++;
6706                  }                  }
6707                  lstInstr = lstInstruments->GetNextSubList();                  lstInstr = lstInstruments->GetNextSubList();
6708              }              }
6709              __notify_progress(pProgress, 1.0); // notify done              if (pProgress)
6710                    __notify_progress(pProgress, 1.0); // notify done
6711            }
6712        }
6713    
6714        /// Updates the 3crc chunk with the checksum of a sample. The
6715        /// update is done directly to disk, as this method is called
6716        /// after File::Save()
6717        void File::SetSampleChecksum(Sample* pSample, uint32_t crc) {
6718            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6719            if (!_3crc) return;
6720    
6721            // get the index of the sample
6722            int iWaveIndex = GetWaveTableIndexOf(pSample);
6723            if (iWaveIndex < 0) throw gig::Exception("Could not update crc, could not find sample");
6724    
6725            // write the CRC-32 checksum to disk
6726            _3crc->SetPos(iWaveIndex * 8);
6727            uint32_t one = 1;
6728            _3crc->WriteUint32(&one); // always 1
6729            _3crc->WriteUint32(&crc);
6730        }
6731    
6732        uint32_t File::GetSampleChecksum(Sample* pSample) {
6733            // get the index of the sample
6734            int iWaveIndex = GetWaveTableIndexOf(pSample);
6735            if (iWaveIndex < 0) throw gig::Exception("Could not retrieve reference crc of sample, could not resolve sample's wave table index");
6736    
6737            return GetSampleChecksumByIndex(iWaveIndex);
6738        }
6739    
6740        uint32_t File::GetSampleChecksumByIndex(int index) {
6741            if (index < 0) throw gig::Exception("Could not retrieve reference crc of sample, invalid wave pool index of sample");
6742    
6743            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6744            if (!_3crc) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
6745            uint8_t* pData = (uint8_t*) _3crc->LoadChunkData();
6746            if (!pData) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
6747    
6748            // read the CRC-32 checksum directly from disk
6749            size_t pos = index * 8;
6750            if (pos + 8 > _3crc->GetNewSize())
6751                throw gig::Exception("Could not retrieve reference crc of sample, could not seek to required position in crc chunk");
6752    
6753            uint32_t one = load32(&pData[pos]); // always 1
6754            if (one != 1)
6755                throw gig::Exception("Could not retrieve reference crc of sample, because reference checksum table is damaged");
6756    
6757            return load32(&pData[pos+4]);
6758        }
6759    
6760        int File::GetWaveTableIndexOf(gig::Sample* pSample) {
6761            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
6762            File::SampleList::iterator iter = pSamples->begin();
6763            File::SampleList::iterator end  = pSamples->end();
6764            for (int index = 0; iter != end; ++iter, ++index)
6765                if (*iter == pSample)
6766                    return index;
6767            return -1;
6768        }
6769    
6770        /**
6771         * Checks whether the file's "3CRC" chunk was damaged. This chunk contains
6772         * the CRC32 check sums of all samples' raw wave data.
6773         *
6774         * @return true if 3CRC chunk is OK, or false if 3CRC chunk is damaged
6775         */
6776        bool File::VerifySampleChecksumTable() {
6777            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6778            if (!_3crc) return false;
6779            if (_3crc->GetNewSize() <= 0) return false;
6780            if (_3crc->GetNewSize() % 8) return false;
6781            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
6782            if (_3crc->GetNewSize() != pSamples->size() * 8) return false;
6783    
6784            const file_offset_t n = _3crc->GetNewSize() / 8;
6785    
6786            uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6787            if (!pData) return false;
6788    
6789            for (file_offset_t i = 0; i < n; ++i) {
6790                uint32_t one = pData[i*2];
6791                if (one != 1) return false;
6792            }
6793    
6794            return true;
6795        }
6796    
6797        /**
6798         * Recalculates CRC32 checksums for all samples and rebuilds this gig
6799         * file's checksum table with those new checksums. This might usually
6800         * just be necessary if the checksum table was damaged.
6801         *
6802         * @e IMPORTANT: The current implementation of this method only works
6803         * with files that have not been modified since it was loaded, because
6804         * it expects that no externally caused file structure changes are
6805         * required!
6806         *
6807         * Due to the expectation above, this method is currently protected
6808         * and actually only used by the command line tool "gigdump" yet.
6809         *
6810         * @returns true if Save() is required to be called after this call,
6811         *          false if no further action is required
6812         */
6813        bool File::RebuildSampleChecksumTable() {
6814            // make sure sample chunks were scanned
6815            if (!pSamples) GetFirstSample();
6816    
6817            bool bRequiresSave = false;
6818    
6819            // make sure "3CRC" chunk exists with required size
6820            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6821            if (!_3crc) {
6822                _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
6823                // the order of einf and 3crc is not the same in v2 and v3
6824                RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
6825                if (einf && pVersion && pVersion->major > 2) pRIFF->MoveSubChunk(_3crc, einf);
6826                bRequiresSave = true;
6827            } else if (_3crc->GetNewSize() != pSamples->size() * 8) {
6828                _3crc->Resize(pSamples->size() * 8);
6829                bRequiresSave = true;
6830            }
6831    
6832            if (bRequiresSave) { // refill CRC table for all samples in RAM ...
6833                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6834                {
6835                    File::SampleList::iterator iter = pSamples->begin();
6836                    File::SampleList::iterator end  = pSamples->end();
6837                    for (; iter != end; ++iter) {
6838                        gig::Sample* pSample = (gig::Sample*) *iter;
6839                        int index = GetWaveTableIndexOf(pSample);
6840                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6841                        pData[index*2]   = 1; // always 1
6842                        pData[index*2+1] = pSample->CalculateWaveDataChecksum();
6843                    }
6844                }
6845            } else { // no file structure changes necessary, so directly write to disk and we are done ...
6846                // make sure file is in write mode
6847                pRIFF->SetMode(RIFF::stream_mode_read_write);
6848                {
6849                    File::SampleList::iterator iter = pSamples->begin();
6850                    File::SampleList::iterator end  = pSamples->end();
6851                    for (; iter != end; ++iter) {
6852                        gig::Sample* pSample = (gig::Sample*) *iter;
6853                        int index = GetWaveTableIndexOf(pSample);
6854                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6855                        pSample->crc  = pSample->CalculateWaveDataChecksum();
6856                        SetSampleChecksum(pSample, pSample->crc);
6857                    }
6858                }
6859          }          }
6860    
6861            return bRequiresSave;
6862      }      }
6863    
6864      Group* File::GetFirstGroup() {      Group* File::GetFirstGroup() {
# Line 3132  namespace { Line 6890  namespace {
6890          return NULL;          return NULL;
6891      }      }
6892    
6893        /**
6894         * Returns the group with the given group name.
6895         *
6896         * Note: group names don't have to be unique in the gig format! So there
6897         * can be multiple groups with the same name. This method will simply
6898         * return the first group found with the given name.
6899         *
6900         * @param name - name of the sought group
6901         * @returns sought group or NULL if there's no group with that name
6902         */
6903        Group* File::GetGroup(String name) {
6904            if (!pGroups) LoadGroups();
6905            GroupsIterator = pGroups->begin();
6906            for (uint i = 0; GroupsIterator != pGroups->end(); ++GroupsIterator, ++i)
6907                if ((*GroupsIterator)->Name == name) return *GroupsIterator;
6908            return NULL;
6909        }
6910    
6911      Group* File::AddGroup() {      Group* File::AddGroup() {
6912          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6913          // there must always be at least one group          // there must always be at least one group
# Line 3161  namespace { Line 6937  namespace {
6937          }          }
6938          // now delete this group object          // now delete this group object
6939          pGroups->erase(iter);          pGroups->erase(iter);
6940            pGroup->DeleteChunks();
6941          delete pGroup;          delete pGroup;
6942      }      }
6943    
# Line 3182  namespace { Line 6959  namespace {
6959          // move all members of this group to another group          // move all members of this group to another group
6960          pGroup->MoveAll();          pGroup->MoveAll();
6961          pGroups->erase(iter);          pGroups->erase(iter);
6962            pGroup->DeleteChunks();
6963          delete pGroup;          delete pGroup;
6964      }      }
6965    
# Line 3195  namespace { Line 6973  namespace {
6973                  RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();                  RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();
6974                  while (ck) {                  while (ck) {
6975                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {
6976                            if (pVersion && pVersion->major > 2 &&
6977                                strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;
6978    
6979                          pGroups->push_back(new Group(this, ck));                          pGroups->push_back(new Group(this, ck));
6980                      }                      }
6981                      ck = lst3gnl->GetNextSubChunk();                      ck = lst3gnl->GetNextSubChunk();
# Line 3209  namespace { Line 6990  namespace {
6990          }          }
6991      }      }
6992    
6993        /** @brief Get instrument script group (by index).
6994         *
6995         * Returns the real-time instrument script group with the given index.
6996         *
6997         * @param index - number of the sought group (0..n)
6998         * @returns sought script group or NULL if there's no such group
6999         */
7000        ScriptGroup* File::GetScriptGroup(uint index) {
7001            if (!pScriptGroups) LoadScriptGroups();
7002            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
7003            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
7004                if (i == index) return *it;
7005            return NULL;
7006        }
7007    
7008        /** @brief Get instrument script group (by name).
7009         *
7010         * Returns the first real-time instrument script group found with the given
7011         * group name. Note that group names may not necessarily be unique.
7012         *
7013         * @param name - name of the sought script group
7014         * @returns sought script group or NULL if there's no such group
7015         */
7016        ScriptGroup* File::GetScriptGroup(const String& name) {
7017            if (!pScriptGroups) LoadScriptGroups();
7018            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
7019            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
7020                if ((*it)->Name == name) return *it;
7021            return NULL;
7022        }
7023    
7024        /** @brief Add new instrument script group.
7025         *
7026         * Adds a new, empty real-time instrument script group to the file.
7027         *
7028         * You have to call Save() to make this persistent to the file.
7029         *
7030         * @return new empty script group
7031         */
7032        ScriptGroup* File::AddScriptGroup() {
7033            if (!pScriptGroups) LoadScriptGroups();
7034            ScriptGroup* pScriptGroup = new ScriptGroup(this, NULL);
7035            pScriptGroups->push_back(pScriptGroup);
7036            return pScriptGroup;
7037        }
7038    
7039        /** @brief Delete an instrument script group.
7040         *
7041         * This will delete the given real-time instrument script group and all its
7042         * instrument scripts it contains. References inside instruments that are
7043         * using the deleted scripts will be removed from the respective instruments
7044         * accordingly.
7045         *
7046         * You have to call Save() to make this persistent to the file.
7047         *
7048         * @param pScriptGroup - script group to delete
7049         * @throws gig::Exception if given script group could not be found
7050         */
7051        void File::DeleteScriptGroup(ScriptGroup* pScriptGroup) {
7052            if (!pScriptGroups) LoadScriptGroups();
7053            std::list<ScriptGroup*>::iterator iter =
7054                find(pScriptGroups->begin(), pScriptGroups->end(), pScriptGroup);
7055            if (iter == pScriptGroups->end())
7056                throw gig::Exception("Could not delete script group, could not find given script group");
7057            pScriptGroups->erase(iter);
7058            for (int i = 0; pScriptGroup->GetScript(i); ++i)
7059                pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));
7060            if (pScriptGroup->pList)
7061                pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);
7062            pScriptGroup->DeleteChunks();
7063            delete pScriptGroup;
7064        }
7065    
7066        void File::LoadScriptGroups() {
7067            if (pScriptGroups) return;
7068            pScriptGroups = new std::list<ScriptGroup*>;
7069            RIFF::List* lstLS = pRIFF->GetSubList(LIST_TYPE_3LS);
7070            if (lstLS) {
7071                for (RIFF::List* lst = lstLS->GetFirstSubList(); lst;
7072                     lst = lstLS->GetNextSubList())
7073                {
7074                    if (lst->GetListType() == LIST_TYPE_RTIS) {
7075                        pScriptGroups->push_back(new ScriptGroup(this, lst));
7076                    }
7077                }
7078            }
7079        }
7080    
7081      /**      /**
7082       * Apply all the gig file's current instruments, samples, groups and settings       * Apply all the gig file's current instruments, samples, groups and settings
7083       * 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 3217  namespace { Line 7086  namespace {
7086       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
7087       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
7088       *       *
7089         * @param pProgress - callback function for progress notification
7090       * @throws Exception - on errors       * @throws Exception - on errors
7091       */       */
7092      void File::UpdateChunks() {      void File::UpdateChunks(progress_t* pProgress) {
7093            bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;
7094    
7095            // update own gig format extension chunks
7096            // (not part of the GigaStudio 4 format)
7097            RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);
7098            if (!lst3LS) {
7099                lst3LS = pRIFF->AddSubList(LIST_TYPE_3LS);
7100            }
7101            // Make sure <3LS > chunk is placed before <ptbl> chunk. The precise
7102            // location of <3LS > is irrelevant, however it should be located
7103            // before  the actual wave data
7104            RIFF::Chunk* ckPTBL = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
7105            pRIFF->MoveSubChunk(lst3LS, ckPTBL);
7106    
7107            // This must be performed before writing the chunks for instruments,
7108            // because the instruments' script slots will write the file offsets
7109            // of the respective instrument script chunk as reference.
7110            if (pScriptGroups) {
7111                // Update instrument script (group) chunks.
7112                for (std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
7113                     it != pScriptGroups->end(); ++it)
7114                {
7115                    (*it)->UpdateChunks(pProgress);
7116                }
7117            }
7118    
7119            // in case no libgig custom format data was added, then remove the
7120            // custom "3LS " chunk again
7121            if (!lst3LS->CountSubChunks()) {
7122                pRIFF->DeleteSubChunk(lst3LS);
7123                lst3LS = NULL;
7124            }
7125    
7126          // first update base class's chunks          // first update base class's chunks
7127          DLS::File::UpdateChunks();          DLS::File::UpdateChunks(pProgress);
7128    
7129            if (newFile) {
7130                // INFO was added by Resource::UpdateChunks - make sure it
7131                // is placed first in file
7132                RIFF::Chunk* info = pRIFF->GetSubList(LIST_TYPE_INFO);
7133                RIFF::Chunk* first = pRIFF->GetFirstSubChunk();
7134                if (first != info) {
7135                    pRIFF->MoveSubChunk(info, first);
7136                }
7137            }
7138    
7139          // update group's chunks          // update group's chunks
7140          if (pGroups) {          if (pGroups) {
7141                // make sure '3gri' and '3gnl' list chunks exist
7142                // (before updating the Group chunks)
7143                RIFF::List* _3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
7144                if (!_3gri) {
7145                    _3gri = pRIFF->AddSubList(LIST_TYPE_3GRI);
7146                    pRIFF->MoveSubChunk(_3gri, pRIFF->GetSubChunk(CHUNK_ID_PTBL));
7147                }
7148                RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
7149                if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
7150    
7151                // v3: make sure the file has 128 3gnm chunks
7152                // (before updating the Group chunks)
7153                if (pVersion && pVersion->major > 2) {
7154                    RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
7155                    for (int i = 0 ; i < 128 ; i++) {
7156                        // create 128 empty placeholder strings which will either
7157                        // be filled by Group::UpdateChunks below or left empty.
7158                        ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
7159                        if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();
7160                    }
7161                }
7162    
7163              std::list<Group*>::iterator iter = pGroups->begin();              std::list<Group*>::iterator iter = pGroups->begin();
7164              std::list<Group*>::iterator end  = pGroups->end();              std::list<Group*>::iterator end  = pGroups->end();
7165              for (; iter != end; ++iter) {              for (; iter != end; ++iter) {
7166                  (*iter)->UpdateChunks();                  (*iter)->UpdateChunks(pProgress);
7167                }
7168            }
7169    
7170            // update einf chunk
7171    
7172            // The einf chunk contains statistics about the gig file, such
7173            // as the number of regions and samples used by each
7174            // instrument. It is divided in equally sized parts, where the
7175            // first part contains information about the whole gig file,
7176            // and the rest of the parts map to each instrument in the
7177            // file.
7178            //
7179            // At the end of each part there is a bit map of each sample
7180            // in the file, where a set bit means that the sample is used
7181            // by the file/instrument.
7182            //
7183            // Note that there are several fields with unknown use. These
7184            // are set to zero.
7185    
7186            int sublen = int(pSamples->size() / 8 + 49);
7187            int einfSize = (Instruments + 1) * sublen;
7188    
7189            RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
7190            if (einf) {
7191                if (einf->GetSize() != einfSize) {
7192                    einf->Resize(einfSize);
7193                    memset(einf->LoadChunkData(), 0, einfSize);
7194                }
7195            } else if (newFile) {
7196                einf = pRIFF->AddSubChunk(CHUNK_ID_EINF, einfSize);
7197            }
7198            if (einf) {
7199                uint8_t* pData = (uint8_t*) einf->LoadChunkData();
7200    
7201                std::map<gig::Sample*,int> sampleMap;
7202                int sampleIdx = 0;
7203                for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
7204                    sampleMap[pSample] = sampleIdx++;
7205                }
7206    
7207                int totnbusedsamples = 0;
7208                int totnbusedchannels = 0;
7209                int totnbregions = 0;
7210                int totnbdimregions = 0;
7211                int totnbloops = 0;
7212                int instrumentIdx = 0;
7213    
7214                memset(&pData[48], 0, sublen - 48);
7215    
7216                for (Instrument* instrument = GetFirstInstrument() ; instrument ;
7217                     instrument = GetNextInstrument()) {
7218                    int nbusedsamples = 0;
7219                    int nbusedchannels = 0;
7220                    int nbdimregions = 0;
7221                    int nbloops = 0;
7222    
7223                    memset(&pData[(instrumentIdx + 1) * sublen + 48], 0, sublen - 48);
7224    
7225                    for (Region* region = instrument->GetFirstRegion() ; region ;
7226                         region = instrument->GetNextRegion()) {
7227                        for (int i = 0 ; i < region->DimensionRegions ; i++) {
7228                            gig::DimensionRegion *d = region->pDimensionRegions[i];
7229                            if (d->pSample) {
7230                                int sampleIdx = sampleMap[d->pSample];
7231                                int byte = 48 + sampleIdx / 8;
7232                                int bit = 1 << (sampleIdx & 7);
7233                                if ((pData[(instrumentIdx + 1) * sublen + byte] & bit) == 0) {
7234                                    pData[(instrumentIdx + 1) * sublen + byte] |= bit;
7235                                    nbusedsamples++;
7236                                    nbusedchannels += d->pSample->Channels;
7237    
7238                                    if ((pData[byte] & bit) == 0) {
7239                                        pData[byte] |= bit;
7240                                        totnbusedsamples++;
7241                                        totnbusedchannels += d->pSample->Channels;
7242                                    }
7243                                }
7244                            }
7245                            if (d->SampleLoops) nbloops++;
7246                        }
7247                        nbdimregions += region->DimensionRegions;
7248                    }
7249                    // first 4 bytes unknown - sometimes 0, sometimes length of einf part
7250                    // store32(&pData[(instrumentIdx + 1) * sublen], sublen);
7251                    store32(&pData[(instrumentIdx + 1) * sublen + 4], nbusedchannels);
7252                    store32(&pData[(instrumentIdx + 1) * sublen + 8], nbusedsamples);
7253                    store32(&pData[(instrumentIdx + 1) * sublen + 12], 1);
7254                    store32(&pData[(instrumentIdx + 1) * sublen + 16], instrument->Regions);
7255                    store32(&pData[(instrumentIdx + 1) * sublen + 20], nbdimregions);
7256                    store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);
7257                    // next 8 bytes unknown
7258                    store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);
7259                    store32(&pData[(instrumentIdx + 1) * sublen + 40], (uint32_t) pSamples->size());
7260                    // next 4 bytes unknown
7261    
7262                    totnbregions += instrument->Regions;
7263                    totnbdimregions += nbdimregions;
7264                    totnbloops += nbloops;
7265                    instrumentIdx++;
7266                }
7267                // first 4 bytes unknown - sometimes 0, sometimes length of einf part
7268                // store32(&pData[0], sublen);
7269                store32(&pData[4], totnbusedchannels);
7270                store32(&pData[8], totnbusedsamples);
7271                store32(&pData[12], Instruments);
7272                store32(&pData[16], totnbregions);
7273                store32(&pData[20], totnbdimregions);
7274                store32(&pData[24], totnbloops);
7275                // next 8 bytes unknown
7276                // next 4 bytes unknown, not always 0
7277                store32(&pData[40], (uint32_t) pSamples->size());
7278                // next 4 bytes unknown
7279            }
7280    
7281            // update 3crc chunk
7282    
7283            // The 3crc chunk contains CRC-32 checksums for the
7284            // samples. When saving a gig file to disk, we first update the 3CRC
7285            // chunk here (in RAM) with the old crc values which we read from the
7286            // 3CRC chunk when we opened the file (available with gig::Sample::crc
7287            // member variable). This step is required, because samples might have
7288            // been deleted by the user since the file was opened, which in turn
7289            // changes the order of the (i.e. old) checksums within the 3crc chunk.
7290            // If a sample was conciously modified by the user (that is if
7291            // Sample::Write() was called later on) then Sample::Write() will just
7292            // update the respective individual checksum(s) directly on disk and
7293            // leaves all other sample checksums untouched.
7294    
7295            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
7296            if (_3crc) {
7297                _3crc->Resize(pSamples->size() * 8);
7298            } else /*if (newFile)*/ {
7299                _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
7300                // the order of einf and 3crc is not the same in v2 and v3
7301                if (einf && pVersion && pVersion->major > 2) pRIFF->MoveSubChunk(_3crc, einf);
7302            }
7303            { // must be performed in RAM here ...
7304                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
7305                if (pData) {
7306                    File::SampleList::iterator iter = pSamples->begin();
7307                    File::SampleList::iterator end  = pSamples->end();
7308                    for (int index = 0; iter != end; ++iter, ++index) {
7309                        gig::Sample* pSample = (gig::Sample*) *iter;
7310                        pData[index*2]   = 1; // always 1
7311                        pData[index*2+1] = pSample->crc;
7312                    }
7313              }              }
7314          }          }
7315      }      }
7316        
7317        void File::UpdateFileOffsets() {
7318            DLS::File::UpdateFileOffsets();
7319    
7320            for (Instrument* instrument = GetFirstInstrument(); instrument;
7321                 instrument = GetNextInstrument())
7322            {
7323                instrument->UpdateScriptFileOffsets();
7324            }
7325        }
7326    
7327        /**
7328         * Enable / disable automatic loading. By default this property is
7329         * enabled and every information is loaded automatically. However
7330         * loading all Regions, DimensionRegions and especially samples might
7331         * take a long time for large .gig files, and sometimes one might only
7332         * be interested in retrieving very superficial informations like the
7333         * amount of instruments and their names. In this case one might disable
7334         * automatic loading to avoid very slow response times.
7335         *
7336         * @e CAUTION: by disabling this property many pointers (i.e. sample
7337         * references) and attributes will have invalid or even undefined
7338         * data! This feature is currently only intended for retrieving very
7339         * superficial information in a very fast way. Don't use it to retrieve
7340         * details like synthesis information or even to modify .gig files!
7341         */
7342        void File::SetAutoLoad(bool b) {
7343            bAutoLoad = b;
7344        }
7345    
7346        /**
7347         * Returns whether automatic loading is enabled.
7348         * @see SetAutoLoad()
7349         */
7350        bool File::GetAutoLoad() {
7351            return bAutoLoad;
7352        }
7353    
7354        /**
7355         * Returns @c true in case this gig File object uses any gig format
7356         * extension, that is e.g. whether any DimensionRegion object currently
7357         * has any setting effective that would require our "LSDE" RIFF chunk to
7358         * be stored to the gig file.
7359         *
7360         * Right now this is a private method. It is considerable though this method
7361         * to become (in slightly modified form) a public API method in future, i.e.
7362         * to allow instrument editors to visualize and/or warn the user of any gig
7363         * format extension being used. See also comments on
7364         * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
7365         * potential public API change in future.
7366         */
7367        bool File::UsesAnyGigFormatExtension() const {
7368            if (!pInstruments) return false;
7369            InstrumentList::iterator iter = pInstruments->begin();
7370            InstrumentList::iterator end  = pInstruments->end();
7371            for (; iter != end; ++iter) {
7372                Instrument* pInstrument = static_cast<gig::Instrument*>(*iter);
7373                if (pInstrument->UsesAnyGigFormatExtension())
7374                    return true;
7375            }
7376            return false;
7377        }
7378    
7379    
7380  // *************** Exception ***************  // *************** Exception ***************
7381  // *  // *
7382    
7383      Exception::Exception(String Message) : DLS::Exception(Message) {      Exception::Exception() : DLS::Exception() {
7384        }
7385    
7386        Exception::Exception(String format, ...) : DLS::Exception() {
7387            va_list arg;
7388            va_start(arg, format);
7389            Message = assemble(format, arg);
7390            va_end(arg);
7391        }
7392    
7393        Exception::Exception(String format, va_list arg) : DLS::Exception() {
7394            Message = assemble(format, arg);
7395      }      }
7396    
7397      void Exception::PrintMessage() {      void Exception::PrintMessage() {

Legend:
Removed from v.1158  
changed lines
  Added in v.3903

  ViewVC Help
Powered by ViewVC