/[svn]/libgig/trunk/src/gig.cpp

Diff of /libgig/trunk/src/gig.cpp

Parent Directory | Revision Log | View Patch Patch

-revision 1247 by persson,
Fri Jun 22 09:59:57 2007 UTC
+revision 2484 by schoenebeck,
Tue Dec 31 00:13:20 2013 UTC
 Line 2
   *                                                                         *
   *   libgig - C++ cross-platform Gigasampler format file access library    *
   *                                                                         *
-  *   Copyright (C) 2003-2007 by Christian Schoenebeck                      *
+  *   Copyright (C) 2003-2013 by Christian Schoenebeck                      *
   *                              <cuse@users.sourceforge.net>               *
   *                                                                         *
   *   This library is free software; you can redistribute it and/or modify  *
 Line 25
  #include "helper.h"
+ #include <algorithm>
  #include <math.h>
  #include <iostream>
-Line 255 
 namespace {
+Line 256 
 namespace {
+ // *************** Internal CRC-32 (Cyclic Redundancy Check) functions  ***************
+ // *
+     static uint32_t* __initCRCTable() {
+         static uint32_t res[256];
+         for (int i = 0 ; i < 256 ; i++) {
+             uint32_t c = i;
+             for (int j = 0 ; j < 8 ; j++) {
+                 c = (c & 1) ? 0xedb88320 ^ (c >> 1) : c >> 1;
+             }
+             res[i] = c;
+         }
+         return res;
+     }
+     static const uint32_t* __CRCTable = __initCRCTable();
+     /**
+      * Initialize a CRC variable.
+      *
+      * @param crc - variable to be initialized
+      */
+     inline static void __resetCRC(uint32_t& crc) {
+         crc = 0xffffffff;
+     }
+     /**
+      * Used to calculate checksums of the sample data in a gig file. The
+      * checksums are stored in the 3crc chunk of the gig file and
+      * automatically updated when a sample is written with Sample::Write().
+      *
+      * One should call __resetCRC() to initialize the CRC variable to be
+      * used before calling this function the first time.
+      *
+      * After initializing the CRC variable one can call this function
+      * arbitrary times, i.e. to split the overall CRC calculation into
+      * steps.
+      *
+      * Once the whole data was processed by __calculateCRC(), one should
+      * call __encodeCRC() to get the final CRC result.
+      *
+      * @param buf     - pointer to data the CRC shall be calculated of
+      * @param bufSize - size of the data to be processed
+      * @param crc     - variable the CRC sum shall be stored to
+      */
+     static void __calculateCRC(unsigned char* buf, int bufSize, uint32_t& crc) {
+         for (int i = 0 ; i < bufSize ; i++) {
+             crc = __CRCTable[(crc ^ buf[i]) & 0xff] ^ (crc >> 8);
+         }
+     }
+     /**
+      * Returns the final CRC result.
+      *
+      * @param crc - variable previously passed to __calculateCRC()
+      */
+     inline static uint32_t __encodeCRC(const uint32_t& crc) {
+         return crc ^ 0xffffffff;
+     }
  // *************** Other Internal functions  ***************
  // *
-Line 278 
 namespace {
+Line 342 
 namespace {
- // *************** CRC ***************
- // *
-     const uint32_t* CRC::table(initTable());
-     uint32_t* CRC::initTable() {
-         uint32_t* res = new uint32_t[256];
-         for (int i = 0 ; i < 256 ; i++) {
-             uint32_t c = i;
-             for (int j = 0 ; j < 8 ; j++) {
-                 c = (c & 1) ? 0xedb88320 ^ (c >> 1) : c >> 1;
-             }
-             res[i] = c;
-         }
-         return res;
-     }
  // *************** Sample ***************
  // *
-Line 323 
 namespace {
+Line 367 
 namespace {
       *                         is located, 0 otherwise
       */
      Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {
-         static const DLS::Info::FixedStringLength fixedStringLengths[] = {
+         static const DLS::Info::string_length_t fixedStringLengths[] = {
              { CHUNK_ID_INAM, 64 },
              { 0, 0 }
          };
-         pInfo->FixedStringLengths = fixedStringLengths;
+         pInfo->SetFixedStringLengths(fixedStringLengths);
          Instances++;
          FileNo = fileNo;
+         __resetCRC(crc);
          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
          if (pCk3gix) {
              uint16_t iSampleGroup = pCk3gix->ReadInt16();
-Line 408 
 namespace {
+Line 454 
 namespace {
      }
      /**
+      * Make a (semi) deep copy of the Sample object given by @a orig (without
+      * the actual waveform data) and assign it to this object.
+      *
+      * Discussion: copying .gig samples is a bit tricky. It requires three
+      * steps:
+      * 1. Copy sample's meta informations (done by CopyAssignMeta()) including
+      *    its new sample waveform data size.
+      * 2. Saving the file (done by File::Save()) so that it gains correct size
+      *    and layout for writing the actual wave form data directly to disc
+      *    in next step.
+      * 3. Copy the waveform data with disk streaming (done by CopyAssignWave()).
+      *
+      * @param orig - original Sample object to be copied from
+      */
+     void Sample::CopyAssignMeta(const Sample* orig) {
+         // handle base classes
+         DLS::Sample::CopyAssignCore(orig);
+         // handle actual own attributes of this class
+         Manufacturer = orig->Manufacturer;
+         Product = orig->Product;
+         SamplePeriod = orig->SamplePeriod;
+         MIDIUnityNote = orig->MIDIUnityNote;
+         FineTune = orig->FineTune;
+         SMPTEFormat = orig->SMPTEFormat;
+         SMPTEOffset = orig->SMPTEOffset;
+         Loops = orig->Loops;
+         LoopID = orig->LoopID;
+         LoopType = orig->LoopType;
+         LoopStart = orig->LoopStart;
+         LoopEnd = orig->LoopEnd;
+         LoopSize = orig->LoopSize;
+         LoopFraction = orig->LoopFraction;
+         LoopPlayCount = orig->LoopPlayCount;
+         // schedule resizing this sample to the given sample's size
+         Resize(orig->GetSize());
+     }
+     /**
+      * Should be called after CopyAssignMeta() and File::Save() sequence.
+      * Read more about it in the discussion of CopyAssignMeta(). This method
+      * copies the actual waveform data by disk streaming.
+      *
+      * @e CAUTION: this method is currently not thread safe! During this
+      * operation the sample must not be used for other purposes by other
+      * threads!
+      *
+      * @param orig - original Sample object to be copied from
+      */
+     void Sample::CopyAssignWave(const Sample* orig) {
+         const int iReadAtOnce = 32*1024;
+         char* buf = new char[iReadAtOnce * orig->FrameSize];
+         Sample* pOrig = (Sample*) orig; //HACK: remove constness for now
+         unsigned long restorePos = pOrig->GetPos();
+         pOrig->SetPos(0);
+         SetPos(0);
+         for (unsigned long n = pOrig->Read(buf, iReadAtOnce); n;
+                            n = pOrig->Read(buf, iReadAtOnce))
+         {
+             Write(buf, n);
+         }
+         pOrig->SetPos(restorePos);
+         delete [] buf;
+     }
+     /**
       * Apply sample and its settings to the respective RIFF chunks. You have
       * to call File::Save() to make changes persistent.
       *
-Line 468 
 namespace {
+Line 581 
 namespace {
          // update '3gix' chunk
          pData = (uint8_t*) pCk3gix->LoadChunkData();
          store16(&pData[0], iSampleGroup);
+         // if the library user toggled the "Compressed" attribute from true to
+         // false, then the EWAV chunk associated with compressed samples needs
+         // to be deleted
+         RIFF::Chunk* ewav = pWaveList->GetSubChunk(CHUNK_ID_EWAV);
+         if (ewav && !Compressed) {
+             pWaveList->DeleteSubChunk(ewav);
+         }
      }
      /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).
-Line 631 
 namespace {
+Line 752 
 namespace {
          if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;
          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
          unsigned long allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;
+         SetPos(0); // reset read position to begin of sample
          RAMCache.pStart            = new int8_t[allocationsize];
          RAMCache.Size              = Read(RAMCache.pStart, SampleCount) * this->FrameSize;
          RAMCache.NullExtensionSize = allocationsize - RAMCache.Size;
-Line 668 
 namespace {
+Line 790 
 namespace {
          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
          RAMCache.pStart = NULL;
          RAMCache.Size   = 0;
+         RAMCache.NullExtensionSize = 0;
      }
      /** @brief Resize sample.
-Line 760 
 namespace {
+Line 883 
 namespace {
      /**
       * Returns the current position in the sample (in sample points).
       */
-     unsigned long Sample::GetPos() {
+     unsigned long Sample::GetPos() const {
          if (Compressed) return SamplePos;
          else            return pCkData->GetPos() / FrameSize;
      }
-Line 862 
 namespace {
+Line 985 
 namespace {
                                  }
                                  // reverse the sample frames for backward playback
-                                 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!
+                                     SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
                              }
                          } while (samplestoread && readsamples);
                          break;
-Line 1152 
 namespace {
+Line 1276 
 namespace {
       *
       * Note: there is currently no support for writing compressed samples.
       *
+      * For 16 bit samples, the data in the source buffer should be
+      * int16_t (using native endianness). For 24 bit, the buffer
+      * should contain three bytes per sample, little-endian.
+      *
       * @param pBuffer     - source buffer
       * @param SampleCount - number of sample points to write
       * @throws DLS::Exception if current sample size is too small
-Line 1164 
 namespace {
+Line 1292 
 namespace {
          // if this is the first write in this sample, reset the
          // checksum calculator
          if (pCkData->GetPos() == 0) {
-             crc.reset();
+             __resetCRC(crc);
          }
-         unsigned long res = DLS::Sample::Write(pBuffer, SampleCount);
+         if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");
-         crc.update((unsigned char *)pBuffer, SampleCount * FrameSize);
+         unsigned long res;
+         if (BitDepth == 24) {
+             res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
+         } else { // 16 bit
+             res = Channels == 2 ? pCkData->Write(pBuffer, SampleCount << 1, 2) >> 1
+                                 : pCkData->Write(pBuffer, SampleCount, 2);
+         }
+         __calculateCRC((unsigned char *)pBuffer, SampleCount * FrameSize, crc);
          // if this is the last write, update the checksum chunk in the
          // file
          if (pCkData->GetPos() == pCkData->GetSize()) {
              File* pFile = static_cast<File*>(GetParent());
-             pFile->SetSampleChecksum(this, crc.getValue());
+             pFile->SetSampleChecksum(this, __encodeCRC(crc));
          }
          return res;
      }
-Line 1251 
 namespace {
+Line 1386 
 namespace {
      uint                               DimensionRegion::Instances       = 0;
      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;
-     DimensionRegion::DimensionRegion(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
+     DimensionRegion::DimensionRegion(Region* pParent, RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
          Instances++;
          pSample = NULL;
+         pRegion = pParent;
          if (_3ewl->GetSubChunk(CHUNK_ID_WSMP)) memcpy(&Crossfade, &SamplerOptions, 4);
          else memset(&Crossfade, 0, 4);
-Line 1372 
 namespace {
+Line 1508 
 namespace {
                                                          : vcf_res_ctrl_none;
              uint16_t eg3depth = _3ewa->ReadUint16();
              EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */
-                                         : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */
+                                         : (-1) * (int16_t) ((eg3depth ^ 0xfff) + 1); /* binary complementary for negatives */
              _3ewa->ReadInt16(); // unknown
              ChannelOffset = _3ewa->ReadUint8() / 4;
              uint8_t regoptions = _3ewa->ReadUint8();
-Line 1500 
 namespace {
+Line 1636 
 namespace {
                                                       VelocityResponseDepth,
                                                       VelocityResponseCurveScaling);
-         curve_type_t curveType = ReleaseVelocityResponseCurve;
+         pVelocityReleaseTable = GetReleaseVelocityTable(
-         uint8_t depth = ReleaseVelocityResponseDepth;
+                                     ReleaseVelocityResponseCurve,
+                                     ReleaseVelocityResponseDepth
+                                 );
+         pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve,
+                                                       VCFVelocityDynamicRange,
+                                                       VCFVelocityScale,
+                                                       VCFCutoffController);
-         // this models a strange behaviour or bug in GSt: two of the
+         SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
-         // velocity response curves for release time are not used even
+         VelocityTable = 0;
-         // if specified, instead another curve is chosen.
+     }
-         if ((curveType == curve_type_nonlinear && depth == 0) ||
-             (curveType == curve_type_special   && depth == 4)) {
-             curveType = curve_type_nonlinear;
-             depth = 3;
-         }
-         pVelocityReleaseTable = GetVelocityTable(curveType, depth, 0);
-         curveType = VCFVelocityCurve;
+     /*
-         depth = VCFVelocityDynamicRange;
+      * Constructs a DimensionRegion by copying all parameters from
+      * another DimensionRegion
+      */
+     DimensionRegion::DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src) : DLS::Sampler(_3ewl) {
+         Instances++;
+         //NOTE: I think we cannot call CopyAssign() here (in a constructor) as long as its a virtual method
+         *this = src; // default memberwise shallow copy of all parameters
+         pParentList = _3ewl; // restore the chunk pointer
+         // deep copy of owned structures
+         if (src.VelocityTable) {
+             VelocityTable = new uint8_t[128];
+             for (int k = 0 ; k < 128 ; k++)
+                 VelocityTable[k] = src.VelocityTable[k];
+         }
+         if (src.pSampleLoops) {
+             pSampleLoops = new DLS::sample_loop_t[src.SampleLoops];
+             for (int k = 0 ; k < src.SampleLoops ; k++)
+                 pSampleLoops[k] = src.pSampleLoops[k];
+         }
+     }
+     /**
+      * Make a (semi) deep copy of the DimensionRegion object given by @a orig
+      * and assign it to this object.
+      *
+      * Note that all sample pointers referenced by @a orig are simply copied as
+      * memory address. Thus the respective samples are shared, not duplicated!
+      *
+      * @param orig - original DimensionRegion object to be copied from
+      */
+     void DimensionRegion::CopyAssign(const DimensionRegion* orig) {
+         CopyAssign(orig, NULL);
+     }
-         // even stranger GSt: two of the velocity response curves for
+     /**
-         // filter cutoff are not used, instead another special curve
+      * Make a (semi) deep copy of the DimensionRegion object given by @a orig
-         // is chosen. This curve is not used anywhere else.
+      * and assign it to this object.
-         if ((curveType == curve_type_nonlinear && depth == 0) ||
+      *
-             (curveType == curve_type_special   && depth == 4)) {
+      * @param orig - original DimensionRegion object to be copied from
-             curveType = curve_type_special;
+      * @param mSamples - crosslink map between the foreign file's samples and
-             depth = 5;
+      *                   this file's samples
+      */
+     void DimensionRegion::CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples) {
+         // delete all allocated data first
+         if (VelocityTable) delete [] VelocityTable;
+         if (pSampleLoops) delete [] pSampleLoops;
+         // backup parent list pointer
+         RIFF::List* p = pParentList;
+         gig::Sample* pOriginalSample = pSample;
+         gig::Region* pOriginalRegion = pRegion;
+         //NOTE: copy code copied from assignment constructor above, see comment there as well
+         *this = *orig; // default memberwise shallow copy of all parameters
+         pParentList = p; // restore the chunk pointer
+         // only take the raw sample reference & parent region reference if the
+         // two DimensionRegion objects are part of the same file
+         if (pOriginalRegion->GetParent()->GetParent() != orig->pRegion->GetParent()->GetParent()) {
+             pRegion = pOriginalRegion;
+             pSample = pOriginalSample;
+         }
+         if (mSamples && mSamples->count(orig->pSample)) {
+             pSample = mSamples->find(orig->pSample)->second;
+         }
+         // deep copy of owned structures
+         if (orig->VelocityTable) {
+             VelocityTable = new uint8_t[128];
+             for (int k = 0 ; k < 128 ; k++)
+                 VelocityTable[k] = orig->VelocityTable[k];
+         }
+         if (orig->pSampleLoops) {
+             pSampleLoops = new DLS::sample_loop_t[orig->SampleLoops];
+             for (int k = 0 ; k < orig->SampleLoops ; k++)
+                 pSampleLoops[k] = orig->pSampleLoops[k];
          }
-         pVelocityCutoffTable = GetVelocityTable(curveType, depth,
+     }
-                                                 VCFCutoffController <= vcf_cutoff_ctrl_none2 ? VCFVelocityScale : 0);
+     /**
+      * Updates the respective member variable and updates @c SampleAttenuation
+      * which depends on this value.
+      */
+     void DimensionRegion::SetGain(int32_t gain) {
+         DLS::Sampler::SetGain(gain);
          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
-         VelocityTable = 0;
      }
      /**
-Line 1551 
 namespace {
+Line 1763 
 namespace {
          // make sure '3ewa' chunk exists
          RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);
-         if (!_3ewa)  _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, 140);
+         if (!_3ewa) {
+             File* pFile = (File*) GetParent()->GetParent()->GetParent();
+             bool version3 = pFile->pVersion && pFile->pVersion->major == 3;
+             _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, version3 ? 148 : 140);
+         }
          pData = (uint8_t*) _3ewa->LoadChunkData();
          // update '3ewa' chunk with DimensionRegion's current settings
-Line 1598 
 namespace {
+Line 1814 
 namespace {
          pData[44] = eg1ctl;
          const uint8_t eg1ctrloptions =
-             (EG1ControllerInvert) ? 0x01 : 0x00 |
+             (EG1ControllerInvert ? 0x01 : 0x00) |
              GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG1ControllerAttackInfluence) |
              GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG1ControllerDecayInfluence) |
              GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG1ControllerReleaseInfluence);
-Line 1608 
 namespace {
+Line 1824 
 namespace {
          pData[46] = eg2ctl;
          const uint8_t eg2ctrloptions =
-             (EG2ControllerInvert) ? 0x01 : 0x00 |
+             (EG2ControllerInvert ? 0x01 : 0x00) |
              GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG2ControllerAttackInfluence) |
              GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG2ControllerDecayInfluence) |
              GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG2ControllerReleaseInfluence);
-Line 1758 
 namespace {
+Line 1974 
 namespace {
          }
          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
-                                                   : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */
+                                                   : uint16_t(((-EG3Depth) - 1) ^ 0xfff); /* binary complementary for negatives */
-         pData[116] = eg3depth;
+         store16(&pData[116], eg3depth);
          // next 2 bytes unknown
-Line 1786 
 namespace {
+Line 2002 
 namespace {
          const uint8_t eg1hold = (EG1Hold) ? 0x80 : 0x00; // bit 7
          pData[131] = eg1hold;
-         const uint8_t vcfcutoff = (VCFEnabled) ? 0x80 : 0x00 |  /* bit 7 */
+         const uint8_t vcfcutoff = (VCFEnabled ? 0x80 : 0x00) |  /* bit 7 */
                                    (VCFCutoff & 0x7f);   /* lower 7 bits */
          pData[132] = vcfcutoff;
          pData[133] = VCFCutoffController;
-         const uint8_t vcfvelscale = (VCFCutoffControllerInvert) ? 0x80 : 0x00 | /* bit 7 */
+         const uint8_t vcfvelscale = (VCFCutoffControllerInvert ? 0x80 : 0x00) | /* bit 7 */
                                      (VCFVelocityScale & 0x7f); /* lower 7 bits */
          pData[134] = vcfvelscale;
          // next byte unknown
-         const uint8_t vcfresonance = (VCFResonanceDynamic) ? 0x00 : 0x80 | /* bit 7 */
+         const uint8_t vcfresonance = (VCFResonanceDynamic ? 0x00 : 0x80) | /* bit 7 */
                                       (VCFResonance & 0x7f); /* lower 7 bits */
          pData[136] = vcfresonance;
-         const uint8_t vcfbreakpoint = (VCFKeyboardTracking) ? 0x80 : 0x00 | /* bit 7 */
+         const uint8_t vcfbreakpoint = (VCFKeyboardTracking ? 0x80 : 0x00) | /* bit 7 */
                                        (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */
          pData[137] = vcfbreakpoint;
-         const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |
+         const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 +
                                      VCFVelocityCurve * 5;
          pData[138] = vcfvelocity;
-Line 1818 
 namespace {
+Line 2034 
 namespace {
          }
      }
+     double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {
+         curve_type_t curveType = releaseVelocityResponseCurve;
+         uint8_t depth = releaseVelocityResponseDepth;
+         // this models a strange behaviour or bug in GSt: two of the
+         // velocity response curves for release time are not used even
+         // if specified, instead another curve is chosen.
+         if ((curveType == curve_type_nonlinear && depth == 0) ||
+             (curveType == curve_type_special   && depth == 4)) {
+             curveType = curve_type_nonlinear;
+             depth = 3;
+         }
+         return GetVelocityTable(curveType, depth, 0);
+     }
+     double* DimensionRegion::GetCutoffVelocityTable(curve_type_t vcfVelocityCurve,
+                                                     uint8_t vcfVelocityDynamicRange,
+                                                     uint8_t vcfVelocityScale,
+                                                     vcf_cutoff_ctrl_t vcfCutoffController)
+     {
+         curve_type_t curveType = vcfVelocityCurve;
+         uint8_t depth = vcfVelocityDynamicRange;
+         // even stranger GSt: two of the velocity response curves for
+         // filter cutoff are not used, instead another special curve
+         // is chosen. This curve is not used anywhere else.
+         if ((curveType == curve_type_nonlinear && depth == 0) ||
+             (curveType == curve_type_special   && depth == 4)) {
+             curveType = curve_type_special;
+             depth = 5;
+         }
+         return GetVelocityTable(curveType, depth,
+                                 (vcfCutoffController <= vcf_cutoff_ctrl_none2)
+                                     ? vcfVelocityScale : 0);
+     }
      // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet
      double* DimensionRegion::GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling)
      {
-Line 1833 
 namespace {
+Line 2083 
 namespace {
          return table;
      }
+     Region* DimensionRegion::GetParent() const {
+         return pRegion;
+     }
      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {
          leverage_ctrl_t decodedcontroller;
          switch (EncodedController) {
-Line 2086 
 namespace {
+Line 2340 
 namespace {
          return pVelocityCutoffTable[MIDIKeyVelocity];
      }
+     /**
+      * Updates the respective member variable and the lookup table / cache
+      * that depends on this value.
+      */
+     void DimensionRegion::SetVelocityResponseCurve(curve_type_t curve) {
+         pVelocityAttenuationTable =
+             GetVelocityTable(
+                 curve, VelocityResponseDepth, VelocityResponseCurveScaling
+             );
+         VelocityResponseCurve = curve;
+     }
+     /**
+      * Updates the respective member variable and the lookup table / cache
+      * that depends on this value.
+      */
+     void DimensionRegion::SetVelocityResponseDepth(uint8_t depth) {
+         pVelocityAttenuationTable =
+             GetVelocityTable(
+                 VelocityResponseCurve, depth, VelocityResponseCurveScaling
+             );
+         VelocityResponseDepth = depth;
+     }
+     /**
+      * Updates the respective member variable and the lookup table / cache
+      * that depends on this value.
+      */
+     void DimensionRegion::SetVelocityResponseCurveScaling(uint8_t scaling) {
+         pVelocityAttenuationTable =
+             GetVelocityTable(
+                 VelocityResponseCurve, VelocityResponseDepth, scaling
+             );
+         VelocityResponseCurveScaling = scaling;
+     }
+     /**
+      * Updates the respective member variable and the lookup table / cache
+      * that depends on this value.
+      */
+     void DimensionRegion::SetReleaseVelocityResponseCurve(curve_type_t curve) {
+         pVelocityReleaseTable = GetReleaseVelocityTable(curve, ReleaseVelocityResponseDepth);
+         ReleaseVelocityResponseCurve = curve;
+     }
+     /**
+      * Updates the respective member variable and the lookup table / cache
+      * that depends on this value.
+      */
+     void DimensionRegion::SetReleaseVelocityResponseDepth(uint8_t depth) {
+         pVelocityReleaseTable = GetReleaseVelocityTable(ReleaseVelocityResponseCurve, depth);
+         ReleaseVelocityResponseDepth = depth;
+     }
+     /**
+      * Updates the respective member variable and the lookup table / cache
+      * that depends on this value.
+      */
+     void DimensionRegion::SetVCFCutoffController(vcf_cutoff_ctrl_t controller) {
+         pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, VCFVelocityDynamicRange, VCFVelocityScale, controller);
+         VCFCutoffController = controller;
+     }
+     /**
+      * Updates the respective member variable and the lookup table / cache
+      * that depends on this value.
+      */
+     void DimensionRegion::SetVCFVelocityCurve(curve_type_t curve) {
+         pVelocityCutoffTable = GetCutoffVelocityTable(curve, VCFVelocityDynamicRange, VCFVelocityScale, VCFCutoffController);
+         VCFVelocityCurve = curve;
+     }
+     /**
+      * Updates the respective member variable and the lookup table / cache
+      * that depends on this value.
+      */
+     void DimensionRegion::SetVCFVelocityDynamicRange(uint8_t range) {
+         pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, range, VCFVelocityScale, VCFCutoffController);
+         VCFVelocityDynamicRange = range;
+     }
+     /**
+      * Updates the respective member variable and the lookup table / cache
+      * that depends on this value.
+      */
+     void DimensionRegion::SetVCFVelocityScale(uint8_t scaling) {
+         pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, VCFVelocityDynamicRange, scaling, VCFCutoffController);
+         VCFVelocityScale = scaling;
+     }
      double* DimensionRegion::CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling) {
          // line-segment approximations of the 15 velocity curves
-Line 2169 
 namespace {
+Line 2513 
 namespace {
          // Actual Loading
+         if (!file->GetAutoLoad()) return;
          LoadDimensionRegions(rgnList);
          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);
-Line 2212 
 namespace {
+Line 2558 
 namespace {
              else
                  _3lnk->SetPos(44);
-             // load sample references
+             // load sample references (if auto loading is enabled)
-             for (uint i = 0; i < DimensionRegions; i++) {
+             if (file->GetAutoLoad()) {
-                 uint32_t wavepoolindex = _3lnk->ReadUint32();
+                 for (uint i = 0; i < DimensionRegions; i++) {
-                 if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
+                     uint32_t wavepoolindex = _3lnk->ReadUint32();
+                     if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
+                 }
+                 GetSample(); // load global region sample reference
              }
-             GetSample(); // load global region sample reference
          } else {
              DimensionRegions = 0;
              for (int i = 0 ; i < 8 ; i++) {
-Line 2232 
 namespace {
+Line 2580 
 namespace {
              RIFF::List* _3prg = rgnList->GetSubList(LIST_TYPE_3PRG);
              if (!_3prg) _3prg = rgnList->AddSubList(LIST_TYPE_3PRG);
              RIFF::List* _3ewl = _3prg->AddSubList(LIST_TYPE_3EWL);
-             pDimensionRegions[0] = new DimensionRegion(_3ewl);
+             pDimensionRegions[0] = new DimensionRegion(this, _3ewl);
              DimensionRegions = 1;
          }
      }
-Line 2256 
 namespace {
+Line 2604 
 namespace {
          // first update base class's chunks
          DLS::Region::UpdateChunks();
-         File* pFile = (File*) GetParent()->GetParent();
-         bool version3 = pFile->pVersion && pFile->pVersion->major == 3;
          // update dimension region's chunks
          for (int i = 0; i < DimensionRegions; i++) {
-             DimensionRegion* d = pDimensionRegions[i];
+             pDimensionRegions[i]->UpdateChunks();
-             // make sure '3ewa' chunk exists (we need to this before
-             // calling DimensionRegion::UpdateChunks, as
-             // DimensionRegion doesn't know which file version it is)
-             RIFF::Chunk* _3ewa = d->pParentList->GetSubChunk(CHUNK_ID_3EWA);
-             if (!_3ewa) d->pParentList->AddSubChunk(CHUNK_ID_3EWA, version3 ? 148 : 140);
-             d->UpdateChunks();
          }
+         File* pFile = (File*) GetParent()->GetParent();
+         bool version3 = pFile->pVersion && pFile->pVersion->major == 3;
          const int iMaxDimensions =  version3 ? 8 : 5;
          const int iMaxDimensionRegions = version3 ? 256 : 32;
-Line 2293 
 namespace {
+Line 2632 
 namespace {
          for (int i = 0; i < iMaxDimensions; i++) {
              pData[4 + i * 8] = (uint8_t) pDimensionDefinitions[i].dimension;
              pData[5 + i * 8] = pDimensionDefinitions[i].bits;
-             pData[6 + i * 8] = shift;
+             pData[6 + i * 8] = pDimensionDefinitions[i].dimension == dimension_none ? 0 : shift;
              pData[7 + i * 8] = (1 << (shift + pDimensionDefinitions[i].bits)) - (1 << shift);
              pData[8 + i * 8] = pDimensionDefinitions[i].zones;
              // next 3 bytes unknown, always zero?
-Line 2315 
 namespace {
+Line 2654 
 namespace {
                          break;
                      }
                  }
-                 if (iWaveIndex < 0) throw gig::Exception("Could not update gig::Region, could not find DimensionRegion's sample");
              }
              store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);
          }
-Line 2328 
 namespace {
+Line 2666 
 namespace {
              RIFF::List* _3ewl = _3prg->GetFirstSubList();
              while (_3ewl) {
                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {
-                     pDimensionRegions[dimensionRegionNr] = new DimensionRegion(_3ewl);
+                     pDimensionRegions[dimensionRegionNr] = new DimensionRegion(this, _3ewl);
                      dimensionRegionNr++;
                  }
                  _3ewl = _3prg->GetNextSubList();
-Line 2337 
 namespace {
+Line 2675 
 namespace {
          }
      }
+     void Region::SetKeyRange(uint16_t Low, uint16_t High) {
+         // update KeyRange struct and make sure regions are in correct order
+         DLS::Region::SetKeyRange(Low, High);
+         // update Region key table for fast lookup
+         ((gig::Instrument*)GetParent())->UpdateRegionKeyTable();
+     }
      void Region::UpdateVelocityTable() {
          // get velocity dimension's index
          int veldim = -1;
-Line 2442 
 namespace {
+Line 2787 
 namespace {
              if (pDimensionDefinitions[i].dimension == pDimDef->dimension)
                  throw gig::Exception("Could not add new dimension, there is already a dimension of the same type");
+         // pos is where the new dimension should be placed, normally
+         // last in list, except for the samplechannel dimension which
+         // has to be first in list
+         int pos = pDimDef->dimension == dimension_samplechannel ? 0 : Dimensions;
+         int bitpos = 0;
+         for (int i = 0 ; i < pos ; i++)
+             bitpos += pDimensionDefinitions[i].bits;
+         // make room for the new dimension
+         for (int i = Dimensions ; i > pos ; i--) pDimensionDefinitions[i] = pDimensionDefinitions[i - 1];
+         for (int i = 0 ; i < (1 << iCurrentBits) ; i++) {
+             for (int j = Dimensions ; j > pos ; j--) {
+                 pDimensionRegions[i]->DimensionUpperLimits[j] =
+                     pDimensionRegions[i]->DimensionUpperLimits[j - 1];
+             }
+         }
          // assign definition of new dimension
-         pDimensionDefinitions[Dimensions] = *pDimDef;
+         pDimensionDefinitions[pos] = *pDimDef;
          // auto correct certain dimension definition fields (where possible)
-         pDimensionDefinitions[Dimensions].split_type  =
+         pDimensionDefinitions[pos].split_type  =
-             __resolveSplitType(pDimensionDefinitions[Dimensions].dimension);
+             __resolveSplitType(pDimensionDefinitions[pos].dimension);
-         pDimensionDefinitions[Dimensions].zone_size =
+         pDimensionDefinitions[pos].zone_size =
-             __resolveZoneSize(pDimensionDefinitions[Dimensions]);
+             __resolveZoneSize(pDimensionDefinitions[pos]);
-         // create new dimension region(s) for this new dimension
+         // create new dimension region(s) for this new dimension, and make
-         for (int i = 1 << iCurrentBits; i < 1 << iNewBits; i++) {
+         // sure that the dimension regions are placed correctly in both the
-             //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
-             RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
+         RIFF::Chunk* moveTo = NULL;
-             RIFF::List* pNewDimRgnListChunk = _3prg->AddSubList(LIST_TYPE_3EWL);
+         RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
-             pDimensionRegions[i] = new DimensionRegion(pNewDimRgnListChunk);
+         for (int i = (1 << iCurrentBits) - (1 << bitpos) ; i >= 0 ; i -= (1 << bitpos)) {
+             for (int k = 0 ; k < (1 << bitpos) ; k++) {
-             // copy the upper limits for the other dimensions
+                 pDimensionRegions[(i << pDimDef->bits) + k] = pDimensionRegions[i + k];
-             memcpy(pDimensionRegions[i]->DimensionUpperLimits,
+             }
-                    pDimensionRegions[i & ((1 << iCurrentBits) - 1)]->DimensionUpperLimits, 8);
+             for (int j = 1 ; j < (1 << pDimDef->bits) ; j++) {
+                 for (int k = 0 ; k < (1 << bitpos) ; k++) {
+                     RIFF::List* pNewDimRgnListChunk = _3prg->AddSubList(LIST_TYPE_3EWL);
+                     if (moveTo) _3prg->MoveSubChunk(pNewDimRgnListChunk, moveTo);
+                     // create a new dimension region and copy all parameter values from
+                     // an existing dimension region
+                     pDimensionRegions[(i << pDimDef->bits) + (j << bitpos) + k] =
+                         new DimensionRegion(pNewDimRgnListChunk, *pDimensionRegions[i + k]);
-             DimensionRegions++;
+                     DimensionRegions++;
+                 }
+             }
+             moveTo = pDimensionRegions[i]->pParentList;
          }
          // initialize the upper limits for this dimension
-         for (int z = 0, j = 0 ; z < pDimDef->zones ; z++, j += 1 << iCurrentBits) {
+         int mask = (1 << bitpos) - 1;
-             uint8_t upperLimit = (z + 1) * 128.0 / pDimDef->zones - 1;
+         for (int z = 0 ; z < pDimDef->zones ; z++) {
+             uint8_t upperLimit = uint8_t((z + 1) * 128.0 / pDimDef->zones - 1);
              for (int i = 0 ; i < 1 << iCurrentBits ; i++) {
-                 pDimensionRegions[j + i]->DimensionUpperLimits[Dimensions] = upperLimit;
+                 pDimensionRegions[((i & ~mask) << pDimDef->bits) |
+                                   (z << bitpos) |
+                                   (i & mask)]->DimensionUpperLimits[pos] = upperLimit;
              }
          }
-Line 2687 
 namespace {
+Line 3062 
 namespace {
          }
          return NULL;
      }
+     /**
+      * Make a (semi) deep copy of the Region object given by @a orig
+      * and assign it to this object.
+      *
+      * Note that all sample pointers referenced by @a orig are simply copied as
+      * memory address. Thus the respective samples are shared, not duplicated!
+      *
+      * @param orig - original Region object to be copied from
+      */
+     void Region::CopyAssign(const Region* orig) {
+         CopyAssign(orig, NULL);
+     }
+     /**
+      * Make a (semi) deep copy of the Region object given by @a orig and
+      * assign it to this object
+      *
+      * @param mSamples - crosslink map between the foreign file's samples and
+      *                   this file's samples
+      */
+     void Region::CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples) {
+         // handle base classes
+         DLS::Region::CopyAssign(orig);
+         if (mSamples && mSamples->count((gig::Sample*)orig->pSample)) {
+             pSample = mSamples->find((gig::Sample*)orig->pSample)->second;
+         }
+         // handle own member variables
+         for (int i = Dimensions - 1; i >= 0; --i) {
+             DeleteDimension(&pDimensionDefinitions[i]);
+         }
+         Layers = 0; // just to be sure
+         for (int i = 0; i < orig->Dimensions; i++) {
+             // we need to copy the dim definition here, to avoid the compiler
+             // complaining about const-ness issue
+             dimension_def_t def = orig->pDimensionDefinitions[i];
+             AddDimension(&def);
+         }
+         for (int i = 0; i < 256; i++) {
+             if (pDimensionRegions[i] && orig->pDimensionRegions[i]) {
+                 pDimensionRegions[i]->CopyAssign(
+                     orig->pDimensionRegions[i],
+                     mSamples
+                 );
+             }
+         }
+         Layers = orig->Layers;
+     }
+ // *************** MidiRule ***************
+ // *
+     MidiRuleCtrlTrigger::MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg) {
+         _3ewg->SetPos(36);
+         Triggers = _3ewg->ReadUint8();
+         _3ewg->SetPos(40);
+         ControllerNumber = _3ewg->ReadUint8();
+         _3ewg->SetPos(46);
+         for (int i = 0 ; i < Triggers ; i++) {
+             pTriggers[i].TriggerPoint = _3ewg->ReadUint8();
+             pTriggers[i].Descending = _3ewg->ReadUint8();
+             pTriggers[i].VelSensitivity = _3ewg->ReadUint8();
+             pTriggers[i].Key = _3ewg->ReadUint8();
+             pTriggers[i].NoteOff = _3ewg->ReadUint8();
+             pTriggers[i].Velocity = _3ewg->ReadUint8();
+             pTriggers[i].OverridePedal = _3ewg->ReadUint8();
+             _3ewg->ReadUint8();
+         }
+     }
+     MidiRuleCtrlTrigger::MidiRuleCtrlTrigger() :
+         ControllerNumber(0),
+         Triggers(0) {
+     }
+     void MidiRuleCtrlTrigger::UpdateChunks(uint8_t* pData) const {
+         pData[32] = 4;
+         pData[33] = 16;
+         pData[36] = Triggers;
+         pData[40] = ControllerNumber;
+         for (int i = 0 ; i < Triggers ; i++) {
+             pData[46 + i * 8] = pTriggers[i].TriggerPoint;
+             pData[47 + i * 8] = pTriggers[i].Descending;
+             pData[48 + i * 8] = pTriggers[i].VelSensitivity;
+             pData[49 + i * 8] = pTriggers[i].Key;
+             pData[50 + i * 8] = pTriggers[i].NoteOff;
+             pData[51 + i * 8] = pTriggers[i].Velocity;
+             pData[52 + i * 8] = pTriggers[i].OverridePedal;
+         }
+     }
+     MidiRuleLegato::MidiRuleLegato(RIFF::Chunk* _3ewg) {
+         _3ewg->SetPos(36);
+         LegatoSamples = _3ewg->ReadUint8(); // always 12
+         _3ewg->SetPos(40);
+         BypassUseController = _3ewg->ReadUint8();
+         BypassKey = _3ewg->ReadUint8();
+         BypassController = _3ewg->ReadUint8();
+         ThresholdTime = _3ewg->ReadUint16();
+         _3ewg->ReadInt16();
+         ReleaseTime = _3ewg->ReadUint16();
+         _3ewg->ReadInt16();
+         KeyRange.low = _3ewg->ReadUint8();
+         KeyRange.high = _3ewg->ReadUint8();
+         _3ewg->SetPos(64);
+         ReleaseTriggerKey = _3ewg->ReadUint8();
+         AltSustain1Key = _3ewg->ReadUint8();
+         AltSustain2Key = _3ewg->ReadUint8();
+     }
+     MidiRuleLegato::MidiRuleLegato() :
+         LegatoSamples(12),
+         BypassUseController(false),
+         BypassKey(0),
+         BypassController(1),
+         ThresholdTime(20),
+         ReleaseTime(20),
+         ReleaseTriggerKey(0),
+         AltSustain1Key(0),
+         AltSustain2Key(0)
+     {
+         KeyRange.low = KeyRange.high = 0;
+     }
+     void MidiRuleLegato::UpdateChunks(uint8_t* pData) const {
+         pData[32] = 0;
+         pData[33] = 16;
+         pData[36] = LegatoSamples;
+         pData[40] = BypassUseController;
+         pData[41] = BypassKey;
+         pData[42] = BypassController;
+         store16(&pData[43], ThresholdTime);
+         store16(&pData[47], ReleaseTime);
+         pData[51] = KeyRange.low;
+         pData[52] = KeyRange.high;
+         pData[64] = ReleaseTriggerKey;
+         pData[65] = AltSustain1Key;
+         pData[66] = AltSustain2Key;
+     }
+     MidiRuleAlternator::MidiRuleAlternator(RIFF::Chunk* _3ewg) {
+         _3ewg->SetPos(36);
+         Articulations = _3ewg->ReadUint8();
+         int flags = _3ewg->ReadUint8();
+         Polyphonic = flags & 8;
+         Chained = flags & 4;
+         Selector = (flags & 2) ? selector_controller :
+             (flags & 1) ? selector_key_switch : selector_none;
+         Patterns = _3ewg->ReadUint8();
+         _3ewg->ReadUint8(); // chosen row
+         _3ewg->ReadUint8(); // unknown
+         _3ewg->ReadUint8(); // unknown
+         _3ewg->ReadUint8(); // unknown
+         KeySwitchRange.low = _3ewg->ReadUint8();
+         KeySwitchRange.high = _3ewg->ReadUint8();
+         Controller = _3ewg->ReadUint8();
+         PlayRange.low = _3ewg->ReadUint8();
+         PlayRange.high = _3ewg->ReadUint8();
+         int n = std::min(int(Articulations), 32);
+         for (int i = 0 ; i < n ; i++) {
+             _3ewg->ReadString(pArticulations[i], 32);
+         }
+         _3ewg->SetPos(1072);
+         n = std::min(int(Patterns), 32);
+         for (int i = 0 ; i < n ; i++) {
+             _3ewg->ReadString(pPatterns[i].Name, 16);
+             pPatterns[i].Size = _3ewg->ReadUint8();
+             _3ewg->Read(&pPatterns[i][0], 1, 32);
+         }
+     }
+     MidiRuleAlternator::MidiRuleAlternator() :
+         Articulations(0),
+         Patterns(0),
+         Selector(selector_none),
+         Controller(0),
+         Polyphonic(false),
+         Chained(false)
+     {
+         PlayRange.low = PlayRange.high = 0;
+         KeySwitchRange.low = KeySwitchRange.high = 0;
+     }
+     void MidiRuleAlternator::UpdateChunks(uint8_t* pData) const {
+         pData[32] = 3;
+         pData[33] = 16;
+         pData[36] = Articulations;
+         pData[37] = (Polyphonic ? 8 : 0) | (Chained ? 4 : 0) |
+             (Selector == selector_controller ? 2 :
+              (Selector == selector_key_switch ? 1 : 0));
+         pData[38] = Patterns;
+         pData[43] = KeySwitchRange.low;
+         pData[44] = KeySwitchRange.high;
+         pData[45] = Controller;
+         pData[46] = PlayRange.low;
+         pData[47] = PlayRange.high;
+         char* str = reinterpret_cast<char*>(pData);
+         int pos = 48;
+         int n = std::min(int(Articulations), 32);
+         for (int i = 0 ; i < n ; i++, pos += 32) {
+             strncpy(&str[pos], pArticulations[i].c_str(), 32);
+         }
+         pos = 1072;
+         n = std::min(int(Patterns), 32);
+         for (int i = 0 ; i < n ; i++, pos += 49) {
+             strncpy(&str[pos], pPatterns[i].Name.c_str(), 16);
+             pData[pos + 16] = pPatterns[i].Size;
+             memcpy(&pData[pos + 16], &(pPatterns[i][0]), 32);
+         }
+     }
  // *************** Instrument ***************
  // *
      Instrument::Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress) : DLS::Instrument((DLS::File*)pFile, insList) {
-         static const DLS::Info::FixedStringLength fixedStringLengths[] = {
+         static const DLS::Info::string_length_t fixedStringLengths[] = {
              { CHUNK_ID_INAM, 64 },
              { CHUNK_ID_ISFT, 12 },
              { 0, 0 }
          };
-         pInfo->FixedStringLengths = fixedStringLengths;
+         pInfo->SetFixedStringLengths(fixedStringLengths);
          // Initialization
          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
-Line 2710 
 namespace {
+Line 3300 
 namespace {
          PianoReleaseMode = false;
          DimensionKeyRange.low = 0;
          DimensionKeyRange.high = 0;
+         pMidiRules = new MidiRule*[3];
+         pMidiRules[0] = NULL;
          // Loading
          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
-Line 2724 
 namespace {
+Line 3316 
 namespace {
                  PianoReleaseMode       = dimkeystart & 0x01;
                  DimensionKeyRange.low  = dimkeystart >> 1;
                  DimensionKeyRange.high = _3ewg->ReadUint8();
+                 if (_3ewg->GetSize() > 32) {
+                     // read MIDI rules
+                     int i = 0;
+                     _3ewg->SetPos(32);
+                     uint8_t id1 = _3ewg->ReadUint8();
+                     uint8_t id2 = _3ewg->ReadUint8();
+                     if (id2 == 16) {
+                         if (id1 == 4) {
+                             pMidiRules[i++] = new MidiRuleCtrlTrigger(_3ewg);
+                         } else if (id1 == 0) {
+                             pMidiRules[i++] = new MidiRuleLegato(_3ewg);
+                         } else if (id1 == 3) {
+                             pMidiRules[i++] = new MidiRuleAlternator(_3ewg);
+                         } else {
+                             pMidiRules[i++] = new MidiRuleUnknown;
+                         }
+                     }
+                     else if (id1 != 0 || id2 != 0) {
+                         pMidiRules[i++] = new MidiRuleUnknown;
+                     }
+                     //TODO: all the other types of rules
+                     pMidiRules[i] = NULL;
+                 }
              }
          }
-         if (!pRegions) pRegions = new RegionList;
+         if (pFile->GetAutoLoad()) {
-         RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
+             if (!pRegions) pRegions = new RegionList;
-         if (lrgn) {
+             RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
-             RIFF::List* rgn = lrgn->GetFirstSubList();
+             if (lrgn) {
-             while (rgn) {
+                 RIFF::List* rgn = lrgn->GetFirstSubList();
-                 if (rgn->GetListType() == LIST_TYPE_RGN) {
+                 while (rgn) {
-                     __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
+                     if (rgn->GetListType() == LIST_TYPE_RGN) {
-                     pRegions->push_back(new Region(this, rgn));
+                         __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
+                         pRegions->push_back(new Region(this, rgn));
+                     }
+                     rgn = lrgn->GetNextSubList();
                  }
-                 rgn = lrgn->GetNextSubList();
+                 // Creating Region Key Table for fast lookup
+                 UpdateRegionKeyTable();
              }
-             // Creating Region Key Table for fast lookup
-             UpdateRegionKeyTable();
          }
          __notify_progress(pProgress, 1.0f); // notify done
      }
      void Instrument::UpdateRegionKeyTable() {
+         for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
          RegionList::iterator iter = pRegions->begin();
          RegionList::iterator end  = pRegions->end();
          for (; iter != end; ++iter) {
-Line 2757 
 namespace {
+Line 3378 
 namespace {
      }
      Instrument::~Instrument() {
+         for (int i = 0 ; pMidiRules[i] ; i++) {
+             delete pMidiRules[i];
+         }
+         delete[] pMidiRules;
      }
      /**
-Line 2785 
 namespace {
+Line 3410 
 namespace {
          if (!lart)  lart = pCkInstrument->AddSubList(LIST_TYPE_LART);
          // make sure '3ewg' RIFF chunk exists
          RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
-         if (!_3ewg)  _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, 12);
+         if (!_3ewg)  {
+             File* pFile = (File*) GetParent();
+             // 3ewg is bigger in gig3, as it includes the iMIDI rules
+             int size = (pFile->pVersion && pFile->pVersion->major == 3) ? 16416 : 12;
+             _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);
+             memset(_3ewg->LoadChunkData(), 0, size);
+         }
          // update '3ewg' RIFF chunk
          uint8_t* pData = (uint8_t*) _3ewg->LoadChunkData();
          store16(&pData[0], EffectSend);
          store32(&pData[2], Attenuation);
          store16(&pData[6], FineTune);
          store16(&pData[8], PitchbendRange);
-         const uint8_t dimkeystart = (PianoReleaseMode) ? 0x01 : 0x00 |
+         const uint8_t dimkeystart = (PianoReleaseMode ? 0x01 : 0x00) |
                                      DimensionKeyRange.low << 1;
          pData[10] = dimkeystart;
          pData[11] = DimensionKeyRange.high;
+         if (pMidiRules[0] == 0 && _3ewg->GetSize() >= 34) {
+             pData[32] = 0;
+             pData[33] = 0;
+         } else {
+             for (int i = 0 ; pMidiRules[i] ; i++) {
+                 pMidiRules[i]->UpdateChunks(pData);
+             }
+         }
      }
      /**
-Line 2806 
 namespace {
+Line 3447 
 namespace {
       *             there is no Region defined for the given \a Key
       */
      Region* Instrument::GetRegion(unsigned int Key) {
-         if (!pRegions || !pRegions->size() || Key > 127) return NULL;
+         if (!pRegions || pRegions->empty() || Key > 127) return NULL;
          return RegionKeyTable[Key];
          /*for (int i = 0; i < Regions; i++) {
-Line 2864 
 namespace {
+Line 3505 
 namespace {
          UpdateRegionKeyTable();
      }
+     /**
+      * Returns a MIDI rule of the instrument.
+      *
+      * The list of MIDI rules, at least in gig v3, always contains at
+      * most two rules. The second rule can only be the DEF filter
+      * (which currently isn't supported by libgig).
+      *
+      * @param i - MIDI rule number
+      * @returns   pointer address to MIDI rule number i or NULL if there is none
+      */
+     MidiRule* Instrument::GetMidiRule(int i) {
+         return pMidiRules[i];
+     }
+     /**
+      * Adds the "controller trigger" MIDI rule to the instrument.
+      *
+      * @returns the new MIDI rule
+      */
+     MidiRuleCtrlTrigger* Instrument::AddMidiRuleCtrlTrigger() {
+         delete pMidiRules[0];
+         MidiRuleCtrlTrigger* r = new MidiRuleCtrlTrigger;
+         pMidiRules[0] = r;
+         pMidiRules[1] = 0;
+         return r;
+     }
+     /**
+      * Adds the legato MIDI rule to the instrument.
+      *
+      * @returns the new MIDI rule
+      */
+     MidiRuleLegato* Instrument::AddMidiRuleLegato() {
+         delete pMidiRules[0];
+         MidiRuleLegato* r = new MidiRuleLegato;
+         pMidiRules[0] = r;
+         pMidiRules[1] = 0;
+         return r;
+     }
+     /**
+      * Adds the alternator MIDI rule to the instrument.
+      *
+      * @returns the new MIDI rule
+      */
+     MidiRuleAlternator* Instrument::AddMidiRuleAlternator() {
+         delete pMidiRules[0];
+         MidiRuleAlternator* r = new MidiRuleAlternator;
+         pMidiRules[0] = r;
+         pMidiRules[1] = 0;
+         return r;
+     }
+     /**
+      * Deletes a MIDI rule from the instrument.
+      *
+      * @param i - MIDI rule number
+      */
+     void Instrument::DeleteMidiRule(int i) {
+         delete pMidiRules[i];
+         pMidiRules[i] = 0;
+     }
+     /**
+      * Make a (semi) deep copy of the Instrument object given by @a orig
+      * and assign it to this object.
+      *
+      * Note that all sample pointers referenced by @a orig are simply copied as
+      * memory address. Thus the respective samples are shared, not duplicated!
+      *
+      * @param orig - original Instrument object to be copied from
+      */
+     void Instrument::CopyAssign(const Instrument* orig) {
+         CopyAssign(orig, NULL);
+     }
+     /**
+      * Make a (semi) deep copy of the Instrument object given by @a orig
+      * and assign it to this object.
+      *
+      * @param orig - original Instrument object to be copied from
+      * @param mSamples - crosslink map between the foreign file's samples and
+      *                   this file's samples
+      */
+     void Instrument::CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples) {
+         // handle base class
+         // (without copying DLS region stuff)
+         DLS::Instrument::CopyAssignCore(orig);
+         // handle own member variables
+         Attenuation = orig->Attenuation;
+         EffectSend = orig->EffectSend;
+         FineTune = orig->FineTune;
+         PitchbendRange = orig->PitchbendRange;
+         PianoReleaseMode = orig->PianoReleaseMode;
+         DimensionKeyRange = orig->DimensionKeyRange;
+         // free old midi rules
+         for (int i = 0 ; pMidiRules[i] ; i++) {
+             delete pMidiRules[i];
+         }
+         //TODO: MIDI rule copying
+         pMidiRules[0] = NULL;
+         // delete all old regions
+         while (Regions) DeleteRegion(GetFirstRegion());
+         // create new regions and copy them from original
+         {
+             RegionList::const_iterator it = orig->pRegions->begin();
+             for (int i = 0; i < orig->Regions; ++i, ++it) {
+                 Region* dstRgn = AddRegion();
+                 //NOTE: Region does semi-deep copy !
+                 dstRgn->CopyAssign(
+                     static_cast<gig::Region*>(*it),
+                     mSamples
+                 );
+             }
+         }
+         UpdateRegionKeyTable();
+     }
  // *************** Group ***************
-Line 2903 
 namespace {
+Line 3665 
 namespace {
          }
          RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
          if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
+         if (!pNameChunk && pFile->pVersion && pFile->pVersion->major == 3) {
+             // v3 has a fixed list of 128 strings, find a free one
+             for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {
+                 if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {
+                     pNameChunk = ck;
+                     break;
+                 }
+             }
+         }
          // now store the name of this group as <3gnm> chunk as subchunk of the <3gnl> list chunk
          ::SaveString(CHUNK_ID_3GNM, pNameChunk, _3gnl, Name, String("Unnamed Group"), true, 64);
      }
-Line 2978 
 namespace {
+Line 3751 
 namespace {
  // *************** File ***************
  // *
-     // File version 2.0, 1998-06-28
+     /// Reflects Gigasampler file format version 2.0 (1998-06-28).
      const DLS::version_t File::VERSION_2 = {
 , 2, 19980628 & 0xffff, 19980628 >> 16
      };
-     // File version 3.0, 2003-03-31
+     /// Reflects Gigasampler file format version 3.0 (2003-03-31).
      const DLS::version_t File::VERSION_3 = {
 , 3, 20030331 & 0xffff, 20030331 >> 16
      };
-     const DLS::Info::FixedStringLength File::FixedStringLengths[] = {
+     static const DLS::Info::string_length_t _FileFixedStringLengths[] = {
          { CHUNK_ID_IARL, 256 },
          { CHUNK_ID_IART, 128 },
          { CHUNK_ID_ICMS, 128 },
-Line 3010 
 namespace {
+Line 3783 
 namespace {
      };
      File::File() : DLS::File() {
+         bAutoLoad = true;
+         *pVersion = VERSION_3;
          pGroups = NULL;
-         pInfo->FixedStringLengths = FixedStringLengths;
+         pInfo->SetFixedStringLengths(_FileFixedStringLengths);
          pInfo->ArchivalLocation = String(256, ' ');
          // add some mandatory chunks to get the file chunks in right
-Line 3024 
 namespace {
+Line 3799 
 namespace {
      }
      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
+         bAutoLoad = true;
          pGroups = NULL;
-         pInfo->FixedStringLengths = FixedStringLengths;
+         pInfo->SetFixedStringLengths(_FileFixedStringLengths);
      }
      File::~File() {
-Line 3052 
 namespace {
+Line 3828 
 namespace {
          SamplesIterator++;
          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
      }
+     /**
+      * Returns Sample object of @a index.
+      *
+      * @returns sample object or NULL if index is out of bounds
+      */
+     Sample* File::GetSample(uint index) {
+         if (!pSamples) LoadSamples();
+         if (!pSamples) return NULL;
+         DLS::File::SampleList::iterator it = pSamples->begin();
+         for (int i = 0; i < index; ++i) {
+             ++it;
+             if (it == pSamples->end()) return NULL;
+         }
+         if (it == pSamples->end()) return NULL;
+         return static_cast<gig::Sample*>( *it );
+     }
      /** @brief Add a new sample.
       *
-Line 3078 
 namespace {
+Line 3871 
 namespace {
      /** @brief Delete a sample.
       *
-      * 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
-      * to call Save() to make this persistent to the file.
+      * references to this sample from Regions and DimensionRegions will be
+      * removed. You have to call Save() to make this persistent to the file.
       *
       * @param pSample - sample to delete
       * @throws gig::Exception if given sample could not be found
-Line 3091 
 namespace {
+Line 3885 
 namespace {
          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
          pSamples->erase(iter);
          delete pSample;
+         SampleList::iterator tmp = SamplesIterator;
+         // remove all references to the sample
+         for (Instrument* instrument = GetFirstInstrument() ; instrument ;
+              instrument = GetNextInstrument()) {
+             for (Region* region = instrument->GetFirstRegion() ; region ;
+                  region = instrument->GetNextRegion()) {
+                 if (region->GetSample() == pSample) region->SetSample(NULL);
+                 for (int i = 0 ; i < region->DimensionRegions ; i++) {
+                     gig::DimensionRegion *d = region->pDimensionRegions[i];
+                     if (d->pSample == pSample) d->pSample = NULL;
+                 }
+             }
+         }
+         SamplesIterator = tmp; // restore iterator
      }
      void File::LoadSamples() {
-Line 3181 
 namespace {
+Line 3992 
 namespace {
              progress_t subprogress;
              __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
              __notify_progress(&subprogress, 0.0f);
-             GetFirstSample(&subprogress); // now force all samples to be loaded
+             if (GetAutoLoad())
+                 GetFirstSample(&subprogress); // now force all samples to be loaded
              __notify_progress(&subprogress, 1.0f);
              // instrument loading subtask
-Line 3230 
 namespace {
+Line 4042 
 namespace {
         pInstruments->push_back(pInstrument);
         return pInstrument;
      }
+     /** @brief Add a duplicate of an existing instrument.
+      *
+      * Duplicates the instrument definition given by @a orig and adds it
+      * to this file. This allows in an instrument editor application to
+      * easily create variations of an instrument, which will be stored in
+      * the same .gig file, sharing i.e. the same samples.
+      *
+      * Note that all sample pointers referenced by @a orig are simply copied as
+      * memory address. Thus the respective samples are shared, not duplicated!
+      *
+      * You have to call Save() to make this persistent to the file.
+      *
+      * @param orig - original instrument to be copied
+      * @returns duplicated copy of the given instrument
+      */
+     Instrument* File::AddDuplicateInstrument(const Instrument* orig) {
+         Instrument* instr = AddInstrument();
+         instr->CopyAssign(orig);
+         return instr;
+     }
+     /** @brief Add content of another existing file.
+      *
+      * Duplicates the samples, groups and instruments of the original file
+      * given by @a pFile and adds them to @c this File. In case @c this File is
+      * a new one that you haven't saved before, then you have to call
+      * SetFileName() before calling AddContentOf(), because this method will
+      * automatically save this file during operation, which is required for
+      * writing the sample waveform data by disk streaming.
+      *
+      * @param pFile - original file whose's content shall be copied from
+      */
+     void File::AddContentOf(File* pFile) {
+         static int iCallCount = -1;
+         iCallCount++;
+         std::map<Group*,Group*> mGroups;
+         std::map<Sample*,Sample*> mSamples;
+         // clone sample groups
+         for (int i = 0; pFile->GetGroup(i); ++i) {
+             Group* g = AddGroup();
+             g->Name =
+                 "COPY" + ToString(iCallCount) + "_" + pFile->GetGroup(i)->Name;
+             mGroups[pFile->GetGroup(i)] = g;
+         }
+         // clone samples (not waveform data here yet)
+         for (int i = 0; pFile->GetSample(i); ++i) {
+             Sample* s = AddSample();
+             s->CopyAssignMeta(pFile->GetSample(i));
+             mGroups[pFile->GetSample(i)->GetGroup()]->AddSample(s);
+             mSamples[pFile->GetSample(i)] = s;
+         }
+         //BUG: For some reason this method only works with this additional
+         //     Save() call in between here.
+         //
+         // Important: The correct one of the 2 Save() methods has to be called
+         // here, depending on whether the file is completely new or has been
+         // saved to disk already, otherwise it will result in data corruption.
+         if (pRIFF->IsNew())
+             Save(GetFileName());
+         else
+             Save();
+         // clone instruments
+         // (passing the crosslink table here for the cloned samples)
+         for (int i = 0; pFile->GetInstrument(i); ++i) {
+             Instrument* instr = AddInstrument();
+             instr->CopyAssign(pFile->GetInstrument(i), &mSamples);
+         }
+         // Mandatory: file needs to be saved to disk at this point, so this
+         // file has the correct size and data layout for writing the samples'
+         // waveform data to disk.
+         Save();
+         // clone samples' waveform data
+         // (using direct read & write disk streaming)
+         for (int i = 0; pFile->GetSample(i); ++i) {
+             mSamples[pFile->GetSample(i)]->CopyAssignWave(pFile->GetSample(i));
+         }
+     }
      /** @brief Delete an instrument.
       *
-Line 3395 
 namespace {
+Line 4291 
 namespace {
                  RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();
                  while (ck) {
                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {
+                         if (pVersion && pVersion->major == 3 &&
+                             strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;
                          pGroups->push_back(new Group(this, ck));
                      }
                      ck = lst3gnl->GetNextSubChunk();
-Line 3439 
 namespace {
+Line 4338 
 namespace {
          // update group's chunks
          if (pGroups) {
+             // make sure '3gri' and '3gnl' list chunks exist
+             // (before updating the Group chunks)
+             RIFF::List* _3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
+             if (!_3gri) {
+                 _3gri = pRIFF->AddSubList(LIST_TYPE_3GRI);
+                 pRIFF->MoveSubChunk(_3gri, pRIFF->GetSubChunk(CHUNK_ID_PTBL));
+             }
+             RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
+             if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
+             // v3: make sure the file has 128 3gnm chunks
+             // (before updating the Group chunks)
+             if (pVersion && pVersion->major == 3) {
+                 RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
+                 for (int i = 0 ; i < 128 ; i++) {
+                     if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
+                     if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();
+                 }
+             }
              std::list<Group*>::iterator iter = pGroups->begin();
              std::list<Group*>::iterator end  = pGroups->end();
              for (; iter != end; ++iter) {
-Line 3487 
 namespace {
+Line 4406 
 namespace {
              int totnbusedchannels = 0;
              int totnbregions = 0;
              int totnbdimregions = 0;
+             int totnbloops = 0;
              int instrumentIdx = 0;
              memset(&pData[48], 0, sublen - 48);
-Line 3496 
 namespace {
+Line 4416 
 namespace {
                  int nbusedsamples = 0;
                  int nbusedchannels = 0;
                  int nbdimregions = 0;
+                 int nbloops = 0;
                  memset(&pData[(instrumentIdx + 1) * sublen + 48], 0, sublen - 48);
-Line 3519 
 namespace {
+Line 4440 
 namespace {
                                  }
                              }
                          }
+                         if (d->SampleLoops) nbloops++;
                      }
                      nbdimregions += region->DimensionRegions;
                  }
-Line 3529 
 namespace {
+Line 4451 
 namespace {
                  store32(&pData[(instrumentIdx + 1) * sublen + 12], 1);
                  store32(&pData[(instrumentIdx + 1) * sublen + 16], instrument->Regions);
                  store32(&pData[(instrumentIdx + 1) * sublen + 20], nbdimregions);
-                 // next 12 bytes unknown
+                 store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);
+                 // next 8 bytes unknown
                  store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);
                  store32(&pData[(instrumentIdx + 1) * sublen + 40], pSamples->size());
                  // next 4 bytes unknown
                  totnbregions += instrument->Regions;
                  totnbdimregions += nbdimregions;
+                 totnbloops += nbloops;
                  instrumentIdx++;
              }
              // first 4 bytes unknown - sometimes 0, sometimes length of einf part
-Line 3545 
 namespace {
+Line 4469 
 namespace {
              store32(&pData[12], Instruments);
              store32(&pData[16], totnbregions);
              store32(&pData[20], totnbdimregions);
-             // next 12 bytes unknown
+             store32(&pData[24], totnbloops);
-             // next 4 bytes unknown, always 0?
+             // next 8 bytes unknown
+             // next 4 bytes unknown, not always 0
              store32(&pData[40], pSamples->size());
              // next 4 bytes unknown
          }
-Line 3563 
 namespace {
+Line 4488 
 namespace {
          } else if (newFile) {
              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
              _3crc->LoadChunkData();
+             // the order of einf and 3crc is not the same in v2 and v3
+             if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
          }
      }
+     /**
+      * Enable / disable automatic loading. By default this properyt is
+      * enabled and all informations are loaded automatically. However
+      * loading all Regions, DimensionRegions and especially samples might
+      * take a long time for large .gig files, and sometimes one might only
+      * be interested in retrieving very superficial informations like the
+      * amount of instruments and their names. In this case one might disable
+      * automatic loading to avoid very slow response times.
+      *
+      * @e CAUTION: by disabling this property many pointers (i.e. sample
+      * references) and informations will have invalid or even undefined
+      * data! This feature is currently only intended for retrieving very
+      * superficial informations in a very fast way. Don't use it to retrieve
+      * details like synthesis informations or even to modify .gig files!
+      */
+     void File::SetAutoLoad(bool b) {
+         bAutoLoad = b;
+     }
+     /**
+      * Returns whether automatic loading is enabled.
+      * @see SetAutoLoad()
+      */
+     bool File::GetAutoLoad() {
+         return bAutoLoad;
+     }
  // *************** Exception ***************

 Legend:



Removed from v.1247
 


changed lines


 
Added in v.2484
 Legend:



Removed from v.1247
 


changed lines


 
Added in v.2484
-Removed from v.1247
+Added in v.2484

	ViewVC Help
Powered by ViewVC