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

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

Parent Directory | Revision Log | View Patch Patch

-revision 3323 by schoenebeck,
Thu Jul 20 22:09:54 2017 UTC
+revision 3937 by schoenebeck,
Thu Jun 17 10:59:54 2021 UTC
 Line 2
   *                                                                         *
   *   libgig - C++ cross-platform Gigasampler format file access library    *
   *                                                                         *
-  *   Copyright (C) 2003-2017 by Christian Schoenebeck                      *
+  *   Copyright (C) 2003-2021 by Christian Schoenebeck                      *
   *                              <cuse@users.sourceforge.net>               *
   *                                                                         *
   *   This library is free software; you can redistribute it and/or modify  *
 Line 347 
 namespace {
      eg_opt_t::eg_opt_t() {
          AttackCancel     = true;
          AttackHoldCancel = true;
-         DecayCancel      = true;
+         Decay1Cancel     = true;
+         Decay2Cancel     = true;
          ReleaseCancel    = true;
      }
      void eg_opt_t::serialize(Serialization::Archive* archive) {
          SRLZ(AttackCancel);
          SRLZ(AttackHoldCancel);
-         SRLZ(DecayCancel);
+         SRLZ(Decay1Cancel);
+         SRLZ(Decay2Cancel);
          SRLZ(ReleaseCancel);
      }
-Line 410 
 namespace {
+Line 412 
 namespace {
          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
          if (pCk3gix) {
+             pCk3gix->SetPos(0);
              uint16_t iSampleGroup = pCk3gix->ReadInt16();
              pGroup = pFile->GetGroup(iSampleGroup);
          } else { // '3gix' chunk missing
-Line 419 
 namespace {
+Line 423 
 namespace {
          pCkSmpl = waveList->GetSubChunk(CHUNK_ID_SMPL);
          if (pCkSmpl) {
+             pCkSmpl->SetPos(0);
              Manufacturer  = pCkSmpl->ReadInt32();
              Product       = pCkSmpl->ReadInt32();
              SamplePeriod  = pCkSmpl->ReadInt32();
-Line 465 
 namespace {
+Line 471 
 namespace {
          Dithered          = false;
          TruncatedBits     = 0;
          if (Compressed) {
+             ewav->SetPos(0);
              uint32_t version = ewav->ReadInt32();
-             if (version == 3 && BitDepth == 24) {
+             if (version > 2 && BitDepth == 24) {
                  Dithered = ewav->ReadInt32();
                  ewav->SetPos(Channels == 2 ? 84 : 64);
                  TruncatedBits = ewav->ReadInt32();
-Line 474 
 namespace {
+Line 482 
 namespace {
              ScanCompressedSample();
          }
-         // we use a buffer for decompression and for truncating 24 bit samples to 16 bit
+         // we use a buffer for decompression only
-         if ((Compressed || BitDepth == 24) && !InternalDecompressionBuffer.Size) {
+         if (Compressed && !InternalDecompressionBuffer.Size) {
              InternalDecompressionBuffer.pStart = new unsigned char[INITIAL_SAMPLE_BUFFER_SIZE];
              InternalDecompressionBuffer.Size   = INITIAL_SAMPLE_BUFFER_SIZE;
          }
-Line 601 
 namespace {
+Line 609 
 namespace {
          uint16_t iSampleGroup = 0; // 0 refers to default sample group
          File* pFile = static_cast<File*>(pParent);
          if (pFile->pGroups) {
-             std::list<Group*>::iterator iter = pFile->pGroups->begin();
+             std::vector<Group*>::iterator iter = pFile->pGroups->begin();
-             std::list<Group*>::iterator end  = pFile->pGroups->end();
+             std::vector<Group*>::iterator end  = pFile->pGroups->end();
              for (int i = 0; iter != end; i++, iter++) {
                  if (*iter == pGroup) {
                      iSampleGroup = i;
-Line 1498 
 namespace {
+Line 1506 
 namespace {
          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);
          if (_3ewa) { // if '3ewa' chunk exists
+             _3ewa->SetPos(0);
              _3ewa->ReadInt32(); // unknown, always == chunk size ?
              LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
              EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
-Line 1730 
 namespace {
+Line 1740 
 namespace {
              VCFType                         = vcf_type_lowpass;
              memset(DimensionUpperLimits, 127, 8);
          }
-         // format extension for EG behavior options, these will *NOT* work with
-         // Gigasampler/GigaStudio !
+         // chunk for own format extensions, these will *NOT* work with Gigasampler/GigaStudio !
          RIFF::Chunk* lsde = _3ewl->GetSubChunk(CHUNK_ID_LSDE);
-         if (lsde) {
+         if (lsde) { // format extension for EG behavior options
-             unsigned char byte = lsde->ReadUint8();
+             lsde->SetPos(0);
-             EGOptions.AttackCancel     = byte & 1;
-             EGOptions.AttackHoldCancel = byte & (1 << 1);
+             eg_opt_t* pEGOpts[2] = { &EG1Options, &EG2Options };
-             EGOptions.DecayCancel      = byte & (1 << 2);
+             for (int i = 0; i < 2; ++i) { // NOTE: we reserved a 3rd byte for a potential future EG3 option
-             EGOptions.ReleaseCancel    = byte & (1 << 3);
+                 unsigned char byte = lsde->ReadUint8();
+                 pEGOpts[i]->AttackCancel     = byte & 1;
+                 pEGOpts[i]->AttackHoldCancel = byte & (1 << 1);
+                 pEGOpts[i]->Decay1Cancel     = byte & (1 << 2);
+                 pEGOpts[i]->Decay2Cancel     = byte & (1 << 3);
+                 pEGOpts[i]->ReleaseCancel    = byte & (1 << 4);
+             }
+         }
+         // format extension for sustain pedal up effect on release trigger samples
+         if (lsde && lsde->GetSize() > 3) { // NOTE: we reserved the 3rd byte for a potential future EG3 option
+             lsde->SetPos(3);
+             uint8_t byte = lsde->ReadUint8();
+             SustainReleaseTrigger   = static_cast<sust_rel_trg_t>(byte & 0x03);
+             NoNoteOffReleaseTrigger = byte >> 7;
+         } else {
+             SustainReleaseTrigger   = sust_rel_trg_none;
+             NoNoteOffReleaseTrigger = false;
+         }
+         // format extension for LFOs' wave form, phase displacement and for
+         // LFO3's flip phase
+         if (lsde && lsde->GetSize() > 4) {
+             lsde->SetPos(4);
+             LFO1WaveForm = static_cast<lfo_wave_t>( lsde->ReadUint16() );
+             LFO2WaveForm = static_cast<lfo_wave_t>( lsde->ReadUint16() );
+             LFO3WaveForm = static_cast<lfo_wave_t>( lsde->ReadUint16() );
+             lsde->ReadUint16(); // unused 16 bits, reserved for potential future use
+             LFO1Phase = (double) GIG_EXP_DECODE( lsde->ReadInt32() );
+             LFO2Phase = (double) GIG_EXP_DECODE( lsde->ReadInt32() );
+             LFO3Phase = (double) GIG_EXP_DECODE( lsde->ReadInt32() );
+             const uint32_t flags = lsde->ReadInt32();
+             LFO3FlipPhase = flags & 1;
+         } else {
+             LFO1WaveForm = lfo_wave_sine;
+             LFO2WaveForm = lfo_wave_sine;
+             LFO3WaveForm = lfo_wave_sine;
+             LFO1Phase = 0.0;
+             LFO2Phase = 0.0;
+             LFO3Phase = 0.0;
+             LFO3FlipPhase = false;
          }
          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
-Line 1865 
 namespace {
+Line 1913 
 namespace {
          SRLZ(EG1ControllerAttackInfluence);
          SRLZ(EG1ControllerDecayInfluence);
          SRLZ(EG1ControllerReleaseInfluence);
+         SRLZ(LFO1WaveForm);
          SRLZ(LFO1Frequency);
+         SRLZ(LFO1Phase);
          SRLZ(LFO1InternalDepth);
          SRLZ(LFO1ControlDepth);
          SRLZ(LFO1Controller);
-Line 1883 
 namespace {
+Line 1933 
 namespace {
          SRLZ(EG2ControllerAttackInfluence);
          SRLZ(EG2ControllerDecayInfluence);
          SRLZ(EG2ControllerReleaseInfluence);
+         SRLZ(LFO2WaveForm);
          SRLZ(LFO2Frequency);
+         SRLZ(LFO2Phase);
          SRLZ(LFO2InternalDepth);
          SRLZ(LFO2ControlDepth);
          SRLZ(LFO2Controller);
-Line 1891 
 namespace {
+Line 1943 
 namespace {
          SRLZ(LFO2Sync);
          SRLZ(EG3Attack);
          SRLZ(EG3Depth);
+         SRLZ(LFO3WaveForm);
          SRLZ(LFO3Frequency);
+         SRLZ(LFO3Phase);
          SRLZ(LFO3InternalDepth);
          SRLZ(LFO3ControlDepth);
          SRLZ(LFO3Controller);
+         SRLZ(LFO3FlipPhase);
          SRLZ(LFO3Sync);
          SRLZ(VCFEnabled);
          SRLZ(VCFType);
-Line 1928 
 namespace {
+Line 1983 
 namespace {
          SRLZ(MSDecode);
          //SRLZ(SampleStartOffset);
          SRLZ(SampleAttenuation);
-         SRLZ(EGOptions);
+         SRLZ(EG1Options);
+         SRLZ(EG2Options);
+         SRLZ(SustainReleaseTrigger);
+         SRLZ(NoNoteOffReleaseTrigger);
          // derived attributes from DLS::Sampler
          SRLZ(FineTune);
-Line 1968 
 namespace {
+Line 2026 
 namespace {
          RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);
          if (!_3ewa) {
              File* pFile = (File*) GetParent()->GetParent()->GetParent();
-             bool version3 = pFile->pVersion && pFile->pVersion->major == 3;
+             bool versiongt2 = pFile->pVersion && pFile->pVersion->major > 2;
-             _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, version3 ? 148 : 140);
+             _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, versiongt2 ? 148 : 140);
          }
          pData = (uint8_t*) _3ewa->LoadChunkData();
-Line 2236 
 namespace {
+Line 2294 
 namespace {
              memcpy(&pData[140], DimensionUpperLimits, 8);
          }
-         // format extension for EG behavior options, these will *NOT* work with
+         // chunk for own format extensions, these will *NOT* work with
          // Gigasampler/GigaStudio !
          RIFF::Chunk* lsde = pParentList->GetSubChunk(CHUNK_ID_LSDE);
-         if (!lsde) {
+         const int lsdeSize =
-             // only add this "LSDE" chunk if the EG options do not match the
+/* EG cancel options */ +
-             // default EG behavior
+/* sustain pedal up on release trigger option */ +
-             eg_opt_t defaultOpt;
+/* LFOs' wave forms */ + 12 /* LFOs' phase */ + 4 /* flags (LFO3FlipPhase) */;
-             if (memcmp(&EGOptions, &defaultOpt, sizeof(eg_opt_t))) {
+         if (!lsde && UsesAnyGigFormatExtension()) {
-                 lsde = pParentList->AddSubChunk(CHUNK_ID_LSDE, 1);
+             // only add this "LSDE" chunk if there is some (format extension)
-                 // move LSDE chunk to the end of parent list
+             // setting effective that would require our "LSDE" format extension
-                 pParentList->MoveSubChunk(lsde, (RIFF::Chunk*)NULL);
+             // chunk to be stored
-             }
+             lsde = pParentList->AddSubChunk(CHUNK_ID_LSDE, lsdeSize);
+             // move LSDE chunk to the end of parent list
+             pParentList->MoveSubChunk(lsde, (RIFF::Chunk*)NULL);
          }
          if (lsde) {
-             unsigned char* pByte = (unsigned char*) lsde->LoadChunkData();
+             if (lsde->GetNewSize() < lsdeSize)
-             *pByte =
+                 lsde->Resize(lsdeSize);
-                 (EGOptions.AttackCancel     ? 1 : 0) |
+             // format extension for EG behavior options
-                 (EGOptions.AttackHoldCancel ? (1<<1) : 0) |
+             unsigned char* pData = (unsigned char*) lsde->LoadChunkData();
-                 (EGOptions.DecayCancel      ? (1<<2) : 0) |
+             eg_opt_t* pEGOpts[2] = { &EG1Options, &EG2Options };
-                 (EGOptions.ReleaseCancel    ? (1<<3) : 0);
+             for (int i = 0; i < 2; ++i) { // NOTE: we reserved the 3rd byte for a potential future EG3 option
+                 pData[i] =
+                     (pEGOpts[i]->AttackCancel     ? 1 : 0) |
+                     (pEGOpts[i]->AttackHoldCancel ? (1<<1) : 0) |
+                     (pEGOpts[i]->Decay1Cancel     ? (1<<2) : 0) |
+                     (pEGOpts[i]->Decay2Cancel     ? (1<<3) : 0) |
+                     (pEGOpts[i]->ReleaseCancel    ? (1<<4) : 0);
+             }
+             // format extension for release trigger options
+             pData[3] = static_cast<uint8_t>(SustainReleaseTrigger) | (NoNoteOffReleaseTrigger ? (1<<7) : 0);
+             // format extension for LFOs' wave form, phase displacement and for
+             // LFO3's flip phase
+             store16(&pData[4], LFO1WaveForm);
+             store16(&pData[6], LFO2WaveForm);
+             store16(&pData[8], LFO3WaveForm);
+             //NOTE: 16 bits reserved here for potential future use !
+             const int32_t lfo1Phase = (int32_t) GIG_EXP_ENCODE(LFO1Phase);
+             const int32_t lfo2Phase = (int32_t) GIG_EXP_ENCODE(LFO2Phase);
+             const int32_t lfo3Phase = (int32_t) GIG_EXP_ENCODE(LFO3Phase);
+             store32(&pData[12], lfo1Phase);
+             store32(&pData[16], lfo2Phase);
+             store32(&pData[20], lfo3Phase);
+             const int32_t flags = LFO3FlipPhase ? 1 : 0;
+             store32(&pData[24], flags);
+             // compile time sanity check: is our last store access here
+             // consistent with the initial lsdeSize value assignment?
+             static_assert(lsdeSize == 28, "Inconsistency in assumed 'LSDE' RIFF chunk size");
          }
      }
+     /**
+      * Returns @c true in case this DimensionRegion object uses any gig format
+      * extension, that is whether this DimensionRegion object currently has any
+      * setting effective that would require our "LSDE" RIFF chunk to be stored
+      * to the gig file.
+      *
+      * Right now this is a private method. It is considerable though this method
+      * to become (in slightly modified form) a public API method in future, i.e.
+      * to allow instrument editors to visualize and/or warn the user of any
+      * format extension being used. Right now this method really just serves to
+      * answer the question whether an LSDE chunk is required, for the public API
+      * purpose this method would also need to check whether any other setting
+      * stored to the regular value '3ewa' chunk, is actually a format extension
+      * as well.
+      */
+     bool DimensionRegion::UsesAnyGigFormatExtension() const {
+         eg_opt_t defaultOpt;
+         return memcmp(&EG1Options, &defaultOpt, sizeof(eg_opt_t)) ||
+                memcmp(&EG2Options, &defaultOpt, sizeof(eg_opt_t)) ||
+                SustainReleaseTrigger || NoNoteOffReleaseTrigger ||
+                LFO1WaveForm || LFO2WaveForm || LFO3WaveForm ||
+                LFO1Phase || LFO2Phase || LFO3Phase ||
+                LFO3FlipPhase;
+     }
      double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {
          curve_type_t curveType = releaseVelocityResponseCurve;
          uint8_t depth = releaseVelocityResponseDepth;
-Line 2296 
 namespace {
+Line 2408 
 namespace {
      // 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)
      {
+         // sanity check input parameters
+         // (fallback to some default parameters on ill input)
+         switch (curveType) {
+             case curve_type_nonlinear:
+             case curve_type_linear:
+                 if (depth > 4) {
+                     printf("Warning: Invalid depth (0x%x) for velocity curve type (0x%x).\n", depth, curveType);
+                     depth   = 0;
+                     scaling = 0;
+                 }
+                 break;
+             case curve_type_special:
+                 if (depth > 5) {
+                     printf("Warning: Invalid depth (0x%x) for velocity curve type 'special'.\n", depth);
+                     depth   = 0;
+                     scaling = 0;
+                 }
+                 break;
+             case curve_type_unknown:
+             default:
+                 printf("Warning: Unknown velocity curve type (0x%x).\n", curveType);
+                 curveType = curve_type_linear;
+                 depth     = 0;
+                 scaling   = 0;
+                 break;
+         }
          double* table;
          uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;
          if (pVelocityTables->count(tableKey)) { // if key exists
-Line 3168 
 namespace {
+Line 3307 
 namespace {
          }
          Layers = 1;
          File* file = (File*) GetParent()->GetParent();
-         int dimensionBits = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
+         int dimensionBits = (file->pVersion && file->pVersion->major > 2) ? 8 : 5;
          // Actual Loading
-Line 3178 
 namespace {
+Line 3317 
 namespace {
          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);
          if (_3lnk) {
+             _3lnk->SetPos(0);
              DimensionRegions = _3lnk->ReadUint32();
              for (int i = 0; i < dimensionBits; i++) {
                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());
-Line 3212 
 namespace {
+Line 3353 
 namespace {
              UpdateVelocityTable();
              // jump to start of the wave pool indices (if not already there)
-             if (file->pVersion && file->pVersion->major == 3)
+             if (file->pVersion && file->pVersion->major > 2)
                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure
              else
                  _3lnk->SetPos(44);
-Line 3221 
 namespace {
+Line 3362 
 namespace {
              if (file->GetAutoLoad()) {
                  for (uint i = 0; i < DimensionRegions; i++) {
                      uint32_t wavepoolindex = _3lnk->ReadUint32();
-                     if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
+                     if (file->pWavePoolTable && pDimensionRegions[i])
+                         pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
                  }
                  GetSample(); // load global region sample reference
              }
-Line 3270 
 namespace {
+Line 3412 
 namespace {
          }
          File* pFile = (File*) GetParent()->GetParent();
-         bool version3 = pFile->pVersion && pFile->pVersion->major == 3;
+         const bool versiongt2 = pFile->pVersion && pFile->pVersion->major > 2;
-         const int iMaxDimensions =  version3 ? 8 : 5;
+         const int iMaxDimensions =  versiongt2 ? 8 : 5;
-         const int iMaxDimensionRegions = version3 ? 256 : 32;
+         const int iMaxDimensionRegions = versiongt2 ? 256 : 32;
          // make sure '3lnk' chunk exists
          RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);
          if (!_3lnk) {
-             const int _3lnkChunkSize = version3 ? 1092 : 172;
+             const int _3lnkChunkSize = versiongt2 ? 1092 : 172;
              _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);
              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
-Line 3301 
 namespace {
+Line 3443 
 namespace {
          }
          // update wave pool table in '3lnk' chunk
-         const int iWavePoolOffset = version3 ? 68 : 44;
+         const int iWavePoolOffset = versiongt2 ? 68 : 44;
          for (uint i = 0; i < iMaxDimensionRegions; i++) {
              int iWaveIndex = -1;
              if (i < DimensionRegions) {
-Line 3317 
 namespace {
+Line 3459 
 namespace {
              }
              store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);
          }
+         // The following chunks are just added for compatibility with the
+         // GigaStudio software, which would show a warning if these were
+         // missing. However currently these chunks don't cover any useful
+         // data. So if this gig file uses any of our own gig format
+         // extensions which would cause this gig file to be unloadable
+         // with GSt software anyway, then just skip these GSt compatibility
+         // chunks here as well.
+         if (versiongt2 && !UsesAnyGigFormatExtension()) {
+             // add 3dnm list which always seems to be empty
+             RIFF::List* _3dnm = pCkRegion->GetSubList(LIST_TYPE_3DNM);
+             if (!_3dnm) _3dnm = pCkRegion->AddSubList(LIST_TYPE_3DNM);
+             // add 3ddp chunk which always seems to have 16 bytes of 0xFF
+             RIFF::Chunk* _3ddp = pCkRegion->GetSubChunk(CHUNK_ID_3DDP);
+             if (!_3ddp) _3ddp =  pCkRegion->AddSubChunk(CHUNK_ID_3DDP, 16);
+             uint8_t* pData = (uint8_t*) _3ddp->LoadChunkData();
+             for (int i = 0; i < 16; i += 4) {
+                 store32(&pData[i], 0xFFFFFFFF);
+             }
+             // move 3dnm and 3ddp to the end of the region list
+             pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3DNM), (RIFF::Chunk*)NULL);
+             pCkRegion->MoveSubChunk(pCkRegion->GetSubChunk(CHUNK_ID_3DDP), (RIFF::Chunk*)NULL);
+         } else {
+             // this is intended for the user switching from GSt >= 3 version
+             // back to an older format version, delete GSt3 chunks ...
+             RIFF::List* _3dnm = pCkRegion->GetSubList(LIST_TYPE_3DNM);
+             if (_3dnm) pCkRegion->DeleteSubChunk(_3dnm);
+             RIFF::Chunk* _3ddp = pCkRegion->GetSubChunk(CHUNK_ID_3DDP);
+             if (_3ddp) pCkRegion->DeleteSubChunk(_3ddp);
+         }
      }
      void Region::LoadDimensionRegions(RIFF::List* rgn) {
          RIFF::List* _3prg = rgn->GetSubList(LIST_TYPE_3PRG);
          if (_3prg) {
              int dimensionRegionNr = 0;
-             RIFF::List* _3ewl = _3prg->GetFirstSubList();
+             size_t i = 0;
-             while (_3ewl) {
+             for (RIFF::List* _3ewl = _3prg->GetSubListAt(i); _3ewl;
+                  _3ewl = _3prg->GetSubListAt(++i))
+             {
                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {
                      pDimensionRegions[dimensionRegionNr] = new DimensionRegion(this, _3ewl);
                      dimensionRegionNr++;
                  }
-                 _3ewl = _3prg->GetNextSubList();
              }
              if (dimensionRegionNr == 0) throw gig::Exception("No dimension region found.");
          }
-Line 3444 
 namespace {
+Line 3620 
 namespace {
          // check if max. amount of dimensions reached
          File* file = (File*) GetParent()->GetParent();
-         const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
+         const int iMaxDimensions = (file->pVersion && file->pVersion->major > 2) ? 8 : 5;
          if (Dimensions >= iMaxDimensions)
              throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimensions already reached");
          // check if max. amount of dimension bits reached
-Line 3632 
 namespace {
+Line 3808 
 namespace {
       * @throws gig::Exception if requested zone could not be deleted
       */
      void Region::DeleteDimensionZone(dimension_t type, int zone) {
+         if (!Dimensions)
+             throw gig::Exception("Could not delete dimension zone, because there is no dimension at all.");
          dimension_def_t* oldDef = GetDimensionDefinition(type);
          if (!oldDef)
              throw gig::Exception("Could not delete dimension zone, no such dimension of given type");
-Line 3660 
 namespace {
+Line 3838 
 namespace {
          // requested by the arguments of this method call) to the temporary
          // region, and don't use Region::CopyAssign() here for this task, since
          // it would also alter fast lookup helper variables here and there
-         dimension_def_t newDef;
+         dimension_def_t newDef = {};
          for (int i = 0; i < Dimensions; ++i) {
              dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
              // is this the dimension requested by the method arguments? ...
-Line 3671 
 namespace {
+Line 3849 
 namespace {
              }
              tempRgn->AddDimension(&def);
          }
+         // silence clang sanitizer warning
+         if (newDef.dimension == dimension_none)
+             throw gig::Exception("Unexpected internal failure resolving dimension in DeleteDimensionZone() [this is a bug].");
          // find the dimension index in the tempRegion which is the dimension
          // type passed to this method (paranoidly expecting different order)
-Line 3715 
 namespace {
+Line 3896 
 namespace {
          // now tempRegion's dimensions and DimensionRegions basically reflect
          // what we wanted to get for this actual Region here, so we now just
          // delete and recreate the dimension in question with the new amount
-         // zones and then copy back from tempRegion
+         // zones and then copy back from tempRegion. we're actually deleting and
-         DeleteDimension(oldDef);
+         // recreating all dimensions here, to avoid altering the precise order
-         AddDimension(&newDef);
+         // of the dimensions (which would not be an error per se, but it would
+         // cause usability issues with instrument editors)
+         {
+             std::vector<dimension_def_t> oldDefs;
+             for (int i = 0; i < Dimensions; ++i)
+                 oldDefs.push_back(pDimensionDefinitions[i]); // copy, don't reference
+             for (int i = Dimensions - 1; i >= 0; --i)
+                 DeleteDimension(&pDimensionDefinitions[i]);
+             for (int i = 0; i < oldDefs.size(); ++i) {
+                 dimension_def_t& def = oldDefs[i];
+                 AddDimension(
+                     (def.dimension == newDef.dimension) ? &newDef : &def
+                 );
+             }
+         }
          for (int iSrc = 0; iSrc < 256; ++iSrc) {
              DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
              if (!srcDimRgn) continue;
-Line 3736 
 namespace {
+Line 3931 
 namespace {
          }
          // delete temporary region
+         tempRgn->DeleteChunks();
          delete tempRgn;
          UpdateVelocityTable();
-Line 3756 
 namespace {
+Line 3952 
 namespace {
       * @throws gig::Exception if requested zone could not be splitted
       */
      void Region::SplitDimensionZone(dimension_t type, int zone) {
+         if (!Dimensions)
+             throw gig::Exception("Could not split dimension zone, because there is no dimension at all.");
          dimension_def_t* oldDef = GetDimensionDefinition(type);
          if (!oldDef)
              throw gig::Exception("Could not split dimension zone, no such dimension of given type");
-Line 3782 
 namespace {
+Line 3980 
 namespace {
          // requested by the arguments of this method call) to the temporary
          // region, and don't use Region::CopyAssign() here for this task, since
          // it would also alter fast lookup helper variables here and there
-         dimension_def_t newDef;
+         dimension_def_t newDef = {};
          for (int i = 0; i < Dimensions; ++i) {
              dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
              // is this the dimension requested by the method arguments? ...
-Line 3793 
 namespace {
+Line 3991 
 namespace {
              }
              tempRgn->AddDimension(&def);
          }
+         // silence clang sanitizer warning
+         if (newDef.dimension == dimension_none)
+             throw gig::Exception("Unexpected internal failure resolving dimension in SplitDimensionZone() [this is a bug].");
          // find the dimension index in the tempRegion which is the dimension
          // type passed to this method (paranoidly expecting different order)
-Line 3854 
 namespace {
+Line 4055 
 namespace {
          // now tempRegion's dimensions and DimensionRegions basically reflect
          // what we wanted to get for this actual Region here, so we now just
          // delete and recreate the dimension in question with the new amount
-         // zones and then copy back from tempRegion
+         // zones and then copy back from tempRegion. we're actually deleting and
-         DeleteDimension(oldDef);
+         // recreating all dimensions here, to avoid altering the precise order
-         AddDimension(&newDef);
+         // of the dimensions (which would not be an error per se, but it would
+         // cause usability issues with instrument editors)
+         {
+             std::vector<dimension_def_t> oldDefs;
+             for (int i = 0; i < Dimensions; ++i)
+                 oldDefs.push_back(pDimensionDefinitions[i]); // copy, don't reference
+             for (int i = Dimensions - 1; i >= 0; --i)
+                 DeleteDimension(&pDimensionDefinitions[i]);
+             for (int i = 0; i < oldDefs.size(); ++i) {
+                 dimension_def_t& def = oldDefs[i];
+                 AddDimension(
+                     (def.dimension == newDef.dimension) ? &newDef : &def
+                 );
+             }
+         }
          for (int iSrc = 0; iSrc < 256; ++iSrc) {
              DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
              if (!srcDimRgn) continue;
-Line 3875 
 namespace {
+Line 4090 
 namespace {
          }
          // delete temporary region
+         tempRgn->DeleteChunks();
          delete tempRgn;
          UpdateVelocityTable();
-Line 4102 
 namespace {
+Line 4318 
 namespace {
          if ((int32_t)WavePoolTableIndex == -1) return NULL;
          File* file = (File*) GetParent()->GetParent();
          if (!file->pWavePoolTable) return NULL;
+         if (WavePoolTableIndex + 1 > file->WavePoolCount) return NULL;
          // for new files or files >= 2 GB use 64 bit wave pool offsets
          if (file->pRIFF->IsNew() || (file->pRIFF->GetCurrentFileSize() >> 31)) {
              // use 64 bit wave pool offsets (treating this as large file)
              uint64_t soughtoffset =
                  uint64_t(file->pWavePoolTable[WavePoolTableIndex]) |
                  uint64_t(file->pWavePoolTableHi[WavePoolTableIndex]) << 32;
-             Sample* sample = file->GetFirstSample(pProgress);
+             size_t i = 0;
-             while (sample) {
+             for (Sample* sample = file->GetSample(i, pProgress); sample;
+                          sample = file->GetSample(++i))
+             {
                  if (sample->ullWavePoolOffset == soughtoffset)
-                     return static_cast<gig::Sample*>(sample);
+                     return sample;
-                 sample = file->GetNextSample();
              }
          } else {
              // use extension files and 32 bit wave pool offsets
              file_offset_t soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
              file_offset_t soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
-             Sample* sample = file->GetFirstSample(pProgress);
+             size_t i = 0;
-             while (sample) {
+             for (Sample* sample = file->GetSample(i, pProgress); sample;
+                          sample = file->GetSample(++i))
+             {
                  if (sample->ullWavePoolOffset == soughtoffset &&
-                     sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
+                     sample->FileNo == soughtfileno) return sample;
-                 sample = file->GetNextSample();
              }
          }
          return NULL;
-Line 4178 
 namespace {
+Line 4397 
 namespace {
          Layers = orig->Layers;
      }
+     /**
+      * Returns @c true in case this Region object uses any gig format
+      * extension, that is e.g. whether any DimensionRegion object currently
+      * has any setting effective that would require our "LSDE" RIFF chunk to
+      * be stored to the gig file.
+      *
+      * Right now this is a private method. It is considerable though this method
+      * to become (in slightly modified form) a public API method in future, i.e.
+      * to allow instrument editors to visualize and/or warn the user of any gig
+      * format extension being used. See also comments on
+      * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
+      * potential public API change in future.
+      */
+     bool Region::UsesAnyGigFormatExtension() const {
+         for (int i = 0; i < 256; i++) {
+             if (pDimensionRegions[i]) {
+                 if (pDimensionRegions[i]->UsesAnyGigFormatExtension())
+                     return true;
+             }
+         }
+         return false;
+     }
  // *************** MidiRule ***************
  // *
-Line 4352 
 namespace {
+Line 4594 
 namespace {
          pGroup = group;
          pChunk = ckScri;
          if (ckScri) { // object is loaded from file ...
+             ckScri->SetPos(0);
              // read header
              uint32_t headerSize = ckScri->ReadUint32();
              Compression = (Compression_t) ckScri->ReadUint32();
              Encoding    = (Encoding_t) ckScri->ReadUint32();
              Language    = (Language_t) ckScri->ReadUint32();
-             Bypass      = (Language_t) ckScri->ReadUint32() & 1;
+             Bypass      = ckScri->ReadUint32() & 1;
              crc         = ckScri->ReadUint32();
              uint32_t nameSize = ckScri->ReadUint32();
              Name.resize(nameSize, ' ');
              for (int i = 0; i < nameSize; ++i)
                  Name[i] = ckScri->ReadUint8();
+             // check if an uuid was already stored along with this script
+             if (headerSize >= 6*sizeof(int32_t) + nameSize + 16) { // yes ...
+                 for (uint i = 0; i < 16; ++i) {
+                     Uuid[i] = ckScri->ReadUint8();
+                 }
+             } else { // no uuid yet, generate one now ...
+                 GenerateUuid();
+             }
              // to handle potential future extensions of the header
              ckScri->SetPos(sizeof(int32_t) + headerSize);
              // read actual script data
-Line 4377 
 namespace {
+Line 4629 
 namespace {
              Bypass   = false;
              crc      = 0;
              Name     = "Unnamed Script";
+             GenerateUuid();
          }
      }
-Line 4404 
 namespace {
+Line 4657 
 namespace {
          memcpy(&data[0], &text[0], text.size());
      }
+     /** @brief Remove all RIFF chunks associated with this Script object.
+      *
+      * At the moment Script::DeleteChunks() does nothing. It is
+      * recommended to call this method explicitly though from deriving classes's
+      * own overridden implementation of this method to avoid potential future
+      * compatiblity issues.
+      *
+      * See DLS::Storage::DeleteChunks() for details.
+      */
+     void Script::DeleteChunks() {
+     }
      /**
       * Apply this script to the respective RIFF chunks. You have to call
       * File::Save() to make changes persistent.
-Line 4419 
 namespace {
+Line 4684 
 namespace {
          __calculateCRC(&data[0], data.size(), crc);
          __finalizeCRC(crc);
          // make sure chunk exists and has the required size
-         const file_offset_t chunkSize = (file_offset_t) 7*sizeof(int32_t) + Name.size() + data.size();
+         const file_offset_t chunkSize =
+             (file_offset_t) 7*sizeof(int32_t) + Name.size() + 16 + data.size();
          if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);
          else pChunk->Resize(chunkSize);
          // fill the chunk data to be written to disk
          uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();
          int pos = 0;
-         store32(&pData[pos], uint32_t(6*sizeof(int32_t) + Name.size())); // total header size
+         store32(&pData[pos], uint32_t(6*sizeof(int32_t) + Name.size() + 16)); // total header size
          pos += sizeof(int32_t);
          store32(&pData[pos], Compression);
          pos += sizeof(int32_t);
-Line 4441 
 namespace {
+Line 4707 
 namespace {
          pos += sizeof(int32_t);
          for (int i = 0; i < Name.size(); ++i, ++pos)
              pData[pos] = Name[i];
+         for (int i = 0; i < 16; ++i, ++pos)
+             pData[pos] = Uuid[i];
          for (int i = 0; i < data.size(); ++i, ++pos)
              pData[pos] = data[i];
      }
      /**
+      * Generate a new Universally Unique Identifier (UUID) for this script.
+      */
+     void Script::GenerateUuid() {
+         DLS::dlsid_t dlsid;
+         DLS::Resource::GenerateDLSID(&dlsid);
+         Uuid[0]  = dlsid.ulData1       & 0xff;
+         Uuid[1]  = dlsid.ulData1 >>  8 & 0xff;
+         Uuid[2]  = dlsid.ulData1 >> 16 & 0xff;
+         Uuid[3]  = dlsid.ulData1 >> 24 & 0xff;
+         Uuid[4]  = dlsid.usData2       & 0xff;
+         Uuid[5]  = dlsid.usData2 >>  8 & 0xff;
+         Uuid[6]  = dlsid.usData3       & 0xff;
+         Uuid[7]  = dlsid.usData3 >>  8 & 0xff;
+         Uuid[8]  = dlsid.abData[0];
+         Uuid[9]  = dlsid.abData[1];
+         Uuid[10] = dlsid.abData[2];
+         Uuid[11] = dlsid.abData[3];
+         Uuid[12] = dlsid.abData[4];
+         Uuid[13] = dlsid.abData[5];
+         Uuid[14] = dlsid.abData[6];
+         Uuid[15] = dlsid.abData[7];
+     }
+     /**
       * Move this script from its current ScriptGroup to another ScriptGroup
       * given by @a pGroup.
       *
-Line 4519 
 namespace {
+Line 4811 
 namespace {
          }
      }
+     /** @brief Remove all RIFF chunks associated with this ScriptGroup object.
+      *
+      * At the moment ScriptGroup::DeleteChunks() does nothing. It is
+      * recommended to call this method explicitly though from deriving classes's
+      * own overridden implementation of this method to avoid potential future
+      * compatiblity issues.
+      *
+      * See DLS::Storage::DeleteChunks() for details.
+      */
+     void ScriptGroup::DeleteChunks() {
+     }
      /**
       * Apply this script group to the respective RIFF chunks. You have to call
       * File::Save() to make changes persistent.
-Line 4605 
 namespace {
+Line 4909 
 namespace {
          pScripts = new std::list<Script*>;
          if (!pList) return;
-         for (RIFF::Chunk* ck = pList->GetFirstSubChunk(); ck;
+         size_t i = 0;
-              ck = pList->GetNextSubChunk())
+         for (RIFF::Chunk* ck = pList->GetSubChunkAt(i); ck;
+              ck = pList->GetSubChunkAt(++i))
          {
              if (ck->GetChunkID() == CHUNK_ID_SCRI) {
                  pScripts->push_back(new Script(this, ck));
-Line 4643 
 namespace {
+Line 4948 
 namespace {
          if (lart) {
              RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
              if (_3ewg) {
+                 _3ewg->SetPos(0);
                  EffectSend             = _3ewg->ReadUint16();
                  Attenuation            = _3ewg->ReadInt32();
                  FineTune               = _3ewg->ReadInt16();
-Line 4684 
 namespace {
+Line 4991 
 namespace {
              if (!pRegions) pRegions = new RegionList;
              RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
              if (lrgn) {
-                 RIFF::List* rgn = lrgn->GetFirstSubList();
+                 size_t i = 0;
-                 while (rgn) {
+                 for (RIFF::List* rgn = lrgn->GetSubListAt(i); rgn;
+                      rgn = lrgn->GetSubListAt(++i))
+                 {
                      if (rgn->GetListType() == LIST_TYPE_RGN) {
-                         __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
+                         if (pProgress)
+                             __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
                          pRegions->push_back(new Region(this, rgn));
                      }
-                     rgn = lrgn->GetNextSubList();
                  }
                  // Creating Region Key Table for fast lookup
                  UpdateRegionKeyTable();
-Line 4700 
 namespace {
+Line 5009 
 namespace {
          // own gig format extensions
          RIFF::List* lst3LS = insList->GetSubList(LIST_TYPE_3LS);
          if (lst3LS) {
+             // script slots (that is references to instrument scripts)
              RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
              if (ckSCSL) {
+                 ckSCSL->SetPos(0);
                  int headerSize = ckSCSL->ReadUint32();
                  int slotCount  = ckSCSL->ReadUint32();
                  if (slotCount) {
-Line 4717 
 namespace {
+Line 5029 
 namespace {
                      }
                  }
              }
+             // overridden script 'patch' variables
+             RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV);
+             if (ckSCPV) {
+                 ckSCPV->SetPos(0);
+                 int nScripts = ckSCPV->ReadUint32();
+                 for (int iScript = 0; iScript < nScripts; ++iScript) {
+                     _UUID uuid;
+                     for (int i = 0; i < 16; ++i)
+                         uuid[i] = ckSCPV->ReadUint8();
+                     uint slot = ckSCPV->ReadUint32();
+                     ckSCPV->ReadUint32(); // unused, reserved 32 bit
+                     int nVars = ckSCPV->ReadUint32();
+                     for (int iVar = 0; iVar < nVars; ++iVar) {
+                         uint8_t type = ckSCPV->ReadUint8();
+                         ckSCPV->ReadUint8();  // unused, reserved byte
+                         int blobSize = ckSCPV->ReadUint16();
+                         RIFF::file_offset_t pos = ckSCPV->GetPos();
+                         // assuming 1st bit is set in 'type', otherwise blob not
+                         // supported for decoding
+                         if (type & 1) {
+                             String name, value;
+                             int len = ckSCPV->ReadUint16();
+                             for (int i = 0; i < len; ++i)
+                                 name += (char) ckSCPV->ReadUint8();
+                             len = ckSCPV->ReadUint16();
+                             for (int i = 0; i < len; ++i)
+                                 value += (char) ckSCPV->ReadUint8();
+                             if (!name.empty()) // 'name' should never be empty, but just to be sure
+                                 scriptVars[uuid][slot][name] = value;
+                         }
+                         // also for potential future extensions: seek forward
+                         // according to blob size
+                         ckSCPV->SetPos(pos + blobSize);
+                     }
+                 }
+             }
          }
-         __notify_progress(pProgress, 1.0f); // notify done
+         if (pProgress)
+             __notify_progress(pProgress, 1.0f); // notify done
      }
      void Instrument::UpdateRegionKeyTable() {
-Line 4728 
 namespace {
+Line 5079 
 namespace {
          RegionList::iterator end  = pRegions->end();
          for (; iter != end; ++iter) {
              gig::Region* pRegion = static_cast<gig::Region*>(*iter);
-             for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {
+             const int low  = std::max(int(pRegion->KeyRange.low), 0);
+             const int high = std::min(int(pRegion->KeyRange.high), 127);
+             for (int iKey = low; iKey <= high; iKey++) {
                  RegionKeyTable[iKey] = pRegion;
              }
          }
-Line 4773 
 namespace {
+Line 5126 
 namespace {
              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;
+             int size = (pFile->pVersion && pFile->pVersion->major > 2) ? 16416 : 12;
              _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);
              memset(_3ewg->LoadChunkData(), 0, size);
          }
-Line 4805 
 namespace {
+Line 5158 
 namespace {
             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
             if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);
+            // save script slots (that is references to instrument scripts)
             const int slotCount = (int) pScriptRefs->size();
             const int headerSize = 3 * sizeof(uint32_t);
             const int slotSize  = 2 * sizeof(uint32_t);
-Line 4829 
 namespace {
+Line 5184 
 namespace {
                 store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0);
                 pos += sizeof(uint32_t);
             }
+            // save overridden script 'patch' variables ...
+            // the actual 'scriptVars' member variable might contain variables of
+            // scripts which are currently no longer assigned to any script slot
+            // of this instrument, we need to get rid of these variables here to
+            // prevent saving those persistently, however instead of touching the
+            // member variable 'scriptVars' directly, rather strip a separate
+            // copy such that the overridden values are not lost during an
+            // instrument editor session (i.e. if script might be re-assigned)
+            _VarsByScript vars = stripScriptVars();
+            if (!vars.empty()) {
+                // determine total size required for 'SCPV' RIFF chunk, and the
+                // total amount of scripts being overridden (the latter is
+                // required because a script might be used on several script
+                // slots, hence vars.size() could then not be used here instead)
+                size_t totalChunkSize = 4;
+                size_t totalScriptsOverridden = 0;
+                for (const auto& script : vars) {
+                    for (const auto& slot : script.second) {
+                        totalScriptsOverridden++;
+                        totalChunkSize += 16 + 4 + 4 + 4;
+                        for (const auto& var : slot.second) {
+                            totalChunkSize += 4 + 2 + var.first.length() +
++ var.second.length();
+                        }
+                    }
+                }
+                // ensure 'SCPV' RIFF chunk exists (with required size)
+                RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV);
+                if (!ckSCPV) ckSCPV = lst3LS->AddSubChunk(CHUNK_ID_SCPV, totalChunkSize);
+                else ckSCPV->Resize(totalChunkSize);
+                // store the actual data to 'SCPV' RIFF chunk
+                uint8_t* pData = (uint8_t*) ckSCPV->LoadChunkData();
+                int pos = 0;
+                store32(&pData[pos], (uint32_t) totalScriptsOverridden); // scripts count
+                pos += 4;
+                for (const auto& script : vars) {
+                    for (const auto& slot : script.second) {
+                        for (int i = 0; i < 16; ++i)
+                            pData[pos+i] = script.first[i]; // uuid
+                        pos += 16;
+                        store32(&pData[pos], (uint32_t) slot.first); // slot index
+                        pos += 4;
+                        store32(&pData[pos], (uint32_t) 0); // unused, reserved 32 bit
+                        pos += 4;
+                        store32(&pData[pos], (uint32_t) slot.second.size()); // variables count
+                        pos += 4;
+                        for (const auto& var : slot.second) {
+                            pData[pos++] = 1; // type
+                            pData[pos++] = 0; // reserved byte
+                            store16(&pData[pos], 2 + var.first.size() + 2 + var.second.size()); // blob size
+                            pos += 2;
+                            store16(&pData[pos], var.first.size()); // variable name length
+                            pos += 2;
+                            for (int i = 0; i < var.first.size(); ++i)
+                                pData[pos++] = var.first[i];
+                            store16(&pData[pos], var.second.size()); // variable value length
+                            pos += 2;
+                            for (int i = 0; i < var.second.size(); ++i)
+                                pData[pos++] = var.second[i];
+                        }
+                    }
+                }
+            } else {
+                // no script variable overridden by this instrument, so get rid
+                // of 'SCPV' RIFF chunk (if any)
+                RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV);
+                if (ckSCPV) lst3LS->DeleteSubChunk(ckSCPV);
+            }
         } else {
             // no script slots, so get rid of any LS custom RIFF chunks (if any)
             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
-Line 4876 
 namespace {
+Line 5303 
 namespace {
      }
      /**
+      * Returns Region at supplied @a pos position within the region list of
+      * this instrument. If supplied @a pos is out of bounds then @c NULL is
+      * returned.
+      *
+      * @param pos - position of sought Region in region list
+      * @returns pointer address to requested region or @c NULL if @a pos is
+      *          out of bounds
+      */
+     Region* Instrument::GetRegionAt(size_t pos) {
+         if (!pRegions) return NULL;
+         if (pos >= pRegions->size()) return NULL;
+         return static_cast<gig::Region*>( (*pRegions)[pos] );
+     }
+     /**
       * Returns the first Region of the instrument. You have to call this
       * method once before you use GetNextRegion().
       *
       * @returns  pointer address to first region or NULL if there is none
       * @see      GetNextRegion()
+      * @deprecated  This method is not reentrant-safe, use GetRegionAt()
+      *              instead.
       */
      Region* Instrument::GetFirstRegion() {
          if (!pRegions) return NULL;
-Line 4895 
 namespace {
+Line 5339 
 namespace {
       *
       * @returns  pointer address to the next region or NULL if end reached
       * @see      GetFirstRegion()
+      * @deprecated  This method is not reentrant-safe, use GetRegionAt()
+      *              instead.
       */
      Region* Instrument::GetNextRegion() {
          if (!pRegions) return NULL;
-Line 5253 
 namespace {
+Line 5699 
 namespace {
              scriptPoolFileOffsets.at(index).bypass = bBypass;
      }
+     /// type cast (by copy) uint8_t[16] -> std::array<uint8_t,16>
+     inline std::array<uint8_t,16> _UUIDFromCArray(const uint8_t* pData) {
+         std::array<uint8_t,16> uuid;
+         memcpy(&uuid[0], pData, 16);
+         return uuid;
+     }
+     /**
+      * Returns true if this @c Instrument has any script slot which references
+      * the @c Script identified by passed @p uuid.
+      */
+     bool Instrument::ReferencesScriptWithUuid(const _UUID& uuid) {
+         const uint nSlots = ScriptSlotCount();
+         for (uint iSlot = 0; iSlot < nSlots; ++iSlot)
+             if (_UUIDFromCArray(&GetScriptOfSlot(iSlot)->Uuid[0]) == uuid)
+                 return true;
+         return false;
+     }
+     /** @brief Checks whether a certain script 'patch' variable value is set.
+      *
+      * Returns @c true if the initial value for the requested script variable is
+      * currently overridden by this instrument.
+      *
+      * @remarks Real-time instrument scripts allow to declare special 'patch'
+      * variables, which essentially behave like regular variables of their data
+      * type, however their initial value may optionally be overridden on a per
+      * instrument basis. That allows to share scripts between instruments while
+      * still being able to fine tune certain aspects of the script for each
+      * instrument individually.
+      *
+      * @note This is an own format extension which did not exist i.e. in the
+      * GigaStudio 4 software. It will currently only work with LinuxSampler and
+      * Gigedit.
+      *
+      * @param slot - script slot index of the variable to be retrieved
+      * @param variable - name of the 'patch' variable in that script
+      */
+     bool Instrument::IsScriptPatchVariableSet(int slot, String variable) {
+         if (variable.empty()) return false;
+         Script* script = GetScriptOfSlot(slot);
+         if (!script) return false;
+         const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
+         if (!scriptVars.count(uuid)) return false;
+         const _VarsBySlot& slots = scriptVars.find(uuid)->second;
+         if (slots.empty()) return false;
+         if (slots.count(slot))
+             return slots.find(slot)->second.count(variable);
+         else
+             return slots.begin()->second.count(variable);
+     }
+     /** @brief Get all overridden script 'patch' variables.
+      *
+      * Returns map of key-value pairs reflecting all patch variables currently
+      * being overridden by this instrument for the given script @p slot, where
+      * key is the variable name and value is the hereby currently overridden
+      * value for that variable.
+      *
+      * @remarks Real-time instrument scripts allow to declare special 'patch'
+      * variables, which essentially behave like regular variables of their data
+      * type, however their initial value may optionally be overridden on a per
+      * instrument basis. That allows to share scripts between instruments while
+      * still being able to fine tune certain aspects of the script for each
+      * instrument individually.
+      *
+      * @note This is an own format extension which did not exist i.e. in the
+      * GigaStudio 4 software. It will currently only work with LinuxSampler and
+      * Gigedit.
+      *
+      * @param slot - script slot index of the variable to be retrieved
+      */
+     std::map<String,String> Instrument::GetScriptPatchVariables(int slot) {
+         Script* script = GetScriptOfSlot(slot);
+         if (!script) return std::map<String,String>();
+         const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
+         if (!scriptVars.count(uuid)) return std::map<String,String>();
+         const _VarsBySlot& slots = scriptVars.find(uuid)->second;
+         if (slots.empty()) return std::map<String,String>();
+         const _PatchVars& vars =
+             (slots.count(slot)) ?
+                 slots.find(slot)->second : slots.begin()->second;
+         return vars;
+     }
+     /** @brief Get overridden initial value for 'patch' variable.
+      *
+      * Returns current initial value for the requested script variable being
+      * overridden by this instrument.
+      *
+      * @remarks Real-time instrument scripts allow to declare special 'patch'
+      * variables, which essentially behave like regular variables of their data
+      * type, however their initial value may optionally be overridden on a per
+      * instrument basis. That allows to share scripts between instruments while
+      * still being able to fine tune certain aspects of the script for each
+      * instrument individually.
+      *
+      * @note This is an own format extension which did not exist i.e. in the
+      * GigaStudio 4 software. It will currently only work with LinuxSampler and
+      * Gigedit.
+      *
+      * @param slot - script slot index of the variable to be retrieved
+      * @param variable - name of the 'patch' variable in that script
+      */
+     String Instrument::GetScriptPatchVariable(int slot, String variable) {
+         std::map<String,String> vars = GetScriptPatchVariables(slot);
+         return (vars.count(variable)) ? vars.find(variable)->second : "";
+     }
+     /** @brief Override initial value for 'patch' variable.
+      *
+      * Overrides initial value for the requested script variable for this
+      * instrument with the passed value.
+      *
+      * @remarks Real-time instrument scripts allow to declare special 'patch'
+      * variables, which essentially behave like regular variables of their data
+      * type, however their initial value may optionally be overridden on a per
+      * instrument basis. That allows to share scripts between instruments while
+      * still being able to fine tune certain aspects of the script for each
+      * instrument individually.
+      *
+      * @note This is an own format extension which did not exist i.e. in the
+      * GigaStudio 4 software. It will currently only work with LinuxSampler and
+      * Gigedit.
+      *
+      * @param slot - script slot index of the variable to be set
+      * @param variable - name of the 'patch' variable in that script
+      * @param value - overridden initial value for that script variable
+      * @throws gig::Exception if given script @p slot index is invalid or given
+      *         @p variable name is empty
+      */
+     void Instrument::SetScriptPatchVariable(int slot, String variable, String value) {
+         if (variable.empty())
+             throw Exception("Variable name must not be empty");
+         Script* script = GetScriptOfSlot(slot);
+         if (!script)
+             throw Exception("No script slot with index " + ToString(slot));
+         const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
+         scriptVars[uuid][slot][variable] = value;
+     }
+     /** @brief Drop overridden initial value(s) for 'patch' variable(s).
+      *
+      * Reverts initial value(s) for requested script variable(s) back to their
+      * default initial value(s) defined in the script itself.
+      *
+      * Both arguments of this method are optional. The most obvious use case of
+      * this method would be passing a valid script @p slot index and a
+      * (non-emtpy string as) @p variable name to this method, which would cause
+      * that single variable to be unset for that specific script slot (on this
+      * @c Instrument level).
+      *
+      * Not passing a value (or @c -1 for @p slot and/or empty string for
+      * @p variable) means 'wildcard'. So accordingly absence of argument(s) will
+      * cause all variables and/or for all script slots being unset. Hence this
+      * method serves 2^2 = 4 possible use cases in total and accordingly covers
+      * 4 different behaviours in one method.
+      *
+      * @remarks Real-time instrument scripts allow to declare special 'patch'
+      * variables, which essentially behave like regular variables of their data
+      * type, however their initial value may optionally be overridden on a per
+      * instrument basis. That allows to share scripts between instruments while
+      * still being able to fine tune certain aspects of the script for each
+      * instrument individually.
+      *
+      * @note This is an own format extension which did not exist i.e. in the
+      * GigaStudio 4 software. It will currently only work with LinuxSampler and
+      * Gigedit.
+      *
+      * @param slot - script slot index of the variable to be unset
+      * @param variable - name of the 'patch' variable in that script
+      */
+     void Instrument::UnsetScriptPatchVariable(int slot, String variable) {
+         Script* script = GetScriptOfSlot(slot);
+         // option 1: unset a particular variable of one particular script slot
+         if (slot != -1 && !variable.empty()) {
+             if (!script) return;
+             const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
+             if (!scriptVars.count(uuid)) return;
+             if (!scriptVars[uuid].count(slot)) return;
+             if (scriptVars[uuid][slot].count(variable))
+                 scriptVars[uuid][slot].erase(
+                     scriptVars[uuid][slot].find(variable)
+                 );
+             if (scriptVars[uuid][slot].empty())
+                 scriptVars[uuid].erase( scriptVars[uuid].find(slot) );
+             if (scriptVars[uuid].empty())
+                 scriptVars.erase( scriptVars.find(uuid) );
+             return;
+         }
+         // option 2: unset all variables of all script slots
+         if (slot == -1 && variable.empty()) {
+             scriptVars.clear();
+             return;
+         }
+         // option 3: unset all variables of one particular script slot only
+         if (slot != -1) {
+             if (!script) return;
+             const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
+             if (scriptVars.count(uuid))
+                 scriptVars.erase( scriptVars.find(uuid) );
+             return;
+         }
+         // option 4: unset a particular variable of all script slots
+         _VarsByScript::iterator itScript = scriptVars.begin();
+         _VarsByScript::iterator endScript = scriptVars.end();
+         while (itScript != endScript) {
+             _VarsBySlot& slots = itScript->second;
+             _VarsBySlot::iterator itSlot = slots.begin();
+             _VarsBySlot::iterator endSlot = slots.end();
+             while (itSlot != endSlot) {
+                 _PatchVars& vars = itSlot->second;
+                 if (vars.count(variable))
+                     vars.erase( vars.find(variable) );
+                 if (vars.empty())
+                     slots.erase(itSlot++); // postfix increment to avoid iterator invalidation
+                 else
+                     ++itSlot;
+             }
+             if (slots.empty())
+                 scriptVars.erase(itScript++); // postfix increment to avoid iterator invalidation
+             else
+                 ++itScript;
+         }
+     }
+     /**
+      * Returns stripped version of member variable @c scriptVars, where scripts
+      * no longer referenced by this @c Instrument are filtered out, and so are
+      * variables of meanwhile obsolete slots (i.e. a script still being
+      * referenced, but previously overridden on a script slot which either no
+      * longer exists or is hosting another script now).
+      */
+     Instrument::_VarsByScript Instrument::stripScriptVars() {
+         _VarsByScript vars;
+         _VarsByScript::const_iterator itScript = scriptVars.begin();
+         _VarsByScript::const_iterator endScript = scriptVars.end();
+         for (; itScript != endScript; ++itScript) {
+             const _UUID& uuid = itScript->first;
+             if (!ReferencesScriptWithUuid(uuid))
+                 continue;
+             const _VarsBySlot& slots = itScript->second;
+             _VarsBySlot::const_iterator itSlot = slots.begin();
+             _VarsBySlot::const_iterator endSlot = slots.end();
+             for (; itSlot != endSlot; ++itSlot) {
+                 Script* script = GetScriptOfSlot(itSlot->first);
+                 if (!script) continue;
+                 if (_UUIDFromCArray(&script->Uuid[0]) != uuid) continue;
+                 if (itSlot->second.empty()) continue;
+                 vars[uuid][itSlot->first] = itSlot->second;
+             }
+         }
+         return vars;
+     }
      /**
       * Make a (semi) deep copy of the Instrument object given by @a orig
       * and assign it to this object.
-Line 5287 
 namespace {
+Line 5992 
 namespace {
          PianoReleaseMode = orig->PianoReleaseMode;
          DimensionKeyRange = orig->DimensionKeyRange;
          scriptPoolFileOffsets = orig->scriptPoolFileOffsets;
-         pScriptRefs = orig->pScriptRefs;
+         // deep copy of pScriptRefs required (to avoid undefined behaviour)
+         if (pScriptRefs) delete pScriptRefs;
+         pScriptRefs = new std::vector<_ScriptPooolRef>;
+         if (orig->pScriptRefs)
+             *pScriptRefs = *orig->pScriptRefs;
+         scriptVars = orig->scriptVars;
          // free old midi rules
          for (int i = 0 ; pMidiRules[i] ; i++) {
-Line 5297 
 namespace {
+Line 6007 
 namespace {
          pMidiRules[0] = NULL;
          // delete all old regions
-         while (Regions) DeleteRegion(GetFirstRegion());
+         while (Regions) DeleteRegion(GetRegionAt(0));
          // create new regions and copy them from original
          {
              RegionList::const_iterator it = orig->pRegions->begin();
-Line 5314 
 namespace {
+Line 6024 
 namespace {
          UpdateRegionKeyTable();
      }
+     /**
+      * Returns @c true in case this Instrument object uses any gig format
+      * extension, that is e.g. whether any DimensionRegion object currently
+      * has any setting effective that would require our "LSDE" RIFF chunk to
+      * be stored to the gig file.
+      *
+      * Right now this is a private method. It is considerable though this method
+      * to become (in slightly modified form) a public API method in future, i.e.
+      * to allow instrument editors to visualize and/or warn the user of any gig
+      * format extension being used. See also comments on
+      * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
+      * potential public API change in future.
+      */
+     bool Instrument::UsesAnyGigFormatExtension() const {
+         if (!pRegions) return false;
+         if (!scriptVars.empty()) return true;
+         RegionList::const_iterator iter = pRegions->begin();
+         RegionList::const_iterator end  = pRegions->end();
+         for (; iter != end; ++iter) {
+             gig::Region* rgn = static_cast<gig::Region*>(*iter);
+             if (rgn->UsesAnyGigFormatExtension())
+                 return true;
+         }
+         return false;
+     }
  // *************** Group ***************
  // *
-Line 5327 
 namespace {
+Line 6063 
 namespace {
      Group::Group(File* file, RIFF::Chunk* ck3gnm) {
          pFile      = file;
          pNameChunk = ck3gnm;
+         SamplesIterator = 0;
          ::LoadString(pNameChunk, Name);
      }
+     /** @brief Destructor.
+      *
+      * Currently this destructor implementation does nothing.
+      */
      Group::~Group() {
-         // remove the chunk associated with this group (if any)
+     }
-         if (pNameChunk) pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
+     /** @brief Remove all RIFF chunks associated with this Group object.
+      *
+      * See DLS::Storage::DeleteChunks() for details.
+      */
+     void Group::DeleteChunks() {
+         // handle own RIFF chunks
+         if (pNameChunk) {
+             pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
+             pNameChunk = NULL;
+         }
      }
      /** @brief Update chunks with current group settings.
-Line 5355 
 namespace {
+Line 6106 
 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) {
+         if (!pNameChunk && pFile->pVersion && pFile->pVersion->major > 2) {
              // v3 has a fixed list of 128 strings, find a free one
-             for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {
+             size_t i = 0;
+             for (RIFF::Chunk* ck = _3gnl->GetSubChunkAt(i); ck; ck = _3gnl->GetSubChunkAt(++i)) {
                  if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {
                      pNameChunk = ck;
                      break;
-Line 5370 
 namespace {
+Line 6122 
 namespace {
      }
      /**
+      * Returns Sample object at @a index of this sample group.
+      *
+      * @param index - position of sample in this sample group's sample list
+      *                (0..n)
+      * @returns sample object or NULL if index is out of bounds
+      */
+     Sample* Group::GetSample(size_t index) {
+         if (pFile->pSamples && index >= pFile->pSamples->size()) return NULL;
+         size_t indexInFile = 0;
+         size_t indexInGroup = 0;
+         for (Sample* pSample = pFile->GetSample(indexInFile); pSample;
+                      pSample = pFile->GetSample(++indexInFile))
+         {
+             if (pSample->GetGroup() != this) continue;
+             if (indexInGroup++ == index) return pSample;
+         }
+         return NULL;
+     }
+     /**
       * Returns the first Sample of this Group. You have to call this method
       * once before you use GetNextSample().
       *
-Line 5379 
 namespace {
+Line 6151 
 namespace {
       * @returns  pointer address to first Sample or NULL if there is none
       *           applied to this Group
       * @see      GetNextSample()
+      * @deprecated  This method is not reentrant-safe, use GetSample()
+      *              instead.
       */
      Sample* Group::GetFirstSample() {
-         // FIXME: lazy und unsafe implementation, should be an autonomous iterator
+         size_t& i = this->SamplesIterator;
-         for (Sample* pSample = pFile->GetFirstSample(); pSample; pSample = pFile->GetNextSample()) {
+         i = 0;
-             if (pSample->GetGroup() == this) return pSample;
+         for (Sample* pSample = pFile->GetSample(i); pSample;
+                      pSample = pFile->GetSample(++i))
+         {
+             if (pSample->GetGroup() == this)
+                 return pSample;
          }
          return NULL;
      }
-Line 5397 
 namespace {
+Line 6175 
 namespace {
       * @returns  pointer address to the next Sample of this Group or NULL if
       *           end reached
       * @see      GetFirstSample()
+      * @deprecated  This method is not reentrant-safe, use GetSample()
+      *              instead.
       */
      Sample* Group::GetNextSample() {
-         // FIXME: lazy und unsafe implementation, should be an autonomous iterator
+         size_t& i = this->SamplesIterator;
-         for (Sample* pSample = pFile->GetNextSample(); pSample; pSample = pFile->GetNextSample()) {
+         for (Sample* pSample = pFile->GetSample(++i); pSample;
-             if (pSample->GetGroup() == this) return pSample;
+                      pSample = pFile->GetSample(++i))
+         {
+             if (pSample->GetGroup() == this)
+                 return pSample;
          }
          return NULL;
      }
-Line 5430 
 namespace {
+Line 6213 
 namespace {
              "other Group. This is a bug, report it!"
          );
          // now move all samples of this group to the other group
-         for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
+         Sample* pSample;
+         while ((pSample = GetSample(0))) {
              pOtherGroup->AddSample(pSample);
          }
      }
-Line 5450 
 namespace {
+Line 6234 
 namespace {
 , 3, 20030331 & 0xffff, 20030331 >> 16
      };
+     /// Reflects Gigasampler file format version 4.0 (2007-10-12).
+     const DLS::version_t File::VERSION_4 = {
+, 4, 20071012 & 0xffff, 20071012 >> 16
+     };
      static const DLS::Info::string_length_t _FileFixedStringLengths[] = {
          { CHUNK_ID_IARL, 256 },
          { CHUNK_ID_IART, 128 },
-Line 5497 
 namespace {
+Line 6286 
 namespace {
      File::~File() {
          if (pGroups) {
-             std::list<Group*>::iterator iter = pGroups->begin();
+             std::vector<Group*>::iterator iter = pGroups->begin();
-             std::list<Group*>::iterator end  = pGroups->end();
+             std::vector<Group*>::iterator end  = pGroups->end();
              while (iter != end) {
                  delete *iter;
                  ++iter;
-Line 5516 
 namespace {
+Line 6305 
 namespace {
          }
      }
+     /**
+      * Returns a pointer to the first <i>Sample</i> object of the file,
+      * <i>NULL</i> otherwise.
+      *
+      * @param pProgress - optional: callback function for progress notification
+      * @deprecated  This method is not reentrant-safe, use GetSample()
+      *              instead.
+      */
      Sample* File::GetFirstSample(progress_t* pProgress) {
          if (!pSamples) LoadSamples(pProgress);
          if (!pSamples) return NULL;
-Line 5523 
 namespace {
+Line 6320 
 namespace {
          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
      }
+     /**
+      * Returns a pointer to the next <i>Sample</i> object of the file,
+      * <i>NULL</i> otherwise.
+      *
+      * @deprecated  This method is not reentrant-safe, use GetSample()
+      *              instead.
+      */
      Sample* File::GetNextSample() {
          if (!pSamples) return NULL;
          SamplesIterator++;
-Line 5532 
 namespace {
+Line 6336 
 namespace {
      /**
       * Returns Sample object of @a index.
       *
+      * @param index - position of sample in sample list (0..n)
+      * @param pProgress - optional: callback function for progress notification
       * @returns sample object or NULL if index is out of bounds
       */
-     Sample* File::GetSample(uint index) {
+     Sample* File::GetSample(size_t index, progress_t* pProgress) {
-         if (!pSamples) LoadSamples();
+         if (!pSamples) LoadSamples(pProgress);
          if (!pSamples) return NULL;
-         DLS::File::SampleList::iterator it = pSamples->begin();
+         if (index >= pSamples->size()) return NULL;
-         for (int i = 0; i < index; ++i) {
+         return static_cast<gig::Sample*>( (*pSamples)[index] );
-             ++it;
+     }
-             if (it == pSamples->end()) return NULL;
-         }
+     /**
-         if (it == pSamples->end()) return NULL;
+      * Returns the total amount of samples of this gig file.
-         return static_cast<gig::Sample*>( *it );
+      *
+      * Note that this method might block for a long time in case it is required
+      * to load the sample info for the first time.
+      *
+      * @returns total amount of samples
+      */
+     size_t File::CountSamples() {
+         if (!pSamples) LoadSamples();
+         if (!pSamples) return 0;
+         return pSamples->size();
      }
      /** @brief Add a new sample.
-Line 5584 
 namespace {
+Line 6399 
 namespace {
          if (iter == pSamples->end()) throw gig::Exception("Could not delete sample, could not find given sample");
          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
          pSamples->erase(iter);
+         pSample->DeleteChunks();
          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 ;
+             size_t iRgn = 0;
-                  region = instrument->GetNextRegion()) {
+             for (Region* region = instrument->GetRegionAt(iRgn); region;
+                  region = instrument->GetRegionAt(++iRgn))
+             {
                  if (region->GetSample() == pSample) region->SetSample(NULL);
                  for (int i = 0 ; i < region->DimensionRegions ; i++) {
-Line 5615 
 namespace {
+Line 6432 
 namespace {
          if (!pSamples) pSamples = new SampleList;
-         RIFF::File* file = pRIFF;
          // just for progress calculation
          int iSampleIndex  = 0;
          int iTotalSamples = WavePoolCount;
-         // check if samples should be loaded from extension files
+         // just for assembling path of optional extension files to be read
-         // (only for old gig files < 2 GB)
+         const std::string folder = parentPath(pRIFF->GetFileName());
-         int lastFileNo = 0;
+         const std::string baseName = pathWithoutExtension(pRIFF->GetFileName());
-         if (!file->IsNew() && !(file->GetCurrentFileSize() >> 31)) {
-             for (int i = 0 ; i < WavePoolCount ; i++) {
+         // the main gig file and the extension files (.gx01, ... , .gx98) may
-                 if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];
+         // contain wave data (wave pool)
-             }
+         std::vector<RIFF::File*> poolFiles;
-         }
+         poolFiles.push_back(pRIFF);
-         String name(pRIFF->GetFileName());
-         int nameLen = (int) name.length();
+         // get info about all extension files
-         char suffix[6];
+         RIFF::Chunk* ckXfil = pRIFF->GetSubChunk(CHUNK_ID_XFIL);
-         if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;
+         if (ckXfil) { // there are extension files (.gx01, ... , .gx98) ...
+             const uint32_t n = ckXfil->ReadInt32();
-         for (int fileNo = 0 ; ; ) {
+             for (int i = 0; i < n; i++) {
+                 // read the filename and load the extension file
+                 std::string name;
+                 ckXfil->ReadString(name, 128);
+                 std::string path = concatPath(folder, name);
+                 RIFF::File* pExtFile = new RIFF::File(path);
+                 // check that the dlsids match
+                 RIFF::Chunk* ckDLSID = pExtFile->GetSubChunk(CHUNK_ID_DLID);
+                 if (ckDLSID) {
+                     ::DLS::dlsid_t idExpected;
+                     idExpected.ulData1 = ckXfil->ReadInt32();
+                     idExpected.usData2 = ckXfil->ReadInt16();
+                     idExpected.usData3 = ckXfil->ReadInt16();
+                     ckXfil->Read(idExpected.abData, 8, 1);
+                     ::DLS::dlsid_t idFound;
+                     ckDLSID->Read(&idFound.ulData1, 1, 4);
+                     ckDLSID->Read(&idFound.usData2, 1, 2);
+                     ckDLSID->Read(&idFound.usData3, 1, 2);
+                     ckDLSID->Read(idFound.abData, 8, 1);
+                     if (memcmp(&idExpected, &idFound, 16) != 0)
+                         throw gig::Exception("dlsid mismatch for extension file: %s", path.c_str());
+                 }
+                 poolFiles.push_back(pExtFile);
+                 ExtensionFiles.push_back(pExtFile);
+             }
+         }
+         // check if a .gx99 (GigaPulse) file exists
+         RIFF::Chunk* ckDoxf = pRIFF->GetSubChunk(CHUNK_ID_DOXF);
+         if (ckDoxf) { // there is a .gx99 (GigaPulse) file ...
+             std::string path = baseName + ".gx99";
+             RIFF::File* pExtFile = new RIFF::File(path);
+             // skip unused int and filename
+             ckDoxf->SetPos(132, RIFF::stream_curpos);
+             // check that the dlsids match
+             RIFF::Chunk* ckDLSID = pExtFile->GetSubChunk(CHUNK_ID_DLID);
+             if (ckDLSID) {
+                 ::DLS::dlsid_t idExpected;
+                 idExpected.ulData1 = ckDoxf->ReadInt32();
+                 idExpected.usData2 = ckDoxf->ReadInt16();
+                 idExpected.usData3 = ckDoxf->ReadInt16();
+                 ckDoxf->Read(idExpected.abData, 8, 1);
+                 ::DLS::dlsid_t idFound;
+                 ckDLSID->Read(&idFound.ulData1, 1, 4);
+                 ckDLSID->Read(&idFound.usData2, 1, 2);
+                 ckDLSID->Read(&idFound.usData3, 1, 2);
+                 ckDLSID->Read(idFound.abData, 8, 1);
+                 if (memcmp(&idExpected, &idFound, 16) != 0)
+                     throw gig::Exception("dlsid mismatch for GigaPulse file: %s", path.c_str());
+             }
+             poolFiles.push_back(pExtFile);
+             ExtensionFiles.push_back(pExtFile);
+         }
+         // load samples from extension files (if required)
+         for (int i = 0; i < poolFiles.size(); i++) {
+             RIFF::File* file = poolFiles[i];
              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
              if (wvpl) {
-                 file_offset_t wvplFileOffset = wvpl->GetFilePos();
+                 file_offset_t wvplFileOffset = wvpl->GetFilePos() -
-                 RIFF::List* wave = wvpl->GetFirstSubList();
+                                                wvpl->GetPos(); // should be zero, but just to be sure
-                 while (wave) {
+                 size_t i = 0;
+                 for (RIFF::List* wave = wvpl->GetSubListAt(i); wave;
+                      wave = wvpl->GetSubListAt(++i))
+                 {
                      if (wave->GetListType() == LIST_TYPE_WAVE) {
                          // notify current progress
-                         const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
+                         if (pProgress) {
-                         __notify_progress(pProgress, subprogress);
+                             const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
+                             __notify_progress(pProgress, subprogress);
+                         }
                          file_offset_t waveFileOffset = wave->GetFilePos();
-                         pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo, iSampleIndex));
+                         pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, i, iSampleIndex));
                          iSampleIndex++;
                      }
-                     wave = wvpl->GetNextSubList();
                  }
+             }
-                 if (fileNo == lastFileNo) break;
-                 // open extension file (*.gx01, *.gx02, ...)
-                 fileNo++;
-                 sprintf(suffix, ".gx%02d", fileNo);
-                 name.replace(nameLen, 5, suffix);
-                 file = new RIFF::File(name);
-                 ExtensionFiles.push_back(file);
-             } else break;
          }
-         __notify_progress(pProgress, 1.0); // notify done
+         if (pProgress)
+             __notify_progress(pProgress, 1.0); // notify done
      }
      Instrument* File::GetFirstInstrument() {
-Line 5681 
 namespace {
+Line 6550 
 namespace {
      }
      /**
+      * Returns the total amount of instruments of this gig file.
+      *
+      * Note that this method might block for a long time in case it is required
+      * to load the instruments info for the first time.
+      *
+      * @returns total amount of instruments
+      */
+     size_t File::CountInstruments() {
+         if (!pInstruments) LoadInstruments();
+         if (!pInstruments) return 0;
+         return pInstruments->size();
+     }
+     /**
       * Returns the instrument with the given index.
       *
       * @param index     - number of the sought instrument (0..n)
-Line 5691 
 namespace {
+Line 6574 
 namespace {
          if (!pInstruments) {
              // TODO: hack - we simply load ALL samples here, it would have been done in the Region constructor anyway (ATM)
-             // sample loading subtask
+             if (pProgress) {
-             progress_t subprogress;
+                 // sample loading subtask
-             __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
+                 progress_t subprogress;
-             __notify_progress(&subprogress, 0.0f);
+                 __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
-             if (GetAutoLoad())
+                 __notify_progress(&subprogress, 0.0f);
-                 GetFirstSample(&subprogress); // now force all samples to be loaded
+                 if (GetAutoLoad())
-             __notify_progress(&subprogress, 1.0f);
+                     GetSample(0, &subprogress); // now force all samples to be loaded
+                 __notify_progress(&subprogress, 1.0f);
-             // instrument loading subtask
-             if (pProgress && pProgress->callback) {
+                 // instrument loading subtask
-                 subprogress.__range_min = subprogress.__range_max;
+                 if (pProgress->callback) {
-                 subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask
+                     subprogress.__range_min = subprogress.__range_max;
-             }
+                     subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask
-             __notify_progress(&subprogress, 0.0f);
+                 }
-             LoadInstruments(&subprogress);
+                 __notify_progress(&subprogress, 0.0f);
-             __notify_progress(&subprogress, 1.0f);
+                 LoadInstruments(&subprogress);
+                 __notify_progress(&subprogress, 1.0f);
+             } else {
+                 // sample loading subtask
+                 if (GetAutoLoad())
+                     GetSample(0); // now force all samples to be loaded
+                 // instrument loading subtask
+                 LoadInstruments();
+             }
          }
          if (!pInstruments) return NULL;
          InstrumentsIterator = pInstruments->begin();
-Line 5855 
 namespace {
+Line 6747 
 namespace {
          InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);
          if (iter == pInstruments->end()) throw gig::Exception("Could not delete instrument, could not find given instrument");
          pInstruments->erase(iter);
+         pInstrument->DeleteChunks();
          delete pInstrument;
      }
-Line 5867 
 namespace {
+Line 6760 
 namespace {
          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
          if (lstInstruments) {
              int iInstrumentIndex = 0;
-             RIFF::List* lstInstr = lstInstruments->GetFirstSubList();
+             size_t i = 0;
-             while (lstInstr) {
+             for (RIFF::List* lstInstr = lstInstruments->GetSubListAt(i);
+                  lstInstr; lstInstr = lstInstruments->GetSubListAt(++i))
+             {
                  if (lstInstr->GetListType() == LIST_TYPE_INS) {
-                     // notify current progress
+                     if (pProgress) {
-                     const float localProgress = (float) iInstrumentIndex / (float) Instruments;
+                         // notify current progress
-                     __notify_progress(pProgress, localProgress);
+                         const float localProgress = (float) iInstrumentIndex / (float) Instruments;
+                         __notify_progress(pProgress, localProgress);
-                     // divide local progress into subprogress for loading current Instrument
-                     progress_t subprogress;
-                     __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
-                     pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
+                         // divide local progress into subprogress for loading current Instrument
+                         progress_t subprogress;
+                         __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
+                         pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
+                     } else {
+                         pInstruments->push_back(new Instrument(this, lstInstr));
+                     }
                      iInstrumentIndex++;
                  }
-                 lstInstr = lstInstruments->GetNextSubList();
              }
-             __notify_progress(pProgress, 1.0); // notify done
+             if (pProgress)
+                 __notify_progress(pProgress, 1.0); // notify done
          }
      }
-Line 5935 
 namespace {
+Line 6834 
 namespace {
      }
      int File::GetWaveTableIndexOf(gig::Sample* pSample) {
-         if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
+         if (!pSamples) GetSample(0); // make sure sample chunks were scanned
          File::SampleList::iterator iter = pSamples->begin();
          File::SampleList::iterator end  = pSamples->end();
          for (int index = 0; iter != end; ++iter, ++index)
-Line 5955 
 namespace {
+Line 6854 
 namespace {
          if (!_3crc) return false;
          if (_3crc->GetNewSize() <= 0) return false;
          if (_3crc->GetNewSize() % 8) return false;
-         if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned
+         if (!pSamples) GetSample(0); // make sure sample chunks were scanned
          if (_3crc->GetNewSize() != pSamples->size() * 8) return false;
          const file_offset_t n = _3crc->GetNewSize() / 8;
-Line 5989 
 namespace {
+Line 6888 
 namespace {
       */
      bool File::RebuildSampleChecksumTable() {
          // make sure sample chunks were scanned
-         if (!pSamples) GetFirstSample();
+         if (!pSamples) GetSample(0);
          bool bRequiresSave = false;
-Line 5999 
 namespace {
+Line 6898 
 namespace {
              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
              // the order of einf and 3crc is not the same in v2 and v3
              RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
-             if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
+             if (einf && pVersion && pVersion->major > 2) pRIFF->MoveSubChunk(_3crc, einf);
              bRequiresSave = true;
          } else if (_3crc->GetNewSize() != pSamples->size() * 8) {
              _3crc->Resize(pSamples->size() * 8);
-Line 6038 
 namespace {
+Line 6937 
 namespace {
          return bRequiresSave;
      }
+     /**
+      * Returns a pointer to the first <i>Group</i> object of the file,
+      * <i>NULL</i> otherwise.
+      *
+      * @deprecated  This method is not reentrant-safe, use GetGroup() instead.
+      */
      Group* File::GetFirstGroup() {
          if (!pGroups) LoadGroups();
          // there must always be at least one group
-Line 6045 
 namespace {
+Line 6950 
 namespace {
          return *GroupsIterator;
      }
+     /**
+      * Returns a pointer to the next <i>Group</i> object of the file,
+      * <i>NULL</i> otherwise.
+      *
+      * @deprecated  This method is not reentrant-safe, use GetGroup() instead.
+      */
      Group* File::GetNextGroup() {
          if (!pGroups) return NULL;
          ++GroupsIterator;
-Line 6057 
 namespace {
+Line 6968 
 namespace {
       * @param index - number of the sought group (0..n)
       * @returns sought group or NULL if there's no such group
       */
-     Group* File::GetGroup(uint index) {
+     Group* File::GetGroup(size_t index) {
          if (!pGroups) LoadGroups();
-         GroupsIterator = pGroups->begin();
+         if (index >= pGroups->size()) return NULL;
-         for (uint i = 0; GroupsIterator != pGroups->end(); i++) {
+         return (*pGroups)[index];
-             if (i == index) return *GroupsIterator;
-             ++GroupsIterator;
-         }
-         return NULL;
      }
      /**
-Line 6105 
 namespace {
+Line 7012 
 namespace {
       */
      void File::DeleteGroup(Group* pGroup) {
          if (!pGroups) LoadGroups();
-         std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
+         std::vector<Group*>::iterator iter =
+             find(pGroups->begin(), pGroups->end(), pGroup);
          if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
          if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
          // delete all members of this group
-         for (Sample* pSample = pGroup->GetFirstSample(); pSample; pSample = pGroup->GetNextSample()) {
+         Sample* pSample;
+         while ((pSample = pGroup->GetSample(0))) {
              DeleteSample(pSample);
          }
          // now delete this group object
          pGroups->erase(iter);
+         pGroup->DeleteChunks();
          delete pGroup;
      }
-Line 6129 
 namespace {
+Line 7039 
 namespace {
       */
      void File::DeleteGroupOnly(Group* pGroup) {
          if (!pGroups) LoadGroups();
-         std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
+         std::vector<Group*>::iterator iter =
+             find(pGroups->begin(), pGroups->end(), pGroup);
          if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
          if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
          // move all members of this group to another group
          pGroup->MoveAll();
          pGroups->erase(iter);
+         pGroup->DeleteChunks();
          delete pGroup;
      }
      void File::LoadGroups() {
-         if (!pGroups) pGroups = new std::list<Group*>;
+         if (!pGroups) pGroups = new std::vector<Group*>;
          // try to read defined groups from file
          RIFF::List* lst3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
          if (lst3gri) {
              RIFF::List* lst3gnl = lst3gri->GetSubList(LIST_TYPE_3GNL);
              if (lst3gnl) {
-                 RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();
+                 size_t i = 0;
-                 while (ck) {
+                 for (RIFF::Chunk* ck = lst3gnl->GetSubChunkAt(i); ck;
+                      ck = lst3gnl->GetSubChunkAt(++i))
+                 {
                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {
-                         if (pVersion && pVersion->major == 3 &&
+                         if (pVersion && pVersion->major > 2 &&
                              strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;
                          pGroups->push_back(new Group(this, ck));
                      }
-                     ck = lst3gnl->GetNextSubChunk();
                  }
              }
          }
-Line 6234 
 namespace {
+Line 7147 
 namespace {
              pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));
          if (pScriptGroup->pList)
              pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);
+         pScriptGroup->DeleteChunks();
          delete pScriptGroup;
      }
-Line 6242 
 namespace {
+Line 7156 
 namespace {
          pScriptGroups = new std::list<ScriptGroup*>;
          RIFF::List* lstLS = pRIFF->GetSubList(LIST_TYPE_3LS);
          if (lstLS) {
-             for (RIFF::List* lst = lstLS->GetFirstSubList(); lst;
+             size_t i = 0;
-                  lst = lstLS->GetNextSubList())
+             for (RIFF::List* lst = lstLS->GetSubListAt(i); lst;
+                  lst = lstLS->GetSubListAt(++i))
              {
                  if (lst->GetListType() == LIST_TYPE_RTIS) {
                      pScriptGroups->push_back(new ScriptGroup(this, lst));
-Line 6304 
 namespace {
+Line 7219 
 namespace {
              // INFO was added by Resource::UpdateChunks - make sure it
              // is placed first in file
              RIFF::Chunk* info = pRIFF->GetSubList(LIST_TYPE_INFO);
-             RIFF::Chunk* first = pRIFF->GetFirstSubChunk();
+             RIFF::Chunk* first = pRIFF->GetSubChunkAt(0);
              if (first != info) {
                  pRIFF->MoveSubChunk(info, first);
              }
-Line 6324 
 namespace {
+Line 7239 
 namespace {
              // v3: make sure the file has 128 3gnm chunks
              // (before updating the Group chunks)
-             if (pVersion && pVersion->major == 3) {
+             if (pVersion && pVersion->major > 2) {
-                 RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
+                 size_t i = 0;
-                 for (int i = 0 ; i < 128 ; i++) {
+                 for (RIFF::Chunk* _3gnm = _3gnl->GetSubChunkAt(i); i < 128;
-                     if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
+                      _3gnm = _3gnl->GetSubChunkAt(++i))
-                     if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();
+                 {
+                     // create 128 empty placeholder strings which will either
+                     // be filled by Group::UpdateChunks below or left empty.
+                     ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
                  }
              }
-             std::list<Group*>::iterator iter = pGroups->begin();
+             std::vector<Group*>::iterator iter = pGroups->begin();
-             std::list<Group*>::iterator end  = pGroups->end();
+             std::vector<Group*>::iterator end  = pGroups->end();
              for (; iter != end; ++iter) {
                  (*iter)->UpdateChunks(pProgress);
              }
-Line 6371 
 namespace {
+Line 7289 
 namespace {
              uint8_t* pData = (uint8_t*) einf->LoadChunkData();
              std::map<gig::Sample*,int> sampleMap;
-             int sampleIdx = 0;
+             size_t sampleIdx = 0;
-             for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
+             for (Sample* pSample = GetSample(0); pSample;
-                 sampleMap[pSample] = sampleIdx++;
+                          pSample = GetSample(++sampleIdx))
+             {
+                 sampleMap[pSample] = sampleIdx;
              }
              int totnbusedsamples = 0;
-Line 6394 
 namespace {
+Line 7314 
 namespace {
                  memset(&pData[(instrumentIdx + 1) * sublen + 48], 0, sublen - 48);
-                 for (Region* region = instrument->GetFirstRegion() ; region ;
+                 size_t iRgn = 0;
-                      region = instrument->GetNextRegion()) {
+                 for (Region* region = instrument->GetRegionAt(iRgn); region;
+                      region = instrument->GetRegionAt(++iRgn))
+                 {
                      for (int i = 0 ; i < region->DimensionRegions ; i++) {
                          gig::DimensionRegion *d = region->pDimensionRegions[i];
                          if (d->pSample) {
-Line 6470 
 namespace {
+Line 7392 
 namespace {
          } else /*if (newFile)*/ {
              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
              // the order of einf and 3crc is not the same in v2 and v3
-             if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
+             if (einf && pVersion && pVersion->major > 2) pRIFF->MoveSubChunk(_3crc, einf);
          }
          { // must be performed in RAM here ...
              uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
-Line 6497 
 namespace {
+Line 7419 
 namespace {
      }
      /**
-      * Enable / disable automatic loading. By default this properyt is
+      * Enable / disable automatic loading. By default this property is
-      * enabled and all informations are loaded automatically. However
+      * enabled and every information is 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
-Line 6506 
 namespace {
+Line 7428 
 namespace {
       * 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
+      * references) and attributes 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
+      * superficial information in a very fast way. Don't use it to retrieve
-      * details like synthesis informations or even to modify .gig files!
+      * details like synthesis information or even to modify .gig files!
       */
      void File::SetAutoLoad(bool b) {
          bAutoLoad = b;
-Line 6523 
 namespace {
+Line 7445 
 namespace {
          return bAutoLoad;
      }
+     /**
+      * Returns @c true in case this gig File object uses any gig format
+      * extension, that is e.g. whether any DimensionRegion object currently
+      * has any setting effective that would require our "LSDE" RIFF chunk to
+      * be stored to the gig file.
+      *
+      * Right now this is a private method. It is considerable though this method
+      * to become (in slightly modified form) a public API method in future, i.e.
+      * to allow instrument editors to visualize and/or warn the user of any gig
+      * format extension being used. See also comments on
+      * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
+      * potential public API change in future.
+      */
+     bool File::UsesAnyGigFormatExtension() const {
+         if (!pInstruments) return false;
+         InstrumentList::iterator iter = pInstruments->begin();
+         InstrumentList::iterator end  = pInstruments->end();
+         for (; iter != end; ++iter) {
+             Instrument* pInstrument = static_cast<gig::Instrument*>(*iter);
+             if (pInstrument->UsesAnyGigFormatExtension())
+                 return true;
+         }
+         return false;
+     }
  // *************** Exception ***************

 Legend:



Removed from v.3323
 


changed lines


 
Added in v.3937
 Legend:



Removed from v.3323
 


changed lines


 
Added in v.3937
-Removed from v.3323
+Added in v.3937

	ViewVC Help
Powered by ViewVC