/[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 1199 by persson, Sun May 20 10:11:39 2007 UTC revision 3414 by schoenebeck, Tue Jan 30 20:17:12 2018 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-2018 by Christian Schoenebeck                      *
6   *                              <cuse@users.sourceforge.net>               *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   This library is free software; you can redistribute it and/or modify  *
# Line 24  Line 24 
24  #include "gig.h"  #include "gig.h"
25    
26  #include "helper.h"  #include "helper.h"
27    #include "Serialization.h"
28    
29    #include <algorithm>
30  #include <math.h>  #include <math.h>
31  #include <iostream>  #include <iostream>
32    #include <assert.h>
33    
34    /// libgig's current file format version (for extending the original Giga file
35    /// format with libgig's own custom data / custom features).
36    #define GIG_FILE_EXT_VERSION    2
37    
38  /// Initial size of the sample buffer which is used for decompression of  /// Initial size of the sample buffer which is used for decompression of
39  /// compressed sample wave streams - this value should always be bigger than  /// compressed sample wave streams - this value should always be bigger than
# Line 49  Line 56 
56  #define GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(x)    ((x & 0x03) << 3)  #define GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(x)    ((x & 0x03) << 3)
57  #define GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(x)  ((x & 0x03) << 5)  #define GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(x)  ((x & 0x03) << 5)
58    
59  namespace gig {  #define SRLZ(member) \
60        archive->serializeMember(*this, member, #member);
 // *************** progress_t ***************  
 // *  
   
     progress_t::progress_t() {  
         callback    = NULL;  
         custom      = NULL;  
         __range_min = 0.0f;  
         __range_max = 1.0f;  
     }  
   
     // private helper function to convert progress of a subprocess into the global progress  
     static void __notify_progress(progress_t* pProgress, float subprogress) {  
         if (pProgress && pProgress->callback) {  
             const float totalrange    = pProgress->__range_max - pProgress->__range_min;  
             const float totalprogress = pProgress->__range_min + subprogress * totalrange;  
             pProgress->factor         = totalprogress;  
             pProgress->callback(pProgress); // now actually notify about the progress  
         }  
     }  
   
     // private helper function to divide a progress into subprogresses  
     static void __divide_progress(progress_t* pParentProgress, progress_t* pSubProgress, float totalTasks, float currentTask) {  
         if (pParentProgress && pParentProgress->callback) {  
             const float totalrange    = pParentProgress->__range_max - pParentProgress->__range_min;  
             pSubProgress->callback    = pParentProgress->callback;  
             pSubProgress->custom      = pParentProgress->custom;  
             pSubProgress->__range_min = pParentProgress->__range_min + totalrange * currentTask / totalTasks;  
             pSubProgress->__range_max = pSubProgress->__range_min + totalrange / totalTasks;  
         }  
     }  
61    
62    namespace gig {
63    
64  // *************** Internal functions for sample decompression ***************  // *************** Internal functions for sample decompression ***************
65  // *  // *
# Line 121  namespace { Line 99  namespace {
99      void Decompress16(int compressionmode, const unsigned char* params,      void Decompress16(int compressionmode, const unsigned char* params,
100                        int srcStep, int dstStep,                        int srcStep, int dstStep,
101                        const unsigned char* pSrc, int16_t* pDst,                        const unsigned char* pSrc, int16_t* pDst,
102                        unsigned long currentframeoffset,                        file_offset_t currentframeoffset,
103                        unsigned long copysamples)                        file_offset_t copysamples)
104      {      {
105          switch (compressionmode) {          switch (compressionmode) {
106              case 0: // 16 bit uncompressed              case 0: // 16 bit uncompressed
# Line 158  namespace { Line 136  namespace {
136    
137      void Decompress24(int compressionmode, const unsigned char* params,      void Decompress24(int compressionmode, const unsigned char* params,
138                        int dstStep, const unsigned char* pSrc, uint8_t* pDst,                        int dstStep, const unsigned char* pSrc, uint8_t* pDst,
139                        unsigned long currentframeoffset,                        file_offset_t currentframeoffset,
140                        unsigned long copysamples, int truncatedBits)                        file_offset_t copysamples, int truncatedBits)
141      {      {
142          int y, dy, ddy, dddy;          int y, dy, ddy, dddy;
143    
# Line 255  namespace { Line 233  namespace {
233    
234    
235    
236    // *************** Internal CRC-32 (Cyclic Redundancy Check) functions  ***************
237    // *
238    
239        static uint32_t* __initCRCTable() {
240            static uint32_t res[256];
241    
242            for (int i = 0 ; i < 256 ; i++) {
243                uint32_t c = i;
244                for (int j = 0 ; j < 8 ; j++) {
245                    c = (c & 1) ? 0xedb88320 ^ (c >> 1) : c >> 1;
246                }
247                res[i] = c;
248            }
249            return res;
250        }
251    
252        static const uint32_t* __CRCTable = __initCRCTable();
253    
254        /**
255         * Initialize a CRC variable.
256         *
257         * @param crc - variable to be initialized
258         */
259        inline static void __resetCRC(uint32_t& crc) {
260            crc = 0xffffffff;
261        }
262    
263        /**
264         * Used to calculate checksums of the sample data in a gig file. The
265         * checksums are stored in the 3crc chunk of the gig file and
266         * automatically updated when a sample is written with Sample::Write().
267         *
268         * One should call __resetCRC() to initialize the CRC variable to be
269         * used before calling this function the first time.
270         *
271         * After initializing the CRC variable one can call this function
272         * arbitrary times, i.e. to split the overall CRC calculation into
273         * steps.
274         *
275         * Once the whole data was processed by __calculateCRC(), one should
276         * call __finalizeCRC() to get the final CRC result.
277         *
278         * @param buf     - pointer to data the CRC shall be calculated of
279         * @param bufSize - size of the data to be processed
280         * @param crc     - variable the CRC sum shall be stored to
281         */
282        static void __calculateCRC(unsigned char* buf, size_t bufSize, uint32_t& crc) {
283            for (size_t i = 0 ; i < bufSize ; i++) {
284                crc = __CRCTable[(crc ^ buf[i]) & 0xff] ^ (crc >> 8);
285            }
286        }
287    
288        /**
289         * Returns the final CRC result.
290         *
291         * @param crc - variable previously passed to __calculateCRC()
292         */
293        inline static void __finalizeCRC(uint32_t& crc) {
294            crc ^= 0xffffffff;
295        }
296    
297    
298    
299  // *************** Other Internal functions  ***************  // *************** Other Internal functions  ***************
300  // *  // *
301    
# Line 278  namespace { Line 319  namespace {
319    
320    
321    
322  // *************** CRC ***************  // *************** leverage_ctrl_t ***************
323  // *  // *
324    
325      const uint32_t* CRC::table(initTable());      void leverage_ctrl_t::serialize(Serialization::Archive* archive) {
326            SRLZ(type);
327            SRLZ(controller_number);
328        }
329    
     uint32_t* CRC::initTable() {  
         uint32_t* res = new uint32_t[256];  
330    
331          for (int i = 0 ; i < 256 ; i++) {  
332              uint32_t c = i;  // *************** crossfade_t ***************
333              for (int j = 0 ; j < 8 ; j++) {  // *
334                  c = (c & 1) ? 0xedb88320 ^ (c >> 1) : c >> 1;  
335              }      void crossfade_t::serialize(Serialization::Archive* archive) {
336              res[i] = c;          SRLZ(in_start);
337          }          SRLZ(in_end);
338          return res;          SRLZ(out_start);
339            SRLZ(out_end);
340        }
341    
342    
343    
344    // *************** eg_opt_t ***************
345    // *
346    
347        eg_opt_t::eg_opt_t() {
348            AttackCancel     = true;
349            AttackHoldCancel = true;
350            Decay1Cancel     = true;
351            Decay2Cancel     = true;
352            ReleaseCancel    = true;
353        }
354    
355        void eg_opt_t::serialize(Serialization::Archive* archive) {
356            SRLZ(AttackCancel);
357            SRLZ(AttackHoldCancel);
358            SRLZ(Decay1Cancel);
359            SRLZ(Decay2Cancel);
360            SRLZ(ReleaseCancel);
361      }      }
362    
363    
# Line 301  namespace { Line 365  namespace {
365  // *************** Sample ***************  // *************** Sample ***************
366  // *  // *
367    
368      unsigned int Sample::Instances = 0;      size_t       Sample::Instances = 0;
369      buffer_t     Sample::InternalDecompressionBuffer;      buffer_t     Sample::InternalDecompressionBuffer;
370    
371      /** @brief Constructor.      /** @brief Constructor.
# Line 321  namespace { Line 385  namespace {
385       *                         ('wvpl') list chunk       *                         ('wvpl') list chunk
386       * @param fileNo         - number of an extension file where this sample       * @param fileNo         - number of an extension file where this sample
387       *                         is located, 0 otherwise       *                         is located, 0 otherwise
388         * @param index          - wave pool index of sample (may be -1 on new sample)
389       */       */
390      Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {      Sample::Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset, unsigned long fileNo, int index)
391          static const DLS::Info::FixedStringLength fixedStringLengths[] = {          : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset)
392        {
393            static const DLS::Info::string_length_t fixedStringLengths[] = {
394              { CHUNK_ID_INAM, 64 },              { CHUNK_ID_INAM, 64 },
395              { 0, 0 }              { 0, 0 }
396          };          };
397          pInfo->FixedStringLengths = fixedStringLengths;          pInfo->SetFixedStringLengths(fixedStringLengths);
398          Instances++;          Instances++;
399          FileNo = fileNo;          FileNo = fileNo;
400    
401            __resetCRC(crc);
402            // if this is not a new sample, try to get the sample's already existing
403            // CRC32 checksum from disk, this checksum will reflect the sample's CRC32
404            // checksum of the time when the sample was consciously modified by the
405            // user for the last time (by calling Sample::Write() that is).
406            if (index >= 0) { // not a new file ...
407                try {
408                    uint32_t crc = pFile->GetSampleChecksumByIndex(index);
409                    this->crc = crc;
410                } catch (...) {}
411            }
412    
413          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
414          if (pCk3gix) {          if (pCk3gix) {
415              uint16_t iSampleGroup = pCk3gix->ReadInt16();              uint16_t iSampleGroup = pCk3gix->ReadInt16();
# Line 362  namespace { Line 441  namespace {
441              Manufacturer  = 0;              Manufacturer  = 0;
442              Product       = 0;              Product       = 0;
443              SamplePeriod  = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);              SamplePeriod  = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
444              MIDIUnityNote = 64;              MIDIUnityNote = 60;
445              FineTune      = 0;              FineTune      = 0;
446              SMPTEFormat   = smpte_format_no_offset;              SMPTEFormat   = smpte_format_no_offset;
447              SMPTEOffset   = 0;              SMPTEOffset   = 0;
# Line 408  namespace { Line 487  namespace {
487      }      }
488    
489      /**      /**
490         * Make a (semi) deep copy of the Sample object given by @a orig (without
491         * the actual waveform data) and assign it to this object.
492         *
493         * Discussion: copying .gig samples is a bit tricky. It requires three
494         * steps:
495         * 1. Copy sample's meta informations (done by CopyAssignMeta()) including
496         *    its new sample waveform data size.
497         * 2. Saving the file (done by File::Save()) so that it gains correct size
498         *    and layout for writing the actual wave form data directly to disc
499         *    in next step.
500         * 3. Copy the waveform data with disk streaming (done by CopyAssignWave()).
501         *
502         * @param orig - original Sample object to be copied from
503         */
504        void Sample::CopyAssignMeta(const Sample* orig) {
505            // handle base classes
506            DLS::Sample::CopyAssignCore(orig);
507            
508            // handle actual own attributes of this class
509            Manufacturer = orig->Manufacturer;
510            Product = orig->Product;
511            SamplePeriod = orig->SamplePeriod;
512            MIDIUnityNote = orig->MIDIUnityNote;
513            FineTune = orig->FineTune;
514            SMPTEFormat = orig->SMPTEFormat;
515            SMPTEOffset = orig->SMPTEOffset;
516            Loops = orig->Loops;
517            LoopID = orig->LoopID;
518            LoopType = orig->LoopType;
519            LoopStart = orig->LoopStart;
520            LoopEnd = orig->LoopEnd;
521            LoopSize = orig->LoopSize;
522            LoopFraction = orig->LoopFraction;
523            LoopPlayCount = orig->LoopPlayCount;
524            
525            // schedule resizing this sample to the given sample's size
526            Resize(orig->GetSize());
527        }
528    
529        /**
530         * Should be called after CopyAssignMeta() and File::Save() sequence.
531         * Read more about it in the discussion of CopyAssignMeta(). This method
532         * copies the actual waveform data by disk streaming.
533         *
534         * @e CAUTION: this method is currently not thread safe! During this
535         * operation the sample must not be used for other purposes by other
536         * threads!
537         *
538         * @param orig - original Sample object to be copied from
539         */
540        void Sample::CopyAssignWave(const Sample* orig) {
541            const int iReadAtOnce = 32*1024;
542            char* buf = new char[iReadAtOnce * orig->FrameSize];
543            Sample* pOrig = (Sample*) orig; //HACK: remove constness for now
544            file_offset_t restorePos = pOrig->GetPos();
545            pOrig->SetPos(0);
546            SetPos(0);
547            for (file_offset_t n = pOrig->Read(buf, iReadAtOnce); n;
548                               n = pOrig->Read(buf, iReadAtOnce))
549            {
550                Write(buf, n);
551            }
552            pOrig->SetPos(restorePos);
553            delete [] buf;
554        }
555    
556        /**
557       * Apply sample and its settings to the respective RIFF chunks. You have       * Apply sample and its settings to the respective RIFF chunks. You have
558       * to call File::Save() to make changes persistent.       * to call File::Save() to make changes persistent.
559       *       *
560       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
561       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
562       *       *
563         * @param pProgress - callback function for progress notification
564       * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data       * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data
565       *                        was provided yet       *                        was provided yet
566       * @throws gig::Exception if there is any invalid sample setting       * @throws gig::Exception if there is any invalid sample setting
567       */       */
568      void Sample::UpdateChunks() {      void Sample::UpdateChunks(progress_t* pProgress) {
569          // first update base class's chunks          // first update base class's chunks
570          DLS::Sample::UpdateChunks();          DLS::Sample::UpdateChunks(pProgress);
571    
572          // make sure 'smpl' chunk exists          // make sure 'smpl' chunk exists
573          pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);          pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);
# Line 468  namespace { Line 615  namespace {
615          // update '3gix' chunk          // update '3gix' chunk
616          pData = (uint8_t*) pCk3gix->LoadChunkData();          pData = (uint8_t*) pCk3gix->LoadChunkData();
617          store16(&pData[0], iSampleGroup);          store16(&pData[0], iSampleGroup);
618    
619            // if the library user toggled the "Compressed" attribute from true to
620            // false, then the EWAV chunk associated with compressed samples needs
621            // to be deleted
622            RIFF::Chunk* ewav = pWaveList->GetSubChunk(CHUNK_ID_EWAV);
623            if (ewav && !Compressed) {
624                pWaveList->DeleteSubChunk(ewav);
625            }
626      }      }
627    
628      /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).      /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).
629      void Sample::ScanCompressedSample() {      void Sample::ScanCompressedSample() {
630          //TODO: we have to add some more scans here (e.g. determine compression rate)          //TODO: we have to add some more scans here (e.g. determine compression rate)
631          this->SamplesTotal = 0;          this->SamplesTotal = 0;
632          std::list<unsigned long> frameOffsets;          std::list<file_offset_t> frameOffsets;
633    
634          SamplesPerFrame = BitDepth == 24 ? 256 : 2048;          SamplesPerFrame = BitDepth == 24 ? 256 : 2048;
635          WorstCaseFrameSize = SamplesPerFrame * FrameSize + Channels; // +Channels for compression flag          WorstCaseFrameSize = SamplesPerFrame * FrameSize + Channels; // +Channels for compression flag
# Line 490  namespace { Line 645  namespace {
645                  const int mode_l = pCkData->ReadUint8();                  const int mode_l = pCkData->ReadUint8();
646                  const int mode_r = pCkData->ReadUint8();                  const int mode_r = pCkData->ReadUint8();
647                  if (mode_l > 5 || mode_r > 5) throw gig::Exception("Unknown compression mode");                  if (mode_l > 5 || mode_r > 5) throw gig::Exception("Unknown compression mode");
648                  const unsigned long frameSize = bytesPerFrame[mode_l] + bytesPerFrame[mode_r];                  const file_offset_t frameSize = bytesPerFrame[mode_l] + bytesPerFrame[mode_r];
649    
650                  if (pCkData->RemainingBytes() <= frameSize) {                  if (pCkData->RemainingBytes() <= frameSize) {
651                      SamplesInLastFrame =                      SamplesInLastFrame =
# Line 509  namespace { Line 664  namespace {
664    
665                  const int mode = pCkData->ReadUint8();                  const int mode = pCkData->ReadUint8();
666                  if (mode > 5) throw gig::Exception("Unknown compression mode");                  if (mode > 5) throw gig::Exception("Unknown compression mode");
667                  const unsigned long frameSize = bytesPerFrame[mode];                  const file_offset_t frameSize = bytesPerFrame[mode];
668    
669                  if (pCkData->RemainingBytes() <= frameSize) {                  if (pCkData->RemainingBytes() <= frameSize) {
670                      SamplesInLastFrame =                      SamplesInLastFrame =
# Line 525  namespace { Line 680  namespace {
680    
681          // Build the frames table (which is used for fast resolving of a frame's chunk offset)          // Build the frames table (which is used for fast resolving of a frame's chunk offset)
682          if (FrameTable) delete[] FrameTable;          if (FrameTable) delete[] FrameTable;
683          FrameTable = new unsigned long[frameOffsets.size()];          FrameTable = new file_offset_t[frameOffsets.size()];
684          std::list<unsigned long>::iterator end  = frameOffsets.end();          std::list<file_offset_t>::iterator end  = frameOffsets.end();
685          std::list<unsigned long>::iterator iter = frameOffsets.begin();          std::list<file_offset_t>::iterator iter = frameOffsets.begin();
686          for (int i = 0; iter != end; i++, iter++) {          for (int i = 0; iter != end; i++, iter++) {
687              FrameTable[i] = *iter;              FrameTable[i] = *iter;
688          }          }
# Line 568  namespace { Line 723  namespace {
723       *                      the cached sample data in bytes       *                      the cached sample data in bytes
724       * @see                 ReleaseSampleData(), Read(), SetPos()       * @see                 ReleaseSampleData(), Read(), SetPos()
725       */       */
726      buffer_t Sample::LoadSampleData(unsigned long SampleCount) {      buffer_t Sample::LoadSampleData(file_offset_t SampleCount) {
727          return LoadSampleDataWithNullSamplesExtension(SampleCount, 0); // 0 amount of NullSamples          return LoadSampleDataWithNullSamplesExtension(SampleCount, 0); // 0 amount of NullSamples
728      }      }
729    
# Line 627  namespace { Line 782  namespace {
782       *                           size of the cached sample data in bytes       *                           size of the cached sample data in bytes
783       * @see                      ReleaseSampleData(), Read(), SetPos()       * @see                      ReleaseSampleData(), Read(), SetPos()
784       */       */
785      buffer_t Sample::LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount) {      buffer_t Sample::LoadSampleDataWithNullSamplesExtension(file_offset_t SampleCount, uint NullSamplesCount) {
786          if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;          if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;
787          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
788          unsigned long allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;          file_offset_t allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;
789            SetPos(0); // reset read position to begin of sample
790          RAMCache.pStart            = new int8_t[allocationsize];          RAMCache.pStart            = new int8_t[allocationsize];
791          RAMCache.Size              = Read(RAMCache.pStart, SampleCount) * this->FrameSize;          RAMCache.Size              = Read(RAMCache.pStart, SampleCount) * this->FrameSize;
792          RAMCache.NullExtensionSize = allocationsize - RAMCache.Size;          RAMCache.NullExtensionSize = allocationsize - RAMCache.Size;
# Line 668  namespace { Line 824  namespace {
824          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
825          RAMCache.pStart = NULL;          RAMCache.pStart = NULL;
826          RAMCache.Size   = 0;          RAMCache.Size   = 0;
827            RAMCache.NullExtensionSize = 0;
828      }      }
829    
830      /** @brief Resize sample.      /** @brief Resize sample.
# Line 692  namespace { Line 849  namespace {
849       * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with       * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with
850       * other formats will fail!       * other formats will fail!
851       *       *
852       * @param iNewSize - new sample wave data size in sample points (must be       * @param NewSize - new sample wave data size in sample points (must be
853       *                   greater than zero)       *                  greater than zero)
854       * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM       * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM
855       *                         or if \a iNewSize is less than 1       * @throws DLS::Exception if \a NewSize is less than 1 or unrealistic large
856       * @throws gig::Exception if existing sample is compressed       * @throws gig::Exception if existing sample is compressed
857       * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,       * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,
858       *      DLS::Sample::FormatTag, File::Save()       *      DLS::Sample::FormatTag, File::Save()
859       */       */
860      void Sample::Resize(int iNewSize) {      void Sample::Resize(file_offset_t NewSize) {
861          if (Compressed) throw gig::Exception("There is no support for modifying compressed samples (yet)");          if (Compressed) throw gig::Exception("There is no support for modifying compressed samples (yet)");
862          DLS::Sample::Resize(iNewSize);          DLS::Sample::Resize(NewSize);
863      }      }
864    
865      /**      /**
# Line 726  namespace { Line 883  namespace {
883       * @returns            the new sample position       * @returns            the new sample position
884       * @see                Read()       * @see                Read()
885       */       */
886      unsigned long Sample::SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence) {      file_offset_t Sample::SetPos(file_offset_t SampleCount, RIFF::stream_whence_t Whence) {
887          if (Compressed) {          if (Compressed) {
888              switch (Whence) {              switch (Whence) {
889                  case RIFF::stream_curpos:                  case RIFF::stream_curpos:
# Line 744  namespace { Line 901  namespace {
901              }              }
902              if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;              if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;
903    
904              unsigned long frame = this->SamplePos / 2048; // to which frame to jump              file_offset_t frame = this->SamplePos / 2048; // to which frame to jump
905              this->FrameOffset   = this->SamplePos % 2048; // offset (in sample points) within that frame              this->FrameOffset   = this->SamplePos % 2048; // offset (in sample points) within that frame
906              pCkData->SetPos(FrameTable[frame]);           // set chunk pointer to the start of sought frame              pCkData->SetPos(FrameTable[frame]);           // set chunk pointer to the start of sought frame
907              return this->SamplePos;              return this->SamplePos;
908          }          }
909          else { // not compressed          else { // not compressed
910              unsigned long orderedBytes = SampleCount * this->FrameSize;              file_offset_t orderedBytes = SampleCount * this->FrameSize;
911              unsigned long result = pCkData->SetPos(orderedBytes, Whence);              file_offset_t result = pCkData->SetPos(orderedBytes, Whence);
912              return (result == orderedBytes) ? SampleCount              return (result == orderedBytes) ? SampleCount
913                                              : result / this->FrameSize;                                              : result / this->FrameSize;
914          }          }
# Line 760  namespace { Line 917  namespace {
917      /**      /**
918       * Returns the current position in the sample (in sample points).       * Returns the current position in the sample (in sample points).
919       */       */
920      unsigned long Sample::GetPos() {      file_offset_t Sample::GetPos() const {
921          if (Compressed) return SamplePos;          if (Compressed) return SamplePos;
922          else            return pCkData->GetPos() / FrameSize;          else            return pCkData->GetPos() / FrameSize;
923      }      }
# Line 799  namespace { Line 956  namespace {
956       * @returns                number of successfully read sample points       * @returns                number of successfully read sample points
957       * @see                    CreateDecompressionBuffer()       * @see                    CreateDecompressionBuffer()
958       */       */
959      unsigned long Sample::ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState,      file_offset_t Sample::ReadAndLoop(void* pBuffer, file_offset_t SampleCount, playback_state_t* pPlaybackState,
960                                        DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {                                        DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {
961          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;          file_offset_t samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;
962          uint8_t* pDst = (uint8_t*) pBuffer;          uint8_t* pDst = (uint8_t*) pBuffer;
963    
964          SetPos(pPlaybackState->position); // recover position from the last time          SetPos(pPlaybackState->position); // recover position from the last time
# Line 839  namespace { Line 996  namespace {
996                                  // reading, swap all sample frames so it reflects                                  // reading, swap all sample frames so it reflects
997                                  // backward playback                                  // backward playback
998    
999                                  unsigned long swapareastart       = totalreadsamples;                                  file_offset_t swapareastart       = totalreadsamples;
1000                                  unsigned long loopoffset          = GetPos() - loop.LoopStart;                                  file_offset_t loopoffset          = GetPos() - loop.LoopStart;
1001                                  unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);                                  file_offset_t samplestoreadinloop = Min(samplestoread, loopoffset);
1002                                  unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;                                  file_offset_t reverseplaybackend  = GetPos() - samplestoreadinloop;
1003    
1004                                  SetPos(reverseplaybackend);                                  SetPos(reverseplaybackend);
1005    
# Line 862  namespace { Line 1019  namespace {
1019                                  }                                  }
1020    
1021                                  // reverse the sample frames for backward playback                                  // reverse the sample frames for backward playback
1022                                  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!
1023                                        SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
1024                              }                              }
1025                          } while (samplestoread && readsamples);                          } while (samplestoread && readsamples);
1026                          break;                          break;
# Line 889  namespace { Line 1047  namespace {
1047                          // reading, swap all sample frames so it reflects                          // reading, swap all sample frames so it reflects
1048                          // backward playback                          // backward playback
1049    
1050                          unsigned long swapareastart       = totalreadsamples;                          file_offset_t swapareastart       = totalreadsamples;
1051                          unsigned long loopoffset          = GetPos() - loop.LoopStart;                          file_offset_t loopoffset          = GetPos() - loop.LoopStart;
1052                          unsigned long samplestoreadinloop = (this->LoopPlayCount) ? Min(samplestoread, pPlaybackState->loop_cycles_left * loop.LoopLength - loopoffset)                          file_offset_t samplestoreadinloop = (this->LoopPlayCount) ? Min(samplestoread, pPlaybackState->loop_cycles_left * loop.LoopLength - loopoffset)
1053                                                                                    : samplestoread;                                                                                    : samplestoread;
1054                          unsigned long reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);                          file_offset_t reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);
1055    
1056                          SetPos(reverseplaybackend);                          SetPos(reverseplaybackend);
1057    
# Line 973  namespace { Line 1131  namespace {
1131       * @returns            number of successfully read sample points       * @returns            number of successfully read sample points
1132       * @see                SetPos(), CreateDecompressionBuffer()       * @see                SetPos(), CreateDecompressionBuffer()
1133       */       */
1134      unsigned long Sample::Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer) {      file_offset_t Sample::Read(void* pBuffer, file_offset_t SampleCount, buffer_t* pExternalDecompressionBuffer) {
1135          if (SampleCount == 0) return 0;          if (SampleCount == 0) return 0;
1136          if (!Compressed) {          if (!Compressed) {
1137              if (BitDepth == 24) {              if (BitDepth == 24) {
# Line 988  namespace { Line 1146  namespace {
1146          else {          else {
1147              if (this->SamplePos >= this->SamplesTotal) return 0;              if (this->SamplePos >= this->SamplesTotal) return 0;
1148              //TODO: efficiency: maybe we should test for an average compression rate              //TODO: efficiency: maybe we should test for an average compression rate
1149              unsigned long assumedsize      = GuessSize(SampleCount),              file_offset_t assumedsize      = GuessSize(SampleCount),
1150                            remainingbytes   = 0,           // remaining bytes in the local buffer                            remainingbytes   = 0,           // remaining bytes in the local buffer
1151                            remainingsamples = SampleCount,                            remainingsamples = SampleCount,
1152                            copysamples, skipsamples,                            copysamples, skipsamples,
# Line 1011  namespace { Line 1169  namespace {
1169              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);
1170    
1171              while (remainingsamples && remainingbytes) {              while (remainingsamples && remainingbytes) {
1172                  unsigned long framesamples = SamplesPerFrame;                  file_offset_t framesamples = SamplesPerFrame;
1173                  unsigned long framebytes, rightChannelOffset = 0, nextFrameOffset;                  file_offset_t framebytes, rightChannelOffset = 0, nextFrameOffset;
1174    
1175                  int mode_l = *pSrc++, mode_r = 0;                  int mode_l = *pSrc++, mode_r = 0;
1176    
# Line 1152  namespace { Line 1310  namespace {
1310       *       *
1311       * Note: there is currently no support for writing compressed samples.       * Note: there is currently no support for writing compressed samples.
1312       *       *
1313         * For 16 bit samples, the data in the source buffer should be
1314         * int16_t (using native endianness). For 24 bit, the buffer
1315         * should contain three bytes per sample, little-endian.
1316         *
1317       * @param pBuffer     - source buffer       * @param pBuffer     - source buffer
1318       * @param SampleCount - number of sample points to write       * @param SampleCount - number of sample points to write
1319       * @throws DLS::Exception if current sample size is too small       * @throws DLS::Exception if current sample size is too small
1320       * @throws gig::Exception if sample is compressed       * @throws gig::Exception if sample is compressed
1321       * @see DLS::LoadSampleData()       * @see DLS::LoadSampleData()
1322       */       */
1323      unsigned long Sample::Write(void* pBuffer, unsigned long SampleCount) {      file_offset_t Sample::Write(void* pBuffer, file_offset_t SampleCount) {
1324          if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");          if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");
1325    
1326            // if this is the first write in this sample, reset the
1327            // checksum calculator
1328          if (pCkData->GetPos() == 0) {          if (pCkData->GetPos() == 0) {
1329              crc.reset();              __resetCRC(crc);
1330          }          }
1331          unsigned long res = DLS::Sample::Write(pBuffer, SampleCount);          if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");
1332          crc.update((unsigned char *)pBuffer, SampleCount * FrameSize);          file_offset_t res;
1333            if (BitDepth == 24) {
1334                res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
1335            } else { // 16 bit
1336                res = Channels == 2 ? pCkData->Write(pBuffer, SampleCount << 1, 2) >> 1
1337                                    : pCkData->Write(pBuffer, SampleCount, 2);
1338            }
1339            __calculateCRC((unsigned char *)pBuffer, SampleCount * FrameSize, crc);
1340    
1341            // if this is the last write, update the checksum chunk in the
1342            // file
1343          if (pCkData->GetPos() == pCkData->GetSize()) {          if (pCkData->GetPos() == pCkData->GetSize()) {
1344                __finalizeCRC(crc);
1345              File* pFile = static_cast<File*>(GetParent());              File* pFile = static_cast<File*>(GetParent());
1346              pFile->SetSampleChecksum(this, crc.getValue());              pFile->SetSampleChecksum(this, crc);
1347          }          }
1348          return res;          return res;
1349      }      }
# Line 1189  namespace { Line 1364  namespace {
1364       * @returns allocated decompression buffer       * @returns allocated decompression buffer
1365       * @see DestroyDecompressionBuffer()       * @see DestroyDecompressionBuffer()
1366       */       */
1367      buffer_t Sample::CreateDecompressionBuffer(unsigned long MaxReadSize) {      buffer_t Sample::CreateDecompressionBuffer(file_offset_t MaxReadSize) {
1368          buffer_t result;          buffer_t result;
1369          const double worstCaseHeaderOverhead =          const double worstCaseHeaderOverhead =
1370                  (256.0 /*frame size*/ + 12.0 /*header*/ + 2.0 /*compression type flag (stereo)*/) / 256.0;                  (256.0 /*frame size*/ + 12.0 /*header*/ + 2.0 /*compression type flag (stereo)*/) / 256.0;
1371          result.Size              = (unsigned long) (double(MaxReadSize) * 3.0 /*(24 Bit)*/ * 2.0 /*stereo*/ * worstCaseHeaderOverhead);          result.Size              = (file_offset_t) (double(MaxReadSize) * 3.0 /*(24 Bit)*/ * 2.0 /*stereo*/ * worstCaseHeaderOverhead);
1372          result.pStart            = new int8_t[result.Size];          result.pStart            = new int8_t[result.Size];
1373          result.NullExtensionSize = 0;          result.NullExtensionSize = 0;
1374          return result;          return result;
# Line 1227  namespace { Line 1402  namespace {
1402          return pGroup;          return pGroup;
1403      }      }
1404    
1405        /**
1406         * Returns the CRC-32 checksum of the sample's raw wave form data at the
1407         * time when this sample's wave form data was modified for the last time
1408         * by calling Write(). This checksum only covers the raw wave form data,
1409         * not any meta informations like i.e. bit depth or loop points. Since
1410         * this method just returns the checksum stored for this sample i.e. when
1411         * the gig file was loaded, this method returns immediately. So it does no
1412         * recalcuation of the checksum with the currently available sample wave
1413         * form data.
1414         *
1415         * @see VerifyWaveData()
1416         */
1417        uint32_t Sample::GetWaveDataCRC32Checksum() {
1418            return crc;
1419        }
1420    
1421        /**
1422         * Checks the integrity of this sample's raw audio wave data. Whenever a
1423         * Sample's raw wave data is intentionally modified (i.e. by calling
1424         * Write() and supplying the new raw audio wave form data) a CRC32 checksum
1425         * is calculated and stored/updated for this sample, along to the sample's
1426         * meta informations.
1427         *
1428         * Now by calling this method the current raw audio wave data is checked
1429         * against the already stored CRC32 check sum in order to check whether the
1430         * sample data had been damaged unintentionally for some reason. Since by
1431         * calling this method always the entire raw audio wave data has to be
1432         * read, verifying all samples this way may take a long time accordingly.
1433         * And that's also the reason why the sample integrity is not checked by
1434         * default whenever a gig file is loaded. So this method must be called
1435         * explicitly to fulfill this task.
1436         *
1437         * @param pActually - (optional) if provided, will be set to the actually
1438         *                    calculated checksum of the current raw wave form data,
1439         *                    you can get the expected checksum instead by calling
1440         *                    GetWaveDataCRC32Checksum()
1441         * @returns true if sample is OK or false if the sample is damaged
1442         * @throws Exception if no checksum had been stored to disk for this
1443         *         sample yet, or on I/O issues
1444         * @see GetWaveDataCRC32Checksum()
1445         */
1446        bool Sample::VerifyWaveData(uint32_t* pActually) {
1447            //File* pFile = static_cast<File*>(GetParent());
1448            uint32_t crc = CalculateWaveDataChecksum();
1449            if (pActually) *pActually = crc;
1450            return crc == this->crc;
1451        }
1452    
1453        uint32_t Sample::CalculateWaveDataChecksum() {
1454            const size_t sz = 20*1024; // 20kB buffer size
1455            std::vector<uint8_t> buffer(sz);
1456            buffer.resize(sz);
1457    
1458            const size_t n = sz / FrameSize;
1459            SetPos(0);
1460            uint32_t crc = 0;
1461            __resetCRC(crc);
1462            while (true) {
1463                file_offset_t nRead = Read(&buffer[0], n);
1464                if (nRead <= 0) break;
1465                __calculateCRC(&buffer[0], nRead * FrameSize, crc);
1466            }
1467            __finalizeCRC(crc);
1468            return crc;
1469        }
1470    
1471      Sample::~Sample() {      Sample::~Sample() {
1472          Instances--;          Instances--;
1473          if (!Instances && InternalDecompressionBuffer.Size) {          if (!Instances && InternalDecompressionBuffer.Size) {
# Line 1243  namespace { Line 1484  namespace {
1484  // *************** DimensionRegion ***************  // *************** DimensionRegion ***************
1485  // *  // *
1486    
1487      uint                               DimensionRegion::Instances       = 0;      size_t                             DimensionRegion::Instances       = 0;
1488      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;
1489    
1490      DimensionRegion::DimensionRegion(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(Region* pParent, RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
1491          Instances++;          Instances++;
1492    
1493          pSample = NULL;          pSample = NULL;
1494            pRegion = pParent;
1495    
1496            if (_3ewl->GetSubChunk(CHUNK_ID_WSMP)) memcpy(&Crossfade, &SamplerOptions, 4);
1497            else memset(&Crossfade, 0, 4);
1498    
         memcpy(&Crossfade, &SamplerOptions, 4);  
1499          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;
1500    
1501          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);
# Line 1365  namespace { Line 1609  namespace {
1609                                                          : vcf_res_ctrl_none;                                                          : vcf_res_ctrl_none;
1610              uint16_t eg3depth = _3ewa->ReadUint16();              uint16_t eg3depth = _3ewa->ReadUint16();
1611              EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */              EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */
1612                                          : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */                                          : (-1) * (int16_t) ((eg3depth ^ 0xfff) + 1); /* binary complementary for negatives */
1613              _3ewa->ReadInt16(); // unknown              _3ewa->ReadInt16(); // unknown
1614              ChannelOffset = _3ewa->ReadUint8() / 4;              ChannelOffset = _3ewa->ReadUint8() / 4;
1615              uint8_t regoptions = _3ewa->ReadUint8();              uint8_t regoptions = _3ewa->ReadUint8();
# Line 1415  namespace { Line 1659  namespace {
1659              LFO1ControlDepth                = 0;              LFO1ControlDepth                = 0;
1660              LFO3ControlDepth                = 0;              LFO3ControlDepth                = 0;
1661              EG1Attack                       = 0.0;              EG1Attack                       = 0.0;
1662              EG1Decay1                       = 0.0;              EG1Decay1                       = 0.005;
1663              EG1Sustain                      = 0;              EG1Sustain                      = 1000;
1664              EG1Release                      = 0.0;              EG1Release                      = 0.3;
1665              EG1Controller.type              = eg1_ctrl_t::type_none;              EG1Controller.type              = eg1_ctrl_t::type_none;
1666              EG1Controller.controller_number = 0;              EG1Controller.controller_number = 0;
1667              EG1ControllerInvert             = false;              EG1ControllerInvert             = false;
# Line 1432  namespace { Line 1676  namespace {
1676              EG2ControllerReleaseInfluence   = 0;              EG2ControllerReleaseInfluence   = 0;
1677              LFO1Frequency                   = 1.0;              LFO1Frequency                   = 1.0;
1678              EG2Attack                       = 0.0;              EG2Attack                       = 0.0;
1679              EG2Decay1                       = 0.0;              EG2Decay1                       = 0.005;
1680              EG2Sustain                      = 0;              EG2Sustain                      = 1000;
1681              EG2Release                      = 0.0;              EG2Release                      = 60;
1682              LFO2ControlDepth                = 0;              LFO2ControlDepth                = 0;
1683              LFO2Frequency                   = 1.0;              LFO2Frequency                   = 1.0;
1684              LFO2InternalDepth               = 0;              LFO2InternalDepth               = 0;
1685              EG1Decay2                       = 0.0;              EG1Decay2                       = 0.0;
1686              EG1InfiniteSustain              = false;              EG1InfiniteSustain              = true;
1687              EG1PreAttack                    = 1000;              EG1PreAttack                    = 0;
1688              EG2Decay2                       = 0.0;              EG2Decay2                       = 0.0;
1689              EG2InfiniteSustain              = false;              EG2InfiniteSustain              = true;
1690              EG2PreAttack                    = 1000;              EG2PreAttack                    = 0;
1691              VelocityResponseCurve           = curve_type_nonlinear;              VelocityResponseCurve           = curve_type_nonlinear;
1692              VelocityResponseDepth           = 3;              VelocityResponseDepth           = 3;
1693              ReleaseVelocityResponseCurve    = curve_type_nonlinear;              ReleaseVelocityResponseCurve    = curve_type_nonlinear;
# Line 1486  namespace { Line 1730  namespace {
1730              VCFVelocityDynamicRange         = 0x04;              VCFVelocityDynamicRange         = 0x04;
1731              VCFVelocityCurve                = curve_type_linear;              VCFVelocityCurve                = curve_type_linear;
1732              VCFType                         = vcf_type_lowpass;              VCFType                         = vcf_type_lowpass;
1733              memset(DimensionUpperLimits, 0, 8);              memset(DimensionUpperLimits, 127, 8);
1734            }
1735            // format extension for EG behavior options, these will *NOT* work with
1736            // Gigasampler/GigaStudio !
1737            RIFF::Chunk* lsde = _3ewl->GetSubChunk(CHUNK_ID_LSDE);
1738            if (lsde) {
1739                eg_opt_t* pEGOpts[2] = { &EG1Options, &EG2Options };
1740                for (int i = 0; i < 2; ++i) {
1741                    unsigned char byte = lsde->ReadUint8();
1742                    pEGOpts[i]->AttackCancel     = byte & 1;
1743                    pEGOpts[i]->AttackHoldCancel = byte & (1 << 1);
1744                    pEGOpts[i]->Decay1Cancel     = byte & (1 << 2);
1745                    pEGOpts[i]->Decay2Cancel     = byte & (1 << 3);
1746                    pEGOpts[i]->ReleaseCancel    = byte & (1 << 4);
1747                }
1748          }          }
1749    
1750          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
1751                                                       VelocityResponseDepth,                                                       VelocityResponseDepth,
1752                                                       VelocityResponseCurveScaling);                                                       VelocityResponseCurveScaling);
1753    
1754          curve_type_t curveType = ReleaseVelocityResponseCurve;          pVelocityReleaseTable = GetReleaseVelocityTable(
1755          uint8_t depth = ReleaseVelocityResponseDepth;                                      ReleaseVelocityResponseCurve,
1756                                        ReleaseVelocityResponseDepth
1757          // this models a strange behaviour or bug in GSt: two of the                                  );
1758          // velocity response curves for release time are not used even  
1759          // if specified, instead another curve is chosen.          pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve,
1760          if ((curveType == curve_type_nonlinear && depth == 0) ||                                                        VCFVelocityDynamicRange,
1761              (curveType == curve_type_special   && depth == 4)) {                                                        VCFVelocityScale,
1762              curveType = curve_type_nonlinear;                                                        VCFCutoffController);
             depth = 3;  
         }  
         pVelocityReleaseTable = GetVelocityTable(curveType, depth, 0);  
1763    
1764          curveType = VCFVelocityCurve;          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1765          depth = VCFVelocityDynamicRange;          VelocityTable = 0;
1766        }
1767    
1768          // even stranger GSt: two of the velocity response curves for      /*
1769          // filter cutoff are not used, instead another special curve       * Constructs a DimensionRegion by copying all parameters from
1770          // is chosen. This curve is not used anywhere else.       * another DimensionRegion
1771          if ((curveType == curve_type_nonlinear && depth == 0) ||       */
1772              (curveType == curve_type_special   && depth == 4)) {      DimensionRegion::DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src) : DLS::Sampler(_3ewl) {
1773              curveType = curve_type_special;          Instances++;
1774              depth = 5;          //NOTE: I think we cannot call CopyAssign() here (in a constructor) as long as its a virtual method
1775            *this = src; // default memberwise shallow copy of all parameters
1776            pParentList = _3ewl; // restore the chunk pointer
1777    
1778            // deep copy of owned structures
1779            if (src.VelocityTable) {
1780                VelocityTable = new uint8_t[128];
1781                for (int k = 0 ; k < 128 ; k++)
1782                    VelocityTable[k] = src.VelocityTable[k];
1783            }
1784            if (src.pSampleLoops) {
1785                pSampleLoops = new DLS::sample_loop_t[src.SampleLoops];
1786                for (int k = 0 ; k < src.SampleLoops ; k++)
1787                    pSampleLoops[k] = src.pSampleLoops[k];
1788          }          }
1789          pVelocityCutoffTable = GetVelocityTable(curveType, depth,      }
1790                                                  VCFCutoffController <= vcf_cutoff_ctrl_none2 ? VCFVelocityScale : 0);      
1791        /**
1792         * Make a (semi) deep copy of the DimensionRegion object given by @a orig
1793         * and assign it to this object.
1794         *
1795         * Note that all sample pointers referenced by @a orig are simply copied as
1796         * memory address. Thus the respective samples are shared, not duplicated!
1797         *
1798         * @param orig - original DimensionRegion object to be copied from
1799         */
1800        void DimensionRegion::CopyAssign(const DimensionRegion* orig) {
1801            CopyAssign(orig, NULL);
1802        }
1803    
1804        /**
1805         * Make a (semi) deep copy of the DimensionRegion object given by @a orig
1806         * and assign it to this object.
1807         *
1808         * @param orig - original DimensionRegion object to be copied from
1809         * @param mSamples - crosslink map between the foreign file's samples and
1810         *                   this file's samples
1811         */
1812        void DimensionRegion::CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples) {
1813            // delete all allocated data first
1814            if (VelocityTable) delete [] VelocityTable;
1815            if (pSampleLoops) delete [] pSampleLoops;
1816            
1817            // backup parent list pointer
1818            RIFF::List* p = pParentList;
1819            
1820            gig::Sample* pOriginalSample = pSample;
1821            gig::Region* pOriginalRegion = pRegion;
1822            
1823            //NOTE: copy code copied from assignment constructor above, see comment there as well
1824            
1825            *this = *orig; // default memberwise shallow copy of all parameters
1826            
1827            // restore members that shall not be altered
1828            pParentList = p; // restore the chunk pointer
1829            pRegion = pOriginalRegion;
1830            
1831            // only take the raw sample reference reference if the
1832            // two DimensionRegion objects are part of the same file
1833            if (pOriginalRegion->GetParent()->GetParent() != orig->pRegion->GetParent()->GetParent()) {
1834                pSample = pOriginalSample;
1835            }
1836            
1837            if (mSamples && mSamples->count(orig->pSample)) {
1838                pSample = mSamples->find(orig->pSample)->second;
1839            }
1840    
1841            // deep copy of owned structures
1842            if (orig->VelocityTable) {
1843                VelocityTable = new uint8_t[128];
1844                for (int k = 0 ; k < 128 ; k++)
1845                    VelocityTable[k] = orig->VelocityTable[k];
1846            }
1847            if (orig->pSampleLoops) {
1848                pSampleLoops = new DLS::sample_loop_t[orig->SampleLoops];
1849                for (int k = 0 ; k < orig->SampleLoops ; k++)
1850                    pSampleLoops[k] = orig->pSampleLoops[k];
1851            }
1852        }
1853    
1854        void DimensionRegion::serialize(Serialization::Archive* archive) {
1855            // in case this class will become backward incompatible one day,
1856            // then set a version and minimum version for this class like:
1857            //archive->setVersion(*this, 2);
1858            //archive->setMinVersion(*this, 1);
1859    
1860            SRLZ(VelocityUpperLimit);
1861            SRLZ(EG1PreAttack);
1862            SRLZ(EG1Attack);
1863            SRLZ(EG1Decay1);
1864            SRLZ(EG1Decay2);
1865            SRLZ(EG1InfiniteSustain);
1866            SRLZ(EG1Sustain);
1867            SRLZ(EG1Release);
1868            SRLZ(EG1Hold);
1869            SRLZ(EG1Controller);
1870            SRLZ(EG1ControllerInvert);
1871            SRLZ(EG1ControllerAttackInfluence);
1872            SRLZ(EG1ControllerDecayInfluence);
1873            SRLZ(EG1ControllerReleaseInfluence);
1874            SRLZ(LFO1Frequency);
1875            SRLZ(LFO1InternalDepth);
1876            SRLZ(LFO1ControlDepth);
1877            SRLZ(LFO1Controller);
1878            SRLZ(LFO1FlipPhase);
1879            SRLZ(LFO1Sync);
1880            SRLZ(EG2PreAttack);
1881            SRLZ(EG2Attack);
1882            SRLZ(EG2Decay1);
1883            SRLZ(EG2Decay2);
1884            SRLZ(EG2InfiniteSustain);
1885            SRLZ(EG2Sustain);
1886            SRLZ(EG2Release);
1887            SRLZ(EG2Controller);
1888            SRLZ(EG2ControllerInvert);
1889            SRLZ(EG2ControllerAttackInfluence);
1890            SRLZ(EG2ControllerDecayInfluence);
1891            SRLZ(EG2ControllerReleaseInfluence);
1892            SRLZ(LFO2Frequency);
1893            SRLZ(LFO2InternalDepth);
1894            SRLZ(LFO2ControlDepth);
1895            SRLZ(LFO2Controller);
1896            SRLZ(LFO2FlipPhase);
1897            SRLZ(LFO2Sync);
1898            SRLZ(EG3Attack);
1899            SRLZ(EG3Depth);
1900            SRLZ(LFO3Frequency);
1901            SRLZ(LFO3InternalDepth);
1902            SRLZ(LFO3ControlDepth);
1903            SRLZ(LFO3Controller);
1904            SRLZ(LFO3Sync);
1905            SRLZ(VCFEnabled);
1906            SRLZ(VCFType);
1907            SRLZ(VCFCutoffController);
1908            SRLZ(VCFCutoffControllerInvert);
1909            SRLZ(VCFCutoff);
1910            SRLZ(VCFVelocityCurve);
1911            SRLZ(VCFVelocityScale);
1912            SRLZ(VCFVelocityDynamicRange);
1913            SRLZ(VCFResonance);
1914            SRLZ(VCFResonanceDynamic);
1915            SRLZ(VCFResonanceController);
1916            SRLZ(VCFKeyboardTracking);
1917            SRLZ(VCFKeyboardTrackingBreakpoint);
1918            SRLZ(VelocityResponseCurve);
1919            SRLZ(VelocityResponseDepth);
1920            SRLZ(VelocityResponseCurveScaling);
1921            SRLZ(ReleaseVelocityResponseCurve);
1922            SRLZ(ReleaseVelocityResponseDepth);
1923            SRLZ(ReleaseTriggerDecay);
1924            SRLZ(Crossfade);
1925            SRLZ(PitchTrack);
1926            SRLZ(DimensionBypass);
1927            SRLZ(Pan);
1928            SRLZ(SelfMask);
1929            SRLZ(AttenuationController);
1930            SRLZ(InvertAttenuationController);
1931            SRLZ(AttenuationControllerThreshold);
1932            SRLZ(ChannelOffset);
1933            SRLZ(SustainDefeat);
1934            SRLZ(MSDecode);
1935            //SRLZ(SampleStartOffset);
1936            SRLZ(SampleAttenuation);
1937            SRLZ(EG1Options);
1938            SRLZ(EG2Options);
1939    
1940            // derived attributes from DLS::Sampler
1941            SRLZ(FineTune);
1942            SRLZ(Gain);
1943        }
1944    
1945        /**
1946         * Updates the respective member variable and updates @c SampleAttenuation
1947         * which depends on this value.
1948         */
1949        void DimensionRegion::SetGain(int32_t gain) {
1950            DLS::Sampler::SetGain(gain);
1951          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
         VelocityTable = 0;  
1952      }      }
1953    
1954      /**      /**
# Line 1530  namespace { Line 1957  namespace {
1957       *       *
1958       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
1959       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
1960         *
1961         * @param pProgress - callback function for progress notification
1962       */       */
1963      void DimensionRegion::UpdateChunks() {      void DimensionRegion::UpdateChunks(progress_t* pProgress) {
1964          // first update base class's chunk          // first update base class's chunk
1965          DLS::Sampler::UpdateChunks();          DLS::Sampler::UpdateChunks(pProgress);
1966    
1967            RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);
1968            uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();
1969            pData[12] = Crossfade.in_start;
1970            pData[13] = Crossfade.in_end;
1971            pData[14] = Crossfade.out_start;
1972            pData[15] = Crossfade.out_end;
1973    
1974          // make sure '3ewa' chunk exists          // make sure '3ewa' chunk exists
1975          RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);
1976          if (!_3ewa)  _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, 140);          if (!_3ewa) {
1977          uint8_t* pData = (uint8_t*) _3ewa->LoadChunkData();              File* pFile = (File*) GetParent()->GetParent()->GetParent();
1978                bool version3 = pFile->pVersion && pFile->pVersion->major == 3;
1979                _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, version3 ? 148 : 140);
1980            }
1981            pData = (uint8_t*) _3ewa->LoadChunkData();
1982    
1983          // update '3ewa' chunk with DimensionRegion's current settings          // update '3ewa' chunk with DimensionRegion's current settings
1984    
1985          const uint32_t chunksize = _3ewa->GetNewSize();          const uint32_t chunksize = (uint32_t) _3ewa->GetNewSize();
1986          store32(&pData[0], chunksize); // unknown, always chunk size?          store32(&pData[0], chunksize); // unknown, always chunk size?
1987    
1988          const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);          const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);
# Line 1584  namespace { Line 2024  namespace {
2024          pData[44] = eg1ctl;          pData[44] = eg1ctl;
2025    
2026          const uint8_t eg1ctrloptions =          const uint8_t eg1ctrloptions =
2027              (EG1ControllerInvert) ? 0x01 : 0x00 |              (EG1ControllerInvert ? 0x01 : 0x00) |
2028              GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG1ControllerAttackInfluence) |              GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG1ControllerAttackInfluence) |
2029              GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG1ControllerDecayInfluence) |              GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG1ControllerDecayInfluence) |
2030              GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG1ControllerReleaseInfluence);              GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG1ControllerReleaseInfluence);
# Line 1594  namespace { Line 2034  namespace {
2034          pData[46] = eg2ctl;          pData[46] = eg2ctl;
2035    
2036          const uint8_t eg2ctrloptions =          const uint8_t eg2ctrloptions =
2037              (EG2ControllerInvert) ? 0x01 : 0x00 |              (EG2ControllerInvert ? 0x01 : 0x00) |
2038              GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG2ControllerAttackInfluence) |              GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG2ControllerAttackInfluence) |
2039              GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG2ControllerDecayInfluence) |              GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG2ControllerDecayInfluence) |
2040              GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG2ControllerReleaseInfluence);              GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG2ControllerReleaseInfluence);
# Line 1744  namespace { Line 2184  namespace {
2184          }          }
2185    
2186          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
2187                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xfff); /* binary complementary for negatives */
2188          pData[116] = eg3depth;          store16(&pData[116], eg3depth);
2189    
2190          // next 2 bytes unknown          // next 2 bytes unknown
2191    
# Line 1772  namespace { Line 2212  namespace {
2212          const uint8_t eg1hold = (EG1Hold) ? 0x80 : 0x00; // bit 7          const uint8_t eg1hold = (EG1Hold) ? 0x80 : 0x00; // bit 7
2213          pData[131] = eg1hold;          pData[131] = eg1hold;
2214    
2215          const uint8_t vcfcutoff = (VCFEnabled) ? 0x80 : 0x00 |  /* bit 7 */          const uint8_t vcfcutoff = (VCFEnabled ? 0x80 : 0x00) |  /* bit 7 */
2216                                    (VCFCutoff & 0x7f);   /* lower 7 bits */                                    (VCFCutoff & 0x7f);   /* lower 7 bits */
2217          pData[132] = vcfcutoff;          pData[132] = vcfcutoff;
2218    
2219          pData[133] = VCFCutoffController;          pData[133] = VCFCutoffController;
2220    
2221          const uint8_t vcfvelscale = (VCFCutoffControllerInvert) ? 0x80 : 0x00 | /* bit 7 */          const uint8_t vcfvelscale = (VCFCutoffControllerInvert ? 0x80 : 0x00) | /* bit 7 */
2222                                      (VCFVelocityScale & 0x7f); /* lower 7 bits */                                      (VCFVelocityScale & 0x7f); /* lower 7 bits */
2223          pData[134] = vcfvelscale;          pData[134] = vcfvelscale;
2224    
2225          // next byte unknown          // next byte unknown
2226    
2227          const uint8_t vcfresonance = (VCFResonanceDynamic) ? 0x00 : 0x80 | /* bit 7 */          const uint8_t vcfresonance = (VCFResonanceDynamic ? 0x00 : 0x80) | /* bit 7 */
2228                                       (VCFResonance & 0x7f); /* lower 7 bits */                                       (VCFResonance & 0x7f); /* lower 7 bits */
2229          pData[136] = vcfresonance;          pData[136] = vcfresonance;
2230    
2231          const uint8_t vcfbreakpoint = (VCFKeyboardTracking) ? 0x80 : 0x00 | /* bit 7 */          const uint8_t vcfbreakpoint = (VCFKeyboardTracking ? 0x80 : 0x00) | /* bit 7 */
2232                                        (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */                                        (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */
2233          pData[137] = vcfbreakpoint;          pData[137] = vcfbreakpoint;
2234    
2235          const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |          const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 +
2236                                      VCFVelocityCurve * 5;                                      VCFVelocityCurve * 5;
2237          pData[138] = vcfvelocity;          pData[138] = vcfvelocity;
2238    
# Line 1802  namespace { Line 2242  namespace {
2242          if (chunksize >= 148) {          if (chunksize >= 148) {
2243              memcpy(&pData[140], DimensionUpperLimits, 8);              memcpy(&pData[140], DimensionUpperLimits, 8);
2244          }          }
2245    
2246            // format extension for EG behavior options, these will *NOT* work with
2247            // Gigasampler/GigaStudio !
2248            RIFF::Chunk* lsde = pParentList->GetSubChunk(CHUNK_ID_LSDE);
2249            if (!lsde) {
2250                // only add this "LSDE" chunk if the EG options do not match the
2251                // default EG behavior
2252                eg_opt_t defaultOpt;
2253                if (memcmp(&EG1Options, &defaultOpt, sizeof(eg_opt_t)) ||
2254                    memcmp(&EG2Options, &defaultOpt, sizeof(eg_opt_t)))
2255                {
2256                    lsde = pParentList->AddSubChunk(CHUNK_ID_LSDE, 2);
2257                    // move LSDE chunk to the end of parent list
2258                    pParentList->MoveSubChunk(lsde, (RIFF::Chunk*)NULL);
2259                }
2260            }
2261            if (lsde) {
2262                unsigned char* pData = (unsigned char*) lsde->LoadChunkData();
2263                eg_opt_t* pEGOpts[2] = { &EG1Options, &EG2Options };
2264                for (int i = 0; i < 2; ++i) {
2265                    pData[i] =
2266                        (pEGOpts[i]->AttackCancel     ? 1 : 0) |
2267                        (pEGOpts[i]->AttackHoldCancel ? (1<<1) : 0) |
2268                        (pEGOpts[i]->Decay1Cancel     ? (1<<2) : 0) |
2269                        (pEGOpts[i]->Decay2Cancel     ? (1<<3) : 0) |
2270                        (pEGOpts[i]->ReleaseCancel    ? (1<<4) : 0);
2271                }
2272            }
2273        }
2274    
2275        double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {
2276            curve_type_t curveType = releaseVelocityResponseCurve;
2277            uint8_t depth = releaseVelocityResponseDepth;
2278            // this models a strange behaviour or bug in GSt: two of the
2279            // velocity response curves for release time are not used even
2280            // if specified, instead another curve is chosen.
2281            if ((curveType == curve_type_nonlinear && depth == 0) ||
2282                (curveType == curve_type_special   && depth == 4)) {
2283                curveType = curve_type_nonlinear;
2284                depth = 3;
2285            }
2286            return GetVelocityTable(curveType, depth, 0);
2287        }
2288    
2289        double* DimensionRegion::GetCutoffVelocityTable(curve_type_t vcfVelocityCurve,
2290                                                        uint8_t vcfVelocityDynamicRange,
2291                                                        uint8_t vcfVelocityScale,
2292                                                        vcf_cutoff_ctrl_t vcfCutoffController)
2293        {
2294            curve_type_t curveType = vcfVelocityCurve;
2295            uint8_t depth = vcfVelocityDynamicRange;
2296            // even stranger GSt: two of the velocity response curves for
2297            // filter cutoff are not used, instead another special curve
2298            // is chosen. This curve is not used anywhere else.
2299            if ((curveType == curve_type_nonlinear && depth == 0) ||
2300                (curveType == curve_type_special   && depth == 4)) {
2301                curveType = curve_type_special;
2302                depth = 5;
2303            }
2304            return GetVelocityTable(curveType, depth,
2305                                    (vcfCutoffController <= vcf_cutoff_ctrl_none2)
2306                                        ? vcfVelocityScale : 0);
2307      }      }
2308    
2309      // 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
2310      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)
2311      {      {
2312            // sanity check input parameters
2313            // (fallback to some default parameters on ill input)
2314            switch (curveType) {
2315                case curve_type_nonlinear:
2316                case curve_type_linear:
2317                    if (depth > 4) {
2318                        printf("Warning: Invalid depth (0x%x) for velocity curve type (0x%x).\n", depth, curveType);
2319                        depth   = 0;
2320                        scaling = 0;
2321                    }
2322                    break;
2323                case curve_type_special:
2324                    if (depth > 5) {
2325                        printf("Warning: Invalid depth (0x%x) for velocity curve type 'special'.\n", depth);
2326                        depth   = 0;
2327                        scaling = 0;
2328                    }
2329                    break;
2330                case curve_type_unknown:
2331                default:
2332                    printf("Warning: Unknown velocity curve type (0x%x).\n", curveType);
2333                    curveType = curve_type_linear;
2334                    depth     = 0;
2335                    scaling   = 0;
2336                    break;
2337            }
2338    
2339          double* table;          double* table;
2340          uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;          uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;
2341          if (pVelocityTables->count(tableKey)) { // if key exists          if (pVelocityTables->count(tableKey)) { // if key exists
# Line 1819  namespace { Line 2348  namespace {
2348          return table;          return table;
2349      }      }
2350    
2351        Region* DimensionRegion::GetParent() const {
2352            return pRegion;
2353        }
2354    
2355    // show error if some _lev_ctrl_* enum entry is not listed in the following function
2356    // (commented out for now, because "diagnostic push" not supported prior GCC 4.6)
2357    // TODO: uncomment and add a GCC version check (see also commented "#pragma GCC diagnostic pop" below)
2358    //#pragma GCC diagnostic push
2359    //#pragma GCC diagnostic error "-Wswitch"
2360    
2361      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {
2362          leverage_ctrl_t decodedcontroller;          leverage_ctrl_t decodedcontroller;
2363          switch (EncodedController) {          switch (EncodedController) {
# Line 1930  namespace { Line 2469  namespace {
2469                  decodedcontroller.controller_number = 95;                  decodedcontroller.controller_number = 95;
2470                  break;                  break;
2471    
2472                // format extension (these controllers are so far only supported by
2473                // LinuxSampler & gigedit) they will *NOT* work with
2474                // Gigasampler/GigaStudio !
2475                case _lev_ctrl_CC3_EXT:
2476                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2477                    decodedcontroller.controller_number = 3;
2478                    break;
2479                case _lev_ctrl_CC6_EXT:
2480                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2481                    decodedcontroller.controller_number = 6;
2482                    break;
2483                case _lev_ctrl_CC7_EXT:
2484                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2485                    decodedcontroller.controller_number = 7;
2486                    break;
2487                case _lev_ctrl_CC8_EXT:
2488                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2489                    decodedcontroller.controller_number = 8;
2490                    break;
2491                case _lev_ctrl_CC9_EXT:
2492                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2493                    decodedcontroller.controller_number = 9;
2494                    break;
2495                case _lev_ctrl_CC10_EXT:
2496                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2497                    decodedcontroller.controller_number = 10;
2498                    break;
2499                case _lev_ctrl_CC11_EXT:
2500                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2501                    decodedcontroller.controller_number = 11;
2502                    break;
2503                case _lev_ctrl_CC14_EXT:
2504                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2505                    decodedcontroller.controller_number = 14;
2506                    break;
2507                case _lev_ctrl_CC15_EXT:
2508                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2509                    decodedcontroller.controller_number = 15;
2510                    break;
2511                case _lev_ctrl_CC20_EXT:
2512                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2513                    decodedcontroller.controller_number = 20;
2514                    break;
2515                case _lev_ctrl_CC21_EXT:
2516                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2517                    decodedcontroller.controller_number = 21;
2518                    break;
2519                case _lev_ctrl_CC22_EXT:
2520                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2521                    decodedcontroller.controller_number = 22;
2522                    break;
2523                case _lev_ctrl_CC23_EXT:
2524                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2525                    decodedcontroller.controller_number = 23;
2526                    break;
2527                case _lev_ctrl_CC24_EXT:
2528                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2529                    decodedcontroller.controller_number = 24;
2530                    break;
2531                case _lev_ctrl_CC25_EXT:
2532                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2533                    decodedcontroller.controller_number = 25;
2534                    break;
2535                case _lev_ctrl_CC26_EXT:
2536                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2537                    decodedcontroller.controller_number = 26;
2538                    break;
2539                case _lev_ctrl_CC27_EXT:
2540                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2541                    decodedcontroller.controller_number = 27;
2542                    break;
2543                case _lev_ctrl_CC28_EXT:
2544                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2545                    decodedcontroller.controller_number = 28;
2546                    break;
2547                case _lev_ctrl_CC29_EXT:
2548                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2549                    decodedcontroller.controller_number = 29;
2550                    break;
2551                case _lev_ctrl_CC30_EXT:
2552                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2553                    decodedcontroller.controller_number = 30;
2554                    break;
2555                case _lev_ctrl_CC31_EXT:
2556                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2557                    decodedcontroller.controller_number = 31;
2558                    break;
2559                case _lev_ctrl_CC68_EXT:
2560                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2561                    decodedcontroller.controller_number = 68;
2562                    break;
2563                case _lev_ctrl_CC69_EXT:
2564                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2565                    decodedcontroller.controller_number = 69;
2566                    break;
2567                case _lev_ctrl_CC70_EXT:
2568                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2569                    decodedcontroller.controller_number = 70;
2570                    break;
2571                case _lev_ctrl_CC71_EXT:
2572                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2573                    decodedcontroller.controller_number = 71;
2574                    break;
2575                case _lev_ctrl_CC72_EXT:
2576                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2577                    decodedcontroller.controller_number = 72;
2578                    break;
2579                case _lev_ctrl_CC73_EXT:
2580                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2581                    decodedcontroller.controller_number = 73;
2582                    break;
2583                case _lev_ctrl_CC74_EXT:
2584                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2585                    decodedcontroller.controller_number = 74;
2586                    break;
2587                case _lev_ctrl_CC75_EXT:
2588                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2589                    decodedcontroller.controller_number = 75;
2590                    break;
2591                case _lev_ctrl_CC76_EXT:
2592                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2593                    decodedcontroller.controller_number = 76;
2594                    break;
2595                case _lev_ctrl_CC77_EXT:
2596                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2597                    decodedcontroller.controller_number = 77;
2598                    break;
2599                case _lev_ctrl_CC78_EXT:
2600                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2601                    decodedcontroller.controller_number = 78;
2602                    break;
2603                case _lev_ctrl_CC79_EXT:
2604                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2605                    decodedcontroller.controller_number = 79;
2606                    break;
2607                case _lev_ctrl_CC84_EXT:
2608                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2609                    decodedcontroller.controller_number = 84;
2610                    break;
2611                case _lev_ctrl_CC85_EXT:
2612                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2613                    decodedcontroller.controller_number = 85;
2614                    break;
2615                case _lev_ctrl_CC86_EXT:
2616                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2617                    decodedcontroller.controller_number = 86;
2618                    break;
2619                case _lev_ctrl_CC87_EXT:
2620                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2621                    decodedcontroller.controller_number = 87;
2622                    break;
2623                case _lev_ctrl_CC89_EXT:
2624                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2625                    decodedcontroller.controller_number = 89;
2626                    break;
2627                case _lev_ctrl_CC90_EXT:
2628                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2629                    decodedcontroller.controller_number = 90;
2630                    break;
2631                case _lev_ctrl_CC96_EXT:
2632                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2633                    decodedcontroller.controller_number = 96;
2634                    break;
2635                case _lev_ctrl_CC97_EXT:
2636                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2637                    decodedcontroller.controller_number = 97;
2638                    break;
2639                case _lev_ctrl_CC102_EXT:
2640                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2641                    decodedcontroller.controller_number = 102;
2642                    break;
2643                case _lev_ctrl_CC103_EXT:
2644                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2645                    decodedcontroller.controller_number = 103;
2646                    break;
2647                case _lev_ctrl_CC104_EXT:
2648                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2649                    decodedcontroller.controller_number = 104;
2650                    break;
2651                case _lev_ctrl_CC105_EXT:
2652                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2653                    decodedcontroller.controller_number = 105;
2654                    break;
2655                case _lev_ctrl_CC106_EXT:
2656                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2657                    decodedcontroller.controller_number = 106;
2658                    break;
2659                case _lev_ctrl_CC107_EXT:
2660                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2661                    decodedcontroller.controller_number = 107;
2662                    break;
2663                case _lev_ctrl_CC108_EXT:
2664                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2665                    decodedcontroller.controller_number = 108;
2666                    break;
2667                case _lev_ctrl_CC109_EXT:
2668                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2669                    decodedcontroller.controller_number = 109;
2670                    break;
2671                case _lev_ctrl_CC110_EXT:
2672                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2673                    decodedcontroller.controller_number = 110;
2674                    break;
2675                case _lev_ctrl_CC111_EXT:
2676                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2677                    decodedcontroller.controller_number = 111;
2678                    break;
2679                case _lev_ctrl_CC112_EXT:
2680                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2681                    decodedcontroller.controller_number = 112;
2682                    break;
2683                case _lev_ctrl_CC113_EXT:
2684                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2685                    decodedcontroller.controller_number = 113;
2686                    break;
2687                case _lev_ctrl_CC114_EXT:
2688                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2689                    decodedcontroller.controller_number = 114;
2690                    break;
2691                case _lev_ctrl_CC115_EXT:
2692                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2693                    decodedcontroller.controller_number = 115;
2694                    break;
2695                case _lev_ctrl_CC116_EXT:
2696                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2697                    decodedcontroller.controller_number = 116;
2698                    break;
2699                case _lev_ctrl_CC117_EXT:
2700                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2701                    decodedcontroller.controller_number = 117;
2702                    break;
2703                case _lev_ctrl_CC118_EXT:
2704                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2705                    decodedcontroller.controller_number = 118;
2706                    break;
2707                case _lev_ctrl_CC119_EXT:
2708                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2709                    decodedcontroller.controller_number = 119;
2710                    break;
2711    
2712              // unknown controller type              // unknown controller type
2713              default:              default:
2714                  throw gig::Exception("Unknown leverage controller type.");                  decodedcontroller.type = leverage_ctrl_t::type_none;
2715                    decodedcontroller.controller_number = 0;
2716                    printf("Warning: Unknown leverage controller type (0x%x).\n", EncodedController);
2717                    break;
2718          }          }
2719          return decodedcontroller;          return decodedcontroller;
2720      }      }
2721        
2722    // see above (diagnostic push not supported prior GCC 4.6)
2723    //#pragma GCC diagnostic pop
2724    
2725      DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {      DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {
2726          _lev_ctrl_t encodedcontroller;          _lev_ctrl_t encodedcontroller;
# Line 2023  namespace { Line 2808  namespace {
2808                      case 95:                      case 95:
2809                          encodedcontroller = _lev_ctrl_effect5depth;                          encodedcontroller = _lev_ctrl_effect5depth;
2810                          break;                          break;
2811    
2812                        // format extension (these controllers are so far only
2813                        // supported by LinuxSampler & gigedit) they will *NOT*
2814                        // work with Gigasampler/GigaStudio !
2815                        case 3:
2816                            encodedcontroller = _lev_ctrl_CC3_EXT;
2817                            break;
2818                        case 6:
2819                            encodedcontroller = _lev_ctrl_CC6_EXT;
2820                            break;
2821                        case 7:
2822                            encodedcontroller = _lev_ctrl_CC7_EXT;
2823                            break;
2824                        case 8:
2825                            encodedcontroller = _lev_ctrl_CC8_EXT;
2826                            break;
2827                        case 9:
2828                            encodedcontroller = _lev_ctrl_CC9_EXT;
2829                            break;
2830                        case 10:
2831                            encodedcontroller = _lev_ctrl_CC10_EXT;
2832                            break;
2833                        case 11:
2834                            encodedcontroller = _lev_ctrl_CC11_EXT;
2835                            break;
2836                        case 14:
2837                            encodedcontroller = _lev_ctrl_CC14_EXT;
2838                            break;
2839                        case 15:
2840                            encodedcontroller = _lev_ctrl_CC15_EXT;
2841                            break;
2842                        case 20:
2843                            encodedcontroller = _lev_ctrl_CC20_EXT;
2844                            break;
2845                        case 21:
2846                            encodedcontroller = _lev_ctrl_CC21_EXT;
2847                            break;
2848                        case 22:
2849                            encodedcontroller = _lev_ctrl_CC22_EXT;
2850                            break;
2851                        case 23:
2852                            encodedcontroller = _lev_ctrl_CC23_EXT;
2853                            break;
2854                        case 24:
2855                            encodedcontroller = _lev_ctrl_CC24_EXT;
2856                            break;
2857                        case 25:
2858                            encodedcontroller = _lev_ctrl_CC25_EXT;
2859                            break;
2860                        case 26:
2861                            encodedcontroller = _lev_ctrl_CC26_EXT;
2862                            break;
2863                        case 27:
2864                            encodedcontroller = _lev_ctrl_CC27_EXT;
2865                            break;
2866                        case 28:
2867                            encodedcontroller = _lev_ctrl_CC28_EXT;
2868                            break;
2869                        case 29:
2870                            encodedcontroller = _lev_ctrl_CC29_EXT;
2871                            break;
2872                        case 30:
2873                            encodedcontroller = _lev_ctrl_CC30_EXT;
2874                            break;
2875                        case 31:
2876                            encodedcontroller = _lev_ctrl_CC31_EXT;
2877                            break;
2878                        case 68:
2879                            encodedcontroller = _lev_ctrl_CC68_EXT;
2880                            break;
2881                        case 69:
2882                            encodedcontroller = _lev_ctrl_CC69_EXT;
2883                            break;
2884                        case 70:
2885                            encodedcontroller = _lev_ctrl_CC70_EXT;
2886                            break;
2887                        case 71:
2888                            encodedcontroller = _lev_ctrl_CC71_EXT;
2889                            break;
2890                        case 72:
2891                            encodedcontroller = _lev_ctrl_CC72_EXT;
2892                            break;
2893                        case 73:
2894                            encodedcontroller = _lev_ctrl_CC73_EXT;
2895                            break;
2896                        case 74:
2897                            encodedcontroller = _lev_ctrl_CC74_EXT;
2898                            break;
2899                        case 75:
2900                            encodedcontroller = _lev_ctrl_CC75_EXT;
2901                            break;
2902                        case 76:
2903                            encodedcontroller = _lev_ctrl_CC76_EXT;
2904                            break;
2905                        case 77:
2906                            encodedcontroller = _lev_ctrl_CC77_EXT;
2907                            break;
2908                        case 78:
2909                            encodedcontroller = _lev_ctrl_CC78_EXT;
2910                            break;
2911                        case 79:
2912                            encodedcontroller = _lev_ctrl_CC79_EXT;
2913                            break;
2914                        case 84:
2915                            encodedcontroller = _lev_ctrl_CC84_EXT;
2916                            break;
2917                        case 85:
2918                            encodedcontroller = _lev_ctrl_CC85_EXT;
2919                            break;
2920                        case 86:
2921                            encodedcontroller = _lev_ctrl_CC86_EXT;
2922                            break;
2923                        case 87:
2924                            encodedcontroller = _lev_ctrl_CC87_EXT;
2925                            break;
2926                        case 89:
2927                            encodedcontroller = _lev_ctrl_CC89_EXT;
2928                            break;
2929                        case 90:
2930                            encodedcontroller = _lev_ctrl_CC90_EXT;
2931                            break;
2932                        case 96:
2933                            encodedcontroller = _lev_ctrl_CC96_EXT;
2934                            break;
2935                        case 97:
2936                            encodedcontroller = _lev_ctrl_CC97_EXT;
2937                            break;
2938                        case 102:
2939                            encodedcontroller = _lev_ctrl_CC102_EXT;
2940                            break;
2941                        case 103:
2942                            encodedcontroller = _lev_ctrl_CC103_EXT;
2943                            break;
2944                        case 104:
2945                            encodedcontroller = _lev_ctrl_CC104_EXT;
2946                            break;
2947                        case 105:
2948                            encodedcontroller = _lev_ctrl_CC105_EXT;
2949                            break;
2950                        case 106:
2951                            encodedcontroller = _lev_ctrl_CC106_EXT;
2952                            break;
2953                        case 107:
2954                            encodedcontroller = _lev_ctrl_CC107_EXT;
2955                            break;
2956                        case 108:
2957                            encodedcontroller = _lev_ctrl_CC108_EXT;
2958                            break;
2959                        case 109:
2960                            encodedcontroller = _lev_ctrl_CC109_EXT;
2961                            break;
2962                        case 110:
2963                            encodedcontroller = _lev_ctrl_CC110_EXT;
2964                            break;
2965                        case 111:
2966                            encodedcontroller = _lev_ctrl_CC111_EXT;
2967                            break;
2968                        case 112:
2969                            encodedcontroller = _lev_ctrl_CC112_EXT;
2970                            break;
2971                        case 113:
2972                            encodedcontroller = _lev_ctrl_CC113_EXT;
2973                            break;
2974                        case 114:
2975                            encodedcontroller = _lev_ctrl_CC114_EXT;
2976                            break;
2977                        case 115:
2978                            encodedcontroller = _lev_ctrl_CC115_EXT;
2979                            break;
2980                        case 116:
2981                            encodedcontroller = _lev_ctrl_CC116_EXT;
2982                            break;
2983                        case 117:
2984                            encodedcontroller = _lev_ctrl_CC117_EXT;
2985                            break;
2986                        case 118:
2987                            encodedcontroller = _lev_ctrl_CC118_EXT;
2988                            break;
2989                        case 119:
2990                            encodedcontroller = _lev_ctrl_CC119_EXT;
2991                            break;
2992    
2993                      default:                      default:
2994                          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");
2995                  }                  }
# Line 2072  namespace { Line 3039  namespace {
3039          return pVelocityCutoffTable[MIDIKeyVelocity];          return pVelocityCutoffTable[MIDIKeyVelocity];
3040      }      }
3041    
3042        /**
3043         * Updates the respective member variable and the lookup table / cache
3044         * that depends on this value.
3045         */
3046        void DimensionRegion::SetVelocityResponseCurve(curve_type_t curve) {
3047            pVelocityAttenuationTable =
3048                GetVelocityTable(
3049                    curve, VelocityResponseDepth, VelocityResponseCurveScaling
3050                );
3051            VelocityResponseCurve = curve;
3052        }
3053    
3054        /**
3055         * Updates the respective member variable and the lookup table / cache
3056         * that depends on this value.
3057         */
3058        void DimensionRegion::SetVelocityResponseDepth(uint8_t depth) {
3059            pVelocityAttenuationTable =
3060                GetVelocityTable(
3061                    VelocityResponseCurve, depth, VelocityResponseCurveScaling
3062                );
3063            VelocityResponseDepth = depth;
3064        }
3065    
3066        /**
3067         * Updates the respective member variable and the lookup table / cache
3068         * that depends on this value.
3069         */
3070        void DimensionRegion::SetVelocityResponseCurveScaling(uint8_t scaling) {
3071            pVelocityAttenuationTable =
3072                GetVelocityTable(
3073                    VelocityResponseCurve, VelocityResponseDepth, scaling
3074                );
3075            VelocityResponseCurveScaling = scaling;
3076        }
3077    
3078        /**
3079         * Updates the respective member variable and the lookup table / cache
3080         * that depends on this value.
3081         */
3082        void DimensionRegion::SetReleaseVelocityResponseCurve(curve_type_t curve) {
3083            pVelocityReleaseTable = GetReleaseVelocityTable(curve, ReleaseVelocityResponseDepth);
3084            ReleaseVelocityResponseCurve = curve;
3085        }
3086    
3087        /**
3088         * Updates the respective member variable and the lookup table / cache
3089         * that depends on this value.
3090         */
3091        void DimensionRegion::SetReleaseVelocityResponseDepth(uint8_t depth) {
3092            pVelocityReleaseTable = GetReleaseVelocityTable(ReleaseVelocityResponseCurve, depth);
3093            ReleaseVelocityResponseDepth = depth;
3094        }
3095    
3096        /**
3097         * Updates the respective member variable and the lookup table / cache
3098         * that depends on this value.
3099         */
3100        void DimensionRegion::SetVCFCutoffController(vcf_cutoff_ctrl_t controller) {
3101            pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, VCFVelocityDynamicRange, VCFVelocityScale, controller);
3102            VCFCutoffController = controller;
3103        }
3104    
3105        /**
3106         * Updates the respective member variable and the lookup table / cache
3107         * that depends on this value.
3108         */
3109        void DimensionRegion::SetVCFVelocityCurve(curve_type_t curve) {
3110            pVelocityCutoffTable = GetCutoffVelocityTable(curve, VCFVelocityDynamicRange, VCFVelocityScale, VCFCutoffController);
3111            VCFVelocityCurve = curve;
3112        }
3113    
3114        /**
3115         * Updates the respective member variable and the lookup table / cache
3116         * that depends on this value.
3117         */
3118        void DimensionRegion::SetVCFVelocityDynamicRange(uint8_t range) {
3119            pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, range, VCFVelocityScale, VCFCutoffController);
3120            VCFVelocityDynamicRange = range;
3121        }
3122    
3123        /**
3124         * Updates the respective member variable and the lookup table / cache
3125         * that depends on this value.
3126         */
3127        void DimensionRegion::SetVCFVelocityScale(uint8_t scaling) {
3128            pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, VCFVelocityDynamicRange, scaling, VCFCutoffController);
3129            VCFVelocityScale = scaling;
3130        }
3131    
3132      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) {
3133    
3134          // line-segment approximations of the 15 velocity curves          // line-segment approximations of the 15 velocity curves
# Line 2155  namespace { Line 3212  namespace {
3212    
3213          // Actual Loading          // Actual Loading
3214    
3215            if (!file->GetAutoLoad()) return;
3216    
3217          LoadDimensionRegions(rgnList);          LoadDimensionRegions(rgnList);
3218    
3219          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);
# Line 2198  namespace { Line 3257  namespace {
3257              else              else
3258                  _3lnk->SetPos(44);                  _3lnk->SetPos(44);
3259    
3260              // load sample references              // load sample references (if auto loading is enabled)
3261              for (uint i = 0; i < DimensionRegions; i++) {              if (file->GetAutoLoad()) {
3262                  uint32_t wavepoolindex = _3lnk->ReadUint32();                  for (uint i = 0; i < DimensionRegions; i++) {
3263                  if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);                      uint32_t wavepoolindex = _3lnk->ReadUint32();
3264                        if (file->pWavePoolTable && pDimensionRegions[i])
3265                            pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
3266                    }
3267                    GetSample(); // load global region sample reference
3268              }              }
             GetSample(); // load global region sample reference  
