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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 3722 by schoenebeck, Wed Jan 22 15:37:09 2020 UTC revision 3939 by schoenebeck, Thu Jun 17 12:04:54 2021 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file access library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2020 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2021 by Christian Schoenebeck                      *
6   *                              <cuse@users.sourceforge.net>               *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   This library is free software; you can redistribute it and/or modify  *
# Line 482  namespace { Line 482  namespace {
482              ScanCompressedSample();              ScanCompressedSample();
483          }          }
484    
485          // we use a buffer for decompression and for truncating 24 bit samples to 16 bit          // we use a buffer for decompression only
486          if ((Compressed || BitDepth == 24) && !InternalDecompressionBuffer.Size) {          if (Compressed && !InternalDecompressionBuffer.Size) {
487              InternalDecompressionBuffer.pStart = new unsigned char[INITIAL_SAMPLE_BUFFER_SIZE];              InternalDecompressionBuffer.pStart = new unsigned char[INITIAL_SAMPLE_BUFFER_SIZE];
488              InternalDecompressionBuffer.Size   = INITIAL_SAMPLE_BUFFER_SIZE;              InternalDecompressionBuffer.Size   = INITIAL_SAMPLE_BUFFER_SIZE;
489          }          }
# Line 609  namespace { Line 609  namespace {
609          uint16_t iSampleGroup = 0; // 0 refers to default sample group          uint16_t iSampleGroup = 0; // 0 refers to default sample group
610          File* pFile = static_cast<File*>(pParent);          File* pFile = static_cast<File*>(pParent);
611          if (pFile->pGroups) {          if (pFile->pGroups) {
612              std::list<Group*>::iterator iter = pFile->pGroups->begin();              std::vector<Group*>::iterator iter = pFile->pGroups->begin();
613              std::list<Group*>::iterator end  = pFile->pGroups->end();              std::vector<Group*>::iterator end  = pFile->pGroups->end();
614              for (int i = 0; iter != end; i++, iter++) {              for (int i = 0; iter != end; i++, iter++) {
615                  if (*iter == pGroup) {                  if (*iter == pGroup) {
616                      iSampleGroup = i;                      iSampleGroup = i;
# Line 3498  namespace { Line 3498  namespace {
3498          RIFF::List* _3prg = rgn->GetSubList(LIST_TYPE_3PRG);          RIFF::List* _3prg = rgn->GetSubList(LIST_TYPE_3PRG);
3499          if (_3prg) {          if (_3prg) {
3500              int dimensionRegionNr = 0;              int dimensionRegionNr = 0;
3501              RIFF::List* _3ewl = _3prg->GetFirstSubList();              size_t i = 0;
3502              while (_3ewl) {              for (RIFF::List* _3ewl = _3prg->GetSubListAt(i); _3ewl;
3503                     _3ewl = _3prg->GetSubListAt(++i))
3504                {
3505                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {
3506                      pDimensionRegions[dimensionRegionNr] = new DimensionRegion(this, _3ewl);                      pDimensionRegions[dimensionRegionNr] = new DimensionRegion(this, _3ewl);
3507                      dimensionRegionNr++;                      dimensionRegionNr++;
3508                  }                  }
                 _3ewl = _3prg->GetNextSubList();  
3509              }              }
3510              if (dimensionRegionNr == 0) throw gig::Exception("No dimension region found.");              if (dimensionRegionNr == 0) throw gig::Exception("No dimension region found.");
3511          }          }
# Line 3807  namespace { Line 3808  namespace {
3808       * @throws gig::Exception if requested zone could not be deleted       * @throws gig::Exception if requested zone could not be deleted
3809       */       */
3810      void Region::DeleteDimensionZone(dimension_t type, int zone) {      void Region::DeleteDimensionZone(dimension_t type, int zone) {
3811            if (!Dimensions)
3812                throw gig::Exception("Could not delete dimension zone, because there is no dimension at all.");
3813          dimension_def_t* oldDef = GetDimensionDefinition(type);          dimension_def_t* oldDef = GetDimensionDefinition(type);
3814          if (!oldDef)          if (!oldDef)
3815              throw gig::Exception("Could not delete dimension zone, no such dimension of given type");              throw gig::Exception("Could not delete dimension zone, no such dimension of given type");
# Line 3835  namespace { Line 3838  namespace {
3838          // requested by the arguments of this method call) to the temporary          // requested by the arguments of this method call) to the temporary
3839          // region, and don't use Region::CopyAssign() here for this task, since          // region, and don't use Region::CopyAssign() here for this task, since
3840          // it would also alter fast lookup helper variables here and there          // it would also alter fast lookup helper variables here and there
3841          dimension_def_t newDef;          dimension_def_t newDef = {};
3842          for (int i = 0; i < Dimensions; ++i) {          for (int i = 0; i < Dimensions; ++i) {
3843              dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference              dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3844              // is this the dimension requested by the method arguments? ...              // is this the dimension requested by the method arguments? ...
# Line 3846  namespace { Line 3849  namespace {
3849              }              }
3850              tempRgn->AddDimension(&def);              tempRgn->AddDimension(&def);
3851          }          }
3852            // silence clang sanitizer warning
3853            if (newDef.dimension == dimension_none)
3854                throw gig::Exception("Unexpected internal failure resolving dimension in DeleteDimensionZone() [this is a bug].");
3855    
3856          // find the dimension index in the tempRegion which is the dimension          // find the dimension index in the tempRegion which is the dimension
3857          // type passed to this method (paranoidly expecting different order)          // type passed to this method (paranoidly expecting different order)
# Line 3946  namespace { Line 3952  namespace {
3952       * @throws gig::Exception if requested zone could not be splitted       * @throws gig::Exception if requested zone could not be splitted
3953       */       */
3954      void Region::SplitDimensionZone(dimension_t type, int zone) {      void Region::SplitDimensionZone(dimension_t type, int zone) {
3955            if (!Dimensions)
3956                throw gig::Exception("Could not split dimension zone, because there is no dimension at all.");
3957          dimension_def_t* oldDef = GetDimensionDefinition(type);          dimension_def_t* oldDef = GetDimensionDefinition(type);
3958          if (!oldDef)          if (!oldDef)
3959              throw gig::Exception("Could not split dimension zone, no such dimension of given type");              throw gig::Exception("Could not split dimension zone, no such dimension of given type");
# Line 3972  namespace { Line 3980  namespace {
3980          // requested by the arguments of this method call) to the temporary          // requested by the arguments of this method call) to the temporary
3981          // region, and don't use Region::CopyAssign() here for this task, since          // region, and don't use Region::CopyAssign() here for this task, since
3982          // it would also alter fast lookup helper variables here and there          // it would also alter fast lookup helper variables here and there
3983          dimension_def_t newDef;          dimension_def_t newDef = {};
3984          for (int i = 0; i < Dimensions; ++i) {          for (int i = 0; i < Dimensions; ++i) {
3985              dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference              dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3986              // is this the dimension requested by the method arguments? ...              // is this the dimension requested by the method arguments? ...
# Line 3983  namespace { Line 3991  namespace {
3991              }              }
3992              tempRgn->AddDimension(&def);              tempRgn->AddDimension(&def);
3993          }          }
3994            // silence clang sanitizer warning
3995            if (newDef.dimension == dimension_none)
3996                throw gig::Exception("Unexpected internal failure resolving dimension in SplitDimensionZone() [this is a bug].");
3997    
3998          // find the dimension index in the tempRegion which is the dimension          // find the dimension index in the tempRegion which is the dimension
3999          // type passed to this method (paranoidly expecting different order)          // type passed to this method (paranoidly expecting different order)
# Line 4314  namespace { Line 4325  namespace {
4325              uint64_t soughtoffset =              uint64_t soughtoffset =
4326                  uint64_t(file->pWavePoolTable[WavePoolTableIndex]) |                  uint64_t(file->pWavePoolTable[WavePoolTableIndex]) |
4327                  uint64_t(file->pWavePoolTableHi[WavePoolTableIndex]) << 32;                  uint64_t(file->pWavePoolTableHi[WavePoolTableIndex]) << 32;
4328              Sample* sample = file->GetFirstSample(pProgress);              size_t i = 0;
4329              while (sample) {              for (Sample* sample = file->GetSample(i, pProgress); sample;
4330                             sample = file->GetSample(++i))
4331                {
4332                  if (sample->ullWavePoolOffset == soughtoffset)                  if (sample->ullWavePoolOffset == soughtoffset)
4333                      return static_cast<gig::Sample*>(sample);                      return sample;
                 sample = file->GetNextSample();  
4334              }              }
4335          } else {          } else {
4336              // use extension files and 32 bit wave pool offsets              // use extension files and 32 bit wave pool offsets
4337              file_offset_t soughtoffset = file->pWavePoolTable[WavePoolTableIndex];              file_offset_t soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
4338              file_offset_t soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];              file_offset_t soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
4339              Sample* sample = file->GetFirstSample(pProgress);              size_t i = 0;
4340              while (sample) {              for (Sample* sample = file->GetSample(i, pProgress); sample;
4341                             sample = file->GetSample(++i))
4342                {
4343                  if (sample->ullWavePoolOffset == soughtoffset &&                  if (sample->ullWavePoolOffset == soughtoffset &&
4344                      sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);                      sample->FileNo == soughtfileno) return sample;
                 sample = file->GetNextSample();  
4345              }              }
4346          }          }
4347          return NULL;          return NULL;
# Line 4594  namespace { Line 4607  namespace {
4607              Name.resize(nameSize, ' ');              Name.resize(nameSize, ' ');
4608              for (int i = 0; i < nameSize; ++i)              for (int i = 0; i < nameSize; ++i)
4609                  Name[i] = ckScri->ReadUint8();                  Name[i] = ckScri->ReadUint8();
4610                // check if an uuid was already stored along with this script
4611                if (headerSize >= 6*sizeof(int32_t) + nameSize + 16) { // yes ...
4612                    for (uint i = 0; i < 16; ++i) {
4613                        Uuid[i] = ckScri->ReadUint8();
4614                    }
4615                } else { // no uuid yet, generate one now ...
4616                    GenerateUuid();
4617                }
4618              // to handle potential future extensions of the header              // to handle potential future extensions of the header
4619              ckScri->SetPos(sizeof(int32_t) + headerSize);              ckScri->SetPos(sizeof(int32_t) + headerSize);
4620              // read actual script data              // read actual script data
# Line 4608  namespace { Line 4629  namespace {
4629              Bypass   = false;              Bypass   = false;
4630              crc      = 0;              crc      = 0;
4631              Name     = "Unnamed Script";              Name     = "Unnamed Script";
4632                GenerateUuid();
4633          }          }
4634      }      }
4635    
# Line 4662  namespace { Line 4684  namespace {
4684          __calculateCRC(&data[0], data.size(), crc);          __calculateCRC(&data[0], data.size(), crc);
4685          __finalizeCRC(crc);          __finalizeCRC(crc);
4686          // make sure chunk exists and has the required size          // make sure chunk exists and has the required size
4687          const file_offset_t chunkSize = (file_offset_t) 7*sizeof(int32_t) + Name.size() + data.size();          const file_offset_t chunkSize =
4688                (file_offset_t) 7*sizeof(int32_t) + Name.size() + 16 + data.size();
4689          if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);          if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);
4690          else pChunk->Resize(chunkSize);          else pChunk->Resize(chunkSize);
4691          // fill the chunk data to be written to disk          // fill the chunk data to be written to disk
4692          uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();          uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();
4693          int pos = 0;          int pos = 0;
4694          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
4695          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4696          store32(&pData[pos], Compression);          store32(&pData[pos], Compression);
4697          pos += sizeof(int32_t);          pos += sizeof(int32_t);
# Line 4684  namespace { Line 4707  namespace {
4707          pos += sizeof(int32_t);          pos += sizeof(int32_t);
4708          for (int i = 0; i < Name.size(); ++i, ++pos)          for (int i = 0; i < Name.size(); ++i, ++pos)
4709              pData[pos] = Name[i];              pData[pos] = Name[i];
4710            for (int i = 0; i < 16; ++i, ++pos)
4711                pData[pos] = Uuid[i];
4712          for (int i = 0; i < data.size(); ++i, ++pos)          for (int i = 0; i < data.size(); ++i, ++pos)
4713              pData[pos] = data[i];              pData[pos] = data[i];
4714      }      }
4715    
4716      /**      /**
4717         * Generate a new Universally Unique Identifier (UUID) for this script.
4718         */
4719        void Script::GenerateUuid() {
4720            DLS::dlsid_t dlsid;
4721            DLS::Resource::GenerateDLSID(&dlsid);
4722            Uuid[0]  = dlsid.ulData1       & 0xff;
4723            Uuid[1]  = dlsid.ulData1 >>  8 & 0xff;
4724            Uuid[2]  = dlsid.ulData1 >> 16 & 0xff;
4725            Uuid[3]  = dlsid.ulData1 >> 24 & 0xff;
4726            Uuid[4]  = dlsid.usData2       & 0xff;
4727            Uuid[5]  = dlsid.usData2 >>  8 & 0xff;
4728            Uuid[6]  = dlsid.usData3       & 0xff;
4729            Uuid[7]  = dlsid.usData3 >>  8 & 0xff;
4730            Uuid[8]  = dlsid.abData[0];
4731            Uuid[9]  = dlsid.abData[1];
4732            Uuid[10] = dlsid.abData[2];
4733            Uuid[11] = dlsid.abData[3];
4734            Uuid[12] = dlsid.abData[4];
4735            Uuid[13] = dlsid.abData[5];
4736            Uuid[14] = dlsid.abData[6];
4737            Uuid[15] = dlsid.abData[7];
4738        }
4739    
4740        /**
4741       * Move this script from its current ScriptGroup to another ScriptGroup       * Move this script from its current ScriptGroup to another ScriptGroup
4742       * given by @a pGroup.       * given by @a pGroup.
4743       *       *
# Line 4860  namespace { Line 4909  namespace {
4909          pScripts = new std::list<Script*>;          pScripts = new std::list<Script*>;
4910          if (!pList) return;          if (!pList) return;
4911    
4912          for (RIFF::Chunk* ck = pList->GetFirstSubChunk(); ck;          size_t i = 0;
4913               ck = pList->GetNextSubChunk())          for (RIFF::Chunk* ck = pList->GetSubChunkAt(i); ck;
4914                 ck = pList->GetSubChunkAt(++i))
4915          {          {
4916              if (ck->GetChunkID() == CHUNK_ID_SCRI) {              if (ck->GetChunkID() == CHUNK_ID_SCRI) {
4917                  pScripts->push_back(new Script(this, ck));                  pScripts->push_back(new Script(this, ck));
# Line 4941  namespace { Line 4991  namespace {
4991              if (!pRegions) pRegions = new RegionList;              if (!pRegions) pRegions = new RegionList;
4992              RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);              RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
4993              if (lrgn) {              if (lrgn) {
4994                  RIFF::List* rgn = lrgn->GetFirstSubList();                  size_t i = 0;
4995                  while (rgn) {                  for (RIFF::List* rgn = lrgn->GetSubListAt(i); rgn;
4996                         rgn = lrgn->GetSubListAt(++i))
4997                    {
4998                      if (rgn->GetListType() == LIST_TYPE_RGN) {                      if (rgn->GetListType() == LIST_TYPE_RGN) {
4999                          if (pProgress)                          if (pProgress)
5000                              __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);                              __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
5001                          pRegions->push_back(new Region(this, rgn));                          pRegions->push_back(new Region(this, rgn));
5002                      }                      }
                     rgn = lrgn->GetNextSubList();  
5003                  }                  }
5004                  // Creating Region Key Table for fast lookup                  // Creating Region Key Table for fast lookup
5005                  UpdateRegionKeyTable();                  UpdateRegionKeyTable();
# Line 4958  namespace { Line 5009  namespace {
5009          // own gig format extensions          // own gig format extensions
5010          RIFF::List* lst3LS = insList->GetSubList(LIST_TYPE_3LS);          RIFF::List* lst3LS = insList->GetSubList(LIST_TYPE_3LS);
5011          if (lst3LS) {          if (lst3LS) {
5012                // script slots (that is references to instrument scripts)
5013              RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);              RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
5014              if (ckSCSL) {              if (ckSCSL) {
5015                  ckSCSL->SetPos(0);                  ckSCSL->SetPos(0);
# Line 4977  namespace { Line 5029  namespace {
5029                      }                      }
5030                  }                  }
5031              }              }
5032    
5033                // overridden script 'patch' variables
5034                RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV);
5035                if (ckSCPV) {
5036                    ckSCPV->SetPos(0);
5037    
5038                    int nScripts = ckSCPV->ReadUint32();
5039                    for (int iScript = 0; iScript < nScripts; ++iScript) {
5040                        _UUID uuid;
5041                        for (int i = 0; i < 16; ++i)
5042                            uuid[i] = ckSCPV->ReadUint8();
5043                        uint slot = ckSCPV->ReadUint32();
5044                        ckSCPV->ReadUint32(); // unused, reserved 32 bit
5045                        int nVars = ckSCPV->ReadUint32();
5046                        for (int iVar = 0; iVar < nVars; ++iVar) {
5047                            uint8_t type = ckSCPV->ReadUint8();
5048                            ckSCPV->ReadUint8();  // unused, reserved byte
5049                            int blobSize = ckSCPV->ReadUint16();
5050                            RIFF::file_offset_t pos = ckSCPV->GetPos();
5051                            // assuming 1st bit is set in 'type', otherwise blob not
5052                            // supported for decoding
5053                            if (type & 1) {
5054                                String name, value;
5055                                int len = ckSCPV->ReadUint16();
5056                                for (int i = 0; i < len; ++i)
5057                                    name += (char) ckSCPV->ReadUint8();
5058                                len = ckSCPV->ReadUint16();
5059                                for (int i = 0; i < len; ++i)
5060                                    value += (char) ckSCPV->ReadUint8();
5061                                if (!name.empty()) // 'name' should never be empty, but just to be sure
5062                                    scriptVars[uuid][slot][name] = value;
5063                            }
5064                            // also for potential future extensions: seek forward
5065                            // according to blob size
5066                            ckSCPV->SetPos(pos + blobSize);
5067                        }
5068                    }
5069                }
5070          }          }
5071    
5072          if (pProgress)          if (pProgress)
# Line 5068  namespace { Line 5158  namespace {
5158    
5159             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
5160             if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);             if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);
5161    
5162               // save script slots (that is references to instrument scripts)
5163             const int slotCount = (int) pScriptRefs->size();             const int slotCount = (int) pScriptRefs->size();
5164             const int headerSize = 3 * sizeof(uint32_t);             const int headerSize = 3 * sizeof(uint32_t);
5165             const int slotSize  = 2 * sizeof(uint32_t);             const int slotSize  = 2 * sizeof(uint32_t);
# Line 5092  namespace { Line 5184  namespace {
5184                 store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0);                 store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0);
5185                 pos += sizeof(uint32_t);                 pos += sizeof(uint32_t);
5186             }             }
5187    
5188               // save overridden script 'patch' variables ...
5189    
5190               // the actual 'scriptVars' member variable might contain variables of
5191               // scripts which are currently no longer assigned to any script slot
5192               // of this instrument, we need to get rid of these variables here to
5193               // prevent saving those persistently, however instead of touching the
5194               // member variable 'scriptVars' directly, rather strip a separate
5195               // copy such that the overridden values are not lost during an
5196               // instrument editor session (i.e. if script might be re-assigned)
5197               _VarsByScript vars = stripScriptVars();
5198               if (!vars.empty()) {
5199                   // determine total size required for 'SCPV' RIFF chunk, and the
5200                   // total amount of scripts being overridden (the latter is
5201                   // required because a script might be used on several script
5202                   // slots, hence vars.size() could then not be used here instead)
5203                   size_t totalChunkSize = 4;
5204                   size_t totalScriptsOverridden = 0;
5205                   for (const auto& script : vars) {
5206                       for (const auto& slot : script.second) {
5207                           totalScriptsOverridden++;
5208                           totalChunkSize += 16 + 4 + 4 + 4;
5209                           for (const auto& var : slot.second) {
5210                               totalChunkSize += 4 + 2 + var.first.length() +
5211                                                     2 + var.second.length();
5212                           }
5213                       }
5214                   }
5215    
5216                   // ensure 'SCPV' RIFF chunk exists (with required size)
5217                   RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV);
5218                   if (!ckSCPV) ckSCPV = lst3LS->AddSubChunk(CHUNK_ID_SCPV, totalChunkSize);
5219                   else ckSCPV->Resize(totalChunkSize);
5220    
5221                   // store the actual data to 'SCPV' RIFF chunk
5222                   uint8_t* pData = (uint8_t*) ckSCPV->LoadChunkData();
5223                   int pos = 0;
5224                   store32(&pData[pos], (uint32_t) totalScriptsOverridden); // scripts count
5225                   pos += 4;
5226                   for (const auto& script : vars) {
5227                       for (const auto& slot : script.second) {
5228                           for (int i = 0; i < 16; ++i)
5229                               pData[pos+i] = script.first[i]; // uuid
5230                           pos += 16;
5231                           store32(&pData[pos], (uint32_t) slot.first); // slot index
5232                           pos += 4;
5233                           store32(&pData[pos], (uint32_t) 0); // unused, reserved 32 bit
5234                           pos += 4;
5235                           store32(&pData[pos], (uint32_t) slot.second.size()); // variables count
5236                           pos += 4;
5237                           for (const auto& var : slot.second) {
5238                               pData[pos++] = 1; // type
5239                               pData[pos++] = 0; // reserved byte
5240                               store16(&pData[pos], 2 + var.first.size() + 2 + var.second.size()); // blob size
5241                               pos += 2;
5242                               store16(&pData[pos], var.first.size()); // variable name length
5243                               pos += 2;
5244                               for (int i = 0; i < var.first.size(); ++i)
5245                                   pData[pos++] = var.first[i];
5246                               store16(&pData[pos], var.second.size()); // variable value length
5247                               pos += 2;
5248                               for (int i = 0; i < var.second.size(); ++i)
5249                                   pData[pos++] = var.second[i];
5250                           }
5251                       }
5252                   }
5253               } else {
5254                   // no script variable overridden by this instrument, so get rid
5255                   // of 'SCPV' RIFF chunk (if any)
5256                   RIFF::Chunk* ckSCPV = lst3LS->GetSubChunk(CHUNK_ID_SCPV);
5257                   if (ckSCPV) lst3LS->DeleteSubChunk(ckSCPV);
5258               }
5259         } else {         } else {
5260             // no script slots, so get rid of any LS custom RIFF chunks (if any)             // no script slots, so get rid of any LS custom RIFF chunks (if any)
5261             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);             RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
# Line 5139  namespace { Line 5303  namespace {
5303      }      }
5304    
5305      /**      /**
5306         * Returns Region at supplied @a pos position within the region list of
5307         * this instrument. If supplied @a pos is out of bounds then @c NULL is
5308         * returned.
5309         *
5310         * @param pos - position of sought Region in region list
5311         * @returns pointer address to requested region or @c NULL if @a pos is
5312         *          out of bounds
5313         */
5314        Region* Instrument::GetRegionAt(size_t pos) {
5315            if (!pRegions) return NULL;
5316            if (pos >= pRegions->size()) return NULL;
5317            return static_cast<gig::Region*>( (*pRegions)[pos] );
5318        }
5319    
5320        /**
5321       * Returns the first Region of the instrument. You have to call this       * Returns the first Region of the instrument. You have to call this
5322       * method once before you use GetNextRegion().       * method once before you use GetNextRegion().
5323       *       *
5324       * @returns  pointer address to first region or NULL if there is none       * @returns  pointer address to first region or NULL if there is none
5325       * @see      GetNextRegion()       * @see      GetNextRegion()
5326         * @deprecated  This method is not reentrant-safe, use GetRegionAt()
5327         *              instead.
5328       */       */
5329      Region* Instrument::GetFirstRegion() {      Region* Instrument::GetFirstRegion() {
5330          if (!pRegions) return NULL;          if (!pRegions) return NULL;
# Line 5158  namespace { Line 5339  namespace {
5339       *       *
5340       * @returns  pointer address to the next region or NULL if end reached       * @returns  pointer address to the next region or NULL if end reached
5341       * @see      GetFirstRegion()       * @see      GetFirstRegion()
5342         * @deprecated  This method is not reentrant-safe, use GetRegionAt()
5343         *              instead.
5344       */       */
5345      Region* Instrument::GetNextRegion() {      Region* Instrument::GetNextRegion() {
5346          if (!pRegions) return NULL;          if (!pRegions) return NULL;
# Line 5516  namespace { Line 5699  namespace {
5699              scriptPoolFileOffsets.at(index).bypass = bBypass;              scriptPoolFileOffsets.at(index).bypass = bBypass;
5700      }      }
5701    
5702        /// type cast (by copy) uint8_t[16] -> std::array<uint8_t,16>
5703        inline std::array<uint8_t,16> _UUIDFromCArray(const uint8_t* pData) {
5704            std::array<uint8_t,16> uuid;
5705            memcpy(&uuid[0], pData, 16);
5706            return uuid;
5707        }
5708    
5709        /**
5710         * Returns true if this @c Instrument has any script slot which references
5711         * the @c Script identified by passed @p uuid.
5712         */
5713        bool Instrument::ReferencesScriptWithUuid(const _UUID& uuid) {
5714            const uint nSlots = ScriptSlotCount();
5715            for (uint iSlot = 0; iSlot < nSlots; ++iSlot)
5716                if (_UUIDFromCArray(&GetScriptOfSlot(iSlot)->Uuid[0]) == uuid)
5717                    return true;
5718            return false;
5719        }
5720    
5721        /** @brief Checks whether a certain script 'patch' variable value is set.
5722         *
5723         * Returns @c true if the initial value for the requested script variable is
5724         * currently overridden by this instrument.
5725         *
5726         * @remarks Real-time instrument scripts allow to declare special 'patch'
5727         * variables, which essentially behave like regular variables of their data
5728         * type, however their initial value may optionally be overridden on a per
5729         * instrument basis. That allows to share scripts between instruments while
5730         * still being able to fine tune certain aspects of the script for each
5731         * instrument individually.
5732         *
5733         * @note This is an own format extension which did not exist i.e. in the
5734         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5735         * Gigedit.
5736         *
5737         * @param slot - script slot index of the variable to be retrieved
5738         * @param variable - name of the 'patch' variable in that script
5739         */
5740        bool Instrument::IsScriptPatchVariableSet(int slot, String variable) {
5741            if (variable.empty()) return false;
5742            Script* script = GetScriptOfSlot(slot);
5743            if (!script) return false;
5744            const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5745            if (!scriptVars.count(uuid)) return false;
5746            const _VarsBySlot& slots = scriptVars.find(uuid)->second;
5747            if (slots.empty()) return false;
5748            if (slots.count(slot))
5749                return slots.find(slot)->second.count(variable);
5750            else
5751                return slots.begin()->second.count(variable);
5752        }
5753    
5754        /** @brief Get all overridden script 'patch' variables.
5755         *
5756         * Returns map of key-value pairs reflecting all patch variables currently
5757         * being overridden by this instrument for the given script @p slot, where
5758         * key is the variable name and value is the hereby currently overridden
5759         * value for that variable.
5760         *
5761         * @remarks Real-time instrument scripts allow to declare special 'patch'
5762         * variables, which essentially behave like regular variables of their data
5763         * type, however their initial value may optionally be overridden on a per
5764         * instrument basis. That allows to share scripts between instruments while
5765         * still being able to fine tune certain aspects of the script for each
5766         * instrument individually.
5767         *
5768         * @note This is an own format extension which did not exist i.e. in the
5769         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5770         * Gigedit.
5771         *
5772         * @param slot - script slot index of the variable to be retrieved
5773         */
5774        std::map<String,String> Instrument::GetScriptPatchVariables(int slot) {
5775            Script* script = GetScriptOfSlot(slot);
5776            if (!script) return std::map<String,String>();
5777            const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5778            if (!scriptVars.count(uuid)) return std::map<String,String>();
5779            const _VarsBySlot& slots = scriptVars.find(uuid)->second;
5780            if (slots.empty()) return std::map<String,String>();
5781            const _PatchVars& vars =
5782                (slots.count(slot)) ?
5783                    slots.find(slot)->second : slots.begin()->second;
5784            return vars;
5785        }
5786    
5787        /** @brief Get overridden initial value for 'patch' variable.
5788         *
5789         * Returns current initial value for the requested script variable being
5790         * overridden by this instrument.
5791         *
5792         * @remarks Real-time instrument scripts allow to declare special 'patch'
5793         * variables, which essentially behave like regular variables of their data
5794         * type, however their initial value may optionally be overridden on a per
5795         * instrument basis. That allows to share scripts between instruments while
5796         * still being able to fine tune certain aspects of the script for each
5797         * instrument individually.
5798         *
5799         * @note This is an own format extension which did not exist i.e. in the
5800         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5801         * Gigedit.
5802         *
5803         * @param slot - script slot index of the variable to be retrieved
5804         * @param variable - name of the 'patch' variable in that script
5805         */
5806        String Instrument::GetScriptPatchVariable(int slot, String variable) {
5807            std::map<String,String> vars = GetScriptPatchVariables(slot);
5808            return (vars.count(variable)) ? vars.find(variable)->second : "";
5809        }
5810    
5811        /** @brief Override initial value for 'patch' variable.
5812         *
5813         * Overrides initial value for the requested script variable for this
5814         * instrument with the passed value.
5815         *
5816         * @remarks Real-time instrument scripts allow to declare special 'patch'
5817         * variables, which essentially behave like regular variables of their data
5818         * type, however their initial value may optionally be overridden on a per
5819         * instrument basis. That allows to share scripts between instruments while
5820         * still being able to fine tune certain aspects of the script for each
5821         * instrument individually.
5822         *
5823         * @note This is an own format extension which did not exist i.e. in the
5824         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5825         * Gigedit.
5826         *
5827         * @param slot - script slot index of the variable to be set
5828         * @param variable - name of the 'patch' variable in that script
5829         * @param value - overridden initial value for that script variable
5830         * @throws gig::Exception if given script @p slot index is invalid or given
5831         *         @p variable name is empty
5832         */
5833        void Instrument::SetScriptPatchVariable(int slot, String variable, String value) {
5834            if (variable.empty())
5835                throw Exception("Variable name must not be empty");
5836            Script* script = GetScriptOfSlot(slot);
5837            if (!script)
5838                throw Exception("No script slot with index " + ToString(slot));
5839            const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5840            scriptVars[uuid][slot][variable] = value;
5841        }
5842    
5843        /** @brief Drop overridden initial value(s) for 'patch' variable(s).
5844         *
5845         * Reverts initial value(s) for requested script variable(s) back to their
5846         * default initial value(s) defined in the script itself.
5847         *
5848         * Both arguments of this method are optional. The most obvious use case of
5849         * this method would be passing a valid script @p slot index and a
5850         * (non-emtpy string as) @p variable name to this method, which would cause
5851         * that single variable to be unset for that specific script slot (on this
5852         * @c Instrument level).
5853         *
5854         * Not passing a value (or @c -1 for @p slot and/or empty string for
5855         * @p variable) means 'wildcard'. So accordingly absence of argument(s) will
5856         * cause all variables and/or for all script slots being unset. Hence this
5857         * method serves 2^2 = 4 possible use cases in total and accordingly covers
5858         * 4 different behaviours in one method.
5859         *
5860         * @remarks Real-time instrument scripts allow to declare special 'patch'
5861         * variables, which essentially behave like regular variables of their data
5862         * type, however their initial value may optionally be overridden on a per
5863         * instrument basis. That allows to share scripts between instruments while
5864         * still being able to fine tune certain aspects of the script for each
5865         * instrument individually.
5866         *
5867         * @note This is an own format extension which did not exist i.e. in the
5868         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5869         * Gigedit.
5870         *
5871         * @param slot - script slot index of the variable to be unset
5872         * @param variable - name of the 'patch' variable in that script
5873         */
5874        void Instrument::UnsetScriptPatchVariable(int slot, String variable) {
5875            Script* script = GetScriptOfSlot(slot);
5876    
5877            // option 1: unset a particular variable of one particular script slot
5878            if (slot != -1 && !variable.empty()) {
5879                if (!script) return;
5880                const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5881                if (!scriptVars.count(uuid)) return;
5882                if (!scriptVars[uuid].count(slot)) return;
5883                if (scriptVars[uuid][slot].count(variable))
5884                    scriptVars[uuid][slot].erase(
5885                        scriptVars[uuid][slot].find(variable)
5886                    );
5887                if (scriptVars[uuid][slot].empty())
5888                    scriptVars[uuid].erase( scriptVars[uuid].find(slot) );
5889                if (scriptVars[uuid].empty())
5890                    scriptVars.erase( scriptVars.find(uuid) );
5891                return;
5892            }
5893    
5894            // option 2: unset all variables of all script slots
5895            if (slot == -1 && variable.empty()) {
5896                scriptVars.clear();
5897                return;
5898            }
5899    
5900            // option 3: unset all variables of one particular script slot only
5901            if (slot != -1) {
5902                if (!script) return;
5903                const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5904                if (scriptVars.count(uuid))
5905                    scriptVars.erase( scriptVars.find(uuid) );
5906                return;
5907            }
5908    
5909            // option 4: unset a particular variable of all script slots
5910            _VarsByScript::iterator itScript = scriptVars.begin();
5911            _VarsByScript::iterator endScript = scriptVars.end();
5912            while (itScript != endScript) {
5913                _VarsBySlot& slots = itScript->second;
5914                _VarsBySlot::iterator itSlot = slots.begin();
5915                _VarsBySlot::iterator endSlot = slots.end();
5916                while (itSlot != endSlot) {
5917                    _PatchVars& vars = itSlot->second;
5918                    if (vars.count(variable))
5919                        vars.erase( vars.find(variable) );
5920                    if (vars.empty())
5921                        slots.erase(itSlot++); // postfix increment to avoid iterator invalidation
5922                    else
5923                        ++itSlot;
5924                }
5925                if (slots.empty())
5926                    scriptVars.erase(itScript++); // postfix increment to avoid iterator invalidation
5927                else
5928                    ++itScript;
5929            }
5930        }
5931    
5932        /**
5933         * Returns stripped version of member variable @c scriptVars, where scripts
5934         * no longer referenced by this @c Instrument are filtered out, and so are
5935         * variables of meanwhile obsolete slots (i.e. a script still being
5936         * referenced, but previously overridden on a script slot which either no
5937         * longer exists or is hosting another script now).
5938         */
5939        Instrument::_VarsByScript Instrument::stripScriptVars() {
5940            _VarsByScript vars;
5941            _VarsByScript::const_iterator itScript = scriptVars.begin();
5942            _VarsByScript::const_iterator endScript = scriptVars.end();
5943            for (; itScript != endScript; ++itScript) {
5944                const _UUID& uuid = itScript->first;
5945                if (!ReferencesScriptWithUuid(uuid))
5946                    continue;
5947                const _VarsBySlot& slots = itScript->second;
5948                _VarsBySlot::const_iterator itSlot = slots.begin();
5949                _VarsBySlot::const_iterator endSlot = slots.end();
5950                for (; itSlot != endSlot; ++itSlot) {
5951                    Script* script = GetScriptOfSlot(itSlot->first);
5952                    if (!script) continue;
5953                    if (_UUIDFromCArray(&script->Uuid[0]) != uuid) continue;
5954                    if (itSlot->second.empty()) continue;
5955                    vars[uuid][itSlot->first] = itSlot->second;
5956                }
5957            }
5958            return vars;
5959        }
5960    
5961      /**      /**
5962       * Make a (semi) deep copy of the Instrument object given by @a orig       * Make a (semi) deep copy of the Instrument object given by @a orig
5963       * and assign it to this object.       * and assign it to this object.
# Line 5550  namespace { Line 5992  namespace {
5992          PianoReleaseMode = orig->PianoReleaseMode;          PianoReleaseMode = orig->PianoReleaseMode;
5993          DimensionKeyRange = orig->DimensionKeyRange;          DimensionKeyRange = orig->DimensionKeyRange;
5994          scriptPoolFileOffsets = orig->scriptPoolFileOffsets;          scriptPoolFileOffsets = orig->scriptPoolFileOffsets;
5995          pScriptRefs = orig->pScriptRefs;          // deep copy of pScriptRefs required (to avoid undefined behaviour)
5996            if (pScriptRefs) delete pScriptRefs;
5997            pScriptRefs = new std::vector<_ScriptPooolRef>;
5998            if (orig->pScriptRefs)
5999                *pScriptRefs = *orig->pScriptRefs;
6000            scriptVars = orig->scriptVars;
6001                    
6002          // free old midi rules          // free old midi rules
6003          for (int i = 0 ; pMidiRules[i] ; i++) {          for (int i = 0 ; pMidiRules[i] ; i++) {
# Line 5560  namespace { Line 6007  namespace {
6007          pMidiRules[0] = NULL;          pMidiRules[0] = NULL;
6008                    
6009          // delete all old regions          // delete all old regions
6010          while (Regions) DeleteRegion(GetFirstRegion());          while (Regions) DeleteRegion(GetRegionAt(0));
6011          // create new regions and copy them from original          // create new regions and copy them from original
6012          {          {
6013              RegionList::const_iterator it = orig->pRegions->begin();              RegionList::const_iterator it = orig->pRegions->begin();
# Line 5592  namespace { Line 6039  namespace {
6039       */       */
6040      bool Instrument::UsesAnyGigFormatExtension() const {      bool Instrument::UsesAnyGigFormatExtension() const {
6041          if (!pRegions) return false;          if (!pRegions) return false;
6042            if (!scriptVars.empty()) return true;
6043          RegionList::const_iterator iter = pRegions->begin();          RegionList::const_iterator iter = pRegions->begin();
6044          RegionList::const_iterator end  = pRegions->end();          RegionList::const_iterator end  = pRegions->end();
6045          for (; iter != end; ++iter) {          for (; iter != end; ++iter) {
# Line 5615  namespace { Line 6063  namespace {
6063      Group::Group(File* file, RIFF::Chunk* ck3gnm) {      Group::Group(File* file, RIFF::Chunk* ck3gnm) {
6064          pFile      = file;          pFile      = file;
6065          pNameChunk = ck3gnm;          pNameChunk = ck3gnm;
6066            SamplesIterator = 0;
6067          ::LoadString(pNameChunk, Name);          ::LoadString(pNameChunk, Name);
6068      }      }
6069    
# Line 5659  namespace { Line 6108  namespace {
6108    
6109          if (!pNameChunk && pFile->pVersion && pFile->pVersion->major > 2) {          if (!pNameChunk && pFile->pVersion && pFile->pVersion->major > 2) {
6110              // v3 has a fixed list of 128 strings, find a free one              // v3 has a fixed list of 128 strings, find a free one
6111              for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {              size_t i = 0;
6112                for (RIFF::Chunk* ck = _3gnl->GetSubChunkAt(i); ck; ck = _3gnl->GetSubChunkAt(++i)) {
6113                  if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {                  if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {
6114                      pNameChunk = ck;                      pNameChunk = ck;
6115                      break;                      break;
# Line 5672  namespace { Line 6122  namespace {
6122      }      }
6123    
6124      /**      /**
6125         * Returns Sample object at @a index of this sample group.
6126         *
6127         * @param index - position of sample in this sample group's sample list
6128         *                (0..n)
6129         * @returns sample object or NULL if index is out of bounds
6130         */
6131        Sample* Group::GetSample(size_t index) {
6132            if (pFile->pSamples && index >= pFile->pSamples->size()) return NULL;
6133            size_t indexInFile = 0;
6134            size_t indexInGroup = 0;
6135            for (Sample* pSample = pFile->GetSample(indexInFile); pSample;
6136                         pSample = pFile->GetSample(++indexInFile))
6137            {
6138                if (pSample->GetGroup() != this) continue;
6139                if (indexInGroup++ == index) return pSample;
6140            }
6141            return NULL;
6142        }
6143    
6144        /**
6145       * Returns the first Sample of this Group. You have to call this method       * Returns the first Sample of this Group. You have to call this method
6146       * once before you use GetNextSample().       * once before you use GetNextSample().
6147       *       *
# Line 5681  namespace { Line 6151  namespace {
6151       * @returns  pointer address to first Sample or NULL if there is none       * @returns  pointer address to first Sample or NULL if there is none
6152       *           applied to this Group       *           applied to this Group
6153       * @see      GetNextSample()       * @see      GetNextSample()
6154         * @deprecated  This method is not reentrant-safe, use GetSample()
6155         *              instead.
6156       */       */
6157      Sample* Group::GetFirstSample() {      Sample* Group::GetFirstSample() {
6158          // FIXME: lazy und unsafe implementation, should be an autonomous iterator          size_t& i = this->SamplesIterator;
6159          for (Sample* pSample = pFile->GetFirstSample(); pSample; pSample = pFile->GetNextSample()) {          i = 0;
6160              if (pSample->GetGroup() == this) return pSample;          for (Sample* pSample = pFile->GetSample(i); pSample;
6161                         pSample = pFile->GetSample(++i))
6162            {
6163                if (pSample->GetGroup() == this)
6164                    return pSample;
6165          }          }
6166          return NULL;          return NULL;
6167      }      }
# Line 5699  namespace { Line 6175  namespace {
6175       * @returns  pointer address to the next Sample of this Group or NULL if       * @returns  pointer address to the next Sample of this Group or NULL if
6176       *           end reached       *           end reached
6177       * @see      GetFirstSample()       * @see      GetFirstSample()
6178         * @deprecated  This method is not reentrant-safe, use GetSample()
6179         *              instead.
6180       */       */
6181      Sample* Group::GetNextSample() {      Sample* Group::GetNextSample() {
6182          // FIXME: lazy und unsafe implementation, should be an autonomous iterator          size_t& i = this->SamplesIterator;
6183          for (Sample* pSample = pFile->GetNextSample(); pSample; pSample = pFile->GetNextSample()) {          for (Sample* pSample = pFile->GetSample(++i); pSample;
6184              if (pSample->GetGroup() == this) return pSample;                       pSample = pFile->GetSample(++i))
6185            {
6186                if (pSample->GetGroup() == this)
6187                    return pSample;
6188          }          }
6189          return NULL;          return NULL;
6190      }      }
# Line 5723  namespace { Line 6204  namespace {
6204       */       */
6205      void Group::MoveAll() {      void Group::MoveAll() {
6206          // get "that" other group first          // get "that" other group first
6207            size_t i = 0;
6208          Group* pOtherGroup = NULL;          Group* pOtherGroup = NULL;
6209          for (pOtherGroup = pFile->GetFirstGroup(); pOtherGroup; pOtherGroup = pFile->GetNextGroup()) {          for (pOtherGroup = pFile->GetGroup(i); pOtherGroup;
6210                 pOtherGroup = pFile->GetGroup(++i))
6211            {
6212              if (pOtherGroup != this) break;              if (pOtherGroup != this) break;
6213          }          }
6214          if (!pOtherGroup) throw Exception(          if (!pOtherGroup) throw Exception(
# Line 5732  namespace { Line 6216  namespace {
6216              "other Group. This is a bug, report it!"              "other Group. This is a bug, report it!"
6217          );          );
6218          // now move all samples of this group to the other group          // now move all samples of this group to the other group
6219          for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {          Sample* pSample;
6220            while ((pSample = GetSample(0))) {
6221              pOtherGroup->AddSample(pSample);              pOtherGroup->AddSample(pSample);
6222          }          }
6223      }      }
# Line 5804  namespace { Line 6289  namespace {
6289    
6290      File::~File() {      File::~File() {
6291          if (pGroups) {          if (pGroups) {
6292              std::list<Group*>::iterator iter = pGroups->begin();              std::vector<Group*>::iterator iter = pGroups->begin();
6293              std::list<Group*>::iterator end  = pGroups->end();              std::vector<Group*>::iterator end  = pGroups->end();
6294              while (iter != end) {              while (iter != end) {
6295                  delete *iter;                  delete *iter;
6296                  ++iter;                  ++iter;
# Line 5823  namespace { Line 6308  namespace {
6308          }          }
6309      }      }
6310    
6311        /**
6312         * Returns a pointer to the first <i>Sample</i> object of the file,
6313         * <i>NULL</i> otherwise.
6314         *
6315         * @param pProgress - optional: callback function for progress notification
6316         * @deprecated  This method is not reentrant-safe, use GetSample()
6317         *              instead.
6318         */
6319      Sample* File::GetFirstSample(progress_t* pProgress) {      Sample* File::GetFirstSample(progress_t* pProgress) {
6320          if (!pSamples) LoadSamples(pProgress);          if (!pSamples) LoadSamples(pProgress);
6321          if (!pSamples) return NULL;          if (!pSamples) return NULL;
# Line 5830  namespace { Line 6323  namespace {
6323          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
6324      }      }
6325    
6326        /**
6327         * Returns a pointer to the next <i>Sample</i> object of the file,
6328         * <i>NULL</i> otherwise.
6329         *
6330         * @deprecated  This method is not reentrant-safe, use GetSample()
6331         *              instead.
6332         */
6333      Sample* File::GetNextSample() {      Sample* File::GetNextSample() {
6334          if (!pSamples) return NULL;          if (!pSamples) return NULL;
6335          SamplesIterator++;          SamplesIterator++;
# Line 5839  namespace { Line 6339  namespace {
6339      /**      /**
6340       * Returns Sample object of @a index.       * Returns Sample object of @a index.
6341       *       *
6342         * @param index - position of sample in sample list (0..n)
6343         * @param pProgress - optional: callback function for progress notification
6344       * @returns sample object or NULL if index is out of bounds       * @returns sample object or NULL if index is out of bounds
6345       */       */
6346      Sample* File::GetSample(uint index) {      Sample* File::GetSample(size_t index, progress_t* pProgress) {
6347          if (!pSamples) LoadSamples();          if (!pSamples) LoadSamples(pProgress);
6348          if (!pSamples) return NULL;          if (!pSamples) return NULL;
6349          DLS::File::SampleList::iterator it = pSamples->begin();          if (index >= pSamples->size()) return NULL;
6350          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;  
         return static_cast<gig::Sample*>( *it );  
6351      }      }
6352    
6353      /**      /**
# Line 5912  namespace { Line 6409  namespace {
6409          // remove all references to the sample          // remove all references to the sample
6410          for (Instrument* instrument = GetFirstInstrument() ; instrument ;          for (Instrument* instrument = GetFirstInstrument() ; instrument ;
6411               instrument = GetNextInstrument()) {               instrument = GetNextInstrument()) {
6412              for (Region* region = instrument->GetFirstRegion() ; region ;              size_t iRgn = 0;
6413                   region = instrument->GetNextRegion()) {              for (Region* region = instrument->GetRegionAt(iRgn); region;
6414                     region = instrument->GetRegionAt(++iRgn))
6415                {
6416                  if (region->GetSample() == pSample) region->SetSample(NULL);                  if (region->GetSample() == pSample) region->SetSample(NULL);
6417    
6418                  for (int i = 0 ; i < region->DimensionRegions ; i++) {                  for (int i = 0 ; i < region->DimensionRegions ; i++) {
# Line 5937  namespace { Line 6435  namespace {
6435    
6436          if (!pSamples) pSamples = new SampleList;          if (!pSamples) pSamples = new SampleList;
6437    
         RIFF::File* file = pRIFF;  
   
6438          // just for progress calculation          // just for progress calculation
6439          int iSampleIndex  = 0;          int iSampleIndex  = 0;
6440          int iTotalSamples = WavePoolCount;          int iTotalSamples = WavePoolCount;
# Line 6019  namespace { Line 6515  namespace {
6515              if (wvpl) {              if (wvpl) {
6516                  file_offset_t wvplFileOffset = wvpl->GetFilePos() -                  file_offset_t wvplFileOffset = wvpl->GetFilePos() -
6517                                                 wvpl->GetPos(); // should be zero, but just to be sure                                                 wvpl->GetPos(); // should be zero, but just to be sure
6518                  RIFF::List* wave = wvpl->GetFirstSubList();                  size_t i = 0;
6519                  while (wave) {                  for (RIFF::List* wave = wvpl->GetSubListAt(i); wave;
6520                         wave = wvpl->GetSubListAt(++i))
6521                    {
6522                      if (wave->GetListType() == LIST_TYPE_WAVE) {                      if (wave->GetListType() == LIST_TYPE_WAVE) {
6523                          // notify current progress                          // notify current progress
6524                          if (pProgress) {                          if (pProgress) {
# Line 6033  namespace { Line 6531  namespace {
6531    
6532                          iSampleIndex++;                          iSampleIndex++;
6533                      }                      }
                     wave = wvpl->GetNextSubList();  
6534                  }                  }
6535              }              }
6536          }          }
# Line 6086  namespace { Line 6583  namespace {
6583                  __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask                  __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
6584                  __notify_progress(&subprogress, 0.0f);                  __notify_progress(&subprogress, 0.0f);
6585                  if (GetAutoLoad())                  if (GetAutoLoad())
6586                      GetFirstSample(&subprogress); // now force all samples to be loaded                      GetSample(0, &subprogress); // now force all samples to be loaded
6587                  __notify_progress(&subprogress, 1.0f);                  __notify_progress(&subprogress, 1.0f);
6588    
6589                  // instrument loading subtask                  // instrument loading subtask
# Line 6100  namespace { Line 6597  namespace {
6597              } else {              } else {
6598                  // sample loading subtask                  // sample loading subtask
6599                  if (GetAutoLoad())                  if (GetAutoLoad())
6600                      GetFirstSample(); // now force all samples to be loaded                      GetSample(0); // now force all samples to be loaded
6601    
6602                  // instrument loading subtask                  // instrument loading subtask
6603                  LoadInstruments();                  LoadInstruments();
# Line 6266  namespace { Line 6763  namespace {
6763          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
6764          if (lstInstruments) {          if (lstInstruments) {
6765              int iInstrumentIndex = 0;              int iInstrumentIndex = 0;
6766              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();              size_t i = 0;
6767              while (lstInstr) {              for (RIFF::List* lstInstr = lstInstruments->GetSubListAt(i);
6768                     lstInstr; lstInstr = lstInstruments->GetSubListAt(++i))
6769                {
6770                  if (lstInstr->GetListType() == LIST_TYPE_INS) {                  if (lstInstr->GetListType() == LIST_TYPE_INS) {
6771                      if (pProgress) {                      if (pProgress) {
6772                          // notify current progress                          // notify current progress
# Line 6285  namespace { Line 6784  namespace {
6784    
6785                      iInstrumentIndex++;                      iInstrumentIndex++;
6786                  }                  }
                 lstInstr = lstInstruments->GetNextSubList();  
6787              }              }
6788              if (pProgress)              if (pProgress)
6789                  __notify_progress(pProgress, 1.0); // notify done                  __notify_progress(pProgress, 1.0); // notify done
# Line 6339  namespace { Line 6837  namespace {
6837      }      }
6838    
6839      int File::GetWaveTableIndexOf(gig::Sample* pSample) {      int File::GetWaveTableIndexOf(gig::Sample* pSample) {
6840          if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned          if (!pSamples) GetSample(0); // make sure sample chunks were scanned
6841          File::SampleList::iterator iter = pSamples->begin();          File::SampleList::iterator iter = pSamples->begin();
6842          File::SampleList::iterator end  = pSamples->end();          File::SampleList::iterator end  = pSamples->end();
6843          for (int index = 0; iter != end; ++iter, ++index)          for (int index = 0; iter != end; ++iter, ++index)
# Line 6359  namespace { Line 6857  namespace {
6857          if (!_3crc) return false;          if (!_3crc) return false;
6858          if (_3crc->GetNewSize() <= 0) return false;          if (_3crc->GetNewSize() <= 0) return false;
6859          if (_3crc->GetNewSize() % 8) return false;          if (_3crc->GetNewSize() % 8) return false;
6860          if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned          if (!pSamples) GetSample(0); // make sure sample chunks were scanned
6861          if (_3crc->GetNewSize() != pSamples->size() * 8) return false;          if (_3crc->GetNewSize() != pSamples->size() * 8) return false;
6862    
6863          const file_offset_t n = _3crc->GetNewSize() / 8;          const file_offset_t n = _3crc->GetNewSize() / 8;
# Line 6393  namespace { Line 6891  namespace {
6891       */       */
6892      bool File::RebuildSampleChecksumTable() {      bool File::RebuildSampleChecksumTable() {
6893          // make sure sample chunks were scanned          // make sure sample chunks were scanned
6894          if (!pSamples) GetFirstSample();          if (!pSamples) GetSample(0);
6895    
6896          bool bRequiresSave = false;          bool bRequiresSave = false;
6897    
# Line 6442  namespace { Line 6940  namespace {
6940          return bRequiresSave;          return bRequiresSave;
6941      }      }
6942    
6943        /**
6944         * Returns a pointer to the first <i>Group</i> object of the file,
6945         * <i>NULL</i> otherwise.
6946         *
6947         * @deprecated  This method is not reentrant-safe, use GetGroup() instead.
6948         */
6949      Group* File::GetFirstGroup() {      Group* File::GetFirstGroup() {
6950          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6951          // there must always be at least one group          // there must always be at least one group
# Line 6449  namespace { Line 6953  namespace {
6953          return *GroupsIterator;          return *GroupsIterator;
6954      }      }
6955    
6956        /**
6957         * Returns a pointer to the next <i>Group</i> object of the file,
6958         * <i>NULL</i> otherwise.
6959         *
6960         * @deprecated  This method is not reentrant-safe, use GetGroup() instead.
6961         */
6962      Group* File::GetNextGroup() {      Group* File::GetNextGroup() {
6963          if (!pGroups) return NULL;          if (!pGroups) return NULL;
6964          ++GroupsIterator;          ++GroupsIterator;
# Line 6461  namespace { Line 6971  namespace {
6971       * @param index - number of the sought group (0..n)       * @param index - number of the sought group (0..n)
6972       * @returns sought group or NULL if there's no such group       * @returns sought group or NULL if there's no such group
6973       */       */
6974      Group* File::GetGroup(uint index) {      Group* File::GetGroup(size_t index) {
6975          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6976          GroupsIterator = pGroups->begin();          if (index >= pGroups->size()) return NULL;
6977          for (uint i = 0; GroupsIterator != pGroups->end(); i++) {          return (*pGroups)[index];
             if (i == index) return *GroupsIterator;  
             ++GroupsIterator;  
         }  
         return NULL;  
6978      }      }
6979    
6980      /**      /**
# Line 6483  namespace { Line 6989  namespace {
6989       */       */
6990      Group* File::GetGroup(String name) {      Group* File::GetGroup(String name) {
6991          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6992          GroupsIterator = pGroups->begin();          size_t i = 0;
6993          for (uint i = 0; GroupsIterator != pGroups->end(); ++GroupsIterator, ++i)          for (Group* pGroup = GetGroup(i); pGroup; pGroup = GetGroup(++i))
6994              if ((*GroupsIterator)->Name == name) return *GroupsIterator;              if (pGroup->Name == name) return pGroup;
6995          return NULL;          return NULL;
6996      }      }
6997    
# Line 6509  namespace { Line 7015  namespace {
7015       */       */
7016      void File::DeleteGroup(Group* pGroup) {      void File::DeleteGroup(Group* pGroup) {
7017          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
7018          std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);          std::vector<Group*>::iterator iter =
7019                find(pGroups->begin(), pGroups->end(), pGroup);
7020          if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");          if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
7021          if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");          if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
7022          // delete all members of this group          // delete all members of this group
7023          for (Sample* pSample = pGroup->GetFirstSample(); pSample; pSample = pGroup->GetNextSample()) {          Sample* pSample;
7024            while ((pSample = pGroup->GetSample(0))) {
7025              DeleteSample(pSample);              DeleteSample(pSample);
7026          }          }
7027          // now delete this group object          // now delete this group object
# Line 6534  namespace { Line 7042  namespace {
7042       */       */
7043      void File::DeleteGroupOnly(Group* pGroup) {      void File::DeleteGroupOnly(Group* pGroup) {
7044          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
7045          std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);          std::vector<Group*>::iterator iter =
7046                find(pGroups->begin(), pGroups->end(), pGroup);
7047          if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");          if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
7048          if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");          if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
7049          // move all members of this group to another group          // move all members of this group to another group
# Line 6545  namespace { Line 7054  namespace {
7054      }      }
7055    
7056      void File::LoadGroups() {      void File::LoadGroups() {
7057          if (!pGroups) pGroups = new std::list<Group*>;          if (!pGroups) pGroups = new std::vector<Group*>;
7058          // try to read defined groups from file          // try to read defined groups from file
7059          RIFF::List* lst3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);          RIFF::List* lst3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
7060          if (lst3gri) {          if (lst3gri) {
7061              RIFF::List* lst3gnl = lst3gri->GetSubList(LIST_TYPE_3GNL);              RIFF::List* lst3gnl = lst3gri->GetSubList(LIST_TYPE_3GNL);
7062              if (lst3gnl) {              if (lst3gnl) {
7063                  RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();                  size_t i = 0;
7064                  while (ck) {                  for (RIFF::Chunk* ck = lst3gnl->GetSubChunkAt(i); ck;
7065                         ck = lst3gnl->GetSubChunkAt(++i))
7066                    {
7067                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {
7068                          if (pVersion && pVersion->major > 2 &&                          if (pVersion && pVersion->major > 2 &&
7069                              strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;                              strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;
7070    
7071                          pGroups->push_back(new Group(this, ck));                          pGroups->push_back(new Group(this, ck));
7072                      }                      }
                     ck = lst3gnl->GetNextSubChunk();  
7073                  }                  }
7074              }              }
7075          }          }
# Line 6649  namespace { Line 7159  namespace {
7159          pScriptGroups = new std::list<ScriptGroup*>;          pScriptGroups = new std::list<ScriptGroup*>;
7160          RIFF::List* lstLS = pRIFF->GetSubList(LIST_TYPE_3LS);          RIFF::List* lstLS = pRIFF->GetSubList(LIST_TYPE_3LS);
7161          if (lstLS) {          if (lstLS) {
7162              for (RIFF::List* lst = lstLS->GetFirstSubList(); lst;              size_t i = 0;
7163                   lst = lstLS->GetNextSubList())              for (RIFF::List* lst = lstLS->GetSubListAt(i); lst;
7164                     lst = lstLS->GetSubListAt(++i))
7165              {              {
7166                  if (lst->GetListType() == LIST_TYPE_RTIS) {                  if (lst->GetListType() == LIST_TYPE_RTIS) {
7167                      pScriptGroups->push_back(new ScriptGroup(this, lst));                      pScriptGroups->push_back(new ScriptGroup(this, lst));
# Line 6711  namespace { Line 7222  namespace {
7222              // INFO was added by Resource::UpdateChunks - make sure it              // INFO was added by Resource::UpdateChunks - make sure it
7223              // is placed first in file              // is placed first in file
7224              RIFF::Chunk* info = pRIFF->GetSubList(LIST_TYPE_INFO);              RIFF::Chunk* info = pRIFF->GetSubList(LIST_TYPE_INFO);
7225              RIFF::Chunk* first = pRIFF->GetFirstSubChunk();              RIFF::Chunk* first = pRIFF->GetSubChunkAt(0);
7226              if (first != info) {              if (first != info) {
7227                  pRIFF->MoveSubChunk(info, first);                  pRIFF->MoveSubChunk(info, first);
7228              }              }
# Line 6732  namespace { Line 7243  namespace {
7243              // v3: make sure the file has 128 3gnm chunks              // v3: make sure the file has 128 3gnm chunks
7244              // (before updating the Group chunks)              // (before updating the Group chunks)
7245              if (pVersion && pVersion->major > 2) {              if (pVersion && pVersion->major > 2) {
7246                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();                  size_t i = 0;
7247                  for (int i = 0 ; i < 128 ; i++) {                  for (RIFF::Chunk* _3gnm = _3gnl->GetSubChunkAt(i); i < 128;
7248                         _3gnm = _3gnl->GetSubChunkAt(++i))
7249                    {
7250                      // create 128 empty placeholder strings which will either                      // create 128 empty placeholder strings which will either
7251                      // be filled by Group::UpdateChunks below or left empty.                      // be filled by Group::UpdateChunks below or left empty.
7252                      ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);                      ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
                     if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();  
7253                  }                  }
7254              }              }
7255    
7256              std::list<Group*>::iterator iter = pGroups->begin();              std::vector<Group*>::iterator iter = pGroups->begin();
7257              std::list<Group*>::iterator end  = pGroups->end();              std::vector<Group*>::iterator end  = pGroups->end();
7258              for (; iter != end; ++iter) {              for (; iter != end; ++iter) {
7259                  (*iter)->UpdateChunks(pProgress);                  (*iter)->UpdateChunks(pProgress);
7260              }              }
# Line 6780  namespace { Line 7292  namespace {
7292              uint8_t* pData = (uint8_t*) einf->LoadChunkData();              uint8_t* pData = (uint8_t*) einf->LoadChunkData();
7293    
7294              std::map<gig::Sample*,int> sampleMap;              std::map<gig::Sample*,int> sampleMap;
7295              int sampleIdx = 0;              size_t sampleIdx = 0;
7296              for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {              for (Sample* pSample = GetSample(0); pSample;
7297                  sampleMap[pSample] = sampleIdx++;                           pSample = GetSample(++sampleIdx))
7298                {
7299                    sampleMap[pSample] = sampleIdx;
7300              }              }
7301    
7302              int totnbusedsamples = 0;              int totnbusedsamples = 0;
# Line 6803  namespace { Line 7317  namespace {
7317    
7318                  memset(&pData[(instrumentIdx + 1) * sublen + 48], 0, sublen - 48);                  memset(&pData[(instrumentIdx + 1) * sublen + 48], 0, sublen - 48);
7319    
7320                  for (Region* region = instrument->GetFirstRegion() ; region ;                  size_t iRgn = 0;
7321                       region = instrument->GetNextRegion()) {                  for (Region* region = instrument->GetRegionAt(iRgn); region;
7322                         region = instrument->GetRegionAt(++iRgn))
7323                    {
7324                      for (int i = 0 ; i < region->DimensionRegions ; i++) {                      for (int i = 0 ; i < region->DimensionRegions ; i++) {
7325                          gig::DimensionRegion *d = region->pDimensionRegions[i];                          gig::DimensionRegion *d = region->pDimensionRegions[i];
7326                          if (d->pSample) {                          if (d->pSample) {

Legend:
Removed from v.3722  
changed lines
  Added in v.3939

  ViewVC Help
Powered by ViewVC