/[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 3323 by schoenebeck, Thu Jul 20 22:09:54 2017 UTC revision 3941 by schoenebeck, Fri Jun 18 14:06:20 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-2017 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 347  namespace { Line 347  namespace {
347      eg_opt_t::eg_opt_t() {      eg_opt_t::eg_opt_t() {
348          AttackCancel     = true;          AttackCancel     = true;
349          AttackHoldCancel = true;          AttackHoldCancel = true;
350          DecayCancel      = true;          Decay1Cancel     = true;
351            Decay2Cancel     = true;
352          ReleaseCancel    = true;          ReleaseCancel    = true;
353      }      }
354    
355      void eg_opt_t::serialize(Serialization::Archive* archive) {      void eg_opt_t::serialize(Serialization::Archive* archive) {
356          SRLZ(AttackCancel);          SRLZ(AttackCancel);
357          SRLZ(AttackHoldCancel);          SRLZ(AttackHoldCancel);
358          SRLZ(DecayCancel);          SRLZ(Decay1Cancel);
359            SRLZ(Decay2Cancel);
360          SRLZ(ReleaseCancel);          SRLZ(ReleaseCancel);
361      }      }
362    
# Line 410  namespace { Line 412  namespace {
412    
413          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
414          if (pCk3gix) {          if (pCk3gix) {
415                pCk3gix->SetPos(0);
416    
417              uint16_t iSampleGroup = pCk3gix->ReadInt16();              uint16_t iSampleGroup = pCk3gix->ReadInt16();
418              pGroup = pFile->GetGroup(iSampleGroup);              pGroup = pFile->GetGroup(iSampleGroup);
419          } else { // '3gix' chunk missing          } else { // '3gix' chunk missing
# Line 419  namespace { Line 423  namespace {
423    
424          pCkSmpl = waveList->GetSubChunk(CHUNK_ID_SMPL);          pCkSmpl = waveList->GetSubChunk(CHUNK_ID_SMPL);
425          if (pCkSmpl) {          if (pCkSmpl) {
426                pCkSmpl->SetPos(0);
427    
428              Manufacturer  = pCkSmpl->ReadInt32();              Manufacturer  = pCkSmpl->ReadInt32();
429              Product       = pCkSmpl->ReadInt32();              Product       = pCkSmpl->ReadInt32();
430              SamplePeriod  = pCkSmpl->ReadInt32();              SamplePeriod  = pCkSmpl->ReadInt32();
# Line 465  namespace { Line 471  namespace {
471          Dithered          = false;          Dithered          = false;
472          TruncatedBits     = 0;          TruncatedBits     = 0;
473          if (Compressed) {          if (Compressed) {
474                ewav->SetPos(0);
475    
476              uint32_t version = ewav->ReadInt32();              uint32_t version = ewav->ReadInt32();
477              if (version == 3 && BitDepth == 24) {              if (version > 2 && BitDepth == 24) {
478                  Dithered = ewav->ReadInt32();                  Dithered = ewav->ReadInt32();
479                  ewav->SetPos(Channels == 2 ? 84 : 64);                  ewav->SetPos(Channels == 2 ? 84 : 64);
480                  TruncatedBits = ewav->ReadInt32();                  TruncatedBits = ewav->ReadInt32();
# Line 474  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 601  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 1498  namespace { Line 1506  namespace {
1506    
1507          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);
1508          if (_3ewa) { // if '3ewa' chunk exists          if (_3ewa) { // if '3ewa' chunk exists
1509                _3ewa->SetPos(0);
1510    
1511              _3ewa->ReadInt32(); // unknown, always == chunk size ?              _3ewa->ReadInt32(); // unknown, always == chunk size ?
1512              LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1513              EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
# Line 1730  namespace { Line 1740  namespace {
1740              VCFType                         = vcf_type_lowpass;              VCFType                         = vcf_type_lowpass;
1741              memset(DimensionUpperLimits, 127, 8);              memset(DimensionUpperLimits, 127, 8);
1742          }          }
1743          // format extension for EG behavior options, these will *NOT* work with  
1744          // Gigasampler/GigaStudio !          // chunk for own format extensions, these will *NOT* work with Gigasampler/GigaStudio !
1745          RIFF::Chunk* lsde = _3ewl->GetSubChunk(CHUNK_ID_LSDE);          RIFF::Chunk* lsde = _3ewl->GetSubChunk(CHUNK_ID_LSDE);
1746          if (lsde) {          if (lsde) { // format extension for EG behavior options
1747              unsigned char byte = lsde->ReadUint8();              lsde->SetPos(0);
1748              EGOptions.AttackCancel     = byte & 1;  
1749              EGOptions.AttackHoldCancel = byte & (1 << 1);              eg_opt_t* pEGOpts[2] = { &EG1Options, &EG2Options };
1750              EGOptions.DecayCancel      = byte & (1 << 2);              for (int i = 0; i < 2; ++i) { // NOTE: we reserved a 3rd byte for a potential future EG3 option
1751              EGOptions.ReleaseCancel    = byte & (1 << 3);                  unsigned char byte = lsde->ReadUint8();
1752                    pEGOpts[i]->AttackCancel     = byte & 1;
1753                    pEGOpts[i]->AttackHoldCancel = byte & (1 << 1);
1754                    pEGOpts[i]->Decay1Cancel     = byte & (1 << 2);
1755                    pEGOpts[i]->Decay2Cancel     = byte & (1 << 3);
1756                    pEGOpts[i]->ReleaseCancel    = byte & (1 << 4);
1757                }
1758            }
1759            // format extension for sustain pedal up effect on release trigger samples
1760            if (lsde && lsde->GetSize() > 3) { // NOTE: we reserved the 3rd byte for a potential future EG3 option
1761                lsde->SetPos(3);
1762                uint8_t byte = lsde->ReadUint8();
1763                SustainReleaseTrigger   = static_cast<sust_rel_trg_t>(byte & 0x03);
1764                NoNoteOffReleaseTrigger = byte >> 7;
1765            } else {
1766                SustainReleaseTrigger   = sust_rel_trg_none;
1767                NoNoteOffReleaseTrigger = false;
1768            }
1769            // format extension for LFOs' wave form, phase displacement and for
1770            // LFO3's flip phase
1771            if (lsde && lsde->GetSize() > 4) {
1772                lsde->SetPos(4);
1773                LFO1WaveForm = static_cast<lfo_wave_t>( lsde->ReadUint16() );
1774                LFO2WaveForm = static_cast<lfo_wave_t>( lsde->ReadUint16() );
1775                LFO3WaveForm = static_cast<lfo_wave_t>( lsde->ReadUint16() );
1776                lsde->ReadUint16(); // unused 16 bits, reserved for potential future use
1777                LFO1Phase = (double) GIG_EXP_DECODE( lsde->ReadInt32() );
1778                LFO2Phase = (double) GIG_EXP_DECODE( lsde->ReadInt32() );
1779                LFO3Phase = (double) GIG_EXP_DECODE( lsde->ReadInt32() );
1780                const uint32_t flags = lsde->ReadInt32();
1781                LFO3FlipPhase = flags & 1;
1782            } else {
1783                LFO1WaveForm = lfo_wave_sine;
1784                LFO2WaveForm = lfo_wave_sine;
1785                LFO3WaveForm = lfo_wave_sine;
1786                LFO1Phase = 0.0;
1787                LFO2Phase = 0.0;
1788                LFO3Phase = 0.0;
1789                LFO3FlipPhase = false;
1790          }          }
1791    
1792          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
# Line 1865  namespace { Line 1913  namespace {
1913          SRLZ(EG1ControllerAttackInfluence);          SRLZ(EG1ControllerAttackInfluence);
1914          SRLZ(EG1ControllerDecayInfluence);          SRLZ(EG1ControllerDecayInfluence);
1915          SRLZ(EG1ControllerReleaseInfluence);          SRLZ(EG1ControllerReleaseInfluence);
1916            SRLZ(LFO1WaveForm);
1917          SRLZ(LFO1Frequency);          SRLZ(LFO1Frequency);
1918            SRLZ(LFO1Phase);
1919          SRLZ(LFO1InternalDepth);          SRLZ(LFO1InternalDepth);
1920          SRLZ(LFO1ControlDepth);          SRLZ(LFO1ControlDepth);
1921          SRLZ(LFO1Controller);          SRLZ(LFO1Controller);
# Line 1883  namespace { Line 1933  namespace {
1933          SRLZ(EG2ControllerAttackInfluence);          SRLZ(EG2ControllerAttackInfluence);
1934          SRLZ(EG2ControllerDecayInfluence);          SRLZ(EG2ControllerDecayInfluence);
1935          SRLZ(EG2ControllerReleaseInfluence);          SRLZ(EG2ControllerReleaseInfluence);
1936            SRLZ(LFO2WaveForm);
1937          SRLZ(LFO2Frequency);          SRLZ(LFO2Frequency);
1938            SRLZ(LFO2Phase);
1939          SRLZ(LFO2InternalDepth);          SRLZ(LFO2InternalDepth);
1940          SRLZ(LFO2ControlDepth);          SRLZ(LFO2ControlDepth);
1941          SRLZ(LFO2Controller);          SRLZ(LFO2Controller);
# Line 1891  namespace { Line 1943  namespace {
1943          SRLZ(LFO2Sync);          SRLZ(LFO2Sync);
1944          SRLZ(EG3Attack);          SRLZ(EG3Attack);
1945          SRLZ(EG3Depth);          SRLZ(EG3Depth);
1946            SRLZ(LFO3WaveForm);
1947          SRLZ(LFO3Frequency);          SRLZ(LFO3Frequency);
1948            SRLZ(LFO3Phase);
1949          SRLZ(LFO3InternalDepth);          SRLZ(LFO3InternalDepth);
1950          SRLZ(LFO3ControlDepth);          SRLZ(LFO3ControlDepth);
1951          SRLZ(LFO3Controller);          SRLZ(LFO3Controller);
1952            SRLZ(LFO3FlipPhase);
1953          SRLZ(LFO3Sync);          SRLZ(LFO3Sync);
1954          SRLZ(VCFEnabled);          SRLZ(VCFEnabled);
1955          SRLZ(VCFType);          SRLZ(VCFType);
# Line 1928  namespace { Line 1983  namespace {
1983          SRLZ(MSDecode);          SRLZ(MSDecode);
1984          //SRLZ(SampleStartOffset);          //SRLZ(SampleStartOffset);
1985          SRLZ(SampleAttenuation);          SRLZ(SampleAttenuation);
1986          SRLZ(EGOptions);          SRLZ(EG1Options);
1987            SRLZ(EG2Options);
1988            SRLZ(SustainReleaseTrigger);
1989            SRLZ(NoNoteOffReleaseTrigger);
1990    
1991          // derived attributes from DLS::Sampler          // derived attributes from DLS::Sampler
1992          SRLZ(FineTune);          SRLZ(FineTune);
# Line 1968  namespace { Line 2026  namespace {
2026          RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);
2027          if (!_3ewa) {          if (!_3ewa) {
2028              File* pFile = (File*) GetParent()->GetParent()->GetParent();              File* pFile = (File*) GetParent()->GetParent()->GetParent();
2029              bool version3 = pFile->pVersion && pFile->pVersion->major == 3;              bool versiongt2 = pFile->pVersion && pFile->pVersion->major > 2;
2030              _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, version3 ? 148 : 140);              _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, versiongt2 ? 148 : 140);
2031          }          }
2032          pData = (uint8_t*) _3ewa->LoadChunkData();          pData = (uint8_t*) _3ewa->LoadChunkData();
2033    
# Line 2236  namespace { Line 2294  namespace {
2294              memcpy(&pData[140], DimensionUpperLimits, 8);              memcpy(&pData[140], DimensionUpperLimits, 8);
2295          }          }
2296    
2297          // format extension for EG behavior options, these will *NOT* work with          // chunk for own format extensions, these will *NOT* work with
2298          // Gigasampler/GigaStudio !          // Gigasampler/GigaStudio !
2299          RIFF::Chunk* lsde = pParentList->GetSubChunk(CHUNK_ID_LSDE);          RIFF::Chunk* lsde = pParentList->GetSubChunk(CHUNK_ID_LSDE);
2300          if (!lsde) {          const int lsdeSize =
2301              // only add this "LSDE" chunk if the EG options do not match the              3 /* EG cancel options */ +
2302              // default EG behavior              1 /* sustain pedal up on release trigger option */ +
2303              eg_opt_t defaultOpt;              8 /* LFOs' wave forms */ + 12 /* LFOs' phase */ + 4 /* flags (LFO3FlipPhase) */;
2304              if (memcmp(&EGOptions, &defaultOpt, sizeof(eg_opt_t))) {          if (!lsde && UsesAnyGigFormatExtension()) {
2305                  lsde = pParentList->AddSubChunk(CHUNK_ID_LSDE, 1);              // only add this "LSDE" chunk if there is some (format extension)
2306                  // move LSDE chunk to the end of parent list              // setting effective that would require our "LSDE" format extension
2307                  pParentList->MoveSubChunk(lsde, (RIFF::Chunk*)NULL);              // chunk to be stored
2308              }              lsde = pParentList->AddSubChunk(CHUNK_ID_LSDE, lsdeSize);
2309                // move LSDE chunk to the end of parent list
2310                pParentList->MoveSubChunk(lsde, (RIFF::Chunk*)NULL);
2311          }          }
2312          if (lsde) {          if (lsde) {
2313              unsigned char* pByte = (unsigned char*) lsde->LoadChunkData();              if (lsde->GetNewSize() < lsdeSize)
2314              *pByte =                  lsde->Resize(lsdeSize);
2315                  (EGOptions.AttackCancel     ? 1 : 0) |              // format extension for EG behavior options
2316                  (EGOptions.AttackHoldCancel ? (1<<1) : 0) |              unsigned char* pData = (unsigned char*) lsde->LoadChunkData();
2317                  (EGOptions.DecayCancel      ? (1<<2) : 0) |              eg_opt_t* pEGOpts[2] = { &EG1Options, &EG2Options };
2318                  (EGOptions.ReleaseCancel    ? (1<<3) : 0);              for (int i = 0; i < 2; ++i) { // NOTE: we reserved the 3rd byte for a potential future EG3 option
2319                    pData[i] =
2320                        (pEGOpts[i]->AttackCancel     ? 1 : 0) |
2321                        (pEGOpts[i]->AttackHoldCancel ? (1<<1) : 0) |
2322                        (pEGOpts[i]->Decay1Cancel     ? (1<<2) : 0) |
2323                        (pEGOpts[i]->Decay2Cancel     ? (1<<3) : 0) |
2324                        (pEGOpts[i]->ReleaseCancel    ? (1<<4) : 0);
2325                }
2326                // format extension for release trigger options
2327                pData[3] = static_cast<uint8_t>(SustainReleaseTrigger) | (NoNoteOffReleaseTrigger ? (1<<7) : 0);
2328                // format extension for LFOs' wave form, phase displacement and for
2329                // LFO3's flip phase
2330                store16(&pData[4], LFO1WaveForm);
2331                store16(&pData[6], LFO2WaveForm);
2332                store16(&pData[8], LFO3WaveForm);
2333                //NOTE: 16 bits reserved here for potential future use !
2334                const int32_t lfo1Phase = (int32_t) GIG_EXP_ENCODE(LFO1Phase);
2335                const int32_t lfo2Phase = (int32_t) GIG_EXP_ENCODE(LFO2Phase);
2336                const int32_t lfo3Phase = (int32_t) GIG_EXP_ENCODE(LFO3Phase);
2337                store32(&pData[12], lfo1Phase);
2338                store32(&pData[16], lfo2Phase);
2339                store32(&pData[20], lfo3Phase);
2340                const int32_t flags = LFO3FlipPhase ? 1 : 0;
2341                store32(&pData[24], flags);
2342    
2343                // compile time sanity check: is our last store access here
2344                // consistent with the initial lsdeSize value assignment?
2345                static_assert(lsdeSize == 28, "Inconsistency in assumed 'LSDE' RIFF chunk size");
2346          }          }
2347      }      }
2348    
2349        /**
2350         * Returns @c true in case this DimensionRegion object uses any gig format
2351         * extension, that is whether this DimensionRegion object currently has any
2352         * setting effective that would require our "LSDE" RIFF chunk to be stored
2353         * to the gig file.
2354         *
2355         * Right now this is a private method. It is considerable though this method
2356         * to become (in slightly modified form) a public API method in future, i.e.
2357         * to allow instrument editors to visualize and/or warn the user of any
2358         * format extension being used. Right now this method really just serves to
2359         * answer the question whether an LSDE chunk is required, for the public API
2360         * purpose this method would also need to check whether any other setting
2361         * stored to the regular value '3ewa' chunk, is actually a format extension
2362         * as well.
2363         */
2364        bool DimensionRegion::UsesAnyGigFormatExtension() const {
2365            eg_opt_t defaultOpt;
2366            return memcmp(&EG1Options, &defaultOpt, sizeof(eg_opt_t)) ||
2367                   memcmp(&EG2Options, &defaultOpt, sizeof(eg_opt_t)) ||
2368                   SustainReleaseTrigger || NoNoteOffReleaseTrigger ||
2369                   LFO1WaveForm || LFO2WaveForm || LFO3WaveForm ||
2370                   LFO1Phase || LFO2Phase || LFO3Phase ||
2371                   LFO3FlipPhase;
2372        }
2373    
2374      double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {      double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {
2375          curve_type_t curveType = releaseVelocityResponseCurve;          curve_type_t curveType = releaseVelocityResponseCurve;
2376          uint8_t depth = releaseVelocityResponseDepth;          uint8_t depth = releaseVelocityResponseDepth;
# Line 2296  namespace { Line 2408  namespace {
2408      // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet      // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet
2409      double* DimensionRegion::GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling)      double* DimensionRegion::GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling)
2410      {      {
2411            // sanity check input parameters
2412            // (fallback to some default parameters on ill input)
2413            switch (curveType) {
2414                case curve_type_nonlinear:
2415                case curve_type_linear:
2416                    if (depth > 4) {
2417                        printf("Warning: Invalid depth (0x%x) for velocity curve type (0x%x).\n", depth, curveType);
2418                        depth   = 0;
2419                        scaling = 0;
2420                    }
2421                    break;
2422                case curve_type_special:
2423                    if (depth > 5) {
2424                        printf("Warning: Invalid depth (0x%x) for velocity curve type 'special'.\n", depth);
2425                        depth   = 0;
2426                        scaling = 0;
2427                    }
2428                    break;
2429                case curve_type_unknown:
2430                default:
2431                    printf("Warning: Unknown velocity curve type (0x%x).\n", curveType);
2432                    curveType = curve_type_linear;
2433                    depth     = 0;
2434                    scaling   = 0;
2435                    break;
2436            }
2437    
2438          double* table;          double* table;
2439          uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;          uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;
2440          if (pVelocityTables->count(tableKey)) { // if key exists          if (pVelocityTables->count(tableKey)) { // if key exists
# Line 3168  namespace { Line 3307  namespace {
3307          }          }
3308          Layers = 1;          Layers = 1;
3309          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
3310          int dimensionBits = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;          int dimensionBits = (file->pVersion && file->pVersion->major > 2) ? 8 : 5;
3311    
3312          // Actual Loading          // Actual Loading
3313    
# Line 3178  namespace { Line 3317  namespace {
3317    
3318          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);
3319          if (_3lnk) {          if (_3lnk) {
3320                _3lnk->SetPos(0);
3321    
3322              DimensionRegions = _3lnk->ReadUint32();              DimensionRegions = _3lnk->ReadUint32();
3323              for (int i = 0; i < dimensionBits; i++) {              for (int i = 0; i < dimensionBits; i++) {
3324                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());
# Line 3212  namespace { Line 3353  namespace {
3353              UpdateVelocityTable();              UpdateVelocityTable();
3354    
3355              // jump to start of the wave pool indices (if not already there)              // jump to start of the wave pool indices (if not already there)
3356              if (file->pVersion && file->pVersion->major == 3)              if (file->pVersion && file->pVersion->major > 2)
3357                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure
3358              else              else
3359                  _3lnk->SetPos(44);                  _3lnk->SetPos(44);
# Line 3221  namespace { Line 3362  namespace {
3362              if (file->GetAutoLoad()) {              if (file->GetAutoLoad()) {
3363                  for (uint i = 0; i < DimensionRegions; i++) {                  for (uint i = 0; i < DimensionRegions; i++) {
3364                      uint32_t wavepoolindex = _3lnk->ReadUint32();                      uint32_t wavepoolindex = _3lnk->ReadUint32();
3365                      if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);                      if (file->pWavePoolTable && pDimensionRegions[i])
3366                            pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
3367                  }                  }
3368                  GetSample(); // load global region sample reference                  GetSample(); // load global region sample reference
3369              }              }
# Line 3270  namespace { Line 3412  namespace {
3412          }          }
3413    
3414          File* pFile = (File*) GetParent()->GetParent();          File* pFile = (File*) GetParent()->GetParent();
3415          bool version3 = pFile->pVersion && pFile->pVersion->major == 3;          const bool versiongt2 = pFile->pVersion && pFile->pVersion->major > 2;
3416          const int iMaxDimensions =  version3 ? 8 : 5;          const int iMaxDimensions =  versiongt2 ? 8 : 5;
3417          const int iMaxDimensionRegions = version3 ? 256 : 32;          const int iMaxDimensionRegions = versiongt2 ? 256 : 32;
3418    
3419          // make sure '3lnk' chunk exists          // make sure '3lnk' chunk exists
3420          RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);          RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);
3421          if (!_3lnk) {          if (!_3lnk) {
3422              const int _3lnkChunkSize = version3 ? 1092 : 172;              const int _3lnkChunkSize = versiongt2 ? 1092 : 172;
3423              _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);              _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);
3424              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
3425    
# Line 3301  namespace { Line 3443  namespace {
3443          }          }
3444    
3445          // update wave pool table in '3lnk' chunk          // update wave pool table in '3lnk' chunk
3446          const int iWavePoolOffset = version3 ? 68 : 44;          const int iWavePoolOffset = versiongt2 ? 68 : 44;
3447          for (uint i = 0; i < iMaxDimensionRegions; i++) {          for (uint i = 0; i < iMaxDimensionRegions; i++) {
3448              int iWaveIndex = -1;              int iWaveIndex = -1;
3449              if (i < DimensionRegions) {              if (i < DimensionRegions) {
# Line 3317  namespace { Line 3459  namespace {
3459              }              }
3460              store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);              store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);
3461          }          }
3462    
3463            // The following chunks are just added for compatibility with the
3464            // GigaStudio software, which would show a warning if these were
3465            // missing. However currently these chunks don't cover any useful
3466            // data. So if this gig file uses any of our own gig format
3467            // extensions which would cause this gig file to be unloadable
3468            // with GSt software anyway, then just skip these GSt compatibility
3469            // chunks here as well.
3470            if (versiongt2 && !UsesAnyGigFormatExtension()) {
3471                // add 3dnm list which always seems to be empty
3472                RIFF::List* _3dnm = pCkRegion->GetSubList(LIST_TYPE_3DNM);
3473                if (!_3dnm) _3dnm = pCkRegion->AddSubList(LIST_TYPE_3DNM);
3474    
3475                // add 3ddp chunk which always seems to have 16 bytes of 0xFF
3476                RIFF::Chunk* _3ddp = pCkRegion->GetSubChunk(CHUNK_ID_3DDP);
3477                if (!_3ddp) _3ddp =  pCkRegion->AddSubChunk(CHUNK_ID_3DDP, 16);
3478                uint8_t* pData = (uint8_t*) _3ddp->LoadChunkData();
3479                for (int i = 0; i < 16; i += 4) {
3480                    store32(&pData[i], 0xFFFFFFFF);
3481                }
3482    
3483                // move 3dnm and 3ddp to the end of the region list
3484                pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3DNM), (RIFF::Chunk*)NULL);
3485                pCkRegion->MoveSubChunk(pCkRegion->GetSubChunk(CHUNK_ID_3DDP), (RIFF::Chunk*)NULL);
3486            } else {
3487                // this is intended for the user switching from GSt >= 3 version
3488                // back to an older format version, delete GSt3 chunks ...
3489                RIFF::List* _3dnm = pCkRegion->GetSubList(LIST_TYPE_3DNM);
3490                if (_3dnm) pCkRegion->DeleteSubChunk(_3dnm);
3491    
3492                RIFF::Chunk* _3ddp = pCkRegion->GetSubChunk(CHUNK_ID_3DDP);
3493                if (_3ddp) pCkRegion->DeleteSubChunk(_3ddp);
3494            }
3495      }      }
3496    
3497      void Region::LoadDimensionRegions(RIFF::List* rgn) {      void Region::LoadDimensionRegions(RIFF::List* rgn) {
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 3444  namespace { Line 3620  namespace {
3620    
3621          // check if max. amount of dimensions reached          // check if max. amount of dimensions reached
3622          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
3623          const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;          const int iMaxDimensions = (file->pVersion && file->pVersion->major > 2) ? 8 : 5;
3624          if (Dimensions >= iMaxDimensions)          if (Dimensions >= iMaxDimensions)
3625              throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimensions already reached");              throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimensions already reached");
3626          // check if max. amount of dimension bits reached          // check if max. amount of dimension bits reached
# Line 3632  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 3660  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 3671  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 3715  namespace { Line 3896  namespace {
3896          // now tempRegion's dimensions and DimensionRegions basically reflect          // now tempRegion's dimensions and DimensionRegions basically reflect
3897          // what we wanted to get for this actual Region here, so we now just          // what we wanted to get for this actual Region here, so we now just
3898          // delete and recreate the dimension in question with the new amount          // delete and recreate the dimension in question with the new amount
3899          // zones and then copy back from tempRegion                // zones and then copy back from tempRegion. we're actually deleting and
3900          DeleteDimension(oldDef);          // recreating all dimensions here, to avoid altering the precise order
3901          AddDimension(&newDef);          // of the dimensions (which would not be an error per se, but it would
3902            // cause usability issues with instrument editors)
3903            {
3904                std::vector<dimension_def_t> oldDefs;
3905                for (int i = 0; i < Dimensions; ++i)
3906                    oldDefs.push_back(pDimensionDefinitions[i]); // copy, don't reference
3907                for (int i = Dimensions - 1; i >= 0; --i)
3908                    DeleteDimension(&pDimensionDefinitions[i]);
3909                for (int i = 0; i < oldDefs.size(); ++i) {
3910                    dimension_def_t& def = oldDefs[i];
3911                    AddDimension(
3912                        (def.dimension == newDef.dimension) ? &newDef : &def
3913                    );
3914                }
3915            }
3916          for (int iSrc = 0; iSrc < 256; ++iSrc) {          for (int iSrc = 0; iSrc < 256; ++iSrc) {
3917              DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];              DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
3918              if (!srcDimRgn) continue;              if (!srcDimRgn) continue;
# Line 3736  namespace { Line 3931  namespace {
3931          }          }
3932    
3933          // delete temporary region          // delete temporary region
3934            tempRgn->DeleteChunks();
3935          delete tempRgn;          delete tempRgn;
3936    
3937          UpdateVelocityTable();          UpdateVelocityTable();
# Line 3756  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 3782  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 3793  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 3854  namespace { Line 4055  namespace {
4055          // now tempRegion's dimensions and DimensionRegions basically reflect          // now tempRegion's dimensions and DimensionRegions basically reflect
4056          // what we wanted to get for this actual Region here, so we now just          // what we wanted to get for this actual Region here, so we now just
4057          // delete and recreate the dimension in question with the new amount          // delete and recreate the dimension in question with the new amount
4058          // zones and then copy back from tempRegion                // zones and then copy back from tempRegion. we're actually deleting and
4059          DeleteDimension(oldDef);          // recreating all dimensions here, to avoid altering the precise order
4060          AddDimension(&newDef);          // of the dimensions (which would not be an error per se, but it would
4061            // cause usability issues with instrument editors)
4062            {
4063                std::vector<dimension_def_t> oldDefs;
4064                for (int i = 0; i < Dimensions; ++i)
4065                    oldDefs.push_back(pDimensionDefinitions[i]); // copy, don't reference
4066                for (int i = Dimensions - 1; i >= 0; --i)
4067                    DeleteDimension(&pDimensionDefinitions[i]);
4068                for (int i = 0; i < oldDefs.size(); ++i) {
4069                    dimension_def_t& def = oldDefs[i];
4070                    AddDimension(
4071                        (def.dimension == newDef.dimension) ? &newDef : &def
4072                    );
4073                }
4074            }
4075          for (int iSrc = 0; iSrc < 256; ++iSrc) {          for (int iSrc = 0; iSrc < 256; ++iSrc) {
4076              DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];              DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
4077              if (!srcDimRgn) continue;              if (!srcDimRgn) continue;
# Line 3875  namespace { Line 4090  namespace {
4090          }          }
4091    
4092          // delete temporary region          // delete temporary region
4093            tempRgn->DeleteChunks();
4094          delete tempRgn;          delete tempRgn;
4095    
4096          UpdateVelocityTable();          UpdateVelocityTable();
# Line 4102  namespace { Line 4318  namespace {
4318          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
4319          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
4320          if (!file->pWavePoolTable) return NULL;          if (!file->pWavePoolTable) return NULL;
4321            if (WavePoolTableIndex + 1 > file->WavePoolCount) return NULL;
4322          // for new files or files >= 2 GB use 64 bit wave pool offsets          // for new files or files >= 2 GB use 64 bit wave pool offsets
4323          if (file->pRIFF->IsNew() || (file->pRIFF->GetCurrentFileSize() >> 31)) {          if (file->pRIFF->IsNew() || (file->pRIFF->GetCurrentFileSize() >> 31)) {
4324              // use 64 bit wave pool offsets (treating this as large file)              // use 64 bit wave pool offsets (treating this as large file)
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 4178  namespace { Line 4397  namespace {
4397          Layers = orig->Layers;          Layers = orig->Layers;
4398      }      }
4399    
4400        /**
4401         * Returns @c true in case this Region object uses any gig format
4402         * extension, that is e.g. whether any DimensionRegion object currently
4403         * has any setting effective that would require our "LSDE" RIFF chunk to
4404         * be stored to the gig file.
4405         *
4406         * Right now this is a private method. It is considerable though this method
4407         * to become (in slightly modified form) a public API method in future, i.e.
4408         * to allow instrument editors to visualize and/or warn the user of any gig
4409         * format extension being used. See also comments on
4410         * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
4411         * potential public API change in future.
4412         */
4413        bool Region::UsesAnyGigFormatExtension() const {
4414            for (int i = 0; i < 256; i++) {
4415                if (pDimensionRegions[i]) {
4416                    if (pDimensionRegions[i]->UsesAnyGigFormatExtension())
4417                        return true;
4418                }
4419            }
4420            return false;
4421        }
4422    
4423    
4424  // *************** MidiRule ***************  // *************** MidiRule ***************
4425  // *  // *
# Line 4352  namespace { Line 4594  namespace {
4594          pGroup = group;          pGroup = group;
4595          pChunk = ckScri;          pChunk = ckScri;
4596          if (ckScri) { // object is loaded from file ...          if (ckScri) { // object is loaded from file ...
4597                ckScri->SetPos(0);
4598    
4599              // read header              // read header
4600              uint32_t headerSize = ckScri->ReadUint32();              uint32_t headerSize = ckScri->ReadUint32();
4601              Compression = (Compression_t) ckScri->ReadUint32();              Compression = (Compression_t) ckScri->ReadUint32();
4602              Encoding    = (Encoding_t) ckScri->ReadUint32();              Encoding    = (Encoding_t) ckScri->ReadUint32();
4603              Language    = (Language_t) ckScri->ReadUint32();              Language    = (Language_t) ckScri->ReadUint32();
4604              Bypass      = (Language_t) ckScri->ReadUint32() & 1;              Bypass      = ckScri->ReadUint32() & 1;
4605              crc         = ckScri->ReadUint32();              crc         = ckScri->ReadUint32();
4606              uint32_t nameSize = ckScri->ReadUint32();              uint32_t nameSize = ckScri->ReadUint32();
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 4377  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 4404  namespace { Line 4657  namespace {
4657          memcpy(&data[0], &text[0], text.size());          memcpy(&data[0], &text[0], text.size());
4658      }      }
4659    
4660        /** @brief Remove all RIFF chunks associated with this Script object.
4661         *
4662         * At the moment Script::DeleteChunks() does nothing. It is
4663         * recommended to call this method explicitly though from deriving classes's
4664         * own overridden implementation of this method to avoid potential future
4665         * compatiblity issues.
4666         *
4667         * See DLS::Storage::DeleteChunks() for details.
4668         */
4669        void Script::DeleteChunks() {
4670        }
4671    
4672      /**      /**
4673       * Apply this script to the respective RIFF chunks. You have to call       * Apply this script to the respective RIFF chunks. You have to call
4674       * File::Save() to make changes persistent.       * File::Save() to make changes persistent.
# Line 4419  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 4441  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 4519  namespace { Line 4811  namespace {
4811          }          }
4812      }      }
4813    
4814        /** @brief Remove all RIFF chunks associated with this ScriptGroup object.
4815         *
4816         * At the moment ScriptGroup::DeleteChunks() does nothing. It is
4817         * recommended to call this method explicitly though from deriving classes's
4818         * own overridden implementation of this method to avoid potential future
4819         * compatiblity issues.
4820         *
4821         * See DLS::Storage::DeleteChunks() for details.
4822         */
4823        void ScriptGroup::DeleteChunks() {
4824        }
4825    
4826      /**      /**
4827       * Apply this script group to the respective RIFF chunks. You have to call       * Apply this script group to the respective RIFF chunks. You have to call
4828       * File::Save() to make changes persistent.       * File::Save() to make changes persistent.
# Line 4605  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 4643  namespace { Line 4948  namespace {
4948          if (lart) {          if (lart) {
4949              RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);              RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
4950              if (_3ewg) {              if (_3ewg) {
4951                    _3ewg->SetPos(0);
4952    
4953                  EffectSend             = _3ewg->ReadUint16();                  EffectSend             = _3ewg->ReadUint16();
4954                  Attenuation            = _3ewg->ReadInt32();                  Attenuation            = _3ewg->ReadInt32();
4955                  FineTune               = _3ewg->ReadInt16();                  FineTune               = _3ewg->ReadInt16();
# Line 4684  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                          __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);                          if (pProgress)
5000                                __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 4700  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);
5016    
5017                  int headerSize = ckSCSL->ReadUint32();                  int headerSize = ckSCSL->ReadUint32();
5018                  int slotCount  = ckSCSL->ReadUint32();                  int slotCount  = ckSCSL->ReadUint32();
5019                  if (slotCount) {                  if (slotCount) {
# Line 4717  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          __notify_progress(pProgress, 1.0f); // notify done          if (pProgress)
5073                __notify_progress(pProgress, 1.0f); // notify done
5074      }      }
5075    
5076      void Instrument::UpdateRegionKeyTable() {      void Instrument::UpdateRegionKeyTable() {
# Line 4728  namespace { Line 5079  namespace {
5079          RegionList::iterator end  = pRegions->end();          RegionList::iterator end  = pRegions->end();
5080          for (; iter != end; ++iter) {          for (; iter != end; ++iter) {
5081              gig::Region* pRegion = static_cast<gig::Region*>(*iter);              gig::Region* pRegion = static_cast<gig::Region*>(*iter);
5082              for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {              const int low  = std::max(int(pRegion->KeyRange.low), 0);
5083                const int high = std::min(int(pRegion->KeyRange.high), 127);
5084                for (int iKey = low; iKey <= high; iKey++) {
5085                  RegionKeyTable[iKey] = pRegion;                  RegionKeyTable[iKey] = pRegion;
5086              }              }
5087          }          }
# Line 4773  namespace { Line 5126  namespace {
5126              File* pFile = (File*) GetParent();              File* pFile = (File*) GetParent();
5127    
5128              // 3ewg is bigger in gig3, as it includes the iMIDI rules              // 3ewg is bigger in gig3, as it includes the iMIDI rules
5129              int size = (pFile->pVersion && pFile->pVersion->major == 3) ? 16416 : 12;              int size = (pFile->pVersion && pFile->pVersion->major > 2) ? 16416 : 12;
5130              _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);              _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);
5131              memset(_3ewg->LoadChunkData(), 0, size);              memset(_3ewg->LoadChunkData(), 0, size);
5132          }          }
# Line 4805  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 4829  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 4876  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 4895  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 4948  namespace { Line 5394  namespace {
5394       * @param dst - destination instrument at which this instrument will be       * @param dst - destination instrument at which this instrument will be
5395       *              moved to, or pass NULL for moving to end of list       *              moved to, or pass NULL for moving to end of list
5396       * @throw gig::Exception if this instrument and target instrument are not       * @throw gig::Exception if this instrument and target instrument are not
5397       *                       part of the same file       *                       part of the same file, as well as on unexpected
5398         *                       internal error
5399       */       */
5400      void Instrument::MoveTo(Instrument* dst) {      void Instrument::MoveTo(Instrument* dst) {
5401          if (dst && GetParent() != dst->GetParent())          if (dst && GetParent() != dst->GetParent())
# Line 4965  namespace { Line 5412  namespace {
5412    
5413              File::InstrumentList::iterator itFrom =              File::InstrumentList::iterator itFrom =
5414                  std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(this));                  std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(this));
5415                if (itFrom == list.end())
5416                    throw Exception(
5417                        "gig::Instrument::MoveTo(): unexpected missing membership "
5418                        "of this instrument."
5419                    );
5420                list.erase(itFrom);
5421    
5422              File::InstrumentList::iterator itTo =              File::InstrumentList::iterator itTo =
5423                  std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(dst));                  std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(dst));
5424    
5425              list.splice(itTo, list, itFrom);              list.insert(itTo, this);
5426          }          }
5427    
5428          // move the instrument's actual list RIFF chunk appropriately          // move the instrument's actual list RIFF chunk appropriately
# Line 5253  namespace { Line 5706  namespace {
5706              scriptPoolFileOffsets.at(index).bypass = bBypass;              scriptPoolFileOffsets.at(index).bypass = bBypass;
5707      }      }
5708    
5709        /// type cast (by copy) uint8_t[16] -> std::array<uint8_t,16>
5710        inline std::array<uint8_t,16> _UUIDFromCArray(const uint8_t* pData) {
5711            std::array<uint8_t,16> uuid;
5712            memcpy(&uuid[0], pData, 16);
5713            return uuid;
5714        }
5715    
5716        /**
5717         * Returns true if this @c Instrument has any script slot which references
5718         * the @c Script identified by passed @p uuid.
5719         */
5720        bool Instrument::ReferencesScriptWithUuid(const _UUID& uuid) {
5721            const uint nSlots = ScriptSlotCount();
5722            for (uint iSlot = 0; iSlot < nSlots; ++iSlot)
5723                if (_UUIDFromCArray(&GetScriptOfSlot(iSlot)->Uuid[0]) == uuid)
5724                    return true;
5725            return false;
5726        }
5727    
5728        /** @brief Checks whether a certain script 'patch' variable value is set.
5729         *
5730         * Returns @c true if the initial value for the requested script variable is
5731         * currently overridden by this instrument.
5732         *
5733         * @remarks Real-time instrument scripts allow to declare special 'patch'
5734         * variables, which essentially behave like regular variables of their data
5735         * type, however their initial value may optionally be overridden on a per
5736         * instrument basis. That allows to share scripts between instruments while
5737         * still being able to fine tune certain aspects of the script for each
5738         * instrument individually.
5739         *
5740         * @note This is an own format extension which did not exist i.e. in the
5741         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5742         * Gigedit.
5743         *
5744         * @param slot - script slot index of the variable to be retrieved
5745         * @param variable - name of the 'patch' variable in that script
5746         */
5747        bool Instrument::IsScriptPatchVariableSet(int slot, String variable) {
5748            if (variable.empty()) return false;
5749            Script* script = GetScriptOfSlot(slot);
5750            if (!script) return false;
5751            const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5752            if (!scriptVars.count(uuid)) return false;
5753            const _VarsBySlot& slots = scriptVars.find(uuid)->second;
5754            if (slots.empty()) return false;
5755            if (slots.count(slot))
5756                return slots.find(slot)->second.count(variable);
5757            else
5758                return slots.begin()->second.count(variable);
5759        }
5760    
5761        /** @brief Get all overridden script 'patch' variables.
5762         *
5763         * Returns map of key-value pairs reflecting all patch variables currently
5764         * being overridden by this instrument for the given script @p slot, where
5765         * key is the variable name and value is the hereby currently overridden
5766         * value for that variable.
5767         *
5768         * @remarks Real-time instrument scripts allow to declare special 'patch'
5769         * variables, which essentially behave like regular variables of their data
5770         * type, however their initial value may optionally be overridden on a per
5771         * instrument basis. That allows to share scripts between instruments while
5772         * still being able to fine tune certain aspects of the script for each
5773         * instrument individually.
5774         *
5775         * @note This is an own format extension which did not exist i.e. in the
5776         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5777         * Gigedit.
5778         *
5779         * @param slot - script slot index of the variable to be retrieved
5780         */
5781        std::map<String,String> Instrument::GetScriptPatchVariables(int slot) {
5782            Script* script = GetScriptOfSlot(slot);
5783            if (!script) return std::map<String,String>();
5784            const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5785            if (!scriptVars.count(uuid)) return std::map<String,String>();
5786            const _VarsBySlot& slots = scriptVars.find(uuid)->second;
5787            if (slots.empty()) return std::map<String,String>();
5788            const _PatchVars& vars =
5789                (slots.count(slot)) ?
5790                    slots.find(slot)->second : slots.begin()->second;
5791            return vars;
5792        }
5793    
5794        /** @brief Get overridden initial value for 'patch' variable.
5795         *
5796         * Returns current initial value for the requested script variable being
5797         * overridden by this instrument.
5798         *
5799         * @remarks Real-time instrument scripts allow to declare special 'patch'
5800         * variables, which essentially behave like regular variables of their data
5801         * type, however their initial value may optionally be overridden on a per
5802         * instrument basis. That allows to share scripts between instruments while
5803         * still being able to fine tune certain aspects of the script for each
5804         * instrument individually.
5805         *
5806         * @note This is an own format extension which did not exist i.e. in the
5807         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5808         * Gigedit.
5809         *
5810         * @param slot - script slot index of the variable to be retrieved
5811         * @param variable - name of the 'patch' variable in that script
5812         */
5813        String Instrument::GetScriptPatchVariable(int slot, String variable) {
5814            std::map<String,String> vars = GetScriptPatchVariables(slot);
5815            return (vars.count(variable)) ? vars.find(variable)->second : "";
5816        }
5817    
5818        /** @brief Override initial value for 'patch' variable.
5819         *
5820         * Overrides initial value for the requested script variable for this
5821         * instrument with the passed value.
5822         *
5823         * @remarks Real-time instrument scripts allow to declare special 'patch'
5824         * variables, which essentially behave like regular variables of their data
5825         * type, however their initial value may optionally be overridden on a per
5826         * instrument basis. That allows to share scripts between instruments while
5827         * still being able to fine tune certain aspects of the script for each
5828         * instrument individually.
5829         *
5830         * @note This is an own format extension which did not exist i.e. in the
5831         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5832         * Gigedit.
5833         *
5834         * @param slot - script slot index of the variable to be set
5835         * @param variable - name of the 'patch' variable in that script
5836         * @param value - overridden initial value for that script variable
5837         * @throws gig::Exception if given script @p slot index is invalid or given
5838         *         @p variable name is empty
5839         */
5840        void Instrument::SetScriptPatchVariable(int slot, String variable, String value) {
5841            if (variable.empty())
5842                throw Exception("Variable name must not be empty");
5843            Script* script = GetScriptOfSlot(slot);
5844            if (!script)
5845                throw Exception("No script slot with index " + ToString(slot));
5846            const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5847            scriptVars[uuid][slot][variable] = value;
5848        }
5849    
5850        /** @brief Drop overridden initial value(s) for 'patch' variable(s).
5851         *
5852         * Reverts initial value(s) for requested script variable(s) back to their
5853         * default initial value(s) defined in the script itself.
5854         *
5855         * Both arguments of this method are optional. The most obvious use case of
5856         * this method would be passing a valid script @p slot index and a
5857         * (non-emtpy string as) @p variable name to this method, which would cause
5858         * that single variable to be unset for that specific script slot (on this
5859         * @c Instrument level).
5860         *
5861         * Not passing a value (or @c -1 for @p slot and/or empty string for
5862         * @p variable) means 'wildcard'. So accordingly absence of argument(s) will
5863         * cause all variables and/or for all script slots being unset. Hence this
5864         * method serves 2^2 = 4 possible use cases in total and accordingly covers
5865         * 4 different behaviours in one method.
5866         *
5867         * @remarks Real-time instrument scripts allow to declare special 'patch'
5868         * variables, which essentially behave like regular variables of their data
5869         * type, however their initial value may optionally be overridden on a per
5870         * instrument basis. That allows to share scripts between instruments while
5871         * still being able to fine tune certain aspects of the script for each
5872         * instrument individually.
5873         *
5874         * @note This is an own format extension which did not exist i.e. in the
5875         * GigaStudio 4 software. It will currently only work with LinuxSampler and
5876         * Gigedit.
5877         *
5878         * @param slot - script slot index of the variable to be unset
5879         * @param variable - name of the 'patch' variable in that script
5880         */
5881        void Instrument::UnsetScriptPatchVariable(int slot, String variable) {
5882            Script* script = GetScriptOfSlot(slot);
5883    
5884            // option 1: unset a particular variable of one particular script slot
5885            if (slot != -1 && !variable.empty()) {
5886                if (!script) return;
5887                const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5888                if (!scriptVars.count(uuid)) return;
5889                if (!scriptVars[uuid].count(slot)) return;
5890                if (scriptVars[uuid][slot].count(variable))
5891                    scriptVars[uuid][slot].erase(
5892                        scriptVars[uuid][slot].find(variable)
5893                    );
5894                if (scriptVars[uuid][slot].empty())
5895                    scriptVars[uuid].erase( scriptVars[uuid].find(slot) );
5896                if (scriptVars[uuid].empty())
5897                    scriptVars.erase( scriptVars.find(uuid) );
5898                return;
5899            }
5900    
5901            // option 2: unset all variables of all script slots
5902            if (slot == -1 && variable.empty()) {
5903                scriptVars.clear();
5904                return;
5905            }
5906    
5907            // option 3: unset all variables of one particular script slot only
5908            if (slot != -1) {
5909                if (!script) return;
5910                const _UUID uuid = _UUIDFromCArray(&script->Uuid[0]);
5911                if (scriptVars.count(uuid))
5912                    scriptVars.erase( scriptVars.find(uuid) );
5913                return;
5914            }
5915    
5916            // option 4: unset a particular variable of all script slots
5917            _VarsByScript::iterator itScript = scriptVars.begin();
5918            _VarsByScript::iterator endScript = scriptVars.end();
5919            while (itScript != endScript) {
5920                _VarsBySlot& slots = itScript->second;
5921                _VarsBySlot::iterator itSlot = slots.begin();
5922                _VarsBySlot::iterator endSlot = slots.end();
5923                while (itSlot != endSlot) {
5924                    _PatchVars& vars = itSlot->second;
5925                    if (vars.count(variable))
5926                        vars.erase( vars.find(variable) );
5927                    if (vars.empty())
5928                        slots.erase(itSlot++); // postfix increment to avoid iterator invalidation
5929                    else
5930                        ++itSlot;
5931                }
5932                if (slots.empty())
5933                    scriptVars.erase(itScript++); // postfix increment to avoid iterator invalidation
5934                else
5935                    ++itScript;
5936            }
5937        }
5938    
5939        /**
5940         * Returns stripped version of member variable @c scriptVars, where scripts
5941         * no longer referenced by this @c Instrument are filtered out, and so are
5942         * variables of meanwhile obsolete slots (i.e. a script still being
5943         * referenced, but previously overridden on a script slot which either no
5944         * longer exists or is hosting another script now).
5945         */
5946        Instrument::_VarsByScript Instrument::stripScriptVars() {
5947            _VarsByScript vars;
5948            _VarsByScript::const_iterator itScript = scriptVars.begin();
5949            _VarsByScript::const_iterator endScript = scriptVars.end();
5950            for (; itScript != endScript; ++itScript) {
5951                const _UUID& uuid = itScript->first;
5952                if (!ReferencesScriptWithUuid(uuid))
5953                    continue;
5954                const _VarsBySlot& slots = itScript->second;
5955                _VarsBySlot::const_iterator itSlot = slots.begin();
5956                _VarsBySlot::const_iterator endSlot = slots.end();
5957                for (; itSlot != endSlot; ++itSlot) {
5958                    Script* script = GetScriptOfSlot(itSlot->first);
5959                    if (!script) continue;
5960                    if (_UUIDFromCArray(&script->Uuid[0]) != uuid) continue;
5961                    if (itSlot->second.empty()) continue;
5962                    vars[uuid][itSlot->first] = itSlot->second;
5963                }
5964            }
5965            return vars;
5966        }
5967    
5968      /**      /**
5969       * 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
5970       * and assign it to this object.       * and assign it to this object.
# Line 5287  namespace { Line 5999  namespace {
5999          PianoReleaseMode = orig->PianoReleaseMode;          PianoReleaseMode = orig->PianoReleaseMode;
6000          DimensionKeyRange = orig->DimensionKeyRange;          DimensionKeyRange = orig->DimensionKeyRange;
6001          scriptPoolFileOffsets = orig->scriptPoolFileOffsets;          scriptPoolFileOffsets = orig->scriptPoolFileOffsets;
6002          pScriptRefs = orig->pScriptRefs;          // deep copy of pScriptRefs required (to avoid undefined behaviour)
6003            if (pScriptRefs) delete pScriptRefs;
6004            pScriptRefs = new std::vector<_ScriptPooolRef>;
6005            if (orig->pScriptRefs)
6006                *pScriptRefs = *orig->pScriptRefs;
6007            scriptVars = orig->scriptVars;
6008                    
6009          // free old midi rules          // free old midi rules
6010          for (int i = 0 ; pMidiRules[i] ; i++) {          for (int i = 0 ; pMidiRules[i] ; i++) {
# Line 5297  namespace { Line 6014  namespace {
6014          pMidiRules[0] = NULL;          pMidiRules[0] = NULL;
6015                    
6016          // delete all old regions          // delete all old regions
6017          while (Regions) DeleteRegion(GetFirstRegion());          while (Regions) DeleteRegion(GetRegionAt(0));
6018          // create new regions and copy them from original          // create new regions and copy them from original
6019          {          {
6020              RegionList::const_iterator it = orig->pRegions->begin();              RegionList::const_iterator it = orig->pRegions->begin();
# Line 5314  namespace { Line 6031  namespace {
6031          UpdateRegionKeyTable();          UpdateRegionKeyTable();
6032      }      }
6033    
6034        /**
6035         * Returns @c true in case this Instrument object uses any gig format
6036         * extension, that is e.g. whether any DimensionRegion object currently
6037         * has any setting effective that would require our "LSDE" RIFF chunk to
6038         * be stored to the gig file.
6039         *
6040         * Right now this is a private method. It is considerable though this method
6041         * to become (in slightly modified form) a public API method in future, i.e.
6042         * to allow instrument editors to visualize and/or warn the user of any gig
6043         * format extension being used. See also comments on
6044         * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
6045         * potential public API change in future.
6046         */
6047        bool Instrument::UsesAnyGigFormatExtension() const {
6048            if (!pRegions) return false;
6049            if (!scriptVars.empty()) return true;
6050            RegionList::const_iterator iter = pRegions->begin();
6051            RegionList::const_iterator end  = pRegions->end();
6052            for (; iter != end; ++iter) {
6053                gig::Region* rgn = static_cast<gig::Region*>(*iter);
6054                if (rgn->UsesAnyGigFormatExtension())
6055                    return true;
6056            }
6057            return false;
6058        }
6059    
6060    
6061  // *************** Group ***************  // *************** Group ***************
6062  // *  // *
# Line 5327  namespace { Line 6070  namespace {
6070      Group::Group(File* file, RIFF::Chunk* ck3gnm) {      Group::Group(File* file, RIFF::Chunk* ck3gnm) {
6071          pFile      = file;          pFile      = file;
6072          pNameChunk = ck3gnm;          pNameChunk = ck3gnm;
6073            SamplesIterator = 0;
6074          ::LoadString(pNameChunk, Name);          ::LoadString(pNameChunk, Name);
6075      }      }
6076    
6077        /** @brief Destructor.
6078         *
6079         * Currently this destructor implementation does nothing.
6080         */
6081      Group::~Group() {      Group::~Group() {
6082          // remove the chunk associated with this group (if any)      }
6083          if (pNameChunk) pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);  
6084        /** @brief Remove all RIFF chunks associated with this Group object.
6085         *
6086         * See DLS::Storage::DeleteChunks() for details.
6087         */
6088        void Group::DeleteChunks() {
6089            // handle own RIFF chunks
6090            if (pNameChunk) {
6091                pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
6092                pNameChunk = NULL;
6093            }
6094      }      }
6095    
6096      /** @brief Update chunks with current group settings.      /** @brief Update chunks with current group settings.
# Line 5355  namespace { Line 6113  namespace {
6113          RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);          RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
6114          if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);          if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
6115    
6116          if (!pNameChunk && pFile->pVersion && pFile->pVersion->major == 3) {          if (!pNameChunk && pFile->pVersion && pFile->pVersion->major > 2) {
6117              // v3 has a fixed list of 128 strings, find a free one              // v3 has a fixed list of 128 strings, find a free one
6118              for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {              size_t i = 0;
6119                for (RIFF::Chunk* ck = _3gnl->GetSubChunkAt(i); ck; ck = _3gnl->GetSubChunkAt(++i)) {
6120                  if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {                  if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {
6121                      pNameChunk = ck;                      pNameChunk = ck;
6122                      break;                      break;
# Line 5370  namespace { Line 6129  namespace {
6129      }      }
6130    
6131      /**      /**
6132         * Returns Sample object at @a index of this sample group.
6133         *
6134         * @param index - position of sample in this sample group's sample list
6135         *                (0..n)
6136         * @returns sample object or NULL if index is out of bounds
6137         */
6138        Sample* Group::GetSample(size_t index) {
6139            if (pFile->pSamples && index >= pFile->pSamples->size()) return NULL;
6140            size_t indexInFile = 0;
6141            size_t indexInGroup = 0;
6142            for (Sample* pSample = pFile->GetSample(indexInFile); pSample;
6143                         pSample = pFile->GetSample(++indexInFile))
6144            {
6145                if (pSample->GetGroup() != this) continue;
6146                if (indexInGroup++ == index) return pSample;
6147            }
6148            return NULL;
6149        }
6150    
6151        /**
6152       * 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
6153       * once before you use GetNextSample().       * once before you use GetNextSample().
6154       *       *
# Line 5379  namespace { Line 6158  namespace {
6158       * @returns  pointer address to first Sample or NULL if there is none       * @returns  pointer address to first Sample or NULL if there is none
6159       *           applied to this Group       *           applied to this Group
6160       * @see      GetNextSample()       * @see      GetNextSample()
6161         * @deprecated  This method is not reentrant-safe, use GetSample()
6162         *              instead.
6163       */       */
6164      Sample* Group::GetFirstSample() {      Sample* Group::GetFirstSample() {
6165          // FIXME: lazy und unsafe implementation, should be an autonomous iterator          size_t& i = this->SamplesIterator;
6166          for (Sample* pSample = pFile->GetFirstSample(); pSample; pSample = pFile->GetNextSample()) {          i = 0;
6167              if (pSample->GetGroup() == this) return pSample;          for (Sample* pSample = pFile->GetSample(i); pSample;
6168                         pSample = pFile->GetSample(++i))
6169            {
6170                if (pSample->GetGroup() == this)
6171                    return pSample;
6172          }          }
6173          return NULL;          return NULL;
6174      }      }
# Line 5397  namespace { Line 6182  namespace {
6182       * @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
6183       *           end reached       *           end reached
6184       * @see      GetFirstSample()       * @see      GetFirstSample()
6185         * @deprecated  This method is not reentrant-safe, use GetSample()
6186         *              instead.
6187       */       */
6188      Sample* Group::GetNextSample() {      Sample* Group::GetNextSample() {
6189          // FIXME: lazy und unsafe implementation, should be an autonomous iterator          size_t& i = this->SamplesIterator;
6190          for (Sample* pSample = pFile->GetNextSample(); pSample; pSample = pFile->GetNextSample()) {          for (Sample* pSample = pFile->GetSample(++i); pSample;
6191              if (pSample->GetGroup() == this) return pSample;                       pSample = pFile->GetSample(++i))
6192            {
6193                if (pSample->GetGroup() == this)
6194                    return pSample;
6195          }          }
6196          return NULL;          return NULL;
6197      }      }
# Line 5421  namespace { Line 6211  namespace {
6211       */       */
6212      void Group::MoveAll() {      void Group::MoveAll() {
6213          // get "that" other group first          // get "that" other group first
6214            size_t i = 0;
6215          Group* pOtherGroup = NULL;          Group* pOtherGroup = NULL;
6216          for (pOtherGroup = pFile->GetFirstGroup(); pOtherGroup; pOtherGroup = pFile->GetNextGroup()) {          for (pOtherGroup = pFile->GetGroup(i); pOtherGroup;
6217                 pOtherGroup = pFile->GetGroup(++i))
6218            {
6219              if (pOtherGroup != this) break;              if (pOtherGroup != this) break;
6220          }          }
6221          if (!pOtherGroup) throw Exception(          if (!pOtherGroup) throw Exception(
# Line 5430  namespace { Line 6223  namespace {
6223              "other Group. This is a bug, report it!"              "other Group. This is a bug, report it!"
6224          );          );
6225          // now move all samples of this group to the other group          // now move all samples of this group to the other group
6226          for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {          Sample* pSample;
6227            while ((pSample = GetSample(0))) {
6228              pOtherGroup->AddSample(pSample);              pOtherGroup->AddSample(pSample);
6229          }          }
6230      }      }
# Line 5450  namespace { Line 6244  namespace {
6244          0, 3, 20030331 & 0xffff, 20030331 >> 16          0, 3, 20030331 & 0xffff, 20030331 >> 16
6245      };      };
6246    
6247        /// Reflects Gigasampler file format version 4.0 (2007-10-12).
6248        const DLS::version_t File::VERSION_4 = {
6249            0, 4, 20071012 & 0xffff, 20071012 >> 16
6250        };
6251    
6252      static const DLS::Info::string_length_t _FileFixedStringLengths[] = {      static const DLS::Info::string_length_t _FileFixedStringLengths[] = {
6253          { CHUNK_ID_IARL, 256 },          { CHUNK_ID_IARL, 256 },
6254          { CHUNK_ID_IART, 128 },          { CHUNK_ID_IART, 128 },
# Line 5497  namespace { Line 6296  namespace {
6296    
6297      File::~File() {      File::~File() {
6298          if (pGroups) {          if (pGroups) {
6299              std::list<Group*>::iterator iter = pGroups->begin();              std::vector<Group*>::iterator iter = pGroups->begin();
6300              std::list<Group*>::iterator end  = pGroups->end();              std::vector<Group*>::iterator end  = pGroups->end();
6301              while (iter != end) {              while (iter != end) {
6302                  delete *iter;                  delete *iter;
6303                  ++iter;                  ++iter;
# Line 5516  namespace { Line 6315  namespace {
6315          }          }
6316      }      }
6317    
6318        /**
6319         * Returns a pointer to the first <i>Sample</i> object of the file,
6320         * <i>NULL</i> otherwise.
6321         *
6322         * @param pProgress - optional: callback function for progress notification
6323         * @deprecated  This method is not reentrant-safe, use GetSample()
6324         *              instead.
6325         */
6326      Sample* File::GetFirstSample(progress_t* pProgress) {      Sample* File::GetFirstSample(progress_t* pProgress) {
6327          if (!pSamples) LoadSamples(pProgress);          if (!pSamples) LoadSamples(pProgress);
6328          if (!pSamples) return NULL;          if (!pSamples) return NULL;
# Line 5523  namespace { Line 6330  namespace {
6330          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
6331      }      }
6332    
6333        /**
6334         * Returns a pointer to the next <i>Sample</i> object of the file,
6335         * <i>NULL</i> otherwise.
6336         *
6337         * @deprecated  This method is not reentrant-safe, use GetSample()
6338         *              instead.
6339         */
6340      Sample* File::GetNextSample() {      Sample* File::GetNextSample() {
6341          if (!pSamples) return NULL;          if (!pSamples) return NULL;
6342          SamplesIterator++;          SamplesIterator++;
# Line 5532  namespace { Line 6346  namespace {
6346      /**      /**
6347       * Returns Sample object of @a index.       * Returns Sample object of @a index.
6348       *       *
6349         * @param index - position of sample in sample list (0..n)
6350         * @param pProgress - optional: callback function for progress notification
6351       * @returns sample object or NULL if index is out of bounds       * @returns sample object or NULL if index is out of bounds
6352       */       */
6353      Sample* File::GetSample(uint index) {      Sample* File::GetSample(size_t index, progress_t* pProgress) {
6354          if (!pSamples) LoadSamples();          if (!pSamples) LoadSamples(pProgress);
6355          if (!pSamples) return NULL;          if (!pSamples) return NULL;
6356          DLS::File::SampleList::iterator it = pSamples->begin();          if (index >= pSamples->size()) return NULL;
6357          for (int i = 0; i < index; ++i) {          return static_cast<gig::Sample*>( (*pSamples)[index] );
6358              ++it;      }
6359              if (it == pSamples->end()) return NULL;  
6360          }      /**
6361          if (it == pSamples->end()) return NULL;       * Returns the total amount of samples of this gig file.
6362          return static_cast<gig::Sample*>( *it );       *
6363         * Note that this method might block for a long time in case it is required
6364         * to load the sample info for the first time.
6365         *
6366         * @returns total amount of samples
6367         */
6368        size_t File::CountSamples() {
6369            if (!pSamples) LoadSamples();
6370            if (!pSamples) return 0;
6371            return pSamples->size();
6372      }      }
6373    
6374      /** @brief Add a new sample.      /** @brief Add a new sample.
# Line 5584  namespace { Line 6409  namespace {
6409          if (iter == pSamples->end()) throw gig::Exception("Could not delete sample, could not find given sample");          if (iter == pSamples->end()) throw gig::Exception("Could not delete sample, could not find given sample");
6410          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation          if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
6411          pSamples->erase(iter);          pSamples->erase(iter);
6412            pSample->DeleteChunks();
6413          delete pSample;          delete pSample;
6414    
6415          SampleList::iterator tmp = SamplesIterator;          SampleList::iterator tmp = SamplesIterator;
6416          // remove all references to the sample          // remove all references to the sample
6417          for (Instrument* instrument = GetFirstInstrument() ; instrument ;          for (Instrument* instrument = GetFirstInstrument() ; instrument ;
6418               instrument = GetNextInstrument()) {               instrument = GetNextInstrument()) {
6419              for (Region* region = instrument->GetFirstRegion() ; region ;              size_t iRgn = 0;
6420                   region = instrument->GetNextRegion()) {              for (Region* region = instrument->GetRegionAt(iRgn); region;
6421                     region = instrument->GetRegionAt(++iRgn))
6422                {
6423                  if (region->GetSample() == pSample) region->SetSample(NULL);                  if (region->GetSample() == pSample) region->SetSample(NULL);
6424    
6425                  for (int i = 0 ; i < region->DimensionRegions ; i++) {                  for (int i = 0 ; i < region->DimensionRegions ; i++) {
# Line 5615  namespace { Line 6442  namespace {
6442    
6443          if (!pSamples) pSamples = new SampleList;          if (!pSamples) pSamples = new SampleList;
6444    
         RIFF::File* file = pRIFF;  
   
6445          // just for progress calculation          // just for progress calculation
6446          int iSampleIndex  = 0;          int iSampleIndex  = 0;
6447          int iTotalSamples = WavePoolCount;          int iTotalSamples = WavePoolCount;
6448    
6449          // check if samples should be loaded from extension files          // just for assembling path of optional extension files to be read
6450          // (only for old gig files < 2 GB)          const std::string folder = parentPath(pRIFF->GetFileName());
6451          int lastFileNo = 0;          const std::string baseName = pathWithoutExtension(pRIFF->GetFileName());
6452          if (!file->IsNew() && !(file->GetCurrentFileSize() >> 31)) {  
6453              for (int i = 0 ; i < WavePoolCount ; i++) {          // the main gig file and the extension files (.gx01, ... , .gx98) may
6454                  if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];          // contain wave data (wave pool)
6455              }          std::vector<RIFF::File*> poolFiles;
6456          }          poolFiles.push_back(pRIFF);
6457          String name(pRIFF->GetFileName());  
6458          int nameLen = (int) name.length();          // get info about all extension files
6459          char suffix[6];          RIFF::Chunk* ckXfil = pRIFF->GetSubChunk(CHUNK_ID_XFIL);
6460          if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;          if (ckXfil) { // there are extension files (.gx01, ... , .gx98) ...
6461                const uint32_t n = ckXfil->ReadInt32();
6462          for (int fileNo = 0 ; ; ) {              for (int i = 0; i < n; i++) {
6463                    // read the filename and load the extension file
6464                    std::string name;
6465                    ckXfil->ReadString(name, 128);
6466                    std::string path = concatPath(folder, name);
6467                    RIFF::File* pExtFile = new RIFF::File(path);
6468                    // check that the dlsids match
6469                    RIFF::Chunk* ckDLSID = pExtFile->GetSubChunk(CHUNK_ID_DLID);
6470                    if (ckDLSID) {
6471                        ::DLS::dlsid_t idExpected;
6472                        idExpected.ulData1 = ckXfil->ReadInt32();
6473                        idExpected.usData2 = ckXfil->ReadInt16();
6474                        idExpected.usData3 = ckXfil->ReadInt16();
6475                        ckXfil->Read(idExpected.abData, 8, 1);
6476                        ::DLS::dlsid_t idFound;
6477                        ckDLSID->Read(&idFound.ulData1, 1, 4);
6478                        ckDLSID->Read(&idFound.usData2, 1, 2);
6479                        ckDLSID->Read(&idFound.usData3, 1, 2);
6480                        ckDLSID->Read(idFound.abData, 8, 1);
6481                        if (memcmp(&idExpected, &idFound, 16) != 0)
6482                            throw gig::Exception("dlsid mismatch for extension file: %s", path.c_str());
6483                    }
6484                    poolFiles.push_back(pExtFile);
6485                    ExtensionFiles.push_back(pExtFile);
6486                }
6487            }
6488    
6489            // check if a .gx99 (GigaPulse) file exists
6490            RIFF::Chunk* ckDoxf = pRIFF->GetSubChunk(CHUNK_ID_DOXF);
6491            if (ckDoxf) { // there is a .gx99 (GigaPulse) file ...
6492                std::string path = baseName + ".gx99";
6493                RIFF::File* pExtFile = new RIFF::File(path);
6494    
6495                // skip unused int and filename
6496                ckDoxf->SetPos(132, RIFF::stream_curpos);
6497    
6498                // check that the dlsids match
6499                RIFF::Chunk* ckDLSID = pExtFile->GetSubChunk(CHUNK_ID_DLID);
6500                if (ckDLSID) {
6501                    ::DLS::dlsid_t idExpected;
6502                    idExpected.ulData1 = ckDoxf->ReadInt32();
6503                    idExpected.usData2 = ckDoxf->ReadInt16();
6504                    idExpected.usData3 = ckDoxf->ReadInt16();
6505                    ckDoxf->Read(idExpected.abData, 8, 1);
6506                    ::DLS::dlsid_t idFound;
6507                    ckDLSID->Read(&idFound.ulData1, 1, 4);
6508                    ckDLSID->Read(&idFound.usData2, 1, 2);
6509                    ckDLSID->Read(&idFound.usData3, 1, 2);
6510                    ckDLSID->Read(idFound.abData, 8, 1);
6511                    if (memcmp(&idExpected, &idFound, 16) != 0)
6512                        throw gig::Exception("dlsid mismatch for GigaPulse file: %s", path.c_str());
6513                }
6514                poolFiles.push_back(pExtFile);
6515                ExtensionFiles.push_back(pExtFile);
6516            }
6517    
6518            // load samples from extension files (if required)
6519            for (int i = 0; i < poolFiles.size(); i++) {
6520                RIFF::File* file = poolFiles[i];
6521              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
6522              if (wvpl) {              if (wvpl) {
6523                  file_offset_t wvplFileOffset = wvpl->GetFilePos();                  file_offset_t wvplFileOffset = wvpl->GetFilePos() -
6524                  RIFF::List* wave = wvpl->GetFirstSubList();                                                 wvpl->GetPos(); // should be zero, but just to be sure
6525                  while (wave) {                  size_t i = 0;
6526                    for (RIFF::List* wave = wvpl->GetSubListAt(i); wave;
6527                         wave = wvpl->GetSubListAt(++i))
6528                    {
6529                      if (wave->GetListType() == LIST_TYPE_WAVE) {                      if (wave->GetListType() == LIST_TYPE_WAVE) {
6530                          // notify current progress                          // notify current progress
6531                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;                          if (pProgress) {
6532                          __notify_progress(pProgress, subprogress);                              const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
6533                                __notify_progress(pProgress, subprogress);
6534                            }
6535    
6536                          file_offset_t waveFileOffset = wave->GetFilePos();                          file_offset_t waveFileOffset = wave->GetFilePos();
6537                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo, iSampleIndex));                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, i, iSampleIndex));
6538    
6539                          iSampleIndex++;                          iSampleIndex++;
6540                      }                      }
                     wave = wvpl->GetNextSubList();  
6541                  }                  }
6542                }
                 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;  
6543          }          }
6544    
6545          __notify_progress(pProgress, 1.0); // notify done          if (pProgress)
6546                __notify_progress(pProgress, 1.0); // notify done
6547      }      }
6548    
6549      Instrument* File::GetFirstInstrument() {      Instrument* File::GetFirstInstrument() {
# Line 5681  namespace { Line 6560  namespace {
6560      }      }
6561    
6562      /**      /**
6563         * Returns the total amount of instruments of this gig file.
6564         *
6565         * Note that this method might block for a long time in case it is required
6566         * to load the instruments info for the first time.
6567         *
6568         * @returns total amount of instruments
6569         */
6570        size_t File::CountInstruments() {
6571            if (!pInstruments) LoadInstruments();
6572            if (!pInstruments) return 0;
6573            return pInstruments->size();
6574        }
6575    
6576        /**
6577       * Returns the instrument with the given index.       * Returns the instrument with the given index.
6578       *       *
6579       * @param index     - number of the sought instrument (0..n)       * @param index     - number of the sought instrument (0..n)
# Line 5691  namespace { Line 6584  namespace {
6584          if (!pInstruments) {          if (!pInstruments) {
6585              // TODO: hack - we simply load ALL samples here, it would have been done in the Region constructor anyway (ATM)              // TODO: hack - we simply load ALL samples here, it would have been done in the Region constructor anyway (ATM)
6586    
6587              // sample loading subtask              if (pProgress) {
6588              progress_t subprogress;                  // sample loading subtask
6589              __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask                  progress_t subprogress;
6590              __notify_progress(&subprogress, 0.0f);                  __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
6591              if (GetAutoLoad())                  __notify_progress(&subprogress, 0.0f);
6592                  GetFirstSample(&subprogress); // now force all samples to be loaded                  if (GetAutoLoad())
6593              __notify_progress(&subprogress, 1.0f);                      GetSample(0, &subprogress); // now force all samples to be loaded
6594                    __notify_progress(&subprogress, 1.0f);
6595              // instrument loading subtask  
6596              if (pProgress && pProgress->callback) {                  // instrument loading subtask
6597                  subprogress.__range_min = subprogress.__range_max;                  if (pProgress->callback) {
6598                  subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask                      subprogress.__range_min = subprogress.__range_max;
6599              }                      subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask
6600              __notify_progress(&subprogress, 0.0f);                  }
6601              LoadInstruments(&subprogress);                  __notify_progress(&subprogress, 0.0f);
6602              __notify_progress(&subprogress, 1.0f);                  LoadInstruments(&subprogress);
6603                    __notify_progress(&subprogress, 1.0f);
6604                } else {
6605                    // sample loading subtask
6606                    if (GetAutoLoad())
6607                        GetSample(0); // now force all samples to be loaded
6608    
6609                    // instrument loading subtask
6610                    LoadInstruments();
6611                }
6612          }          }
6613          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
6614          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
# Line 5855  namespace { Line 6757  namespace {
6757          InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);          InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);
6758          if (iter == pInstruments->end()) throw gig::Exception("Could not delete instrument, could not find given instrument");          if (iter == pInstruments->end()) throw gig::Exception("Could not delete instrument, could not find given instrument");
6759          pInstruments->erase(iter);          pInstruments->erase(iter);
6760            pInstrument->DeleteChunks();
6761          delete pInstrument;          delete pInstrument;
6762      }      }
6763    
# Line 5867  namespace { Line 6770  namespace {
6770          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
6771          if (lstInstruments) {          if (lstInstruments) {
6772              int iInstrumentIndex = 0;              int iInstrumentIndex = 0;
6773              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();              size_t i = 0;
6774              while (lstInstr) {              for (RIFF::List* lstInstr = lstInstruments->GetSubListAt(i);
6775                     lstInstr; lstInstr = lstInstruments->GetSubListAt(++i))
6776                {
6777                  if (lstInstr->GetListType() == LIST_TYPE_INS) {                  if (lstInstr->GetListType() == LIST_TYPE_INS) {
6778                      // notify current progress                      if (pProgress) {
6779                      const float localProgress = (float) iInstrumentIndex / (float) Instruments;                          // notify current progress
6780                      __notify_progress(pProgress, localProgress);                          const float localProgress = (float) iInstrumentIndex / (float) Instruments;
6781                            __notify_progress(pProgress, localProgress);
                     // divide local progress into subprogress for loading current Instrument  
                     progress_t subprogress;  
                     __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);  
6782    
6783                      pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));                          // divide local progress into subprogress for loading current Instrument
6784                            progress_t subprogress;
6785                            __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
6786    
6787                            pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
6788                        } else {
6789                            pInstruments->push_back(new Instrument(this, lstInstr));
6790                        }
6791    
6792                      iInstrumentIndex++;                      iInstrumentIndex++;
6793                  }                  }
                 lstInstr = lstInstruments->GetNextSubList();  
6794              }              }
6795              __notify_progress(pProgress, 1.0); // notify done              if (pProgress)
6796                    __notify_progress(pProgress, 1.0); // notify done
6797          }          }
6798      }      }
6799    
# Line 5935  namespace { Line 6844  namespace {
6844      }      }
6845    
6846      int File::GetWaveTableIndexOf(gig::Sample* pSample) {      int File::GetWaveTableIndexOf(gig::Sample* pSample) {
6847          if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned          if (!pSamples) GetSample(0); // make sure sample chunks were scanned
6848          File::SampleList::iterator iter = pSamples->begin();          File::SampleList::iterator iter = pSamples->begin();
6849          File::SampleList::iterator end  = pSamples->end();          File::SampleList::iterator end  = pSamples->end();
6850          for (int index = 0; iter != end; ++iter, ++index)          for (int index = 0; iter != end; ++iter, ++index)
# Line 5955  namespace { Line 6864  namespace {
6864          if (!_3crc) return false;          if (!_3crc) return false;
6865          if (_3crc->GetNewSize() <= 0) return false;          if (_3crc->GetNewSize() <= 0) return false;
6866          if (_3crc->GetNewSize() % 8) return false;          if (_3crc->GetNewSize() % 8) return false;
6867          if (!pSamples) GetFirstSample(); // make sure sample chunks were scanned          if (!pSamples) GetSample(0); // make sure sample chunks were scanned
6868          if (_3crc->GetNewSize() != pSamples->size() * 8) return false;          if (_3crc->GetNewSize() != pSamples->size() * 8) return false;
6869    
6870          const file_offset_t n = _3crc->GetNewSize() / 8;          const file_offset_t n = _3crc->GetNewSize() / 8;
# Line 5989  namespace { Line 6898  namespace {
6898       */       */
6899      bool File::RebuildSampleChecksumTable() {      bool File::RebuildSampleChecksumTable() {
6900          // make sure sample chunks were scanned          // make sure sample chunks were scanned
6901          if (!pSamples) GetFirstSample();          if (!pSamples) GetSample(0);
6902    
6903          bool bRequiresSave = false;          bool bRequiresSave = false;
6904    
# Line 5999  namespace { Line 6908  namespace {
6908              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
6909              // the order of einf and 3crc is not the same in v2 and v3              // the order of einf and 3crc is not the same in v2 and v3
6910              RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);              RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
6911              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);              if (einf && pVersion && pVersion->major > 2) pRIFF->MoveSubChunk(_3crc, einf);
6912              bRequiresSave = true;              bRequiresSave = true;
6913          } else if (_3crc->GetNewSize() != pSamples->size() * 8) {          } else if (_3crc->GetNewSize() != pSamples->size() * 8) {
6914              _3crc->Resize(pSamples->size() * 8);              _3crc->Resize(pSamples->size() * 8);
# Line 6038  namespace { Line 6947  namespace {
6947          return bRequiresSave;          return bRequiresSave;
6948      }      }
6949    
6950        /**
6951         * Returns a pointer to the first <i>Group</i> object of the file,
6952         * <i>NULL</i> otherwise.
6953         *
6954         * @deprecated  This method is not reentrant-safe, use GetGroup() instead.
6955         */
6956      Group* File::GetFirstGroup() {      Group* File::GetFirstGroup() {
6957          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6958          // there must always be at least one group          // there must always be at least one group
# Line 6045  namespace { Line 6960  namespace {
6960          return *GroupsIterator;          return *GroupsIterator;
6961      }      }
6962    
6963        /**
6964         * Returns a pointer to the next <i>Group</i> object of the file,
6965         * <i>NULL</i> otherwise.
6966         *
6967         * @deprecated  This method is not reentrant-safe, use GetGroup() instead.
6968         */
6969      Group* File::GetNextGroup() {      Group* File::GetNextGroup() {
6970          if (!pGroups) return NULL;          if (!pGroups) return NULL;
6971          ++GroupsIterator;          ++GroupsIterator;
# Line 6057  namespace { Line 6978  namespace {
6978       * @param index - number of the sought group (0..n)       * @param index - number of the sought group (0..n)
6979       * @returns sought group or NULL if there's no such group       * @returns sought group or NULL if there's no such group
6980       */       */
6981      Group* File::GetGroup(uint index) {      Group* File::GetGroup(size_t index) {
6982          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6983          GroupsIterator = pGroups->begin();          if (index >= pGroups->size()) return NULL;
6984          for (uint i = 0; GroupsIterator != pGroups->end(); i++) {          return (*pGroups)[index];
             if (i == index) return *GroupsIterator;  
             ++GroupsIterator;  
         }  
         return NULL;  
6985      }      }
6986    
6987      /**      /**
# Line 6079  namespace { Line 6996  namespace {
6996       */       */
6997      Group* File::GetGroup(String name) {      Group* File::GetGroup(String name) {
6998          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
6999          GroupsIterator = pGroups->begin();          size_t i = 0;
7000          for (uint i = 0; GroupsIterator != pGroups->end(); ++GroupsIterator, ++i)          for (Group* pGroup = GetGroup(i); pGroup; pGroup = GetGroup(++i))
7001              if ((*GroupsIterator)->Name == name) return *GroupsIterator;              if (pGroup->Name == name) return pGroup;
7002          return NULL;          return NULL;
7003      }      }
7004    
# Line 6105  namespace { Line 7022  namespace {
7022       */       */
7023      void File::DeleteGroup(Group* pGroup) {      void File::DeleteGroup(Group* pGroup) {
7024          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
7025          std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);          std::vector<Group*>::iterator iter =
7026                find(pGroups->begin(), pGroups->end(), pGroup);
7027          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");
7028          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!");
7029          // delete all members of this group          // delete all members of this group
7030          for (Sample* pSample = pGroup->GetFirstSample(); pSample; pSample = pGroup->GetNextSample()) {          Sample* pSample;
7031            while ((pSample = pGroup->GetSample(0))) {
7032              DeleteSample(pSample);              DeleteSample(pSample);
7033          }          }
7034          // now delete this group object          // now delete this group object
7035          pGroups->erase(iter);          pGroups->erase(iter);
7036            pGroup->DeleteChunks();
7037          delete pGroup;          delete pGroup;
7038      }      }
7039    
# Line 6129  namespace { Line 7049  namespace {
7049       */       */
7050      void File::DeleteGroupOnly(Group* pGroup) {      void File::DeleteGroupOnly(Group* pGroup) {
7051          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
7052          std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);          std::vector<Group*>::iterator iter =
7053                find(pGroups->begin(), pGroups->end(), pGroup);
7054          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");
7055          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!");
7056          // move all members of this group to another group          // move all members of this group to another group
7057          pGroup->MoveAll();          pGroup->MoveAll();
7058          pGroups->erase(iter);          pGroups->erase(iter);
7059            pGroup->DeleteChunks();
7060          delete pGroup;          delete pGroup;
7061      }      }
7062    
7063      void File::LoadGroups() {      void File::LoadGroups() {
7064          if (!pGroups) pGroups = new std::list<Group*>;          if (!pGroups) pGroups = new std::vector<Group*>;
7065          // try to read defined groups from file          // try to read defined groups from file
7066          RIFF::List* lst3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);          RIFF::List* lst3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
7067          if (lst3gri) {          if (lst3gri) {
7068              RIFF::List* lst3gnl = lst3gri->GetSubList(LIST_TYPE_3GNL);              RIFF::List* lst3gnl = lst3gri->GetSubList(LIST_TYPE_3GNL);
7069              if (lst3gnl) {              if (lst3gnl) {
7070                  RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();                  size_t i = 0;
7071                  while (ck) {                  for (RIFF::Chunk* ck = lst3gnl->GetSubChunkAt(i); ck;
7072                         ck = lst3gnl->GetSubChunkAt(++i))
7073                    {
7074                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {                      if (ck->GetChunkID() == CHUNK_ID_3GNM) {
7075                          if (pVersion && pVersion->major == 3 &&                          if (pVersion && pVersion->major > 2 &&
7076                              strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;                              strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;
7077    
7078                          pGroups->push_back(new Group(this, ck));                          pGroups->push_back(new Group(this, ck));
7079                      }                      }
                     ck = lst3gnl->GetNextSubChunk();  
7080                  }                  }
7081              }              }
7082          }          }
# Line 6234  namespace { Line 7157  namespace {
7157              pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));              pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));
7158          if (pScriptGroup->pList)          if (pScriptGroup->pList)
7159              pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);              pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);
7160            pScriptGroup->DeleteChunks();
7161          delete pScriptGroup;          delete pScriptGroup;
7162      }      }
7163    
# Line 6242  namespace { Line 7166  namespace {
7166          pScriptGroups = new std::list<ScriptGroup*>;          pScriptGroups = new std::list<ScriptGroup*>;
7167          RIFF::List* lstLS = pRIFF->GetSubList(LIST_TYPE_3LS);          RIFF::List* lstLS = pRIFF->GetSubList(LIST_TYPE_3LS);
7168          if (lstLS) {          if (lstLS) {
7169              for (RIFF::List* lst = lstLS->GetFirstSubList(); lst;              size_t i = 0;
7170                   lst = lstLS->GetNextSubList())              for (RIFF::List* lst = lstLS->GetSubListAt(i); lst;
7171                     lst = lstLS->GetSubListAt(++i))
7172              {              {
7173                  if (lst->GetListType() == LIST_TYPE_RTIS) {                  if (lst->GetListType() == LIST_TYPE_RTIS) {
7174                      pScriptGroups->push_back(new ScriptGroup(this, lst));                      pScriptGroups->push_back(new ScriptGroup(this, lst));
# Line 6304  namespace { Line 7229  namespace {
7229              // INFO was added by Resource::UpdateChunks - make sure it              // INFO was added by Resource::UpdateChunks - make sure it
7230              // is placed first in file              // is placed first in file
7231              RIFF::Chunk* info = pRIFF->GetSubList(LIST_TYPE_INFO);              RIFF::Chunk* info = pRIFF->GetSubList(LIST_TYPE_INFO);
7232              RIFF::Chunk* first = pRIFF->GetFirstSubChunk();              RIFF::Chunk* first = pRIFF->GetSubChunkAt(0);
7233              if (first != info) {              if (first != info) {
7234                  pRIFF->MoveSubChunk(info, first);                  pRIFF->MoveSubChunk(info, first);
7235              }              }
# Line 6324  namespace { Line 7249  namespace {
7249    
7250              // v3: make sure the file has 128 3gnm chunks              // v3: make sure the file has 128 3gnm chunks
7251              // (before updating the Group chunks)              // (before updating the Group chunks)
7252              if (pVersion && pVersion->major == 3) {              if (pVersion && pVersion->major > 2) {
7253                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();                  size_t i = 0;
7254                  for (int i = 0 ; i < 128 ; i++) {                  for (RIFF::Chunk* _3gnm = _3gnl->GetSubChunkAt(i); i < 128;
7255                      if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);                       _3gnm = _3gnl->GetSubChunkAt(++i))
7256                      if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();                  {
7257                        // create 128 empty placeholder strings which will either
7258                        // be filled by Group::UpdateChunks below or left empty.
7259                        ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
7260                  }                  }
7261              }              }
7262    
7263              std::list<Group*>::iterator iter = pGroups->begin();              std::vector<Group*>::iterator iter = pGroups->begin();
7264              std::list<Group*>::iterator end  = pGroups->end();              std::vector<Group*>::iterator end  = pGroups->end();
7265              for (; iter != end; ++iter) {              for (; iter != end; ++iter) {
7266                  (*iter)->UpdateChunks(pProgress);                  (*iter)->UpdateChunks(pProgress);
7267              }              }
# Line 6371  namespace { Line 7299  namespace {
7299              uint8_t* pData = (uint8_t*) einf->LoadChunkData();              uint8_t* pData = (uint8_t*) einf->LoadChunkData();
7300    
7301              std::map<gig::Sample*,int> sampleMap;              std::map<gig::Sample*,int> sampleMap;
7302              int sampleIdx = 0;              size_t sampleIdx = 0;
7303              for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {              for (Sample* pSample = GetSample(0); pSample;
7304                  sampleMap[pSample] = sampleIdx++;                           pSample = GetSample(++sampleIdx))
7305                {
7306                    sampleMap[pSample] = sampleIdx;
7307              }              }
7308    
7309              int totnbusedsamples = 0;              int totnbusedsamples = 0;
# Line 6394  namespace { Line 7324  namespace {
7324    
7325                  memset(&pData[(instrumentIdx + 1) * sublen + 48], 0, sublen - 48);                  memset(&pData[(instrumentIdx + 1) * sublen + 48], 0, sublen - 48);
7326    
7327                  for (Region* region = instrument->GetFirstRegion() ; region ;                  size_t iRgn = 0;
7328                       region = instrument->GetNextRegion()) {                  for (Region* region = instrument->GetRegionAt(iRgn); region;
7329                         region = instrument->GetRegionAt(++iRgn))
7330                    {
7331                      for (int i = 0 ; i < region->DimensionRegions ; i++) {                      for (int i = 0 ; i < region->DimensionRegions ; i++) {
7332                          gig::DimensionRegion *d = region->pDimensionRegions[i];                          gig::DimensionRegion *d = region->pDimensionRegions[i];
7333                          if (d->pSample) {                          if (d->pSample) {
# Line 6470  namespace { Line 7402  namespace {
7402          } else /*if (newFile)*/ {          } else /*if (newFile)*/ {
7403              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);              _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
7404              // the order of einf and 3crc is not the same in v2 and v3              // the order of einf and 3crc is not the same in v2 and v3
7405              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);              if (einf && pVersion && pVersion->major > 2) pRIFF->MoveSubChunk(_3crc, einf);
7406          }          }
7407          { // must be performed in RAM here ...          { // must be performed in RAM here ...
7408              uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();              uint32_t* pData = (uint32_t*) _3crc->LoadChunkData();
# Line 6497  namespace { Line 7429  namespace {
7429      }      }
7430    
7431      /**      /**
7432       * Enable / disable automatic loading. By default this properyt is       * Enable / disable automatic loading. By default this property is
7433       * enabled and all informations are loaded automatically. However       * enabled and every information is loaded automatically. However
7434       * loading all Regions, DimensionRegions and especially samples might       * loading all Regions, DimensionRegions and especially samples might
7435       * take a long time for large .gig files, and sometimes one might only       * take a long time for large .gig files, and sometimes one might only
7436       * be interested in retrieving very superficial informations like the       * be interested in retrieving very superficial informations like the
# Line 6506  namespace { Line 7438  namespace {
7438       * automatic loading to avoid very slow response times.       * automatic loading to avoid very slow response times.
7439       *       *
7440       * @e CAUTION: by disabling this property many pointers (i.e. sample       * @e CAUTION: by disabling this property many pointers (i.e. sample
7441       * references) and informations will have invalid or even undefined       * references) and attributes will have invalid or even undefined
7442       * data! This feature is currently only intended for retrieving very       * data! This feature is currently only intended for retrieving very
7443       * 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
7444       * details like synthesis informations or even to modify .gig files!       * details like synthesis information or even to modify .gig files!
7445       */       */
7446      void File::SetAutoLoad(bool b) {      void File::SetAutoLoad(bool b) {
7447          bAutoLoad = b;          bAutoLoad = b;
# Line 6523  namespace { Line 7455  namespace {
7455          return bAutoLoad;          return bAutoLoad;
7456      }      }
7457    
7458        /**
7459         * Returns @c true in case this gig File object uses any gig format
7460         * extension, that is e.g. whether any DimensionRegion object currently
7461         * has any setting effective that would require our "LSDE" RIFF chunk to
7462         * be stored to the gig file.
7463         *
7464         * Right now this is a private method. It is considerable though this method
7465         * to become (in slightly modified form) a public API method in future, i.e.
7466         * to allow instrument editors to visualize and/or warn the user of any gig
7467         * format extension being used. See also comments on
7468         * DimensionRegion::UsesAnyGigFormatExtension() for details about such a
7469         * potential public API change in future.
7470         */
7471        bool File::UsesAnyGigFormatExtension() const {
7472            if (!pInstruments) return false;
7473            InstrumentList::iterator iter = pInstruments->begin();
7474            InstrumentList::iterator end  = pInstruments->end();
7475            for (; iter != end; ++iter) {
7476                Instrument* pInstrument = static_cast<gig::Instrument*>(*iter);
7477                if (pInstrument->UsesAnyGigFormatExtension())
7478                    return true;
7479            }
7480            return false;
7481        }
7482    
7483    
7484  // *************** Exception ***************  // *************** Exception ***************

Legend:
Removed from v.3323  
changed lines
  Added in v.3941

  ViewVC Help
Powered by ViewVC