3269          } else {          } else {
3270              DimensionRegions = 0;              DimensionRegions = 0;
3271              for (int i = 0 ; i < 8 ; i++) {              for (int i = 0 ; i < 8 ; i++) {
# Line 2218  namespace { Line 3280  namespace {
3280              RIFF::List* _3prg = rgnList->GetSubList(LIST_TYPE_3PRG);              RIFF::List* _3prg = rgnList->GetSubList(LIST_TYPE_3PRG);
3281              if (!_3prg) _3prg = rgnList->AddSubList(LIST_TYPE_3PRG);              if (!_3prg) _3prg = rgnList->AddSubList(LIST_TYPE_3PRG);
3282              RIFF::List* _3ewl = _3prg->AddSubList(LIST_TYPE_3EWL);              RIFF::List* _3ewl = _3prg->AddSubList(LIST_TYPE_3EWL);
3283              pDimensionRegions[0] = new DimensionRegion(_3ewl);              pDimensionRegions[0] = new DimensionRegion(this, _3ewl);
3284              DimensionRegions = 1;              DimensionRegions = 1;
3285          }          }
3286      }      }
# Line 2230  namespace { Line 3292  namespace {
3292       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
3293       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
3294       *       *
3295         * @param pProgress - callback function for progress notification
3296       * @throws gig::Exception if samples cannot be dereferenced       * @throws gig::Exception if samples cannot be dereferenced
3297       */       */
3298      void Region::UpdateChunks() {      void Region::UpdateChunks(progress_t* pProgress) {
3299          // 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
3300          // 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
3301          // 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 2240  namespace { Line 3303  namespace {
3303          pSample = pDimensionRegions[0]->pSample;          pSample = pDimensionRegions[0]->pSample;
3304    
3305          // first update base class's chunks          // first update base class's chunks
3306          DLS::Region::UpdateChunks();          DLS::Region::UpdateChunks(pProgress);
3307    
3308          // update dimension region's chunks          // update dimension region's chunks
3309          for (int i = 0; i < DimensionRegions; i++) {          for (int i = 0; i < DimensionRegions; i++) {
3310              pDimensionRegions[i]->UpdateChunks();              pDimensionRegions[i]->UpdateChunks(pProgress);
3311          }          }
3312    
3313          File* pFile = (File*) GetParent()->GetParent();          File* pFile = (File*) GetParent()->GetParent();
3314          const int iMaxDimensions = (pFile->pVersion && pFile->pVersion->major == 3) ? 8 : 5;          bool version3 = pFile->pVersion && pFile->pVersion->major == 3;
3315          const int iMaxDimensionRegions = (pFile->pVersion && pFile->pVersion->major == 3) ? 256 : 32;          const int iMaxDimensions =  version3 ? 8 : 5;
3316            const int iMaxDimensionRegions = version3 ? 256 : 32;
3317    
3318          // make sure '3lnk' chunk exists          // make sure '3lnk' chunk exists
3319          RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);          RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);
3320          if (!_3lnk) {          if (!_3lnk) {
3321              const int _3lnkChunkSize = (pFile->pVersion && pFile->pVersion->major == 3) ? 1092 : 172;              const int _3lnkChunkSize = version3 ? 1092 : 172;
3322              _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);              _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);
3323              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
3324    
3325              // move 3prg to last position              // move 3prg to last position
3326              pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), 0);              pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), (RIFF::Chunk*)NULL);
3327          }          }
3328    
3329          // update dimension definitions in '3lnk' chunk          // update dimension definitions in '3lnk' chunk
# Line 2269  namespace { Line 3333  namespace {
3333          for (int i = 0; i < iMaxDimensions; i++) {          for (int i = 0; i < iMaxDimensions; i++) {
3334              pData[4 + i * 8] = (uint8_t) pDimensionDefinitions[i].dimension;              pData[4 + i * 8] = (uint8_t) pDimensionDefinitions[i].dimension;
3335              pData[5 + i * 8] = pDimensionDefinitions[i].bits;              pData[5 + i * 8] = pDimensionDefinitions[i].bits;
3336              pData[6 + i * 8] = shift;              pData[6 + i * 8] = pDimensionDefinitions[i].dimension == dimension_none ? 0 : shift;
3337              pData[7 + i * 8] = (1 << (shift + pDimensionDefinitions[i].bits)) - (1 << shift);              pData[7 + i * 8] = (1 << (shift + pDimensionDefinitions[i].bits)) - (1 << shift);
3338              pData[8 + i * 8] = pDimensionDefinitions[i].zones;              pData[8 + i * 8] = pDimensionDefinitions[i].zones;
3339              // next 3 bytes unknown, always zero?              // next 3 bytes unknown, always zero?
# Line 2278  namespace { Line 3342  namespace {
3342          }          }
3343    
3344          // update wave pool table in '3lnk' chunk          // update wave pool table in '3lnk' chunk
3345          const int iWavePoolOffset = (pFile->pVersion && pFile->pVersion->major == 3) ? 68 : 44;          const int iWavePoolOffset = version3 ? 68 : 44;
3346          for (uint i = 0; i < iMaxDimensionRegions; i++) {          for (uint i = 0; i < iMaxDimensionRegions; i++) {
3347              int iWaveIndex = -1;              int iWaveIndex = -1;
3348              if (i < DimensionRegions) {              if (i < DimensionRegions) {
# Line 2291  namespace { Line 3355  namespace {
3355                          break;                          break;
3356                      }                      }
3357                  }                  }
                 if (iWaveIndex < 0) throw gig::Exception("Could not update gig::Region, could not find DimensionRegion's sample");  
3358              }              }
3359              store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);              store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);
3360          }          }
# Line 2304  namespace { Line 3367  namespace {
3367              RIFF::List* _3ewl = _3prg->GetFirstSubList();              RIFF::List* _3ewl = _3prg->GetFirstSubList();
3368              while (_3ewl) {              while (_3ewl) {
3369                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {
3370                      pDimensionRegions[dimensionRegionNr] = new DimensionRegion(_3ewl);                      pDimensionRegions[dimensionRegionNr] = new DimensionRegion(this, _3ewl);
3371                      dimensionRegionNr++;                      dimensionRegionNr++;
3372                  }                  }
3373                  _3ewl = _3prg->GetNextSubList();                  _3ewl = _3prg->GetNextSubList();
# Line 2313  namespace { Line 3376  namespace {
3376          }          }
3377      }      }
3378    
3379        void Region::SetKeyRange(uint16_t Low, uint16_t High) {
3380            // update KeyRange struct and make sure regions are in correct order
3381            DLS::Region::SetKeyRange(Low, High);
3382            // update Region key table for fast lookup
3383            ((gig::Instrument*)GetParent())->UpdateRegionKeyTable();
3384        }
3385    
3386      void Region::UpdateVelocityTable() {      void Region::UpdateVelocityTable() {
3387          // get velocity dimension's index          // get velocity dimension's index
3388          int veldim = -1;          int veldim = -1;
# Line 2327  namespace { Line 3397  namespace {
3397          int step = 1;          int step = 1;
3398          for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;          for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
3399          int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;          int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
         int end = step * pDimensionDefinitions[veldim].zones;  
3400    
3401          // loop through all dimension regions for all dimensions except the velocity dimension          // loop through all dimension regions for all dimensions except the velocity dimension
3402          int dim[8] = { 0 };          int dim[8] = { 0 };
3403          for (int i = 0 ; i < DimensionRegions ; i++) {          for (int i = 0 ; i < DimensionRegions ; i++) {
3404                const int end = i + step * pDimensionDefinitions[veldim].zones;
3405    
3406                // create a velocity table for all cases where the velocity zone is zero
3407              if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||              if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||
3408                  pDimensionRegions[i]->VelocityUpperLimit) {                  pDimensionRegions[i]->VelocityUpperLimit) {
3409                  // create the velocity table                  // create the velocity table
# Line 2363  namespace { Line 3434  namespace {
3434                  }                  }
3435              }              }
3436    
3437                // jump to the next case where the velocity zone is zero
3438              int j;              int j;
3439              int shift = 0;              int shift = 0;
3440              for (j = 0 ; j < Dimensions ; j++) {              for (j = 0 ; j < Dimensions ; j++) {
# Line 2399  namespace { Line 3471  namespace {
3471       *                        dimension bits limit is violated       *                        dimension bits limit is violated
3472       */       */
3473      void Region::AddDimension(dimension_def_t* pDimDef) {      void Region::AddDimension(dimension_def_t* pDimDef) {
3474            // some initial sanity checks of the given dimension definition
3475            if (pDimDef->zones < 2)
3476                throw gig::Exception("Could not add new dimension, amount of requested zones must always be at least two");
3477            if (pDimDef->bits < 1)
3478                throw gig::Exception("Could not add new dimension, amount of requested requested zone bits must always be at least one");
3479            if (pDimDef->dimension == dimension_samplechannel) {
3480                if (pDimDef->zones != 2)
3481                    throw gig::Exception("Could not add new 'sample channel' dimensions, the requested amount of zones must always be 2 for this dimension type");
3482                if (pDimDef->bits != 1)
3483                    throw gig::Exception("Could not add new 'sample channel' dimensions, the requested amount of zone bits must always be 1 for this dimension type");
3484            }
3485    
3486          // check if max. amount of dimensions reached          // check if max. amount of dimensions reached
3487          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
3488          const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;          const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
# Line 2418  namespace { Line 3502  namespace {
3502              if (pDimensionDefinitions[i].dimension == pDimDef->dimension)              if (pDimensionDefinitions[i].dimension == pDimDef->dimension)
3503                  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");
3504    
3505            // pos is where the new dimension should be placed, normally
3506            // last in list, except for the samplechannel dimension which
3507            // has to be first in list
3508            int pos = pDimDef->dimension == dimension_samplechannel ? 0 : Dimensions;
3509            int bitpos = 0;
3510            for (int i = 0 ; i < pos ; i++)
3511                bitpos += pDimensionDefinitions[i].bits;
3512    
3513            // make room for the new dimension
3514            for (int i = Dimensions ; i > pos ; i--) pDimensionDefinitions[i] = pDimensionDefinitions[i - 1];
3515            for (int i = 0 ; i < (1 << iCurrentBits) ; i++) {
3516                for (int j = Dimensions ; j > pos ; j--) {
3517                    pDimensionRegions[i]->DimensionUpperLimits[j] =
3518                        pDimensionRegions[i]->DimensionUpperLimits[j - 1];
3519                }
3520            }
3521    
3522          // assign definition of new dimension          // assign definition of new dimension
3523          pDimensionDefinitions[Dimensions] = *pDimDef;          pDimensionDefinitions[pos] = *pDimDef;
3524    
3525          // auto correct certain dimension definition fields (where possible)          // auto correct certain dimension definition fields (where possible)
3526          pDimensionDefinitions[Dimensions].split_type  =          pDimensionDefinitions[pos].split_type  =
3527              __resolveSplitType(pDimensionDefinitions[Dimensions].dimension);              __resolveSplitType(pDimensionDefinitions[pos].dimension);
3528          pDimensionDefinitions[Dimensions].zone_size =          pDimensionDefinitions[pos].zone_size =
3529              __resolveZoneSize(pDimensionDefinitions[Dimensions]);              __resolveZoneSize(pDimensionDefinitions[pos]);
3530    
3531          // create new dimension region(s) for this new dimension          // create new dimension region(s) for this new dimension, and make
3532          for (int i = 1 << iCurrentBits; i < 1 << iNewBits; i++) {          // sure that the dimension regions are placed correctly in both the
3533              //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
3534              RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);          RIFF::Chunk* moveTo = NULL;
3535              RIFF::List* pNewDimRgnListChunk = _3prg->AddSubList(LIST_TYPE_3EWL);          RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
3536              pDimensionRegions[i] = new DimensionRegion(pNewDimRgnListChunk);          for (int i = (1 << iCurrentBits) - (1 << bitpos) ; i >= 0 ; i -= (1 << bitpos)) {
3537              DimensionRegions++;              for (int k = 0 ; k < (1 << bitpos) ; k++) {
3538                    pDimensionRegions[(i << pDimDef->bits) + k] = pDimensionRegions[i + k];
3539                }
3540                for (int j = 1 ; j < (1 << pDimDef->bits) ; j++) {
3541                    for (int k = 0 ; k < (1 << bitpos) ; k++) {
3542                        RIFF::List* pNewDimRgnListChunk = _3prg->AddSubList(LIST_TYPE_3EWL);
3543                        if (moveTo) _3prg->MoveSubChunk(pNewDimRgnListChunk, moveTo);
3544                        // create a new dimension region and copy all parameter values from
3545                        // an existing dimension region
3546                        pDimensionRegions[(i << pDimDef->bits) + (j << bitpos) + k] =
3547                            new DimensionRegion(pNewDimRgnListChunk, *pDimensionRegions[i + k]);
3548    
3549                        DimensionRegions++;
3550                    }
3551                }
3552                moveTo = pDimensionRegions[i]->pParentList;
3553            }
3554    
3555            // initialize the upper limits for this dimension
3556            int mask = (1 << bitpos) - 1;
3557            for (int z = 0 ; z < pDimDef->zones ; z++) {
3558                uint8_t upperLimit = uint8_t((z + 1) * 128.0 / pDimDef->zones - 1);
3559                for (int i = 0 ; i < 1 << iCurrentBits ; i++) {
3560                    pDimensionRegions[((i & ~mask) << pDimDef->bits) |
3561                                      (z << bitpos) |
3562                                      (i & mask)]->DimensionUpperLimits[pos] = upperLimit;
3563                }
3564          }          }
3565    
3566          Dimensions++;          Dimensions++;
# Line 2476  namespace { Line 3603  namespace {
3603          for (int i = iDimensionNr + 1; i < Dimensions; i++)          for (int i = iDimensionNr + 1; i < Dimensions; i++)
3604              iUpperBits += pDimensionDefinitions[i].bits;              iUpperBits += pDimensionDefinitions[i].bits;
3605    
3606            RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
3607    
3608          // delete dimension regions which belong to the given dimension          // delete dimension regions which belong to the given dimension
3609          // (that is where the dimension's bit > 0)          // (that is where the dimension's bit > 0)
3610          for (int iUpperBit = 0; iUpperBit < 1 << iUpperBits; iUpperBit++) {          for (int iUpperBit = 0; iUpperBit < 1 << iUpperBits; iUpperBit++) {
# Line 2484  namespace { Line 3613  namespace {
3613                      int iToDelete = iUpperBit    << (pDimensionDefinitions[iDimensionNr].bits + iLowerBits) |                      int iToDelete = iUpperBit    << (pDimensionDefinitions[iDimensionNr].bits + iLowerBits) |
3614                                      iObsoleteBit << iLowerBits |                                      iObsoleteBit << iLowerBits |
3615                                      iLowerBit;                                      iLowerBit;
3616    
3617                        _3prg->DeleteSubChunk(pDimensionRegions[iToDelete]->pParentList);
3618                      delete pDimensionRegions[iToDelete];                      delete pDimensionRegions[iToDelete];
3619                      pDimensionRegions[iToDelete] = NULL;                      pDimensionRegions[iToDelete] = NULL;
3620                      DimensionRegions--;                      DimensionRegions--;
# Line 2504  namespace { Line 3635  namespace {
3635              }              }
3636          }          }
3637    
3638            // remove the this dimension from the upper limits arrays
3639            for (int j = 0 ; j < 256 && pDimensionRegions[j] ; j++) {
3640                DimensionRegion* d = pDimensionRegions[j];
3641                for (int i = iDimensionNr + 1; i < Dimensions; i++) {
3642                    d->DimensionUpperLimits[i - 1] = d->DimensionUpperLimits[i];
3643                }
3644                d->DimensionUpperLimits[Dimensions - 1] = 127;
3645            }
3646    
3647          // 'remove' dimension definition          // 'remove' dimension definition
3648          for (int i = iDimensionNr + 1; i < Dimensions; i++) {          for (int i = iDimensionNr + 1; i < Dimensions; i++) {
3649              pDimensionDefinitions[i - 1] = pDimensionDefinitions[i];              pDimensionDefinitions[i - 1] = pDimensionDefinitions[i];
# Line 2518  namespace { Line 3658  namespace {
3658          if (pDimDef->dimension == dimension_layer) Layers = 1;          if (pDimDef->dimension == dimension_layer) Layers = 1;
3659      }      }
3660    
3661        /** @brief Delete one split zone of a dimension (decrement zone amount).
3662         *
3663         * Instead of deleting an entire dimensions, this method will only delete
3664         * one particular split zone given by @a zone of the Region's dimension
3665         * given by @a type. So this method will simply decrement the amount of
3666         * zones by one of the dimension in question. To be able to do that, the
3667         * respective dimension must exist on this Region and it must have at least
3668         * 3 zones. All DimensionRegion objects associated with the zone will be
3669         * deleted.
3670         *
3671         * @param type - identifies the dimension where a zone shall be deleted
3672         * @param zone - index of the dimension split zone that shall be deleted
3673         * @throws gig::Exception if requested zone could not be deleted
3674         */
3675        void Region::DeleteDimensionZone(dimension_t type, int zone) {
3676            dimension_def_t* oldDef = GetDimensionDefinition(type);
3677            if (!oldDef)
3678                throw gig::Exception("Could not delete dimension zone, no such dimension of given type");
3679            if (oldDef->zones <= 2)
3680                throw gig::Exception("Could not delete dimension zone, because it would end up with only one zone.");
3681            if (zone < 0 || zone >= oldDef->zones)
3682                throw gig::Exception("Could not delete dimension zone, requested zone index out of bounds.");
3683    
3684            const int newZoneSize = oldDef->zones - 1;
3685    
3686            // create a temporary Region which just acts as a temporary copy
3687            // container and will be deleted at the end of this function and will
3688            // also not be visible through the API during this process
3689            gig::Region* tempRgn = NULL;
3690            {
3691                // adding these temporary chunks is probably not even necessary
3692                Instrument* instr = static_cast<Instrument*>(GetParent());
3693                RIFF::List* pCkInstrument = instr->pCkInstrument;
3694                RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
3695                if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3696                RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3697                tempRgn = new Region(instr, rgn);
3698            }
3699    
3700            // copy this region's dimensions (with already the dimension split size
3701            // requested by the arguments of this method call) to the temporary
3702            // region, and don't use Region::CopyAssign() here for this task, since
3703            // it would also alter fast lookup helper variables here and there
3704            dimension_def_t newDef;
3705            for (int i = 0; i < Dimensions; ++i) {
3706                dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3707                // is this the dimension requested by the method arguments? ...
3708                if (def.dimension == type) { // ... if yes, decrement zone amount by one
3709                    def.zones = newZoneSize;
3710                    if ((1 << (def.bits - 1)) == def.zones) def.bits--;
3711                    newDef = def;
3712                }
3713                tempRgn->AddDimension(&def);
3714            }
3715    
3716            // find the dimension index in the tempRegion which is the dimension
3717            // type passed to this method (paranoidly expecting different order)
3718            int tempReducedDimensionIndex = -1;
3719            for (int d = 0; d < tempRgn->Dimensions; ++d) {
3720                if (tempRgn->pDimensionDefinitions[d].dimension == type) {
3721                    tempReducedDimensionIndex = d;
3722                    break;
3723                }
3724            }
3725    
3726            // copy dimension regions from this region to the temporary region
3727            for (int iDst = 0; iDst < 256; ++iDst) {
3728                DimensionRegion* dstDimRgn = tempRgn->pDimensionRegions[iDst];
3729                if (!dstDimRgn) continue;
3730                std::map<dimension_t,int> dimCase;
3731                bool isValidZone = true;
3732                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3733                    const int dstBits = tempRgn->pDimensionDefinitions[d].bits;
3734                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3735                        (iDst >> baseBits) & ((1 << dstBits) - 1);
3736                    baseBits += dstBits;
3737                    // there are also DimensionRegion objects of unused zones, skip them
3738                    if (dimCase[tempRgn->pDimensionDefinitions[d].dimension] >= tempRgn->pDimensionDefinitions[d].zones) {
3739                        isValidZone = false;
3740                        break;
3741                    }
3742                }
3743                if (!isValidZone) continue;
3744                // a bit paranoid: cope with the chance that the dimensions would
3745                // have different order in source and destination regions
3746                const bool isLastZone = (dimCase[type] == newZoneSize - 1);
3747                if (dimCase[type] >= zone) dimCase[type]++;
3748                DimensionRegion* srcDimRgn = GetDimensionRegionByBit(dimCase);
3749                dstDimRgn->CopyAssign(srcDimRgn);
3750                // if this is the upper most zone of the dimension passed to this
3751                // method, then correct (raise) its upper limit to 127
3752                if (newDef.split_type == split_type_normal && isLastZone)
3753                    dstDimRgn->DimensionUpperLimits[tempReducedDimensionIndex] = 127;
3754            }
3755    
3756            // now tempRegion's dimensions and DimensionRegions basically reflect
3757            // what we wanted to get for this actual Region here, so we now just
3758            // delete and recreate the dimension in question with the new amount
3759            // zones and then copy back from tempRegion      
3760            DeleteDimension(oldDef);
3761            AddDimension(&newDef);
3762            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3763                DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
3764                if (!srcDimRgn) continue;
3765                std::map<dimension_t,int> dimCase;
3766                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3767                    const int srcBits = tempRgn->pDimensionDefinitions[d].bits;
3768                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3769                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3770                    baseBits += srcBits;
3771                }
3772                // a bit paranoid: cope with the chance that the dimensions would
3773                // have different order in source and destination regions
3774                DimensionRegion* dstDimRgn = GetDimensionRegionByBit(dimCase);
3775                if (!dstDimRgn) continue;
3776                dstDimRgn->CopyAssign(srcDimRgn);
3777            }
3778    
3779            // delete temporary region
3780            delete tempRgn;
3781    
3782            UpdateVelocityTable();
3783        }
3784    
3785        /** @brief Divide split zone of a dimension in two (increment zone amount).
3786         *
3787         * This will increment the amount of zones for the dimension (given by
3788         * @a type) by one. It will do so by dividing the zone (given by @a zone)
3789         * in the middle of its zone range in two. So the two zones resulting from
3790         * the zone being splitted, will be an equivalent copy regarding all their
3791         * articulation informations and sample reference. The two zones will only
3792         * differ in their zone's upper limit
3793         * (DimensionRegion::DimensionUpperLimits).
3794         *
3795         * @param type - identifies the dimension where a zone shall be splitted
3796         * @param zone - index of the dimension split zone that shall be splitted
3797         * @throws gig::Exception if requested zone could not be splitted
3798         */
3799        void Region::SplitDimensionZone(dimension_t type, int zone) {
3800            dimension_def_t* oldDef = GetDimensionDefinition(type);
3801            if (!oldDef)
3802                throw gig::Exception("Could not split dimension zone, no such dimension of given type");
3803            if (zone < 0 || zone >= oldDef->zones)
3804                throw gig::Exception("Could not split dimension zone, requested zone index out of bounds.");
3805    
3806            const int newZoneSize = oldDef->zones + 1;
3807    
3808            // create a temporary Region which just acts as a temporary copy
3809            // container and will be deleted at the end of this function and will
3810            // also not be visible through the API during this process
3811            gig::Region* tempRgn = NULL;
3812            {
3813                // adding these temporary chunks is probably not even necessary
3814                Instrument* instr = static_cast<Instrument*>(GetParent());
3815                RIFF::List* pCkInstrument = instr->pCkInstrument;
3816                RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
3817                if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3818                RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3819                tempRgn = new Region(instr, rgn);
3820            }
3821    
3822            // copy this region's dimensions (with already the dimension split size
3823            // requested by the arguments of this method call) to the temporary
3824            // region, and don't use Region::CopyAssign() here for this task, since
3825            // it would also alter fast lookup helper variables here and there
3826            dimension_def_t newDef;
3827            for (int i = 0; i < Dimensions; ++i) {
3828                dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3829                // is this the dimension requested by the method arguments? ...
3830                if (def.dimension == type) { // ... if yes, increment zone amount by one
3831                    def.zones = newZoneSize;
3832                    if ((1 << oldDef->bits) < newZoneSize) def.bits++;
3833                    newDef = def;
3834                }
3835                tempRgn->AddDimension(&def);
3836            }
3837    
3838            // find the dimension index in the tempRegion which is the dimension
3839            // type passed to this method (paranoidly expecting different order)
3840            int tempIncreasedDimensionIndex = -1;
3841            for (int d = 0; d < tempRgn->Dimensions; ++d) {
3842                if (tempRgn->pDimensionDefinitions[d].dimension == type) {
3843                    tempIncreasedDimensionIndex = d;
3844                    break;
3845                }
3846            }
3847    
3848            // copy dimension regions from this region to the temporary region
3849            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3850                DimensionRegion* srcDimRgn = pDimensionRegions[iSrc];
3851                if (!srcDimRgn) continue;
3852                std::map<dimension_t,int> dimCase;
3853                bool isValidZone = true;
3854                for (int d = 0, baseBits = 0; d < Dimensions; ++d) {
3855                    const int srcBits = pDimensionDefinitions[d].bits;
3856                    dimCase[pDimensionDefinitions[d].dimension] =
3857                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3858                    // there are also DimensionRegion objects for unused zones, skip them
3859                    if (dimCase[pDimensionDefinitions[d].dimension] >= pDimensionDefinitions[d].zones) {
3860                        isValidZone = false;
3861                        break;
3862                    }
3863                    baseBits += srcBits;
3864                }
3865                if (!isValidZone) continue;
3866                // a bit paranoid: cope with the chance that the dimensions would
3867                // have different order in source and destination regions            
3868                if (dimCase[type] > zone) dimCase[type]++;
3869                DimensionRegion* dstDimRgn = tempRgn->GetDimensionRegionByBit(dimCase);
3870                dstDimRgn->CopyAssign(srcDimRgn);
3871                // if this is the requested zone to be splitted, then also copy
3872                // the source DimensionRegion to the newly created target zone
3873                // and set the old zones upper limit lower
3874                if (dimCase[type] == zone) {
3875                    // lower old zones upper limit
3876                    if (newDef.split_type == split_type_normal) {
3877                        const int high =
3878                            dstDimRgn->DimensionUpperLimits[tempIncreasedDimensionIndex];
3879                        int low = 0;
3880                        if (zone > 0) {
3881                            std::map<dimension_t,int> lowerCase = dimCase;
3882                            lowerCase[type]--;
3883                            DimensionRegion* dstDimRgnLow = tempRgn->GetDimensionRegionByBit(lowerCase);
3884                            low = dstDimRgnLow->DimensionUpperLimits[tempIncreasedDimensionIndex];
3885                        }
3886                        dstDimRgn->DimensionUpperLimits[tempIncreasedDimensionIndex] = low + (high - low) / 2;
3887                    }
3888                    // fill the newly created zone of the divided zone as well
3889                    dimCase[type]++;
3890                    dstDimRgn = tempRgn->GetDimensionRegionByBit(dimCase);
3891                    dstDimRgn->CopyAssign(srcDimRgn);
3892                }
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      
3899            DeleteDimension(oldDef);
3900            AddDimension(&newDef);
3901            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3902                DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
3903                if (!srcDimRgn) continue;
3904                std::map<dimension_t,int> dimCase;
3905                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3906                    const int srcBits = tempRgn->pDimensionDefinitions[d].bits;
3907                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3908                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3909                    baseBits += srcBits;
3910                }
3911                // a bit paranoid: cope with the chance that the dimensions would
3912                // have different order in source and destination regions
3913                DimensionRegion* dstDimRgn = GetDimensionRegionByBit(dimCase);
3914                if (!dstDimRgn) continue;
3915                dstDimRgn->CopyAssign(srcDimRgn);
3916            }
3917    
3918            // delete temporary region
3919            delete tempRgn;
3920    
3921            UpdateVelocityTable();
3922        }
3923    
3924        /** @brief Change type of an existing dimension.
3925         *
3926         * Alters the dimension type of a dimension already existing on this
3927         * region. If there is currently no dimension on this Region with type
3928         * @a oldType, then this call with throw an Exception. Likewise there are
3929         * cases where the requested dimension type cannot be performed. For example
3930         * if the new dimension type shall be gig::dimension_samplechannel, and the
3931         * current dimension has more than 2 zones. In such cases an Exception is
3932         * thrown as well.
3933         *
3934         * @param oldType - identifies the existing dimension to be changed
3935         * @param newType - to which dimension type it should be changed to
3936         * @throws gig::Exception if requested change cannot be performed
3937         */
3938        void Region::SetDimensionType(dimension_t oldType, dimension_t newType) {
3939            if (oldType == newType) return;
3940            dimension_def_t* def = GetDimensionDefinition(oldType);
3941            if (!def)
3942                throw gig::Exception("No dimension with provided old dimension type exists on this region");
3943            if (newType == dimension_samplechannel && def->zones != 2)
3944                throw gig::Exception("Cannot change to dimension type 'sample channel', because existing dimension does not have 2 zones");
3945            if (GetDimensionDefinition(newType))
3946                throw gig::Exception("There is already a dimension with requested new dimension type on this region");
3947            def->dimension  = newType;
3948            def->split_type = __resolveSplitType(newType);
3949        }
3950    
3951        DimensionRegion* Region::GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase) {
3952            uint8_t bits[8] = {};
3953            for (std::map<dimension_t,int>::const_iterator it = DimCase.begin();
3954                 it != DimCase.end(); ++it)
3955            {
3956                for (int d = 0; d < Dimensions; ++d) {
3957                    if (pDimensionDefinitions[d].dimension == it->first) {
3958                        bits[d] = it->second;
3959                        goto nextDimCaseSlice;
3960                    }
3961                }
3962                assert(false); // do crash ... too harsh maybe ? ignore it instead ?
3963                nextDimCaseSlice:
3964                ; // noop
3965            }
3966            return GetDimensionRegionByBit(bits);
3967        }
3968    
3969        /**
3970         * Searches in the current Region for a dimension of the given dimension
3971         * type and returns the precise configuration of that dimension in this
3972         * Region.
3973         *
3974         * @param type - dimension type of the sought dimension
3975         * @returns dimension definition or NULL if there is no dimension with
3976         *          sought type in this Region.
3977         */
3978        dimension_def_t* Region::GetDimensionDefinition(dimension_t type) {
3979            for (int i = 0; i < Dimensions; ++i)
3980                if (pDimensionDefinitions[i].dimension == type)
3981                    return &pDimensionDefinitions[i];
3982            return NULL;
3983        }
3984    
3985      Region::~Region() {      Region::~Region() {
3986          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
3987              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
# Line 2545  namespace { Line 4009  namespace {
4009      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
4010          uint8_t bits;          uint8_t bits;
4011          int veldim = -1;          int veldim = -1;
4012          int velbitpos;          int velbitpos = 0;
4013          int bitpos = 0;          int bitpos = 0;
4014          int dimregidx = 0;          int dimregidx = 0;
4015          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
# Line 2575  namespace { Line 4039  namespace {
4039              }              }
4040              bitpos += pDimensionDefinitions[i].bits;              bitpos += pDimensionDefinitions[i].bits;
4041          }          }
4042          DimensionRegion* dimreg = pDimensionRegions[dimregidx];          DimensionRegion* dimreg = pDimensionRegions[dimregidx & 255];
4043            if (!dimreg) return NULL;
4044          if (veldim != -1) {          if (veldim != -1) {
4045              // (dimreg is now the dimension region for the lowest velocity)              // (dimreg is now the dimension region for the lowest velocity)
4046              if (dimreg->VelocityTable) // custom defined zone ranges              if (dimreg->VelocityTable) // custom defined zone ranges
4047                  bits = dimreg->VelocityTable[DimValues[veldim]];                  bits = dimreg->VelocityTable[DimValues[veldim] & 127];
4048              else // normal split type              else // normal split type
4049                  bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);                  bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
4050    
4051              dimregidx |= bits << velbitpos;              const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
4052              dimreg = pDimensionRegions[dimregidx];              dimregidx |= (bits & limiter_mask) << velbitpos;
4053                dimreg = pDimensionRegions[dimregidx & 255];
4054          }          }
4055          return dimreg;          return dimreg;
4056      }      }
4057    
4058        int Region::GetDimensionRegionIndexByValue(const uint DimValues[8]) {
4059            uint8_t bits;
4060            int veldim = -1;
4061            int velbitpos = 0;
4062            int bitpos = 0;
4063            int dimregidx = 0;
4064            for (uint i = 0; i < Dimensions; i++) {
4065                if (pDimensionDefinitions[i].dimension == dimension_velocity) {
4066                    // the velocity dimension must be handled after the other dimensions
4067                    veldim = i;
4068                    velbitpos = bitpos;
4069                } else {
4070                    switch (pDimensionDefinitions[i].split_type) {
4071                        case split_type_normal:
4072                            if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
4073                                // gig3: all normal dimensions (not just the velocity dimension) have custom zone ranges
4074                                for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
4075                                    if (DimValues[i] <= pDimensionRegions[bits << bitpos]->DimensionUpperLimits[i]) break;
4076                                }
4077                            } else {
4078                                // gig2: evenly sized zones
4079                                bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
4080                            }
4081                            break;
4082                        case split_type_bit: // the value is already the sought dimension bit number
4083                            const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
4084                            bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
4085                            break;
4086                    }
4087                    dimregidx |= bits << bitpos;
4088                }
4089                bitpos += pDimensionDefinitions[i].bits;
4090            }
4091            dimregidx &= 255;
4092            DimensionRegion* dimreg = pDimensionRegions[dimregidx];
4093            if (!dimreg) return -1;
4094            if (veldim != -1) {
4095                // (dimreg is now the dimension region for the lowest velocity)
4096                if (dimreg->VelocityTable) // custom defined zone ranges
4097                    bits = dimreg->VelocityTable[DimValues[veldim] & 127];
4098                else // normal split type
4099                    bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
4100    
4101                const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
4102                dimregidx |= (bits & limiter_mask) << velbitpos;
4103                dimregidx &= 255;
4104            }
4105            return dimregidx;
4106        }
4107    
4108      /**      /**
4109       * Returns the appropriate DimensionRegion for the given dimension bit       * Returns the appropriate DimensionRegion for the given dimension bit
4110       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>
# Line 2627  namespace { Line 4143  namespace {
4143          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
4144          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
4145          if (!file->pWavePoolTable) return NULL;          if (!file->pWavePoolTable) return NULL;
4146          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          if (WavePoolTableIndex + 1 > file->WavePoolCount) return NULL;
4147          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];          // for new files or files >= 2 GB use 64 bit wave pool offsets
4148          Sample* sample = file->GetFirstSample(pProgress);          if (file->pRIFF->IsNew() || (file->pRIFF->GetCurrentFileSize() >> 31)) {
4149          while (sample) {              // use 64 bit wave pool offsets (treating this as large file)
4150              if (sample->ulWavePoolOffset == soughtoffset &&              uint64_t soughtoffset =
4151                  sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);                  uint64_t(file->pWavePoolTable[WavePoolTableIndex]) |
4152              sample = file->GetNextSample();                  uint64_t(file->pWavePoolTableHi[WavePoolTableIndex]) << 32;
4153                Sample* sample = file->GetFirstSample(pProgress);
4154                while (sample) {
4155                    if (sample->ullWavePoolOffset == soughtoffset)
4156                        return static_cast<gig::Sample*>(sample);
4157                    sample = file->GetNextSample();
4158                }
4159            } else {
4160                // use extension files and 32 bit wave pool offsets
4161                file_offset_t soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
4162                file_offset_t soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
4163                Sample* sample = file->GetFirstSample(pProgress);
4164                while (sample) {
4165                    if (sample->ullWavePoolOffset == soughtoffset &&
4166                        sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
4167                    sample = file->GetNextSample();
4168                }
4169            }
4170            return NULL;
4171        }
4172        
4173        /**
4174         * Make a (semi) deep copy of the Region object given by @a orig
4175         * and assign it to this object.
4176         *
4177         * Note that all sample pointers referenced by @a orig are simply copied as
4178         * memory address. Thus the respective samples are shared, not duplicated!
4179         *
4180         * @param orig - original Region object to be copied from
4181         */
4182        void Region::CopyAssign(const Region* orig) {
4183            CopyAssign(orig, NULL);
4184        }
4185        
4186        /**
4187         * Make a (semi) deep copy of the Region object given by @a orig and
4188         * assign it to this object
4189         *
4190         * @param mSamples - crosslink map between the foreign file's samples and
4191         *                   this file's samples
4192         */
4193        void Region::CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples) {
4194            // handle base classes
4195            DLS::Region::CopyAssign(orig);
4196            
4197            if (mSamples && mSamples->count((gig::Sample*)orig->pSample)) {
4198                pSample = mSamples->find((gig::Sample*)orig->pSample)->second;
4199            }
4200            
4201            // handle own member variables
4202            for (int i = Dimensions - 1; i >= 0; --i) {
4203                DeleteDimension(&pDimensionDefinitions[i]);
4204            }
4205            Layers = 0; // just to be sure
4206            for (int i = 0; i < orig->Dimensions; i++) {
4207                // we need to copy the dim definition here, to avoid the compiler
4208                // complaining about const-ness issue
4209                dimension_def_t def = orig->pDimensionDefinitions[i];
4210                AddDimension(&def);
4211            }
4212            for (int i = 0; i < 256; i++) {
4213                if (pDimensionRegions[i] && orig->pDimensionRegions[i]) {
4214                    pDimensionRegions[i]->CopyAssign(
4215                        orig->pDimensionRegions[i],
4216                        mSamples
4217                    );
4218                }
4219            }
4220            Layers = orig->Layers;
4221        }
4222    
4223    
4224    // *************** MidiRule ***************
4225    // *
4226    
4227        MidiRuleCtrlTrigger::MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg) {
4228            _3ewg->SetPos(36);
4229            Triggers = _3ewg->ReadUint8();
4230            _3ewg->SetPos(40);
4231            ControllerNumber = _3ewg->ReadUint8();
4232            _3ewg->SetPos(46);
4233            for (int i = 0 ; i < Triggers ; i++) {
4234                pTriggers[i].TriggerPoint = _3ewg->ReadUint8();
4235                pTriggers[i].Descending = _3ewg->ReadUint8();
4236                pTriggers[i].VelSensitivity = _3ewg->ReadUint8();
4237                pTriggers[i].Key = _3ewg->ReadUint8();
4238                pTriggers[i].NoteOff = _3ewg->ReadUint8();
4239                pTriggers[i].Velocity = _3ewg->ReadUint8();
4240                pTriggers[i].OverridePedal = _3ewg->ReadUint8();
4241                _3ewg->ReadUint8();
4242            }
4243        }
4244    
4245        MidiRuleCtrlTrigger::MidiRuleCtrlTrigger() :
4246            ControllerNumber(0),
4247            Triggers(0) {
4248        }
4249    
4250        void MidiRuleCtrlTrigger::UpdateChunks(uint8_t* pData) const {
4251            pData[32] = 4;
4252            pData[33] = 16;
4253            pData[36] = Triggers;
4254            pData[40] = ControllerNumber;
4255            for (int i = 0 ; i < Triggers ; i++) {
4256                pData[46 + i * 8] = pTriggers[i].TriggerPoint;
4257                pData[47 + i * 8] = pTriggers[i].Descending;
4258                pData[48 + i * 8] = pTriggers[i].VelSensitivity;
4259                pData[49 + i * 8] = pTriggers[i].Key;
4260                pData[50 + i * 8] = pTriggers[i].NoteOff;
4261                pData[51 + i * 8] = pTriggers[i].Velocity;
4262                pData[52 + i * 8] = pTriggers[i].OverridePedal;
4263            }
4264        }
4265    
4266        MidiRuleLegato::MidiRuleLegato(RIFF::Chunk* _3ewg) {
4267            _3ewg->SetPos(36);
4268            LegatoSamples = _3ewg->ReadUint8(); // always 12
4269            _3ewg->SetPos(40);
4270            BypassUseController = _3ewg->ReadUint8();
4271            BypassKey = _3ewg->ReadUint8();
4272            BypassController = _3ewg->ReadUint8();
4273            ThresholdTime = _3ewg->ReadUint16();
4274            _3ewg->ReadInt16();
4275            ReleaseTime = _3ewg->ReadUint16();
4276            _3ewg->ReadInt16();
4277            KeyRange.low = _3ewg->ReadUint8();
4278            KeyRange.high = _3ewg->ReadUint8();
4279            _3ewg->SetPos(64);
4280            ReleaseTriggerKey = _3ewg->ReadUint8();
4281            AltSustain1Key = _3ewg->ReadUint8();
4282            AltSustain2Key = _3ewg->ReadUint8();
4283        }
4284    
4285        MidiRuleLegato::MidiRuleLegato() :
4286            LegatoSamples(12),
4287            BypassUseController(false),
4288            BypassKey(0),
4289            BypassController(1),
4290            ThresholdTime(20),
4291            ReleaseTime(20),
4292            ReleaseTriggerKey(0),
4293            AltSustain1Key(0),
4294            AltSustain2Key(0)
4295        {
4296            KeyRange.low = KeyRange.high = 0;
4297        }
4298    
4299        void MidiRuleLegato::UpdateChunks(uint8_t* pData) const {
4300            pData[32] = 0;
4301            pData[33] = 16;
4302            pData[36] = LegatoSamples;
4303            pData[40] = BypassUseController;
4304            pData[41] = BypassKey;
4305            pData[42] = BypassController;
4306            store16(&pData[43], ThresholdTime);
4307            store16(&pData[47], ReleaseTime);
4308            pData[51] = KeyRange.low;
4309            pData[52] = KeyRange.high;
4310            pData[64] = ReleaseTriggerKey;
4311            pData[65] = AltSustain1Key;
4312            pData[66] = AltSustain2Key;
4313        }
4314    
4315        MidiRuleAlternator::MidiRuleAlternator(RIFF::Chunk* _3ewg) {
4316            _3ewg->SetPos(36);
4317            Articulations = _3ewg->ReadUint8();
4318            int flags = _3ewg->ReadUint8();
4319            Polyphonic = flags & 8;
4320            Chained = flags & 4;
4321            Selector = (flags & 2) ? selector_controller :
4322                (flags & 1) ? selector_key_switch : selector_none;
4323            Patterns = _3ewg->ReadUint8();
4324            _3ewg->ReadUint8(); // chosen row
4325            _3ewg->ReadUint8(); // unknown
4326            _3ewg->ReadUint8(); // unknown
4327            _3ewg->ReadUint8(); // unknown
4328            KeySwitchRange.low = _3ewg->ReadUint8();
4329            KeySwitchRange.high = _3ewg->ReadUint8();
4330            Controller = _3ewg->ReadUint8();
4331            PlayRange.low = _3ewg->ReadUint8();
4332            PlayRange.high = _3ewg->ReadUint8();
4333    
4334            int n = std::min(int(Articulations), 32);
4335            for (int i = 0 ; i < n ; i++) {
4336                _3ewg->ReadString(pArticulations[i], 32);
4337            }
4338            _3ewg->SetPos(1072);
4339            n = std::min(int(Patterns), 32);
4340            for (int i = 0 ; i < n ; i++) {
4341                _3ewg->ReadString(pPatterns[i].Name, 16);
4342                pPatterns[i].Size = _3ewg->ReadUint8();
4343                _3ewg->Read(&pPatterns[i][0], 1, 32);
4344            }
4345        }
4346    
4347        MidiRuleAlternator::MidiRuleAlternator() :
4348            Articulations(0),
4349            Patterns(0),
4350            Selector(selector_none),
4351            Controller(0),
4352            Polyphonic(false),
4353            Chained(false)
4354        {
4355            PlayRange.low = PlayRange.high = 0;
4356            KeySwitchRange.low = KeySwitchRange.high = 0;
4357        }
4358    
4359        void MidiRuleAlternator::UpdateChunks(uint8_t* pData) const {
4360            pData[32] = 3;
4361            pData[33] = 16;
4362            pData[36] = Articulations;
4363            pData[37] = (Polyphonic ? 8 : 0) | (Chained ? 4 : 0) |
4364                (Selector == selector_controller ? 2 :
4365                 (Selector == selector_key_switch ? 1 : 0));
4366            pData[38] = Patterns;
4367    
4368            pData[43] = KeySwitchRange.low;
4369            pData[44] = KeySwitchRange.high;
4370            pData[45] = Controller;
4371            pData[46] = PlayRange.low;
4372            pData[47] = PlayRange.high;
4373    
4374            char* str = reinterpret_cast<char*>(pData);
4375            int pos = 48;
4376            int n = std::min(int(Articulations), 32);
4377            for (int i = 0 ; i < n ; i++, pos += 32) {
4378                strncpy(&str[pos], pArticulations[i].c_str(), 32);
4379            }
4380    
4381            pos = 1072;
4382            n = std::min(int(Patterns), 32);
4383            for (int i = 0 ; i < n ; i++, pos += 49) {
4384                strncpy(&str[pos], pPatterns[i].Name.c_str(), 16);
4385                pData[pos + 16] = pPatterns[i].Size;
4386                memcpy(&pData[pos + 16], &(pPatterns[i][0]), 32);
4387            }
4388        }
4389    
4390    // *************** Script ***************
4391    // *
4392    
4393        Script::Script(ScriptGroup* group, RIFF::Chunk* ckScri) {
4394            pGroup = group;
4395            pChunk = ckScri;
4396            if (ckScri) { // object is loaded from file ...
4397                // read header
4398                uint32_t headerSize = ckScri->ReadUint32();
4399                Compression = (Compression_t) ckScri->ReadUint32();
4400                Encoding    = (Encoding_t) ckScri->ReadUint32();
4401                Language    = (Language_t) ckScri->ReadUint32();
4402                Bypass      = (Language_t) ckScri->ReadUint32() & 1;
4403                crc         = ckScri->ReadUint32();
4404                uint32_t nameSize = ckScri->ReadUint32();
4405                Name.resize(nameSize, ' ');
4406                for (int i = 0; i < nameSize; ++i)
4407                    Name[i] = ckScri->ReadUint8();
4408                // to handle potential future extensions of the header
4409                ckScri->SetPos(sizeof(int32_t) + headerSize);
4410                // read actual script data
4411                uint32_t scriptSize = uint32_t(ckScri->GetSize() - ckScri->GetPos());
4412                data.resize(scriptSize);
4413                for (int i = 0; i < scriptSize; ++i)
4414                    data[i] = ckScri->ReadUint8();
4415            } else { // this is a new script object, so just initialize it as such ...
4416                Compression = COMPRESSION_NONE;
4417                Encoding = ENCODING_ASCII;
4418                Language = LANGUAGE_NKSP;
4419                Bypass   = false;
4420                crc      = 0;
4421                Name     = "Unnamed Script";
4422            }
4423        }
4424    
4425        Script::~Script() {
4426        }
4427    
4428        /**
4429         * Returns the current script (i.e. as source code) in text format.
4430         */
4431        String Script::GetScriptAsText() {
4432            String s;
4433            s.resize(data.size(), ' ');
4434            memcpy(&s[0], &data[0], data.size());
4435            return s;
4436        }
4437    
4438        /**
4439         * Replaces the current script with the new script source code text given
4440         * by @a text.
4441         *
4442         * @param text - new script source code
4443         */
4444        void Script::SetScriptAsText(const String& text) {
4445            data.resize(text.size());
4446            memcpy(&data[0], &text[0], text.size());
4447        }
4448    
4449        /**
4450         * Apply this script to the respective RIFF chunks. You have to call
4451         * File::Save() to make changes persistent.
4452         *
4453         * Usually there is absolutely no need to call this method explicitly.
4454         * It will be called automatically when File::Save() was called.
4455         *
4456         * @param pProgress - callback function for progress notification
4457         */
4458        void Script::UpdateChunks(progress_t* pProgress) {
4459            // recalculate CRC32 check sum
4460            __resetCRC(crc);
4461            __calculateCRC(&data[0], data.size(), crc);
4462            __finalizeCRC(crc);
4463            // make sure chunk exists and has the required size
4464            const file_offset_t chunkSize = (file_offset_t) 7*sizeof(int32_t) + Name.size() + data.size();
4465            if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);
4466            else pChunk->Resize(chunkSize);
4467            // fill the chunk data to be written to disk
4468            uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();
4469            int pos = 0;
4470            store32(&pData[pos], uint32_t(6*sizeof(int32_t) + Name.size())); // total header size
4471            pos += sizeof(int32_t);
4472            store32(&pData[pos], Compression);
4473            pos += sizeof(int32_t);
4474            store32(&pData[pos], Encoding);
4475            pos += sizeof(int32_t);
4476            store32(&pData[pos], Language);
4477            pos += sizeof(int32_t);
4478            store32(&pData[pos], Bypass ? 1 : 0);
4479            pos += sizeof(int32_t);
4480            store32(&pData[pos], crc);
4481            pos += sizeof(int32_t);
4482            store32(&pData[pos], (uint32_t) Name.size());
4483            pos += sizeof(int32_t);
4484            for (int i = 0; i < Name.size(); ++i, ++pos)
4485                pData[pos] = Name[i];
4486            for (int i = 0; i < data.size(); ++i, ++pos)
4487                pData[pos] = data[i];
4488        }
4489    
4490        /**
4491         * Move this script from its current ScriptGroup to another ScriptGroup
4492         * given by @a pGroup.
4493         *
4494         * @param pGroup - script's new group
4495         */
4496        void Script::SetGroup(ScriptGroup* pGroup) {
4497            if (this->pGroup == pGroup) return;
4498            if (pChunk)
4499                pChunk->GetParent()->MoveSubChunk(pChunk, pGroup->pList);
4500            this->pGroup = pGroup;
4501        }
4502    
4503        /**
4504         * Returns the script group this script currently belongs to. Each script
4505         * is a member of exactly one ScriptGroup.
4506         *
4507         * @returns current script group
4508         */
4509        ScriptGroup* Script::GetGroup() const {
4510            return pGroup;
4511        }
4512    
4513        /**
4514         * Make a (semi) deep copy of the Script object given by @a orig
4515         * and assign it to this object. Note: the ScriptGroup this Script
4516         * object belongs to remains untouched by this call.
4517         *
4518         * @param orig - original Script object to be copied from
4519         */
4520        void Script::CopyAssign(const Script* orig) {
4521            Name        = orig->Name;
4522            Compression = orig->Compression;
4523            Encoding    = orig->Encoding;
4524            Language    = orig->Language;
4525            Bypass      = orig->Bypass;
4526            data        = orig->data;
4527        }
4528    
4529        void Script::RemoveAllScriptReferences() {
4530            File* pFile = pGroup->pFile;
4531            for (int i = 0; pFile->GetInstrument(i); ++i) {
4532                Instrument* instr = pFile->GetInstrument(i);
4533                instr->RemoveScript(this);
4534            }
4535        }
4536    
4537    // *************** ScriptGroup ***************
4538    // *
4539    
4540        ScriptGroup::ScriptGroup(File* file, RIFF::List* lstRTIS) {
4541            pFile = file;
4542            pList = lstRTIS;
4543            pScripts = NULL;
4544            if (lstRTIS) {
4545                RIFF::Chunk* ckName = lstRTIS->GetSubChunk(CHUNK_ID_LSNM);
4546                ::LoadString(ckName, Name);
4547            } else {
4548                Name = "Default Group";
4549            }
4550        }
4551    
4552        ScriptGroup::~ScriptGroup() {
4553            if (pScripts) {
4554                std::list<Script*>::iterator iter = pScripts->begin();
4555                std::list<Script*>::iterator end  = pScripts->end();
4556                while (iter != end) {
4557                    delete *iter;
4558                    ++iter;
4559                }
4560                delete pScripts;
4561            }
4562        }
4563    
4564        /**
4565         * Apply this script group to the respective RIFF chunks. You have to call
4566         * File::Save() to make changes persistent.
4567         *
4568         * Usually there is absolutely no need to call this method explicitly.
4569         * It will be called automatically when File::Save() was called.
4570         *
4571         * @param pProgress - callback function for progress notification
4572         */
4573        void ScriptGroup::UpdateChunks(progress_t* pProgress) {
4574            if (pScripts) {
4575                if (!pList)
4576                    pList = pFile->pRIFF->GetSubList(LIST_TYPE_3LS)->AddSubList(LIST_TYPE_RTIS);
4577    
4578                // now store the name of this group as <LSNM> chunk as subchunk of the <RTIS> list chunk
4579                ::SaveString(CHUNK_ID_LSNM, NULL, pList, Name, String("Unnamed Group"), true, 64);
4580    
4581                for (std::list<Script*>::iterator it = pScripts->begin();
4582                     it != pScripts->end(); ++it)
4583                {
4584                    (*it)->UpdateChunks(pProgress);
4585                }
4586          }          }
4587        }
4588    
4589        /** @brief Get instrument script.
4590         *
4591         * Returns the real-time instrument script with the given index.
4592         *
4593         * @param index - number of the sought script (0..n)
4594         * @returns sought script or NULL if there's no such script
4595         */
4596        Script* ScriptGroup::GetScript(uint index) {
4597            if (!pScripts) LoadScripts();
4598            std::list<Script*>::iterator it = pScripts->begin();
4599            for (uint i = 0; it != pScripts->end(); ++i, ++it)
4600                if (i == index) return *it;
4601          return NULL;          return NULL;
4602      }      }
4603    
4604        /** @brief Add new instrument script.
4605         *
4606         * Adds a new real-time instrument script to the file. The script is not
4607         * actually used / executed unless it is referenced by an instrument to be
4608         * used. This is similar to samples, which you can add to a file, without
4609         * an instrument necessarily actually using it.
4610         *
4611         * You have to call Save() to make this persistent to the file.
4612         *
4613         * @return new empty script object
4614         */
4615        Script* ScriptGroup::AddScript() {
4616            if (!pScripts) LoadScripts();
4617            Script* pScript = new Script(this, NULL);
4618            pScripts->push_back(pScript);
4619            return pScript;
4620        }
4621    
4622        /** @brief Delete an instrument script.
4623         *
4624         * This will delete the given real-time instrument script. References of
4625         * instruments that are using that script will be removed accordingly.
4626         *
4627         * You have to call Save() to make this persistent to the file.
4628         *
4629         * @param pScript - script to delete
4630         * @throws gig::Exception if given script could not be found
4631         */
4632        void ScriptGroup::DeleteScript(Script* pScript) {
4633            if (!pScripts) LoadScripts();
4634            std::list<Script*>::iterator iter =
4635                find(pScripts->begin(), pScripts->end(), pScript);
4636            if (iter == pScripts->end())
4637                throw gig::Exception("Could not delete script, could not find given script");
4638            pScripts->erase(iter);
4639            pScript->RemoveAllScriptReferences();
4640            if (pScript->pChunk)
4641                pScript->pChunk->GetParent()->DeleteSubChunk(pScript->pChunk);
4642            delete pScript;
4643        }
4644    
4645        void ScriptGroup::LoadScripts() {
4646            if (pScripts) return;
4647            pScripts = new std::list<Script*>;
4648            if (!pList) return;
4649    
4650            for (RIFF::Chunk* ck = pList->GetFirstSubChunk(); ck;
4651                 ck = pList->GetNextSubChunk())
4652            {
4653                if (ck->GetChunkID() == CHUNK_ID_SCRI) {
4654                    pScripts->push_back(new Script(this, ck));
4655                }
4656            }
4657        }
4658    
4659  // *************** Instrument ***************  // *************** Instrument ***************
4660  // *  // *
4661    
4662      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) {
4663          static const DLS::Info::FixedStringLength fixedStringLengths[] = {          static const DLS::Info::string_length_t fixedStringLengths[] = {
4664              { CHUNK_ID_INAM, 64 },              { CHUNK_ID_INAM, 64 },
4665              { CHUNK_ID_ISFT, 12 },              { CHUNK_ID_ISFT, 12 },
4666              { 0, 0 }              { 0, 0 }
4667          };          };
4668          pInfo->FixedStringLengths = fixedStringLengths;          pInfo->SetFixedStringLengths(fixedStringLengths);
4669    
4670          // Initialization          // Initialization
4671          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
4672          EffectSend = 0;          EffectSend = 0;
4673          Attenuation = 0;          Attenuation = 0;
4674          FineTune = 0;          FineTune = 0;
4675          PitchbendRange = 0;          PitchbendRange = 2;
4676          PianoReleaseMode = false;          PianoReleaseMode = false;
4677          DimensionKeyRange.low = 0;          DimensionKeyRange.low = 0;
4678          DimensionKeyRange.high = 0;          DimensionKeyRange.high = 0;
4679            pMidiRules = new MidiRule*[3];
4680            pMidiRules[0] = NULL;
4681            pScriptRefs = NULL;
4682    
4683          // Loading          // Loading
4684          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
# Line 2674  namespace { Line 4693  namespace {
4693                  PianoReleaseMode       = dimkeystart & 0x01;                  PianoReleaseMode       = dimkeystart & 0x01;
4694                  DimensionKeyRange.low  = dimkeystart >> 1;                  DimensionKeyRange.low  = dimkeystart >> 1;
4695                  DimensionKeyRange.high = _3ewg->ReadUint8();                  DimensionKeyRange.high = _3ewg->ReadUint8();
4696    
4697                    if (_3ewg->GetSize() > 32) {
4698                        // read MIDI rules
4699                        int i = 0;
4700                        _3ewg->SetPos(32);
4701                        uint8_t id1 = _3ewg->ReadUint8();
4702                        uint8_t id2 = _3ewg->ReadUint8();
4703    
4704                        if (id2 == 16) {
4705                            if (id1 == 4) {
4706                                pMidiRules[i++] = new MidiRuleCtrlTrigger(_3ewg);
4707                            } else if (id1 == 0) {
4708                                pMidiRules[i++] = new MidiRuleLegato(_3ewg);
4709                            } else if (id1 == 3) {
4710                                pMidiRules[i++] = new MidiRuleAlternator(_3ewg);
4711                            } else {
4712                                pMidiRules[i++] = new MidiRuleUnknown;
4713                            }
4714                        }
4715                        else if (id1 != 0 || id2 != 0) {
4716                            pMidiRules[i++] = new MidiRuleUnknown;
4717                        }
4718                        //TODO: all the other types of rules
4719    
4720                        pMidiRules[i] = NULL;
4721                    }
4722              }              }
4723          }          }
4724    
4725          if (!pRegions) pRegions = new RegionList;          if (pFile->GetAutoLoad()) {
4726          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);              if (!pRegions) pRegions = new RegionList;
4727          if (lrgn) {              RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
4728              RIFF::List* rgn = lrgn->GetFirstSubList();              if (lrgn) {
4729              while (rgn) {                  RIFF::List* rgn = lrgn->GetFirstSubList();
4730                  if (rgn->GetListType() == LIST_TYPE_RGN) {                  while (rgn) {
4731                      __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);                      if (rgn->GetListType() == LIST_TYPE_RGN) {
4732                      pRegions->push_back(new Region(this, rgn));                          __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
4733                            pRegions->push_back(new Region(this, rgn));
4734                        }
4735                        rgn = lrgn->GetNextSubList();
4736                    }
4737                    // Creating Region Key Table for fast lookup
4738                    UpdateRegionKeyTable();
4739                }
4740            }
4741    
4742            // own gig format extensions
4743            RIFF::List* lst3LS = insList->GetSubList(LIST_TYPE_3LS);
4744            if (lst3LS) {
4745                RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4746                if (ckSCSL) {
4747                    int headerSize = ckSCSL->ReadUint32();
4748                    int slotCount  = ckSCSL->ReadUint32();
4749                    if (slotCount) {
4750                        int slotSize  = ckSCSL->ReadUint32();
4751                        ckSCSL->SetPos(headerSize); // in case of future header extensions
4752                        int unknownSpace = slotSize - 2*sizeof(uint32_t); // in case of future slot extensions
4753                        for (int i = 0; i < slotCount; ++i) {
4754                            _ScriptPooolEntry e;
4755                            e.fileOffset = ckSCSL->ReadUint32();
4756                            e.bypass     = ckSCSL->ReadUint32() & 1;
4757                            if (unknownSpace) ckSCSL->SetPos(unknownSpace, RIFF::stream_curpos); // in case of future extensions
4758                            scriptPoolFileOffsets.push_back(e);
4759                        }
4760                  }                  }
                 rgn = lrgn->GetNextSubList();  
4761              }              }
             // Creating Region Key Table for fast lookup  
             UpdateRegionKeyTable();  
4762          }          }
4763    
4764          __notify_progress(pProgress, 1.0f); // notify done          __notify_progress(pProgress, 1.0f); // notify done
4765      }      }
4766    
4767      void Instrument::UpdateRegionKeyTable() {      void Instrument::UpdateRegionKeyTable() {
4768            for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
4769          RegionList::iterator iter = pRegions->begin();          RegionList::iterator iter = pRegions->begin();
4770          RegionList::iterator end  = pRegions->end();          RegionList::iterator end  = pRegions->end();
4771          for (; iter != end; ++iter) {          for (; iter != end; ++iter) {
4772              gig::Region* pRegion = static_cast<gig::Region*>(*iter);              gig::Region* pRegion = static_cast<gig::Region*>(*iter);
4773              for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {              const int low  = std::max(int(pRegion->KeyRange.low), 0);
4774                const int high = std::min(int(pRegion->KeyRange.high), 127);
4775                for (int iKey = low; iKey <= high; iKey++) {
4776                  RegionKeyTable[iKey] = pRegion;                  RegionKeyTable[iKey] = pRegion;
4777              }              }
4778          }          }
4779      }      }
4780    
4781      Instrument::~Instrument() {      Instrument::~Instrument() {
4782            for (int i = 0 ; pMidiRules[i] ; i++) {
4783                delete pMidiRules[i];
4784            }
4785            delete[] pMidiRules;
4786            if (pScriptRefs) delete pScriptRefs;
4787      }      }
4788    
4789      /**      /**
# Line 2716  namespace { Line 4793  namespace {
4793       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
4794       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
4795       *       *
4796         * @param pProgress - callback function for progress notification
4797       * @throws gig::Exception if samples cannot be dereferenced       * @throws gig::Exception if samples cannot be dereferenced
4798       */       */
4799      void Instrument::UpdateChunks() {      void Instrument::UpdateChunks(progress_t* pProgress) {
4800          // first update base classes' chunks          // first update base classes' chunks
4801          DLS::Instrument::UpdateChunks();          DLS::Instrument::UpdateChunks(pProgress);
4802    
4803          // update Regions' chunks          // update Regions' chunks
4804          {          {
4805              RegionList::iterator iter = pRegions->begin();              RegionList::iterator iter = pRegions->begin();
4806              RegionList::iterator end  = pRegions->end();              RegionList::iterator end  = pRegions->end();
4807              for (; iter != end; ++iter)              for (; iter != end; ++iter)
4808                  (*iter)->UpdateChunks();                  (*iter)->UpdateChunks(pProgress);
4809          }          }
4810    
4811          // make sure 'lart' RIFF list chunk exists          // make sure 'lart' RIFF list chunk exists
# Line 2735  namespace { Line 4813  namespace {
4813          if (!lart)  lart = pCkInstrument->AddSubList(LIST_TYPE_LART);          if (!lart)  lart = pCkInstrument->AddSubList(LIST_TYPE_LART);
4814          // make sure '3ewg' RIFF chunk exists          // make sure '3ewg' RIFF chunk exists
4815          RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);          RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
4816          if (!_3ewg)  _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, 12);          if (!_3ewg)  {
4817                File* pFile = (File*) GetParent();
4818    
4819                // 3ewg is bigger in gig3, as it includes the iMIDI rules
4820                int size = (pFile->pVersion && pFile->pVersion->major == 3) ? 16416 : 12;
4821                _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);
4822                memset(_3ewg->LoadChunkData(), 0, size);
4823            }
4824          // update '3ewg' RIFF chunk          // update '3ewg' RIFF chunk
4825          uint8_t* pData = (uint8_t*) _3ewg->LoadChunkData();          uint8_t* pData = (uint8_t*) _3ewg->LoadChunkData();
4826          store16(&pData[0], EffectSend);          store16(&pData[0], EffectSend);
4827          store32(&pData[2], Attenuation);          store32(&pData[2], Attenuation);
4828          store16(&pData[6], FineTune);          store16(&pData[6], FineTune);
4829          store16(&pData[8], PitchbendRange);          store16(&pData[8], PitchbendRange);
4830          const uint8_t dimkeystart = (PianoReleaseMode) ? 0x01 : 0x00 |          const uint8_t dimkeystart = (PianoReleaseMode ? 0x01 : 0x00) |
4831                                      DimensionKeyRange.low << 1;                                      DimensionKeyRange.low << 1;
4832          pData[10] = dimkeystart;          pData[10] = dimkeystart;
4833          pData[11] = DimensionKeyRange.high;          pData[11] = DimensionKeyRange.high;
4834    
4835            if (pMidiRules[0] == 0 && _3ewg->GetSize() >= 34) {
4836                pData[32] = 0;
4837                pData[33] = 0;
4838            } else {
4839                for (int i = 0 ; pMidiRules[i] ; i++) {
4840                    pMidiRules[i]->UpdateChunks(pData);
4841                }
4842            }
4843    
4844            // own gig format extensions
4845           if (ScriptSlotCount()) {
4846               // make sure we have converted the original loaded script file
4847               // offsets into valid Script object pointers
4848               LoadScripts();
4849    
4850               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4851               if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);
4852               const int slotCount = (int) pScriptRefs->size();
4853               const int headerSize = 3 * sizeof(uint32_t);
4854               const int slotSize  = 2 * sizeof(uint32_t);
4855               const int totalChunkSize = headerSize + slotCount * slotSize;
4856               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4857               if (!ckSCSL) ckSCSL = lst3LS->AddSubChunk(CHUNK_ID_SCSL, totalChunkSize);
4858               else ckSCSL->Resize(totalChunkSize);
4859               uint8_t* pData = (uint8_t*) ckSCSL->LoadChunkData();
4860               int pos = 0;
4861               store32(&pData[pos], headerSize);
4862               pos += sizeof(uint32_t);
4863               store32(&pData[pos], slotCount);
4864               pos += sizeof(uint32_t);
4865               store32(&pData[pos], slotSize);
4866               pos += sizeof(uint32_t);
4867               for (int i = 0; i < slotCount; ++i) {
4868                   // arbitrary value, the actual file offset will be updated in
4869                   // UpdateScriptFileOffsets() after the file has been resized
4870                   int bogusFileOffset = 0;
4871                   store32(&pData[pos], bogusFileOffset);
4872                   pos += sizeof(uint32_t);
4873                   store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0);
4874                   pos += sizeof(uint32_t);
4875               }
4876           } else {
4877               // no script slots, so get rid of any LS custom RIFF chunks (if any)
4878               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4879               if (lst3LS) pCkInstrument->DeleteSubChunk(lst3LS);
4880           }
4881        }
4882    
4883        void Instrument::UpdateScriptFileOffsets() {
4884           // own gig format extensions
4885           if (pScriptRefs && pScriptRefs->size() > 0) {
4886               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4887               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4888               const int slotCount = (int) pScriptRefs->size();
4889               const int headerSize = 3 * sizeof(uint32_t);
4890               ckSCSL->SetPos(headerSize);
4891               for (int i = 0; i < slotCount; ++i) {
4892                   uint32_t fileOffset = uint32_t(
4893                        (*pScriptRefs)[i].script->pChunk->GetFilePos() -
4894                        (*pScriptRefs)[i].script->pChunk->GetPos() -
4895                        CHUNK_HEADER_SIZE(ckSCSL->GetFile()->GetFileOffsetSize())
4896                   );
4897                   ckSCSL->WriteUint32(&fileOffset);
4898                   // jump over flags entry (containing the bypass flag)
4899                   ckSCSL->SetPos(sizeof(uint32_t), RIFF::stream_curpos);
4900               }
4901           }        
4902      }      }
4903    
4904      /**      /**
# Line 2756  namespace { Line 4909  namespace {
4909       *             there is no Region defined for the given \a Key       *             there is no Region defined for the given \a Key
4910       */       */
4911      Region* Instrument::GetRegion(unsigned int Key) {      Region* Instrument::GetRegion(unsigned int Key) {
4912          if (!pRegions || !pRegions->size() || Key > 127) return NULL;          if (!pRegions || pRegions->empty() || Key > 127) return NULL;
4913          return RegionKeyTable[Key];          return RegionKeyTable[Key];
4914    
4915          /*for (int i = 0; i < Regions; i++) {          /*for (int i = 0; i < Regions; i++) {
# Line 2800  namespace { Line 4953  namespace {
4953          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
4954          Region* pNewRegion = new Region(this, rgn);          Region* pNewRegion = new Region(this, rgn);
4955          pRegions->push_back(pNewRegion);          pRegions->push_back(pNewRegion);
4956          Regions = pRegions->size();          Regions = (uint32_t) pRegions->size();
4957          // update Region key table for fast lookup          // update Region key table for fast lookup
4958          UpdateRegionKeyTable();          UpdateRegionKeyTable();
4959          // done          // done
# Line 2814  namespace { Line 4967  namespace {
4967          UpdateRegionKeyTable();          UpdateRegionKeyTable();
4968      }      }
4969    
4970        /**
4971         * Move this instrument at the position before @arg dst.
4972         *
4973         * This method can be used to reorder the sequence of instruments in a
4974         * .gig file. This might be helpful especially on large .gig files which
4975         * contain a large number of instruments within the same .gig file. So
4976         * grouping such instruments to similar ones, can help to keep track of them
4977         * when working with such complex .gig files.
4978         *
4979         * When calling this method, this instrument will be removed from in its
4980         * current position in the instruments list and moved to the requested
4981         * target position provided by @param dst. You may also pass NULL as
4982         * argument to this method, in that case this intrument will be moved to the
4983         * very end of the .gig file's instrument list.
4984         *
4985         * You have to call Save() to make the order change persistent to the .gig
4986         * file.
4987         *
4988         * Currently this method is limited to moving the instrument within the same
4989         * .gig file. Trying to move it to another .gig file by calling this method
4990         * will throw an exception.
4991         *
4992         * @param dst - destination instrument at which this instrument will be
4993         *              moved to, or pass NULL for moving to end of list
4994         * @throw gig::Exception if this instrument and target instrument are not
4995         *                       part of the same file
4996         */
4997        void Instrument::MoveTo(Instrument* dst) {
4998            if (dst && GetParent() != dst->GetParent())
4999                throw Exception(
5000                    "gig::Instrument::MoveTo() can only be used for moving within "
5001                    "the same gig file."
5002                );
5003    
5004            File* pFile = (File*) GetParent();
5005    
5006            // move this instrument within the instrument list
5007            {
5008                File::InstrumentList& list = *pFile->pInstruments;
5009    
5010                File::InstrumentList::iterator itFrom =
5011                    std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(this));
5012    
5013                File::InstrumentList::iterator itTo =
5014                    std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(dst));
5015    
5016                list.splice(itTo, list, itFrom);
5017            }
5018    
5019            // move the instrument's actual list RIFF chunk appropriately
5020            RIFF::List* lstCkInstruments = pFile->pRIFF->GetSubList(LIST_TYPE_LINS);
5021            lstCkInstruments->MoveSubChunk(
5022                this->pCkInstrument,
5023                (RIFF::Chunk*) ((dst) ? dst->pCkInstrument : NULL)
5024            );
5025        }
5026    
5027        /**
5028         * Returns a MIDI rule of the instrument.
5029         *
5030         * The list of MIDI rules, at least in gig v3, always contains at
5031         * most two rules. The second rule can only be the DEF filter
5032         * (which currently isn't supported by libgig).
5033         *
5034         * @param i - MIDI rule number
5035         * @returns   pointer address to MIDI rule number i or NULL if there is none
5036         */
5037        MidiRule* Instrument::GetMidiRule(int i) {
5038            return pMidiRules[i];
5039        }
5040    
5041        /**
5042         * Adds the "controller trigger" MIDI rule to the instrument.
5043         *
5044         * @returns the new MIDI rule
5045         */
5046        MidiRuleCtrlTrigger* Instrument::AddMidiRuleCtrlTrigger() {
5047            delete pMidiRules[0];
5048            MidiRuleCtrlTrigger* r = new MidiRuleCtrlTrigger;
5049            pMidiRules[0] = r;
5050            pMidiRules[1] = 0;
5051            return r;
5052        }
5053    
5054        /**
5055         * Adds the legato MIDI rule to the instrument.
5056         *
5057         * @returns the new MIDI rule
5058         */
5059        MidiRuleLegato* Instrument::AddMidiRuleLegato() {
5060            delete pMidiRules[0];
5061            MidiRuleLegato* r = new MidiRuleLegato;
5062            pMidiRules[0] = r;
5063            pMidiRules[1] = 0;
5064            return r;
5065        }
5066    
5067        /**
5068         * Adds the alternator MIDI rule to the instrument.
5069         *
5070         * @returns the new MIDI rule
5071         */
5072        MidiRuleAlternator* Instrument::AddMidiRuleAlternator() {
5073            delete pMidiRules[0];
5074            MidiRuleAlternator* r = new MidiRuleAlternator;
5075            pMidiRules[0] = r;
5076            pMidiRules[1] = 0;
5077            return r;
5078        }
5079    
5080        /**
5081         * Deletes a MIDI rule from the instrument.
5082         *
5083         * @param i - MIDI rule number
5084         */
5085        void Instrument::DeleteMidiRule(int i) {
5086            delete pMidiRules[i];
5087            pMidiRules[i] = 0;
5088        }
5089    
5090        void Instrument::LoadScripts() {
5091            if (pScriptRefs) return;
5092            pScriptRefs = new std::vector<_ScriptPooolRef>;
5093            if (scriptPoolFileOffsets.empty()) return;
5094            File* pFile = (File*) GetParent();
5095            for (uint k = 0; k < scriptPoolFileOffsets.size(); ++k) {
5096                uint32_t soughtOffset = scriptPoolFileOffsets[k].fileOffset;
5097                for (uint i = 0; pFile->GetScriptGroup(i); ++i) {
5098                    ScriptGroup* group = pFile->GetScriptGroup(i);
5099                    for (uint s = 0; group->GetScript(s); ++s) {
5100                        Script* script = group->GetScript(s);
5101                        if (script->pChunk) {
5102                            uint32_t offset = uint32_t(
5103                                script->pChunk->GetFilePos() -
5104                                script->pChunk->GetPos() -
5105                                CHUNK_HEADER_SIZE(script->pChunk->GetFile()->GetFileOffsetSize())
5106                            );
5107                            if (offset == soughtOffset)
5108                            {
5109                                _ScriptPooolRef ref;
5110                                ref.script = script;
5111                                ref.bypass = scriptPoolFileOffsets[k].bypass;
5112                                pScriptRefs->push_back(ref);
5113                                break;
5114                            }
5115                        }
5116                    }
5117                }
5118            }
5119            // we don't need that anymore
5120            scriptPoolFileOffsets.clear();
5121        }
5122    
5123        /** @brief Get instrument script (gig format extension).
5124         *
5125         * Returns the real-time instrument script of instrument script slot
5126         * @a index.
5127         *
5128         * @note This is an own format extension which did not exist i.e. in the
5129         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5130         * gigedit.
5131         *
5132         * @param index - instrument script slot index
5133         * @returns script or NULL if index is out of bounds
5134         */
5135        Script* Instrument::GetScriptOfSlot(uint index) {
5136            LoadScripts();
5137            if (index >= pScriptRefs->size()) return NULL;
5138            return pScriptRefs->at(index).script;
5139        }
5140    
5141        /** @brief Add new instrument script slot (gig format extension).
5142         *
5143         * Add the given real-time instrument script reference to this instrument,
5144         * which shall be executed by the sampler for for this instrument. The
5145         * script will be added to the end of the script list of this instrument.
5146         * The positions of the scripts in the Instrument's Script list are
5147         * relevant, because they define in which order they shall be executed by
5148         * the sampler. For this reason it is also legal to add the same script
5149         * twice to an instrument, for example you might have a script called
5150         * "MyFilter" which performs an event filter task, and you might have
5151         * another script called "MyNoteTrigger" which triggers new notes, then you
5152         * might for example have the following list of scripts on the instrument:
5153         *
5154         * 1. Script "MyFilter"
5155         * 2. Script "MyNoteTrigger"
5156         * 3. Script "MyFilter"
5157         *
5158         * Which would make sense, because the 2nd script launched new events, which
5159         * you might need to filter as well.
5160         *
5161         * There are two ways to disable / "bypass" scripts. You can either disable
5162         * a script locally for the respective script slot on an instrument (i.e. by
5163         * passing @c false to the 2nd argument of this method, or by calling
5164         * SetScriptBypassed()). Or you can disable a script globally for all slots
5165         * and all instruments by setting Script::Bypass.
5166         *
5167         * @note This is an own format extension which did not exist i.e. in the
5168         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5169         * gigedit.
5170         *
5171         * @param pScript - script that shall be executed for this instrument
5172         * @param bypass  - if enabled, the sampler shall skip executing this
5173         *                  script (in the respective list position)
5174         * @see SetScriptBypassed()
5175         */
5176        void Instrument::AddScriptSlot(Script* pScript, bool bypass) {
5177            LoadScripts();
5178            _ScriptPooolRef ref = { pScript, bypass };
5179            pScriptRefs->push_back(ref);
5180        }
5181    
5182        /** @brief Flip two script slots with each other (gig format extension).
5183         *
5184         * Swaps the position of the two given scripts in the Instrument's Script
5185         * list. The positions of the scripts in the Instrument's Script list are
5186         * relevant, because they define in which order they shall be executed by
5187         * the sampler.
5188         *
5189         * @note This is an own format extension which did not exist i.e. in the
5190         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5191         * gigedit.
5192         *
5193         * @param index1 - index of the first script slot to swap
5194         * @param index2 - index of the second script slot to swap
5195         */
5196        void Instrument::SwapScriptSlots(uint index1, uint index2) {
5197            LoadScripts();
5198            if (index1 >= pScriptRefs->size() || index2 >= pScriptRefs->size())
5199                return;
5200            _ScriptPooolRef tmp = (*pScriptRefs)[index1];
5201            (*pScriptRefs)[index1] = (*pScriptRefs)[index2];
5202            (*pScriptRefs)[index2] = tmp;
5203        }
5204    
5205        /** @brief Remove script slot.
5206         *
5207         * Removes the script slot with the given slot index.
5208         *
5209         * @param index - index of script slot to remove
5210         */
5211        void Instrument::RemoveScriptSlot(uint index) {
5212            LoadScripts();
5213            if (index >= pScriptRefs->size()) return;
5214            pScriptRefs->erase( pScriptRefs->begin() + index );
5215        }
5216    
5217        /** @brief Remove reference to given Script (gig format extension).
5218         *
5219         * This will remove all script slots on the instrument which are referencing
5220         * the given script.
5221         *
5222         * @note This is an own format extension which did not exist i.e. in the
5223         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5224         * gigedit.
5225         *
5226         * @param pScript - script reference to remove from this instrument
5227         * @see RemoveScriptSlot()
5228         */
5229        void Instrument::RemoveScript(Script* pScript) {
5230            LoadScripts();
5231            for (ssize_t i = pScriptRefs->size() - 1; i >= 0; --i) {
5232                if ((*pScriptRefs)[i].script == pScript) {
5233                    pScriptRefs->erase( pScriptRefs->begin() + i );
5234                }
5235            }
5236        }
5237    
5238        /** @brief Instrument's amount of script slots.
5239         *
5240         * This method returns the amount of script slots this instrument currently
5241         * uses.
5242         *
5243         * A script slot is a reference of a real-time instrument script to be
5244         * executed by the sampler. The scripts will be executed by the sampler in
5245         * sequence of the slots. One (same) script may be referenced multiple
5246         * times in different slots.
5247         *
5248         * @note This is an own format extension which did not exist i.e. in the
5249         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5250         * gigedit.
5251         */
5252        uint Instrument::ScriptSlotCount() const {
5253            return uint(pScriptRefs ? pScriptRefs->size() : scriptPoolFileOffsets.size());
5254        }
5255    
5256        /** @brief Whether script execution shall be skipped.
5257         *
5258         * Defines locally for the Script reference slot in the Instrument's Script
5259         * list, whether the script shall be skipped by the sampler regarding
5260         * execution.
5261         *
5262         * It is also possible to ignore exeuction of the script globally, for all
5263         * slots and for all instruments by setting Script::Bypass.
5264         *
5265         * @note This is an own format extension which did not exist i.e. in the
5266         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5267         * gigedit.
5268         *
5269         * @param index - index of the script slot on this instrument
5270         * @see Script::Bypass
5271         */
5272        bool Instrument::IsScriptSlotBypassed(uint index) {
5273            if (index >= ScriptSlotCount()) return false;
5274            return pScriptRefs ? pScriptRefs->at(index).bypass
5275                               : scriptPoolFileOffsets.at(index).bypass;
5276            
5277        }
5278    
5279        /** @brief Defines whether execution shall be skipped.
5280         *
5281         * You can call this method to define locally whether or whether not the
5282         * given script slot shall be executed by the sampler.
5283         *
5284         * @note This is an own format extension which did not exist i.e. in the
5285         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5286         * gigedit.
5287         *
5288         * @param index - script slot index on this instrument
5289         * @param bBypass - if true, the script slot will be skipped by the sampler
5290         * @see Script::Bypass
5291         */
5292        void Instrument::SetScriptSlotBypassed(uint index, bool bBypass) {
5293            if (index >= ScriptSlotCount()) return;
5294            if (pScriptRefs)
5295                pScriptRefs->at(index).bypass = bBypass;
5296            else
5297                scriptPoolFileOffsets.at(index).bypass = bBypass;
5298        }
5299    
5300        /**
5301         * Make a (semi) deep copy of the Instrument object given by @a orig
5302         * and assign it to this object.
5303         *
5304         * Note that all sample pointers referenced by @a orig are simply copied as
5305         * memory address. Thus the respective samples are shared, not duplicated!
5306         *
5307         * @param orig - original Instrument object to be copied from
5308         */
5309        void Instrument::CopyAssign(const Instrument* orig) {
5310            CopyAssign(orig, NULL);
5311        }
5312            
5313        /**
5314         * Make a (semi) deep copy of the Instrument object given by @a orig
5315         * and assign it to this object.
5316         *
5317         * @param orig - original Instrument object to be copied from
5318         * @param mSamples - crosslink map between the foreign file's samples and
5319         *                   this file's samples
5320         */
5321        void Instrument::CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples) {
5322            // handle base class
5323            // (without copying DLS region stuff)
5324            DLS::Instrument::CopyAssignCore(orig);
5325            
5326            // handle own member variables
5327            Attenuation = orig->Attenuation;
5328            EffectSend = orig->EffectSend;
5329            FineTune = orig->FineTune;
5330            PitchbendRange = orig->PitchbendRange;
5331            PianoReleaseMode = orig->PianoReleaseMode;
5332            DimensionKeyRange = orig->DimensionKeyRange;
5333            scriptPoolFileOffsets = orig->scriptPoolFileOffsets;
5334            pScriptRefs = orig->pScriptRefs;
5335            
5336            // free old midi rules
5337            for (int i = 0 ; pMidiRules[i] ; i++) {
5338                delete pMidiRules[i];
5339            }
5340            //TODO: MIDI rule copying
5341            pMidiRules[0] = NULL;
5342            
5343            // delete all old regions
5344            while (Regions) DeleteRegion(GetFirstRegion());
5345            // create new regions and copy them from original
5346            {
5347                RegionList::const_iterator it = orig->pRegions->begin();
5348                for (int i = 0; i < orig->Regions; ++i, ++it) {
5349                    Region* dstRgn = AddRegion();
5350                    //NOTE: Region does semi-deep copy !
5351                    dstRgn->CopyAssign(
5352                        static_cast<gig::Region*>(*it),
5353                        mSamples
5354                    );
5355                }
5356            }
5357    
5358            UpdateRegionKeyTable();
5359        }
5360    
5361    
5362  // *************** Group ***************  // *************** Group ***************
# Line 2843  namespace { Line 5386  namespace {
5386       *       *
5387       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
5388       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
5389         *
5390         * @param pProgress - callback function for progress notification
5391       */       */
5392      void Group::UpdateChunks() {      void Group::UpdateChunks(progress_t* pProgress) {
5393          // make sure <3gri> and <3gnl> list chunks exist          // make sure <3gri> and <3gnl> list chunks exist
5394          RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);          RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);
5395          if (!_3gri) {          if (!_3gri) {
# Line 2853  namespace { Line 5398  namespace {
5398          }          }
5399          RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);          RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
5400          if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);          if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
5401    
5402            if (!pNameChunk && pFile->pVersion && pFile->pVersion->major == 3) {
5403                // v3 has a fixed list of 128 strings, find a free one
5404                for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {
5405                    if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {
5406                        pNameChunk = ck;
5407                        break;
5408                    }
5409                }
5410            }
5411    
5412          // 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
5413          ::SaveString(CHUNK_ID_3GNM, pNameChunk, _3gnl, Name, String("Unnamed Group"), true, 64);          ::SaveString(CHUNK_ID_3GNM, pNameChunk, _3gnl, Name, String("Unnamed Group"), true, 64);
5414      }      }
# Line 2928  namespace { Line 5484  namespace {
5484  // *************** File ***************  // *************** File ***************
5485  // *  // *
5486    
5487      // File version 2.0, 1998-06-28      /// Reflects Gigasampler file format version 2.0 (1998-06-28).
5488      const DLS::version_t File::VERSION_2 = {      const DLS::version_t File::VERSION_2 = {
5489          0, 2, 19980628 & 0xffff, 19980628 >> 16          0, 2, 19980628 & 0xffff, 19980628 >> 16
5490      };      };
5491    
5492      // File version 3.0, 2003-03-31      /// Reflects Gigasampler file format version 3.0 (2003-03-31).
5493      const DLS::version_t File::VERSION_3 = {      const DLS::version_t File::VERSION_3 = {
5494          0, 3, 20030331 & 0xffff, 20030331 >> 16          0, 3, 20030331 & 0xffff, 20030331 >> 16
5495      };      };
5496    
5497      const DLS::Info::FixedStringLength File::FixedStringLengths[] = {      static const DLS::Info::string_length_t _FileFixedStringLengths[] = {
5498          { CHUNK_ID_IARL, 256 },          { CHUNK_ID_IARL, 256 },
5499          { CHUNK_ID_IART, 128 },          { CHUNK_ID_IART, 128 },
5500          { CHUNK_ID_ICMS, 128 },          { CHUNK_ID_ICMS, 128 },
# Line 2960  namespace { Line 5516  namespace {
5516      };      };
5517    
5518      File::File() : DLS::File() {      File::File() : DLS::File() {
5519            bAutoLoad = true;
5520            *pVersion = VERSION_3;
5521          pGroups = NULL;          pGroups = NULL;
5522          pInfo->FixedStringLengths = FixedStringLengths;          pScriptGroups = NULL;
5523            pInfo->SetFixedStringLengths(_FileFixedStringLengths);
5524          pInfo->ArchivalLocation = String(256, ' ');          pInfo->ArchivalLocation = String(256, ' ');
5525    
5526          // add some mandatory chunks to get the file chunks in right          // add some mandatory chunks to get the file chunks in right
5527          // order (INFO chunk will be moved to first position later)          // order (INFO chunk will be moved to first position later)
5528          pRIFF->AddSubChunk(CHUNK_ID_VERS, 8);          pRIFF->AddSubChunk(CHUNK_ID_VERS, 8);
5529          pRIFF->AddSubChunk(CHUNK_ID_COLH, 4);          pRIFF->AddSubChunk(CHUNK_ID_COLH, 4);
5530            pRIFF->AddSubChunk(CHUNK_ID_DLID, 16);
5531    
5532            GenerateDLSID();
5533      }      }
5534    
5535      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
5536            bAutoLoad = true;
5537          pGroups = NULL;          pGroups = NULL;
5538          pInfo->FixedStringLengths = FixedStringLengths;          pScriptGroups = NULL;
5539            pInfo->SetFixedStringLengths(_FileFixedStringLengths);
5540      }      }
5541    
5542      File::~File() {      File::~File() {
# Line 2985  namespace { Line 5549  namespace {
5549              }              }
5550              delete pGroups;              delete pGroups;
5551          }          }
5552            if (pScriptGroups) {
5553                std::list<ScriptGroup*>::iterator iter = pScriptGroups->begin();
5554                std::list<ScriptGroup*>::iterator end  = pScriptGroups->end();
5555                while (iter != end) {
5556                    delete *iter;
5557                    ++iter;
5558                }
5559                delete pScriptGroups;
5560            }
5561      }      }
5562    
5563      Sample* File::GetFirstSample(progress_t* pProgress) {      Sample* File::GetFirstSample(progress_t* pProgress) {
# Line 2999  namespace { Line 5572  namespace {
5572          SamplesIterator++;          SamplesIterator++;
5573          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
5574      }      }
5575        
5576        /**
5577         * Returns Sample object of @a index.
5578         *
5579         * @returns sample object or NULL if index is out of bounds
5580         */
5581        Sample* File::GetSample(uint index) {
5582            if (!pSamples) LoadSamples();
5583            if (!pSamples) return NULL;
5584            DLS::File::SampleList::iterator it = pSamples->begin();
5585            for (int i = 0; i < index; ++i) {
5586                ++it;
5587                if (it == pSamples->end()) return NULL;
5588            }
5589            if (it == pSamples->end()) return NULL;
5590            return static_cast<gig::Sample*>( *it );
5591        }
5592    
5593        /**
5594         * Returns the total amount of samples of this gig file.
5595         *
5596         * Note that this method might block for a long time in case it is required
5597         * to load the sample info for the first time.
5598         *
5599         * @returns total amount of samples
5600         */
5601        size_t File::CountSamples() {
5602            if (!pSamples) LoadSamples();
5603            if (!pSamples) return 0;
5604            return pSamples->size();
5605        }
5606    
5607      /** @brief Add a new sample.      /** @brief Add a new sample.
5608       *       *
# Line 3025  namespace { Line 5629  namespace {
5629    
5630      /** @brief Delete a sample.      /** @brief Delete a sample.
5631       *       *
5632       * 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
5633       * to call Save() to make this persistent to the file.       * references to this sample from Regions and DimensionRegions will be
5634         * removed. You have to call Save() to make this persistent to the file.
5635       *       *
5636       * @param pSample - sample to delete       * @param pSample - sample to delete
5637       * @throws gig::Exception if given sample could not be found       * @throws gig::Exception if given sample could not be found
# Line 3038  namespace { Line 5643  namespace {
5643          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
5644          pSamples->erase(iter);          pSamples->erase(iter);
5645          delete pSample;          delete pSample;
5646    
5647            SampleList::iterator tmp = SamplesIterator;
5648            // remove all references to the sample
5649            for (Instrument* instrument = GetFirstInstrument() ; instrument ;
5650                 instrument = GetNextInstrument()) {
5651                for (Region* region = instrument->GetFirstRegion() ; region ;
5652                     region = instrument->GetNextRegion()) {
5653    
5654                    if (region->GetSample() == pSample) region->SetSample(NULL);
5655    
5656                    for (int i = 0 ; i < region->DimensionRegions ; i++) {
5657                        gig::DimensionRegion *d = region->pDimensionRegions[i];
5658                        if (d->pSample == pSample) d->pSample = NULL;
5659                    }
5660                }
5661            }
5662            SamplesIterator = tmp; // restore iterator
5663      }      }
5664    
5665      void File::LoadSamples() {      void File::LoadSamples() {
# Line 3058  namespace { Line 5680  namespace {
5680          int iTotalSamples = WavePoolCount;          int iTotalSamples = WavePoolCount;
5681    
5682          // check if samples should be loaded from extension files          // check if samples should be loaded from extension files
5683            // (only for old gig files < 2 GB)
5684          int lastFileNo = 0;          int lastFileNo = 0;
5685          for (int i = 0 ; i < WavePoolCount ; i++) {          if (!file->IsNew() && !(file->GetCurrentFileSize() >> 31)) {
5686              if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];              for (int i = 0 ; i < WavePoolCount ; i++) {
5687                    if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];
5688                }
5689          }          }
5690          String name(pRIFF->GetFileName());          String name(pRIFF->GetFileName());
5691          int nameLen = name.length();          int nameLen = (int) name.length();
5692          char suffix[6];          char suffix[6];
5693          if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;          if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;
5694    
5695          for (int fileNo = 0 ; ; ) {          for (int fileNo = 0 ; ; ) {
5696              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
5697              if (wvpl) {              if (wvpl) {
5698                  unsigned long wvplFileOffset = wvpl->GetFilePos();                  file_offset_t wvplFileOffset = wvpl->GetFilePos();
5699                  RIFF::List* wave = wvpl->GetFirstSubList();                  RIFF::List* wave = wvpl->GetFirstSubList();
5700                  while (wave) {                  while (wave) {
5701                      if (wave->GetListType() == LIST_TYPE_WAVE) {                      if (wave->GetListType() == LIST_TYPE_WAVE) {
# Line 3078  namespace { Line 5703  namespace {
5703                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
5704                          __notify_progress(pProgress, subprogress);                          __notify_progress(pProgress, subprogress);
5705    
5706                          unsigned long waveFileOffset = wave->GetFilePos();                          file_offset_t waveFileOffset = wave->GetFilePos();
5707                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo, iSampleIndex));
5708    
5709                          iSampleIndex++;                          iSampleIndex++;
5710                      }                      }
# Line 3114  namespace { Line 5739  namespace {
5739      }      }
5740    
5741      /**      /**
5742         * Returns the total amount of instruments of this gig file.
5743         *
5744         * Note that this method might block for a long time in case it is required
5745         * to load the instruments info for the first time.
5746         *
5747         * @returns total amount of instruments
5748         */
5749        size_t File::CountInstruments() {
5750            if (!pInstruments) LoadInstruments();
5751            if (!pInstruments) return 0;
5752            return pInstruments->size();
5753        }
5754    
5755        /**
5756       * Returns the instrument with the given index.       * Returns the instrument with the given index.
5757       *       *
5758       * @param index     - number of the sought instrument (0..n)       * @param index     - number of the sought instrument (0..n)
# Line 3128  namespace { Line 5767  namespace {
5767              progress_t subprogress;              progress_t subprogress;
5768              __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask              __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
5769              __notify_progress(&subprogress, 0.0f);              __notify_progress(&subprogress, 0.0f);
5770              GetFirstSample(&subprogress); // now force all samples to be loaded              if (GetAutoLoad())
5771                    GetFirstSample(&subprogress); // now force all samples to be loaded
5772              __notify_progress(&subprogress, 1.0f);              __notify_progress(&subprogress, 1.0f);
5773    
5774              // instrument loading subtask              // instrument loading subtask
# Line 3164  namespace { Line 5804  namespace {
5804    
5805         // add mandatory chunks to get the chunks in right order         // add mandatory chunks to get the chunks in right order
5806         lstInstr->AddSubList(LIST_TYPE_INFO);         lstInstr->AddSubList(LIST_TYPE_INFO);
5807           lstInstr->AddSubChunk(CHUNK_ID_DLID, 16);
5808    
5809         Instrument* pInstrument = new Instrument(this, lstInstr);         Instrument* pInstrument = new Instrument(this, lstInstr);
5810           pInstrument->GenerateDLSID();
5811    
5812         lstInstr->AddSubChunk(CHUNK_ID_INSH, 12);         lstInstr->AddSubChunk(CHUNK_ID_INSH, 12);
5813    
# Line 3175  namespace { Line 5817  namespace {
5817         pInstruments->push_back(pInstrument);         pInstruments->push_back(pInstrument);
5818         return pInstrument;         return pInstrument;
5819      }      }
5820        
5821        /** @brief Add a duplicate of an existing instrument.
5822         *
5823         * Duplicates the instrument definition given by @a orig and adds it
5824         * to this file. This allows in an instrument editor application to
5825         * easily create variations of an instrument, which will be stored in
5826         * the same .gig file, sharing i.e. the same samples.
5827         *
5828         * Note that all sample pointers referenced by @a orig are simply copied as
5829         * memory address. Thus the respective samples are shared, not duplicated!
5830         *
5831         * You have to call Save() to make this persistent to the file.
5832         *
5833         * @param orig - original instrument to be copied
5834         * @returns duplicated copy of the given instrument
5835         */
5836        Instrument* File::AddDuplicateInstrument(const Instrument* orig) {
5837            Instrument* instr = AddInstrument();
5838            instr->CopyAssign(orig);
5839            return instr;
5840        }
5841        
5842        /** @brief Add content of another existing file.
5843         *
5844         * Duplicates the samples, groups and instruments of the original file
5845         * given by @a pFile and adds them to @c this File. In case @c this File is
5846         * a new one that you haven't saved before, then you have to call
5847         * SetFileName() before calling AddContentOf(), because this method will
5848         * automatically save this file during operation, which is required for
5849         * writing the sample waveform data by disk streaming.
5850         *
5851         * @param pFile - original file whose's content shall be copied from
5852         */
5853        void File::AddContentOf(File* pFile) {
5854            static int iCallCount = -1;
5855            iCallCount++;
5856            std::map<Group*,Group*> mGroups;
5857            std::map<Sample*,Sample*> mSamples;
5858            
5859            // clone sample groups
5860            for (int i = 0; pFile->GetGroup(i); ++i) {
5861                Group* g = AddGroup();
5862                g->Name =
5863                    "COPY" + ToString(iCallCount) + "_" + pFile->GetGroup(i)->Name;
5864                mGroups[pFile->GetGroup(i)] = g;
5865            }
5866            
5867            // clone samples (not waveform data here yet)
5868            for (int i = 0; pFile->GetSample(i); ++i) {
5869                Sample* s = AddSample();
5870                s->CopyAssignMeta(pFile->GetSample(i));
5871                mGroups[pFile->GetSample(i)->GetGroup()]->AddSample(s);
5872                mSamples[pFile->GetSample(i)] = s;
5873            }
5874    
5875            // clone script groups and their scripts
5876            for (int iGroup = 0; pFile->GetScriptGroup(iGroup); ++iGroup) {
5877                ScriptGroup* sg = pFile->GetScriptGroup(iGroup);
5878                ScriptGroup* dg = AddScriptGroup();
5879                dg->Name = "COPY" + ToString(iCallCount) + "_" + sg->Name;
5880                for (int iScript = 0; sg->GetScript(iScript); ++iScript) {
5881                    Script* ss = sg->GetScript(iScript);
5882                    Script* ds = dg->AddScript();
5883                    ds->CopyAssign(ss);
5884                }
5885            }
5886    
5887            //BUG: For some reason this method only works with this additional
5888            //     Save() call in between here.
5889            //
5890            // Important: The correct one of the 2 Save() methods has to be called
5891            // here, depending on whether the file is completely new or has been
5892            // saved to disk already, otherwise it will result in data corruption.
5893            if (pRIFF->IsNew())
5894                Save(GetFileName());
5895            else
5896                Save();
5897            
5898            // clone instruments
5899            // (passing the crosslink table here for the cloned samples)
5900            for (int i = 0; pFile->GetInstrument(i); ++i) {
5901                Instrument* instr = AddInstrument();
5902                instr->CopyAssign(pFile->GetInstrument(i), &mSamples);
5903            }
5904            
5905            // Mandatory: file needs to be saved to disk at this point, so this
5906            // file has the correct size and data layout for writing the samples'
5907            // waveform data to disk.
5908            Save();
5909            
5910            // clone samples' waveform data
5911            // (using direct read & write disk streaming)
5912            for (int i = 0; pFile->GetSample(i); ++i) {
5913                mSamples[pFile->GetSample(i)]->CopyAssignWave(pFile->GetSample(i));
5914            }
5915        }
5916    
5917      /** @brief Delete an instrument.      /** @brief Delete an instrument.
5918       *       *
# Line 3222  namespace { Line 5960  namespace {
5960          }          }
5961      }      }
5962    
5963        /// Updates the 3crc chunk with the checksum of a sample. The
5964        /// update is done directly to disk, as this method is called
5965        /// after File::Save()
5966      void File::SetSampleChecksum(Sample* pSample, uint32_t crc) {      void File::SetSampleChecksum(Sample* pSample, uint32_t crc) {
5967          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
5968          if (!_3crc) return;          if (!_3crc) return;
5969          int iWaveIndex = -1;  
5970            // get the index of the sample
5971            int iWaveIndex = GetWaveTableIndexOf(pSample);
5972            if (iWaveIndex < 0) throw gig::Exception("Could not update crc, could not find sample");
5973    
5974            // write the CRC-32 checksum to disk
5975            _3crc->SetPos(iWaveIndex * 8);
5976            uint32_t one = 1;
5977            _3crc->WriteUint32(&one); // always 1
5978            _3crc->WriteUint32(&crc);
5979        }
5980    
5981        uint32_t File::GetSampleChecksum(Sample* pSample) {
5982            // get the index of the sample
5983            int iWaveIndex = GetWaveTableIndexOf(pSample);
5984            if (iWaveIndex < 0) throw gig::Exception("Could not retrieve reference crc of sample, could not resolve sample's wave table index");
5985    
5986            return GetSampleChecksumByIndex(iWaveIndex);
5987        }
5988    
5989        uint32_t File::GetSampleChecksumByIndex(int index) {
5990            if (index < 0) throw gig::Exception("Could not retrieve reference crc of sample, invalid wave pool index of sample");
5991    
5992            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
5993            if (!_3crc) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
5994            uint8_t* pData = (uint8_t*) _3crc->LoadChunkData();
5995            if (!pData) throw gig::Exception("Could not retrieve reference crc of sample, no checksums stored for this file yet");
5996    
5997            // read the CRC-32 checksum directly from disk
5998            size_t pos = index * 8;
5999            if (pos + 8 > _3crc->GetNewSize())
6000                throw gig::Exception("Could not retrieve reference crc of sample, could not seek to required position in crc chunk");
6001    
6002            uint32_t one = load32(&pData[pos]); // always 1
6003            if (one != 1)
6004                throw gig::Exception("Could not retrieve reference crc of sample, because reference checksum table is damaged");
6005    
6006            return load32(&pData[pos+4]);
6007        }
6008    
6009        int File::GetWaveTableIndexOf(gig::Sample* pSample) {
6010            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
6011          File::SampleList::iterator iter = pSamples->begin();          File::SampleList::iterator iter = pSamples->begin();
6012          File::SampleList::iterator end  = pSamples->end();          File::SampleList::iterator end  = pSamples->end();
6013          for (int index = 0; iter != end; ++iter, ++index) {          for (int index = 0; iter != end; ++iter, ++index)
6014              if (*iter == pSample) {              if (*iter == pSample)
6015                  iWaveIndex = index;                  return index;
6016                  break;          return -1;
6017        }
6018    
6019        /**
6020         * Checks whether the file's "3CRC" chunk was damaged. This chunk contains
6021         * the CRC32 check sums of all samples' raw wave data.
6022         *
6023         * @return true if 3CRC chunk is OK, or false if 3CRC chunk is damaged
6024         */
6025        bool File::VerifySampleChecksumTable() {
6026            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6027            if (!_3crc) return false;
6028            if (_3crc->GetNewSize() <= 0) return false;
6029            if (_3crc->GetNewSize() % 8) return false;
6030            if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
6031            if (_3crc->GetNewSize() != pSamples->size() * 8) return false;
6032    
6033            const file_offset_t n = _3crc->GetNewSize() / 8;
6034    
6035            uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6036            if (!pData) return false;
6037    
6038            for (file_offset_t i = 0; i < n; ++i) {
6039                uint32_t one = pData[i*2];
6040                if (one != 1) return false;
6041            }
6042    
6043            return true;
6044        }
6045    
6046        /**
6047         * Recalculates CRC32 checksums for all samples and rebuilds this gig
6048         * file's checksum table with those new checksums. This might usually
6049         * just be necessary if the checksum table was damaged.
6050         *
6051         * @e IMPORTANT: The current implementation of this method only works
6052         * with files that have not been modified since it was loaded, because
6053         * it expects that no externally caused file structure changes are
6054         * required!
6055         *
6056         * Due to the expectation above, this method is currently protected
6057         * and actually only used by the command line tool "gigdump" yet.
6058         *
6059         * @returns true if Save() is required to be called after this call,
6060         *          false if no further action is required
6061         */
6062        bool File::RebuildSampleChecksumTable() {
6063            // make sure sample chunks were scanned
6064            if (!pSamples) GetFirstSample();
6065    
6066            bool bRequiresSave = false;
6067    
6068            // make sure "3CRC" chunk exists with required size
6069            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6070            if (!_3crc) {
6071                _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
6072                // the order of einf and 3crc is not the same in v2 and v3
6073                RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
6074                if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
6075                bRequiresSave = true;
6076            } else if (_3crc->GetNewSize() != pSamples->size() * 8) {
6077                _3crc->Resize(pSamples->size() * 8);
6078                bRequiresSave = true;
6079            }
6080    
6081            if (bRequiresSave) { // refill CRC table for all samples in RAM ...
6082                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6083                {
6084                    File::SampleList::iterator iter = pSamples->begin();
6085                    File::SampleList::iterator end  = pSamples->end();
6086                    for (; iter != end; ++iter) {
6087                        gig::Sample* pSample = (gig::Sample*) *iter;
6088                        int index = GetWaveTableIndexOf(pSample);
6089                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6090                        pData[index*2]   = 1; // always 1
6091                        pData[index*2+1] = pSample->CalculateWaveDataChecksum();
6092                    }
6093                }
6094            } else { // no file structure changes necessary, so directly write to disk and we are done ...
6095                // make sure file is in write mode
6096                pRIFF->SetMode(RIFF::stream_mode_read_write);
6097                {
6098                    File::SampleList::iterator iter = pSamples->begin();
6099                    File::SampleList::iterator end  = pSamples->end();
6100                    for (; iter != end; ++iter) {
6101                        gig::Sample* pSample = (gig::Sample*) *iter;
6102                        int index = GetWaveTableIndexOf(pSample);
6103                        if (index < 0) throw gig::Exception("Could not rebuild crc table for samples, wave table index of a sample could not be resolved");
6104                        pSample->crc  = pSample->CalculateWaveDataChecksum();
6105                        SetSampleChecksum(pSample, pSample->crc);
6106                    }
6107              }              }
6108          }          }
         if (iWaveIndex < 0) throw gig::Exception("Could not update crc, could not find sample");  
6109    
6110          _3crc->SetPos(iWaveIndex * 8);          return bRequiresSave;
         uint32_t tmp = 1;  
         _3crc->WriteUint32(&tmp); // unknown, always 1?  
         _3crc->WriteUint32(&crc);  
6111      }      }
6112    
6113      Group* File::GetFirstGroup() {      Group* File::GetFirstGroup() {
# Line 3271  namespace { Line 6139  namespace {
6139          return NULL;          return NULL;
6140      }      }
6141    
6142        /**
6143         * Returns the group with the given group name.
6144         *
6145         * Note: group names don't have to be unique in the gig format! So there
6146         * can be multiple groups with the same name. This method will simply
6147         * return the first group found with the given name.
6148         *
6149         * @param name - name of the sought group
6150         * @returns sought group or NULL if there's no group with that name
6151         */
6152        Group* File::GetGroup(String name) {
6153            if (!pGroups) LoadGroups();
6154            GroupsIterator = pGroups->begin();
6155            for (uint i = 0; GroupsIterator != pGroups->end(); ++GroupsIterator, ++i)
6156                if ((*GroupsIterator)->Name == name) return *GroupsIterator;
6157            return NULL;
6158        }
6159    
6160      Group* File::AddGroup() {      Group* File::AddGroup() {
6161          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6162          // there must always be at least one group          // there must always be at least one group
# Line 3334  namespace { Line 6220  namespace {
6220                  RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();                  RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();
6221                  while (ck) {                  while (ck) {
6222                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {
6223                            if (pVersion && pVersion->major == 3 &&
6224                                strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;
6225    
6226                          pGroups->push_back(new Group(this, ck));                          pGroups->push_back(new Group(this, ck));
6227                      }                      }
6228                      ck = lst3gnl->GetNextSubChunk();                      ck = lst3gnl->GetNextSubChunk();
# Line 3348  namespace { Line 6237  namespace {
6237          }          }
6238      }      }
6239    
6240        /** @brief Get instrument script group (by index).
6241         *
6242         * Returns the real-time instrument script group with the given index.
6243         *
6244         * @param index - number of the sought group (0..n)
6245         * @returns sought script group or NULL if there's no such group
6246         */
6247        ScriptGroup* File::GetScriptGroup(uint index) {
6248            if (!pScriptGroups) LoadScriptGroups();
6249            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
6250            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
6251                if (i == index) return *it;
6252            return NULL;
6253        }
6254    
6255        /** @brief Get instrument script group (by name).
6256         *
6257         * Returns the first real-time instrument script group found with the given
6258         * group name. Note that group names may not necessarily be unique.
6259         *
6260         * @param name - name of the sought script group
6261         * @returns sought script group or NULL if there's no such group
6262         */
6263        ScriptGroup* File::GetScriptGroup(const String& name) {
6264            if (!pScriptGroups) LoadScriptGroups();
6265            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
6266            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
6267                if ((*it)->Name == name) return *it;
6268            return NULL;
6269        }
6270    
6271        /** @brief Add new instrument script group.
6272         *
6273         * Adds a new, empty real-time instrument script group to the file.
6274         *
6275         * You have to call Save() to make this persistent to the file.
6276         *
6277         * @return new empty script group
6278         */
6279        ScriptGroup* File::AddScriptGroup() {
6280            if (!pScriptGroups) LoadScriptGroups();
6281            ScriptGroup* pScriptGroup = new ScriptGroup(this, NULL);
6282            pScriptGroups->push_back(pScriptGroup);
6283            return pScriptGroup;
6284        }
6285    
6286        /** @brief Delete an instrument script group.
6287         *
6288         * This will delete the given real-time instrument script group and all its
6289         * instrument scripts it contains. References inside instruments that are
6290         * using the deleted scripts will be removed from the respective instruments
6291         * accordingly.
6292         *
6293         * You have to call Save() to make this persistent to the file.
6294         *
6295         * @param pScriptGroup - script group to delete
6296         * @throws gig::Exception if given script group could not be found
6297         */
6298        void File::DeleteScriptGroup(ScriptGroup* pScriptGroup) {
6299            if (!pScriptGroups) LoadScriptGroups();
6300            std::list<ScriptGroup*>::iterator iter =
6301                find(pScriptGroups->begin(), pScriptGroups->end(), pScriptGroup);
6302            if (iter == pScriptGroups->end())
6303                throw gig::Exception("Could not delete script group, could not find given script group");
6304            pScriptGroups->erase(iter);
6305            for (int i = 0; pScriptGroup->GetScript(i); ++i)
6306                pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));
6307            if (pScriptGroup->pList)
6308                pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);
6309            delete pScriptGroup;
6310        }
6311    
6312        void File::LoadScriptGroups() {
6313            if (pScriptGroups) return;
6314            pScriptGroups = new std::list<ScriptGroup*>;
6315            RIFF::List* lstLS = pRIFF->GetSubList(LIST_TYPE_3LS);
6316            if (lstLS) {
6317                for (RIFF::List* lst = lstLS->GetFirstSubList(); lst;
6318                     lst = lstLS->GetNextSubList())
6319                {
6320                    if (lst->GetListType() == LIST_TYPE_RTIS) {
6321                        pScriptGroups->push_back(new ScriptGroup(this, lst));
6322                    }
6323                }
6324            }
6325        }
6326    
6327      /**      /**
6328       * Apply all the gig file's current instruments, samples, groups and settings       * Apply all the gig file's current instruments, samples, groups and settings
6329       * 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 3356  namespace { Line 6332  namespace {
6332       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
6333       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
6334       *       *
6335         * @param pProgress - callback function for progress notification
6336       * @throws Exception - on errors       * @throws Exception - on errors
6337       */       */
6338      void File::UpdateChunks() {      void File::UpdateChunks(progress_t* pProgress) {
6339          bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;          bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;
6340    
6341            // update own gig format extension chunks
6342            // (not part of the GigaStudio 4 format)
6343            RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);
6344            if (!lst3LS) {
6345                lst3LS = pRIFF->AddSubList(LIST_TYPE_3LS);
6346            }
6347            // Make sure <3LS > chunk is placed before <ptbl> chunk. The precise
6348            // location of <3LS > is irrelevant, however it should be located
6349            // before  the actual wave data
6350            RIFF::Chunk* ckPTBL = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
6351            pRIFF->MoveSubChunk(lst3LS, ckPTBL);
6352    
6353            // This must be performed before writing the chunks for instruments,
6354            // because the instruments' script slots will write the file offsets
6355            // of the respective instrument script chunk as reference.
6356            if (pScriptGroups) {
6357                // Update instrument script (group) chunks.
6358                for (std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
6359                     it != pScriptGroups->end(); ++it)
6360                {
6361                    (*it)->UpdateChunks(pProgress);
6362                }
6363            }
6364    
6365            // in case no libgig custom format data was added, then remove the
6366            // custom "3LS " chunk again
6367            if (!lst3LS->CountSubChunks()) {
6368                pRIFF->DeleteSubChunk(lst3LS);
6369                lst3LS = NULL;
6370            }
6371    
6372          // first update base class's chunks          // first update base class's chunks
6373          DLS::File::UpdateChunks();          DLS::File::UpdateChunks(pProgress);
6374    
6375          if (newFile) {          if (newFile) {
6376              // INFO was added by Resource::UpdateChunks - make sure it              // INFO was added by Resource::UpdateChunks - make sure it
# Line 3376  namespace { Line 6384  namespace {
6384    
6385          // update group's chunks          // update group's chunks
6386          if (pGroups) {          if (pGroups) {
6387                // make sure '3gri' and '3gnl' list chunks exist
6388                // (before updating the Group chunks)
6389                RIFF::List* _3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
6390                if (!_3gri) {
6391                    _3gri = pRIFF->AddSubList(LIST_TYPE_3GRI);
6392                    pRIFF->MoveSubChunk(_3gri, pRIFF->GetSubChunk(CHUNK_ID_PTBL));
6393                }
6394                RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
6395                if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
6396    
6397                // v3: make sure the file has 128 3gnm chunks
6398                // (before updating the Group chunks)
6399                if (pVersion && pVersion->major == 3) {
6400                    RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
6401                    for (int i = 0 ; i < 128 ; i++) {
6402                        if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
6403                        if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();
6404                    }
6405                }
6406    
6407              std::list<Group*>::iterator iter = pGroups->begin();              std::list<Group*>::iterator iter = pGroups->begin();
6408              std::list<Group*>::iterator end  = pGroups->end();              std::list<Group*>::iterator end  = pGroups->end();
6409              for (; iter != end; ++iter) {              for (; iter != end; ++iter) {
6410                  (*iter)->UpdateChunks();                  (*iter)->UpdateChunks(pProgress);
6411              }              }
6412          }          }
6413    
# Line 3399  namespace { Line 6427  namespace {
6427          // Note that there are several fields with unknown use. These          // Note that there are several fields with unknown use. These
6428          // are set to zero.          // are set to zero.
6429    
6430          int sublen = pSamples->size() / 8 + 49;          int sublen = int(pSamples->size() / 8 + 49);
6431          int einfSize = (Instruments + 1) * sublen;          int einfSize = (Instruments + 1) * sublen;
6432    
6433          RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);          RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
# Line 3424  namespace { Line 6452  namespace {
6452              int totnbusedchannels = 0;              int totnbusedchannels = 0;
6453              int totnbregions = 0;              int totnbregions = 0;
6454              int totnbdimregions = 0;              int totnbdimregions = 0;
6455                int totnbloops = 0;
6456              int instrumentIdx = 0;              int instrumentIdx = 0;
6457    
6458              memset(&pData[48], 0, sublen - 48);              memset(&pData[48], 0, sublen - 48);
# Line 3433  namespace { Line 6462  namespace {
6462                  int nbusedsamples = 0;                  int nbusedsamples = 0;
6463                  int nbusedchannels = 0;                  int nbusedchannels = 0;
6464                  int nbdimregions = 0;                  int nbdimregions = 0;
6465                    int nbloops = 0;
6466    
6467                  memset(&pData[(instrumentIdx + 1) * sublen + 48], 0, sublen - 48);                  memset(&pData[(instrumentIdx + 1) * sublen + 48], 0, sublen - 48);
6468    
# Line 3456  namespace { Line 6486  namespace {
6486                                  }                                  }
6487                              }                              }
6488                          }                          }
6489                            if (d->SampleLoops) nbloops++;
6490                      }                      }
6491                      nbdimregions += region->DimensionRegions;                      nbdimregions += region->DimensionRegions;
6492                  }                  }
# Line 3466  namespace { Line 6497  namespace {
6497                  store32(&pData[(instrumentIdx + 1) * sublen + 12], 1);                  store32(&pData[(instrumentIdx + 1) * sublen + 12], 1);
6498                  store32(&pData[(instrumentIdx + 1) * sublen + 16], instrument->Regions);                  store32(&pData[(instrumentIdx + 1) * sublen + 16], instrument->Regions);
6499                  store32(&pData[(instrumentIdx + 1) * sublen + 20], nbdimregions);                  store32(&pData[(instrumentIdx + 1) * sublen + 20], nbdimregions);
6500                  // next 12 bytes unknown                  store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);
6501                    // next 8 bytes unknown
6502                  store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);                  store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);
6503                  store32(&pData[(instrumentIdx + 1) * sublen + 40], pSamples->size());                  store32(&pData[(instrumentIdx + 1) * sublen + 40], (uint32_t) pSamples->size());
6504                  // next 4 bytes unknown                  // next 4 bytes unknown
6505    
6506                  totnbregions += instrument->Regions;                  totnbregions += instrument->Regions;
6507                  totnbdimregions += nbdimregions;                  totnbdimregions += nbdimregions;
6508                    totnbloops += nbloops;
6509                  instrumentIdx++;                  instrumentIdx++;
6510              }              }
6511              // first 4 bytes unknown - sometimes 0, sometimes length of einf part              // first 4 bytes unknown - sometimes 0, sometimes length of einf part
# Line 3482  namespace { Line 6515  namespace {
6515              store32(&pData[12], Instruments);              store32(&pData[12], Instruments);
6516              store32(&pData[16], totnbregions);              store32(&pData[16], totnbregions);
6517              store32(&pData[20], totnbdimregions);              store32(&pData[20], totnbdimregions);
6518              // next 12 bytes unknown              store32(&pData[24], totnbloops);
6519              // next 4 bytes unknown, always 0?              // next 8 bytes unknown
6520              store32(&pData[40], pSamples->size());              // next 4 bytes unknown, not always 0
6521                store32(&pData[40], (uint32_t) pSamples->size());
6522              // next 4 bytes unknown              // next 4 bytes unknown
6523          }          }
6524    
6525          // update 3crc chunk          // update 3crc chunk
6526    
6527          // The 3crc chunk contains CRC-32 checksums for the          // The 3crc chunk contains CRC-32 checksums for the
6528          // samples. The actual checksum values will be filled in          // samples. When saving a gig file to disk, we first update the 3CRC
6529          // later, by Sample::Write.          // chunk here (in RAM) with the old crc values which we read from the
6530            // 3CRC chunk when we opened the file (available with gig::Sample::crc
6531            // member variable). This step is required, because samples might have
6532            // been deleted by the user since the file was opened, which in turn
6533            // changes the order of the (i.e. old) checksums within the 3crc chunk.
6534            // If a sample was conciously modified by the user (that is if
6535            // Sample::Write() was called later on) then Sample::Write() will just
6536            // update the respective individual checksum(s) directly on disk and
6537            // leaves all other sample checksums untouched.
6538    
6539          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);          RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
6540          if (_3crc) {          if (_3crc) {
6541              _3crc->Resize(pSamples->size() * 8);              _3crc->Resize(pSamples->size() * 8);
6542          } else if (newFile) {          } else /*if (newFile)*/ {
6543              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
6544              _3crc->LoadChunkData();              // the order of einf and 3crc is not the same in v2 and v3
6545                if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
6546            }
6547            { // must be performed in RAM here ...
6548                uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
6549                if (pData) {
6550                    File::SampleList::iterator iter = pSamples->begin();
6551                    File::SampleList::iterator end  = pSamples->end();
6552                    for (int index = 0; iter != end; ++iter, ++index) {
6553                        gig::Sample* pSample = (gig::Sample*) *iter;
6554                        pData[index*2]   = 1; // always 1
6555                        pData[index*2+1] = pSample->crc;
6556                    }
6557                }
6558            }
6559        }
6560        
6561        void File::UpdateFileOffsets() {
6562            DLS::File::UpdateFileOffsets();
6563    
6564            for (Instrument* instrument = GetFirstInstrument(); instrument;
6565                 instrument = GetNextInstrument())
6566            {
6567                instrument->UpdateScriptFileOffsets();
6568          }          }
6569      }      }
6570    
6571        /**
6572         * Enable / disable automatic loading. By default this properyt is
6573         * enabled and all informations are loaded automatically. However
6574         * loading all Regions, DimensionRegions and especially samples might
6575         * take a long time for large .gig files, and sometimes one might only
6576         * be interested in retrieving very superficial informations like the
6577         * amount of instruments and their names. In this case one might disable
6578         * automatic loading to avoid very slow response times.
6579         *
6580         * @e CAUTION: by disabling this property many pointers (i.e. sample
6581         * references) and informations will have invalid or even undefined
6582         * data! This feature is currently only intended for retrieving very
6583         * superficial informations in a very fast way. Don't use it to retrieve
6584         * details like synthesis informations or even to modify .gig files!
6585         */
6586        void File::SetAutoLoad(bool b) {
6587            bAutoLoad = b;
6588        }
6589    
6590        /**
6591         * Returns whether automatic loading is enabled.
6592         * @see SetAutoLoad()
6593         */
6594        bool File::GetAutoLoad() {
6595            return bAutoLoad;
6596        }
6597    
6598    
6599    
6600  // *************** Exception ***************  // *************** Exception ***************
6601  // *  // *
6602    
6603      Exception::Exception(String Message) : DLS::Exception(Message) {      Exception::Exception() : DLS::Exception() {
6604        }
6605    
6606        Exception::Exception(String format, ...) : DLS::Exception() {
6607            va_list arg;
6608            va_start(arg, format);
6609            Message = assemble(format, arg);
6610            va_end(arg);
6611        }
6612    
6613        Exception::Exception(String format, va_list arg) : DLS::Exception() {
6614            Message = assemble(format, arg);
6615      }      }
6616    
6617      void Exception::PrintMessage() {      void Exception::PrintMessage() {

Legend:
Removed from v.1199  
changed lines
  Added in v.3414

  ViewVC Help
Powered by ViewVC