/[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 1335 by schoenebeck, Sun Sep 9 21:22:58 2007 UTC revision 2601 by schoenebeck, Sat Jun 7 15:19:58 2014 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file access library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2007 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2014 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 25  Line 25 
25    
26  #include "helper.h"  #include "helper.h"
27    
28    #include <algorithm>
29  #include <math.h>  #include <math.h>
30  #include <iostream>  #include <iostream>
31    #include <assert.h>
32    
33  /// Initial size of the sample buffer which is used for decompression of  /// Initial size of the sample buffer which is used for decompression of
34  /// compressed sample wave streams - this value should always be bigger than  /// compressed sample wave streams - this value should always be bigger than
# Line 255  namespace { Line 257  namespace {
257    
258    
259    
260    // *************** Internal CRC-32 (Cyclic Redundancy Check) functions  ***************
261    // *
262    
263        static uint32_t* __initCRCTable() {
264            static uint32_t res[256];
265    
266            for (int i = 0 ; i < 256 ; i++) {
267                uint32_t c = i;
268                for (int j = 0 ; j < 8 ; j++) {
269                    c = (c & 1) ? 0xedb88320 ^ (c >> 1) : c >> 1;
270                }
271                res[i] = c;
272            }
273            return res;
274        }
275    
276        static const uint32_t* __CRCTable = __initCRCTable();
277    
278        /**
279         * Initialize a CRC variable.
280         *
281         * @param crc - variable to be initialized
282         */
283        inline static void __resetCRC(uint32_t& crc) {
284            crc = 0xffffffff;
285        }
286    
287        /**
288         * Used to calculate checksums of the sample data in a gig file. The
289         * checksums are stored in the 3crc chunk of the gig file and
290         * automatically updated when a sample is written with Sample::Write().
291         *
292         * One should call __resetCRC() to initialize the CRC variable to be
293         * used before calling this function the first time.
294         *
295         * After initializing the CRC variable one can call this function
296         * arbitrary times, i.e. to split the overall CRC calculation into
297         * steps.
298         *
299         * Once the whole data was processed by __calculateCRC(), one should
300         * call __encodeCRC() to get the final CRC result.
301         *
302         * @param buf     - pointer to data the CRC shall be calculated of
303         * @param bufSize - size of the data to be processed
304         * @param crc     - variable the CRC sum shall be stored to
305         */
306        static void __calculateCRC(unsigned char* buf, int bufSize, uint32_t& crc) {
307            for (int i = 0 ; i < bufSize ; i++) {
308                crc = __CRCTable[(crc ^ buf[i]) & 0xff] ^ (crc >> 8);
309            }
310        }
311    
312        /**
313         * Returns the final CRC result.
314         *
315         * @param crc - variable previously passed to __calculateCRC()
316         */
317        inline static uint32_t __encodeCRC(const uint32_t& crc) {
318            return crc ^ 0xffffffff;
319        }
320    
321    
322    
323  // *************** Other Internal functions  ***************  // *************** Other Internal functions  ***************
324  // *  // *
325    
# Line 278  namespace { Line 343  namespace {
343    
344    
345    
 // *************** CRC ***************  
 // *  
   
     const uint32_t* CRC::table(initTable());  
   
     uint32_t* CRC::initTable() {  
         uint32_t* res = new uint32_t[256];  
   
         for (int i = 0 ; i < 256 ; i++) {  
             uint32_t c = i;  
             for (int j = 0 ; j < 8 ; j++) {  
                 c = (c & 1) ? 0xedb88320 ^ (c >> 1) : c >> 1;  
             }  
             res[i] = c;  
         }  
         return res;  
     }  
   
   
   
346  // *************** Sample ***************  // *************** Sample ***************
347  // *  // *
348    
# Line 323  namespace { Line 368  namespace {
368       *                         is located, 0 otherwise       *                         is located, 0 otherwise
369       */       */
370      Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {      Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {
371          static const DLS::Info::FixedStringLength fixedStringLengths[] = {          static const DLS::Info::string_length_t fixedStringLengths[] = {
372              { CHUNK_ID_INAM, 64 },              { CHUNK_ID_INAM, 64 },
373              { 0, 0 }              { 0, 0 }
374          };          };
375          pInfo->FixedStringLengths = fixedStringLengths;          pInfo->SetFixedStringLengths(fixedStringLengths);
376          Instances++;          Instances++;
377          FileNo = fileNo;          FileNo = fileNo;
378    
379            __resetCRC(crc);
380    
381          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
382          if (pCk3gix) {          if (pCk3gix) {
383              uint16_t iSampleGroup = pCk3gix->ReadInt16();              uint16_t iSampleGroup = pCk3gix->ReadInt16();
# Line 408  namespace { Line 455  namespace {
455      }      }
456    
457      /**      /**
458         * Make a (semi) deep copy of the Sample object given by @a orig (without
459         * the actual waveform data) and assign it to this object.
460         *
461         * Discussion: copying .gig samples is a bit tricky. It requires three
462         * steps:
463         * 1. Copy sample's meta informations (done by CopyAssignMeta()) including
464         *    its new sample waveform data size.
465         * 2. Saving the file (done by File::Save()) so that it gains correct size
466         *    and layout for writing the actual wave form data directly to disc
467         *    in next step.
468         * 3. Copy the waveform data with disk streaming (done by CopyAssignWave()).
469         *
470         * @param orig - original Sample object to be copied from
471         */
472        void Sample::CopyAssignMeta(const Sample* orig) {
473            // handle base classes
474            DLS::Sample::CopyAssignCore(orig);
475            
476            // handle actual own attributes of this class
477            Manufacturer = orig->Manufacturer;
478            Product = orig->Product;
479            SamplePeriod = orig->SamplePeriod;
480            MIDIUnityNote = orig->MIDIUnityNote;
481            FineTune = orig->FineTune;
482            SMPTEFormat = orig->SMPTEFormat;
483            SMPTEOffset = orig->SMPTEOffset;
484            Loops = orig->Loops;
485            LoopID = orig->LoopID;
486            LoopType = orig->LoopType;
487            LoopStart = orig->LoopStart;
488            LoopEnd = orig->LoopEnd;
489            LoopSize = orig->LoopSize;
490            LoopFraction = orig->LoopFraction;
491            LoopPlayCount = orig->LoopPlayCount;
492            
493            // schedule resizing this sample to the given sample's size
494            Resize(orig->GetSize());
495        }
496    
497        /**
498         * Should be called after CopyAssignMeta() and File::Save() sequence.
499         * Read more about it in the discussion of CopyAssignMeta(). This method
500         * copies the actual waveform data by disk streaming.
501         *
502         * @e CAUTION: this method is currently not thread safe! During this
503         * operation the sample must not be used for other purposes by other
504         * threads!
505         *
506         * @param orig - original Sample object to be copied from
507         */
508        void Sample::CopyAssignWave(const Sample* orig) {
509            const int iReadAtOnce = 32*1024;
510            char* buf = new char[iReadAtOnce * orig->FrameSize];
511            Sample* pOrig = (Sample*) orig; //HACK: remove constness for now
512            unsigned long restorePos = pOrig->GetPos();
513            pOrig->SetPos(0);
514            SetPos(0);
515            for (unsigned long n = pOrig->Read(buf, iReadAtOnce); n;
516                               n = pOrig->Read(buf, iReadAtOnce))
517            {
518                Write(buf, n);
519            }
520            pOrig->SetPos(restorePos);
521            delete [] buf;
522        }
523    
524        /**
525       * Apply sample and its settings to the respective RIFF chunks. You have       * Apply sample and its settings to the respective RIFF chunks. You have
526       * to call File::Save() to make changes persistent.       * to call File::Save() to make changes persistent.
527       *       *
# Line 468  namespace { Line 582  namespace {
582          // update '3gix' chunk          // update '3gix' chunk
583          pData = (uint8_t*) pCk3gix->LoadChunkData();          pData = (uint8_t*) pCk3gix->LoadChunkData();
584          store16(&pData[0], iSampleGroup);          store16(&pData[0], iSampleGroup);
585    
586            // if the library user toggled the "Compressed" attribute from true to
587            // false, then the EWAV chunk associated with compressed samples needs
588            // to be deleted
589            RIFF::Chunk* ewav = pWaveList->GetSubChunk(CHUNK_ID_EWAV);
590            if (ewav && !Compressed) {
591                pWaveList->DeleteSubChunk(ewav);
592            }
593      }      }
594    
595      /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).      /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).
# Line 631  namespace { Line 753  namespace {
753          if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;          if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;
754          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
755          unsigned long allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;          unsigned long allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;
756            SetPos(0); // reset read position to begin of sample
757          RAMCache.pStart            = new int8_t[allocationsize];          RAMCache.pStart            = new int8_t[allocationsize];
758          RAMCache.Size              = Read(RAMCache.pStart, SampleCount) * this->FrameSize;          RAMCache.Size              = Read(RAMCache.pStart, SampleCount) * this->FrameSize;
759          RAMCache.NullExtensionSize = allocationsize - RAMCache.Size;          RAMCache.NullExtensionSize = allocationsize - RAMCache.Size;
# Line 668  namespace { Line 791  namespace {
791          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
792          RAMCache.pStart = NULL;          RAMCache.pStart = NULL;
793          RAMCache.Size   = 0;          RAMCache.Size   = 0;
794            RAMCache.NullExtensionSize = 0;
795      }      }
796    
797      /** @brief Resize sample.      /** @brief Resize sample.
# Line 760  namespace { Line 884  namespace {
884      /**      /**
885       * Returns the current position in the sample (in sample points).       * Returns the current position in the sample (in sample points).
886       */       */
887      unsigned long Sample::GetPos() {      unsigned long Sample::GetPos() const {
888          if (Compressed) return SamplePos;          if (Compressed) return SamplePos;
889          else            return pCkData->GetPos() / FrameSize;          else            return pCkData->GetPos() / FrameSize;
890      }      }
# Line 862  namespace { Line 986  namespace {
986                                  }                                  }
987    
988                                  // reverse the sample frames for backward playback                                  // reverse the sample frames for backward playback
989                                  SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);                                  if (totalreadsamples > swapareastart) //FIXME: this if() is just a crash workaround for now (#102), but totalreadsamples <= swapareastart should never be the case, so there's probably still a bug above!
990                                        SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
991                              }                              }
992                          } while (samplestoread && readsamples);                          } while (samplestoread && readsamples);
993                          break;                          break;
# Line 1168  namespace { Line 1293  namespace {
1293          // if this is the first write in this sample, reset the          // if this is the first write in this sample, reset the
1294          // checksum calculator          // checksum calculator
1295          if (pCkData->GetPos() == 0) {          if (pCkData->GetPos() == 0) {
1296              crc.reset();              __resetCRC(crc);
1297          }          }
1298          if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");          if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");
1299          unsigned long res;          unsigned long res;
# Line 1178  namespace { Line 1303  namespace {
1303              res = Channels == 2 ? pCkData->Write(pBuffer, SampleCount << 1, 2) >> 1              res = Channels == 2 ? pCkData->Write(pBuffer, SampleCount << 1, 2) >> 1
1304                                  : pCkData->Write(pBuffer, SampleCount, 2);                                  : pCkData->Write(pBuffer, SampleCount, 2);
1305          }          }
1306          crc.update((unsigned char *)pBuffer, SampleCount * FrameSize);          __calculateCRC((unsigned char *)pBuffer, SampleCount * FrameSize, crc);
1307    
1308          // if this is the last write, update the checksum chunk in the          // if this is the last write, update the checksum chunk in the
1309          // file          // file
1310          if (pCkData->GetPos() == pCkData->GetSize()) {          if (pCkData->GetPos() == pCkData->GetSize()) {
1311              File* pFile = static_cast<File*>(GetParent());              File* pFile = static_cast<File*>(GetParent());
1312              pFile->SetSampleChecksum(this, crc.getValue());              pFile->SetSampleChecksum(this, __encodeCRC(crc));
1313          }          }
1314          return res;          return res;
1315      }      }
# Line 1384  namespace { Line 1509  namespace {
1509                                                          : vcf_res_ctrl_none;                                                          : vcf_res_ctrl_none;
1510              uint16_t eg3depth = _3ewa->ReadUint16();              uint16_t eg3depth = _3ewa->ReadUint16();
1511              EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */              EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */
1512                                          : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */                                          : (-1) * (int16_t) ((eg3depth ^ 0xfff) + 1); /* binary complementary for negatives */
1513              _3ewa->ReadInt16(); // unknown              _3ewa->ReadInt16(); // unknown
1514              ChannelOffset = _3ewa->ReadUint8() / 4;              ChannelOffset = _3ewa->ReadUint8() / 4;
1515              uint8_t regoptions = _3ewa->ReadUint8();              uint8_t regoptions = _3ewa->ReadUint8();
# Line 1512  namespace { Line 1637  namespace {
1637                                                       VelocityResponseDepth,                                                       VelocityResponseDepth,
1638                                                       VelocityResponseCurveScaling);                                                       VelocityResponseCurveScaling);
1639    
1640          curve_type_t curveType = ReleaseVelocityResponseCurve;          pVelocityReleaseTable = GetReleaseVelocityTable(
1641          uint8_t depth = ReleaseVelocityResponseDepth;                                      ReleaseVelocityResponseCurve,
1642                                        ReleaseVelocityResponseDepth
1643          // this models a strange behaviour or bug in GSt: two of the                                  );
1644          // velocity response curves for release time are not used even  
1645          // if specified, instead another curve is chosen.          pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve,
1646          if ((curveType == curve_type_nonlinear && depth == 0) ||                                                        VCFVelocityDynamicRange,
1647              (curveType == curve_type_special   && depth == 4)) {                                                        VCFVelocityScale,
1648              curveType = curve_type_nonlinear;                                                        VCFCutoffController);
             depth = 3;  
         }  
         pVelocityReleaseTable = GetVelocityTable(curveType, depth, 0);  
   
         curveType = VCFVelocityCurve;  
         depth = VCFVelocityDynamicRange;  
   
         // even stranger GSt: two of the velocity response curves for  
         // filter cutoff are not used, instead another special curve  
         // is chosen. This curve is not used anywhere else.  
         if ((curveType == curve_type_nonlinear && depth == 0) ||  
             (curveType == curve_type_special   && depth == 4)) {  
             curveType = curve_type_special;  
             depth = 5;  
         }  
         pVelocityCutoffTable = GetVelocityTable(curveType, depth,  
                                                 VCFCutoffController <= vcf_cutoff_ctrl_none2 ? VCFVelocityScale : 0);  
1649    
1650          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1651          VelocityTable = 0;          VelocityTable = 0;
# Line 1549  namespace { Line 1657  namespace {
1657       */       */
1658      DimensionRegion::DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src) : DLS::Sampler(_3ewl) {
1659          Instances++;          Instances++;
1660            //NOTE: I think we cannot call CopyAssign() here (in a constructor) as long as its a virtual method
1661          *this = src; // default memberwise shallow copy of all parameters          *this = src; // default memberwise shallow copy of all parameters
1662          pParentList = _3ewl; // restore the chunk pointer          pParentList = _3ewl; // restore the chunk pointer
1663    
# Line 1564  namespace { Line 1673  namespace {
1673                  pSampleLoops[k] = src.pSampleLoops[k];                  pSampleLoops[k] = src.pSampleLoops[k];
1674          }          }
1675      }      }
1676        
1677        /**
1678         * Make a (semi) deep copy of the DimensionRegion object given by @a orig
1679         * and assign it to this object.
1680         *
1681         * Note that all sample pointers referenced by @a orig are simply copied as
1682         * memory address. Thus the respective samples are shared, not duplicated!
1683         *
1684         * @param orig - original DimensionRegion object to be copied from
1685         */
1686        void DimensionRegion::CopyAssign(const DimensionRegion* orig) {
1687            CopyAssign(orig, NULL);
1688        }
1689    
1690        /**
1691         * Make a (semi) deep copy of the DimensionRegion object given by @a orig
1692         * and assign it to this object.
1693         *
1694         * @param orig - original DimensionRegion object to be copied from
1695         * @param mSamples - crosslink map between the foreign file's samples and
1696         *                   this file's samples
1697         */
1698        void DimensionRegion::CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples) {
1699            // delete all allocated data first
1700            if (VelocityTable) delete [] VelocityTable;
1701            if (pSampleLoops) delete [] pSampleLoops;
1702            
1703            // backup parent list pointer
1704            RIFF::List* p = pParentList;
1705            
1706            gig::Sample* pOriginalSample = pSample;
1707            gig::Region* pOriginalRegion = pRegion;
1708            
1709            //NOTE: copy code copied from assignment constructor above, see comment there as well
1710            
1711            *this = *orig; // default memberwise shallow copy of all parameters
1712            
1713            // restore members that shall not be altered
1714            pParentList = p; // restore the chunk pointer
1715            pRegion = pOriginalRegion;
1716            
1717            // only take the raw sample reference reference if the
1718            // two DimensionRegion objects are part of the same file
1719            if (pOriginalRegion->GetParent()->GetParent() != orig->pRegion->GetParent()->GetParent()) {
1720                pSample = pOriginalSample;
1721            }
1722            
1723            if (mSamples && mSamples->count(orig->pSample)) {
1724                pSample = mSamples->find(orig->pSample)->second;
1725            }
1726    
1727            // deep copy of owned structures
1728            if (orig->VelocityTable) {
1729                VelocityTable = new uint8_t[128];
1730                for (int k = 0 ; k < 128 ; k++)
1731                    VelocityTable[k] = orig->VelocityTable[k];
1732            }
1733            if (orig->pSampleLoops) {
1734                pSampleLoops = new DLS::sample_loop_t[orig->SampleLoops];
1735                for (int k = 0 ; k < orig->SampleLoops ; k++)
1736                    pSampleLoops[k] = orig->pSampleLoops[k];
1737            }
1738        }
1739    
1740        /**
1741         * Updates the respective member variable and updates @c SampleAttenuation
1742         * which depends on this value.
1743         */
1744        void DimensionRegion::SetGain(int32_t gain) {
1745            DLS::Sampler::SetGain(gain);
1746            SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1747        }
1748    
1749      /**      /**
1750       * Apply dimension region settings to the respective RIFF chunks. You       * Apply dimension region settings to the respective RIFF chunks. You
# Line 1796  namespace { Line 1977  namespace {
1977          }          }
1978    
1979          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
1980                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xfff); /* binary complementary for negatives */
1981          pData[116] = eg3depth;          store16(&pData[116], eg3depth);
1982    
1983          // next 2 bytes unknown          // next 2 bytes unknown
1984    
# Line 1844  namespace { Line 2025  namespace {
2025                                        (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */                                        (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */
2026          pData[137] = vcfbreakpoint;          pData[137] = vcfbreakpoint;
2027    
2028          const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |          const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 +
2029                                      VCFVelocityCurve * 5;                                      VCFVelocityCurve * 5;
2030          pData[138] = vcfvelocity;          pData[138] = vcfvelocity;
2031    
# Line 1856  namespace { Line 2037  namespace {
2037          }          }
2038      }      }
2039    
2040        double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {
2041            curve_type_t curveType = releaseVelocityResponseCurve;
2042            uint8_t depth = releaseVelocityResponseDepth;
2043            // this models a strange behaviour or bug in GSt: two of the
2044            // velocity response curves for release time are not used even
2045            // if specified, instead another curve is chosen.
2046            if ((curveType == curve_type_nonlinear && depth == 0) ||
2047                (curveType == curve_type_special   && depth == 4)) {
2048                curveType = curve_type_nonlinear;
2049                depth = 3;
2050            }
2051            return GetVelocityTable(curveType, depth, 0);
2052        }
2053    
2054        double* DimensionRegion::GetCutoffVelocityTable(curve_type_t vcfVelocityCurve,
2055                                                        uint8_t vcfVelocityDynamicRange,
2056                                                        uint8_t vcfVelocityScale,
2057                                                        vcf_cutoff_ctrl_t vcfCutoffController)
2058        {
2059            curve_type_t curveType = vcfVelocityCurve;
2060            uint8_t depth = vcfVelocityDynamicRange;
2061            // even stranger GSt: two of the velocity response curves for
2062            // filter cutoff are not used, instead another special curve
2063            // is chosen. This curve is not used anywhere else.
2064            if ((curveType == curve_type_nonlinear && depth == 0) ||
2065                (curveType == curve_type_special   && depth == 4)) {
2066                curveType = curve_type_special;
2067                depth = 5;
2068            }
2069            return GetVelocityTable(curveType, depth,
2070                                    (vcfCutoffController <= vcf_cutoff_ctrl_none2)
2071                                        ? vcfVelocityScale : 0);
2072        }
2073    
2074      // 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
2075      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)
2076      {      {
# Line 1875  namespace { Line 2090  namespace {
2090          return pRegion;          return pRegion;
2091      }      }
2092    
2093    // show error if some _lev_ctrl_* enum entry is not listed in the following function
2094    // (commented out for now, because "diagnostic push" not supported prior GCC 4.6)
2095    // TODO: uncomment and add a GCC version check (see also commented "#pragma GCC diagnostic pop" below)
2096    //#pragma GCC diagnostic push
2097    //#pragma GCC diagnostic error "-Wswitch"
2098    
2099      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {
2100          leverage_ctrl_t decodedcontroller;          leverage_ctrl_t decodedcontroller;
2101          switch (EncodedController) {          switch (EncodedController) {
# Line 1986  namespace { Line 2207  namespace {
2207                  decodedcontroller.controller_number = 95;                  decodedcontroller.controller_number = 95;
2208                  break;                  break;
2209    
2210                // format extension (these controllers are so far only supported by
2211                // LinuxSampler & gigedit) they will *NOT* work with
2212                // Gigasampler/GigaStudio !
2213                case _lev_ctrl_CC3_EXT:
2214                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2215                    decodedcontroller.controller_number = 3;
2216                    break;
2217                case _lev_ctrl_CC6_EXT:
2218                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2219                    decodedcontroller.controller_number = 6;
2220                    break;
2221                case _lev_ctrl_CC7_EXT:
2222                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2223                    decodedcontroller.controller_number = 7;
2224                    break;
2225                case _lev_ctrl_CC8_EXT:
2226                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2227                    decodedcontroller.controller_number = 8;
2228                    break;
2229                case _lev_ctrl_CC9_EXT:
2230                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2231                    decodedcontroller.controller_number = 9;
2232                    break;
2233                case _lev_ctrl_CC10_EXT:
2234                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2235                    decodedcontroller.controller_number = 10;
2236                    break;
2237                case _lev_ctrl_CC11_EXT:
2238                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2239                    decodedcontroller.controller_number = 11;
2240                    break;
2241                case _lev_ctrl_CC14_EXT:
2242                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2243                    decodedcontroller.controller_number = 14;
2244                    break;
2245                case _lev_ctrl_CC15_EXT:
2246                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2247                    decodedcontroller.controller_number = 15;
2248                    break;
2249                case _lev_ctrl_CC20_EXT:
2250                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2251                    decodedcontroller.controller_number = 20;
2252                    break;
2253                case _lev_ctrl_CC21_EXT:
2254                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2255                    decodedcontroller.controller_number = 21;
2256                    break;
2257                case _lev_ctrl_CC22_EXT:
2258                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2259                    decodedcontroller.controller_number = 22;
2260                    break;
2261                case _lev_ctrl_CC23_EXT:
2262                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2263                    decodedcontroller.controller_number = 23;
2264                    break;
2265                case _lev_ctrl_CC24_EXT:
2266                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2267                    decodedcontroller.controller_number = 24;
2268                    break;
2269                case _lev_ctrl_CC25_EXT:
2270                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2271                    decodedcontroller.controller_number = 25;
2272                    break;
2273                case _lev_ctrl_CC26_EXT:
2274                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2275                    decodedcontroller.controller_number = 26;
2276                    break;
2277                case _lev_ctrl_CC27_EXT:
2278                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2279                    decodedcontroller.controller_number = 27;
2280                    break;
2281                case _lev_ctrl_CC28_EXT:
2282                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2283                    decodedcontroller.controller_number = 28;
2284                    break;
2285                case _lev_ctrl_CC29_EXT:
2286                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2287                    decodedcontroller.controller_number = 29;
2288                    break;
2289                case _lev_ctrl_CC30_EXT:
2290                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2291                    decodedcontroller.controller_number = 30;
2292                    break;
2293                case _lev_ctrl_CC31_EXT:
2294                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2295                    decodedcontroller.controller_number = 31;
2296                    break;
2297                case _lev_ctrl_CC68_EXT:
2298                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2299                    decodedcontroller.controller_number = 68;
2300                    break;
2301                case _lev_ctrl_CC69_EXT:
2302                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2303                    decodedcontroller.controller_number = 69;
2304                    break;
2305                case _lev_ctrl_CC70_EXT:
2306                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2307                    decodedcontroller.controller_number = 70;
2308                    break;
2309                case _lev_ctrl_CC71_EXT:
2310                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2311                    decodedcontroller.controller_number = 71;
2312                    break;
2313                case _lev_ctrl_CC72_EXT:
2314                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2315                    decodedcontroller.controller_number = 72;
2316                    break;
2317                case _lev_ctrl_CC73_EXT:
2318                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2319                    decodedcontroller.controller_number = 73;
2320                    break;
2321                case _lev_ctrl_CC74_EXT:
2322                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2323                    decodedcontroller.controller_number = 74;
2324                    break;
2325                case _lev_ctrl_CC75_EXT:
2326                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2327                    decodedcontroller.controller_number = 75;
2328                    break;
2329                case _lev_ctrl_CC76_EXT:
2330                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2331                    decodedcontroller.controller_number = 76;
2332                    break;
2333                case _lev_ctrl_CC77_EXT:
2334                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2335                    decodedcontroller.controller_number = 77;
2336                    break;
2337                case _lev_ctrl_CC78_EXT:
2338                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2339                    decodedcontroller.controller_number = 78;
2340                    break;
2341                case _lev_ctrl_CC79_EXT:
2342                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2343                    decodedcontroller.controller_number = 79;
2344                    break;
2345                case _lev_ctrl_CC84_EXT:
2346                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2347                    decodedcontroller.controller_number = 84;
2348                    break;
2349                case _lev_ctrl_CC85_EXT:
2350                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2351                    decodedcontroller.controller_number = 85;
2352                    break;
2353                case _lev_ctrl_CC86_EXT:
2354                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2355                    decodedcontroller.controller_number = 86;
2356                    break;
2357                case _lev_ctrl_CC87_EXT:
2358                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2359                    decodedcontroller.controller_number = 87;
2360                    break;
2361                case _lev_ctrl_CC89_EXT:
2362                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2363                    decodedcontroller.controller_number = 89;
2364                    break;
2365                case _lev_ctrl_CC90_EXT:
2366                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2367                    decodedcontroller.controller_number = 90;
2368                    break;
2369                case _lev_ctrl_CC96_EXT:
2370                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2371                    decodedcontroller.controller_number = 96;
2372                    break;
2373                case _lev_ctrl_CC97_EXT:
2374                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2375                    decodedcontroller.controller_number = 97;
2376                    break;
2377                case _lev_ctrl_CC102_EXT:
2378                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2379                    decodedcontroller.controller_number = 102;
2380                    break;
2381                case _lev_ctrl_CC103_EXT:
2382                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2383                    decodedcontroller.controller_number = 103;
2384                    break;
2385                case _lev_ctrl_CC104_EXT:
2386                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2387                    decodedcontroller.controller_number = 104;
2388                    break;
2389                case _lev_ctrl_CC105_EXT:
2390                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2391                    decodedcontroller.controller_number = 105;
2392                    break;
2393                case _lev_ctrl_CC106_EXT:
2394                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2395                    decodedcontroller.controller_number = 106;
2396                    break;
2397                case _lev_ctrl_CC107_EXT:
2398                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2399                    decodedcontroller.controller_number = 107;
2400                    break;
2401                case _lev_ctrl_CC108_EXT:
2402                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2403                    decodedcontroller.controller_number = 108;
2404                    break;
2405                case _lev_ctrl_CC109_EXT:
2406                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2407                    decodedcontroller.controller_number = 109;
2408                    break;
2409                case _lev_ctrl_CC110_EXT:
2410                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2411                    decodedcontroller.controller_number = 110;
2412                    break;
2413                case _lev_ctrl_CC111_EXT:
2414                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2415                    decodedcontroller.controller_number = 111;
2416                    break;
2417                case _lev_ctrl_CC112_EXT:
2418                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2419                    decodedcontroller.controller_number = 112;
2420                    break;
2421                case _lev_ctrl_CC113_EXT:
2422                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2423                    decodedcontroller.controller_number = 113;
2424                    break;
2425                case _lev_ctrl_CC114_EXT:
2426                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2427                    decodedcontroller.controller_number = 114;
2428                    break;
2429                case _lev_ctrl_CC115_EXT:
2430                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2431                    decodedcontroller.controller_number = 115;
2432                    break;
2433                case _lev_ctrl_CC116_EXT:
2434                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2435                    decodedcontroller.controller_number = 116;
2436                    break;
2437                case _lev_ctrl_CC117_EXT:
2438                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2439                    decodedcontroller.controller_number = 117;
2440                    break;
2441                case _lev_ctrl_CC118_EXT:
2442                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2443                    decodedcontroller.controller_number = 118;
2444                    break;
2445                case _lev_ctrl_CC119_EXT:
2446                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2447                    decodedcontroller.controller_number = 119;
2448                    break;
2449    
2450              // unknown controller type              // unknown controller type
2451              default:              default:
2452                  throw gig::Exception("Unknown leverage controller type.");                  throw gig::Exception("Unknown leverage controller type.");
2453          }          }
2454          return decodedcontroller;          return decodedcontroller;
2455      }      }
2456        
2457    // see above (diagnostic push not supported prior GCC 4.6)
2458    //#pragma GCC diagnostic pop
2459    
2460      DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {      DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {
2461          _lev_ctrl_t encodedcontroller;          _lev_ctrl_t encodedcontroller;
# Line 2079  namespace { Line 2543  namespace {
2543                      case 95:                      case 95:
2544                          encodedcontroller = _lev_ctrl_effect5depth;                          encodedcontroller = _lev_ctrl_effect5depth;
2545                          break;                          break;
2546    
2547                        // format extension (these controllers are so far only
2548                        // supported by LinuxSampler & gigedit) they will *NOT*
2549                        // work with Gigasampler/GigaStudio !
2550                        case 3:
2551                            encodedcontroller = _lev_ctrl_CC3_EXT;
2552                            break;
2553                        case 6:
2554                            encodedcontroller = _lev_ctrl_CC6_EXT;
2555                            break;
2556                        case 7:
2557                            encodedcontroller = _lev_ctrl_CC7_EXT;
2558                            break;
2559                        case 8:
2560                            encodedcontroller = _lev_ctrl_CC8_EXT;
2561                            break;
2562                        case 9:
2563                            encodedcontroller = _lev_ctrl_CC9_EXT;
2564                            break;
2565                        case 10:
2566                            encodedcontroller = _lev_ctrl_CC10_EXT;
2567                            break;
2568                        case 11:
2569                            encodedcontroller = _lev_ctrl_CC11_EXT;
2570                            break;
2571                        case 14:
2572                            encodedcontroller = _lev_ctrl_CC14_EXT;
2573                            break;
2574                        case 15:
2575                            encodedcontroller = _lev_ctrl_CC15_EXT;
2576                            break;
2577                        case 20:
2578                            encodedcontroller = _lev_ctrl_CC20_EXT;
2579                            break;
2580                        case 21:
2581                            encodedcontroller = _lev_ctrl_CC21_EXT;
2582                            break;
2583                        case 22:
2584                            encodedcontroller = _lev_ctrl_CC22_EXT;
2585                            break;
2586                        case 23:
2587                            encodedcontroller = _lev_ctrl_CC23_EXT;
2588                            break;
2589                        case 24:
2590                            encodedcontroller = _lev_ctrl_CC24_EXT;
2591                            break;
2592                        case 25:
2593                            encodedcontroller = _lev_ctrl_CC25_EXT;
2594                            break;
2595                        case 26:
2596                            encodedcontroller = _lev_ctrl_CC26_EXT;
2597                            break;
2598                        case 27:
2599                            encodedcontroller = _lev_ctrl_CC27_EXT;
2600                            break;
2601                        case 28:
2602                            encodedcontroller = _lev_ctrl_CC28_EXT;
2603                            break;
2604                        case 29:
2605                            encodedcontroller = _lev_ctrl_CC29_EXT;
2606                            break;
2607                        case 30:
2608                            encodedcontroller = _lev_ctrl_CC30_EXT;
2609                            break;
2610                        case 31:
2611                            encodedcontroller = _lev_ctrl_CC31_EXT;
2612                            break;
2613                        case 68:
2614                            encodedcontroller = _lev_ctrl_CC68_EXT;
2615                            break;
2616                        case 69:
2617                            encodedcontroller = _lev_ctrl_CC69_EXT;
2618                            break;
2619                        case 70:
2620                            encodedcontroller = _lev_ctrl_CC70_EXT;
2621                            break;
2622                        case 71:
2623                            encodedcontroller = _lev_ctrl_CC71_EXT;
2624                            break;
2625                        case 72:
2626                            encodedcontroller = _lev_ctrl_CC72_EXT;
2627                            break;
2628                        case 73:
2629                            encodedcontroller = _lev_ctrl_CC73_EXT;
2630                            break;
2631                        case 74:
2632                            encodedcontroller = _lev_ctrl_CC74_EXT;
2633                            break;
2634                        case 75:
2635                            encodedcontroller = _lev_ctrl_CC75_EXT;
2636                            break;
2637                        case 76:
2638                            encodedcontroller = _lev_ctrl_CC76_EXT;
2639                            break;
2640                        case 77:
2641                            encodedcontroller = _lev_ctrl_CC77_EXT;
2642                            break;
2643                        case 78:
2644                            encodedcontroller = _lev_ctrl_CC78_EXT;
2645                            break;
2646                        case 79:
2647                            encodedcontroller = _lev_ctrl_CC79_EXT;
2648                            break;
2649                        case 84:
2650                            encodedcontroller = _lev_ctrl_CC84_EXT;
2651                            break;
2652                        case 85:
2653                            encodedcontroller = _lev_ctrl_CC85_EXT;
2654                            break;
2655                        case 86:
2656                            encodedcontroller = _lev_ctrl_CC86_EXT;
2657                            break;
2658                        case 87:
2659                            encodedcontroller = _lev_ctrl_CC87_EXT;
2660                            break;
2661                        case 89:
2662                            encodedcontroller = _lev_ctrl_CC89_EXT;
2663                            break;
2664                        case 90:
2665                            encodedcontroller = _lev_ctrl_CC90_EXT;
2666                            break;
2667                        case 96:
2668                            encodedcontroller = _lev_ctrl_CC96_EXT;
2669                            break;
2670                        case 97:
2671                            encodedcontroller = _lev_ctrl_CC97_EXT;
2672                            break;
2673                        case 102:
2674                            encodedcontroller = _lev_ctrl_CC102_EXT;
2675                            break;
2676                        case 103:
2677                            encodedcontroller = _lev_ctrl_CC103_EXT;
2678                            break;
2679                        case 104:
2680                            encodedcontroller = _lev_ctrl_CC104_EXT;
2681                            break;
2682                        case 105:
2683                            encodedcontroller = _lev_ctrl_CC105_EXT;
2684                            break;
2685                        case 106:
2686                            encodedcontroller = _lev_ctrl_CC106_EXT;
2687                            break;
2688                        case 107:
2689                            encodedcontroller = _lev_ctrl_CC107_EXT;
2690                            break;
2691                        case 108:
2692                            encodedcontroller = _lev_ctrl_CC108_EXT;
2693                            break;
2694                        case 109:
2695                            encodedcontroller = _lev_ctrl_CC109_EXT;
2696                            break;
2697                        case 110:
2698                            encodedcontroller = _lev_ctrl_CC110_EXT;
2699                            break;
2700                        case 111:
2701                            encodedcontroller = _lev_ctrl_CC111_EXT;
2702                            break;
2703                        case 112:
2704                            encodedcontroller = _lev_ctrl_CC112_EXT;
2705                            break;
2706                        case 113:
2707                            encodedcontroller = _lev_ctrl_CC113_EXT;
2708                            break;
2709                        case 114:
2710                            encodedcontroller = _lev_ctrl_CC114_EXT;
2711                            break;
2712                        case 115:
2713                            encodedcontroller = _lev_ctrl_CC115_EXT;
2714                            break;
2715                        case 116:
2716                            encodedcontroller = _lev_ctrl_CC116_EXT;
2717                            break;
2718                        case 117:
2719                            encodedcontroller = _lev_ctrl_CC117_EXT;
2720                            break;
2721                        case 118:
2722                            encodedcontroller = _lev_ctrl_CC118_EXT;
2723                            break;
2724                        case 119:
2725                            encodedcontroller = _lev_ctrl_CC119_EXT;
2726                            break;
2727    
2728                      default:                      default:
2729                          throw gig::Exception("leverage controller number is not supported by the gig format");                          throw gig::Exception("leverage controller number is not supported by the gig format");
2730                  }                  }
# Line 2128  namespace { Line 2774  namespace {
2774          return pVelocityCutoffTable[MIDIKeyVelocity];          return pVelocityCutoffTable[MIDIKeyVelocity];
2775      }      }
2776    
2777        /**
2778         * Updates the respective member variable and the lookup table / cache
2779         * that depends on this value.
2780         */
2781        void DimensionRegion::SetVelocityResponseCurve(curve_type_t curve) {
2782            pVelocityAttenuationTable =
2783                GetVelocityTable(
2784                    curve, VelocityResponseDepth, VelocityResponseCurveScaling
2785                );
2786            VelocityResponseCurve = curve;
2787        }
2788    
2789        /**
2790         * Updates the respective member variable and the lookup table / cache
2791         * that depends on this value.
2792         */
2793        void DimensionRegion::SetVelocityResponseDepth(uint8_t depth) {
2794            pVelocityAttenuationTable =
2795                GetVelocityTable(
2796                    VelocityResponseCurve, depth, VelocityResponseCurveScaling
2797                );
2798            VelocityResponseDepth = depth;
2799        }
2800    
2801        /**
2802         * Updates the respective member variable and the lookup table / cache
2803         * that depends on this value.
2804         */
2805        void DimensionRegion::SetVelocityResponseCurveScaling(uint8_t scaling) {
2806            pVelocityAttenuationTable =
2807                GetVelocityTable(
2808                    VelocityResponseCurve, VelocityResponseDepth, scaling
2809                );
2810            VelocityResponseCurveScaling = scaling;
2811        }
2812    
2813        /**
2814         * Updates the respective member variable and the lookup table / cache
2815         * that depends on this value.
2816         */
2817        void DimensionRegion::SetReleaseVelocityResponseCurve(curve_type_t curve) {
2818            pVelocityReleaseTable = GetReleaseVelocityTable(curve, ReleaseVelocityResponseDepth);
2819            ReleaseVelocityResponseCurve = curve;
2820        }
2821    
2822        /**
2823         * Updates the respective member variable and the lookup table / cache
2824         * that depends on this value.
2825         */
2826        void DimensionRegion::SetReleaseVelocityResponseDepth(uint8_t depth) {
2827            pVelocityReleaseTable = GetReleaseVelocityTable(ReleaseVelocityResponseCurve, depth);
2828            ReleaseVelocityResponseDepth = depth;
2829        }
2830    
2831        /**
2832         * Updates the respective member variable and the lookup table / cache
2833         * that depends on this value.
2834         */
2835        void DimensionRegion::SetVCFCutoffController(vcf_cutoff_ctrl_t controller) {
2836            pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, VCFVelocityDynamicRange, VCFVelocityScale, controller);
2837            VCFCutoffController = controller;
2838        }
2839    
2840        /**
2841         * Updates the respective member variable and the lookup table / cache
2842         * that depends on this value.
2843         */
2844        void DimensionRegion::SetVCFVelocityCurve(curve_type_t curve) {
2845            pVelocityCutoffTable = GetCutoffVelocityTable(curve, VCFVelocityDynamicRange, VCFVelocityScale, VCFCutoffController);
2846            VCFVelocityCurve = curve;
2847        }
2848    
2849        /**
2850         * Updates the respective member variable and the lookup table / cache
2851         * that depends on this value.
2852         */
2853        void DimensionRegion::SetVCFVelocityDynamicRange(uint8_t range) {
2854            pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, range, VCFVelocityScale, VCFCutoffController);
2855            VCFVelocityDynamicRange = range;
2856        }
2857    
2858        /**
2859         * Updates the respective member variable and the lookup table / cache
2860         * that depends on this value.
2861         */
2862        void DimensionRegion::SetVCFVelocityScale(uint8_t scaling) {
2863            pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, VCFVelocityDynamicRange, scaling, VCFCutoffController);
2864            VCFVelocityScale = scaling;
2865        }
2866    
2867      double* DimensionRegion::CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling) {      double* DimensionRegion::CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling) {
2868    
2869          // line-segment approximations of the 15 velocity curves          // line-segment approximations of the 15 velocity curves
# Line 2211  namespace { Line 2947  namespace {
2947    
2948          // Actual Loading          // Actual Loading
2949    
2950            if (!file->GetAutoLoad()) return;
2951    
2952          LoadDimensionRegions(rgnList);          LoadDimensionRegions(rgnList);
2953    
2954          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);
# Line 2254  namespace { Line 2992  namespace {
2992              else              else
2993                  _3lnk->SetPos(44);                  _3lnk->SetPos(44);
2994    
2995              // load sample references              // load sample references (if auto loading is enabled)
2996              for (uint i = 0; i < DimensionRegions; i++) {              if (file->GetAutoLoad()) {
2997                  uint32_t wavepoolindex = _3lnk->ReadUint32();                  for (uint i = 0; i < DimensionRegions; i++) {
2998                  if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);                      uint32_t wavepoolindex = _3lnk->ReadUint32();
2999                        if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
3000                    }
3001                    GetSample(); // load global region sample reference
3002              }              }
             GetSample(); // load global region sample reference  
3003          } else {          } else {
3004              DimensionRegions = 0;              DimensionRegions = 0;
3005              for (int i = 0 ; i < 8 ; i++) {              for (int i = 0 ; i < 8 ; i++) {
# Line 2316  namespace { Line 3056  namespace {
3056              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
3057    
3058              // move 3prg to last position              // move 3prg to last position
3059              pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), 0);              pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), (RIFF::Chunk*)NULL);
3060          }          }
3061    
3062          // update dimension definitions in '3lnk' chunk          // update dimension definitions in '3lnk' chunk
# Line 2462  namespace { Line 3202  namespace {
3202       *                        dimension bits limit is violated       *                        dimension bits limit is violated
3203       */       */
3204      void Region::AddDimension(dimension_def_t* pDimDef) {      void Region::AddDimension(dimension_def_t* pDimDef) {
3205            // some initial sanity checks of the given dimension definition
3206            if (pDimDef->zones < 2)
3207                throw gig::Exception("Could not add new dimension, amount of requested zones must always be at least two");
3208            if (pDimDef->bits < 1)
3209                throw gig::Exception("Could not add new dimension, amount of requested requested zone bits must always be at least one");
3210            if (pDimDef->dimension == dimension_samplechannel) {
3211                if (pDimDef->zones != 2)
3212                    throw gig::Exception("Could not add new 'sample channel' dimensions, the requested amount of zones must always be 2 for this dimension type");
3213                if (pDimDef->bits != 1)
3214                    throw gig::Exception("Could not add new 'sample channel' dimensions, the requested amount of zone bits must always be 1 for this dimension type");
3215            }
3216    
3217          // check if max. amount of dimensions reached          // check if max. amount of dimensions reached
3218          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
3219          const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;          const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
# Line 2637  namespace { Line 3389  namespace {
3389          if (pDimDef->dimension == dimension_layer) Layers = 1;          if (pDimDef->dimension == dimension_layer) Layers = 1;
3390      }      }
3391    
3392        /** @brief Delete one split zone of a dimension (decrement zone amount).
3393         *
3394         * Instead of deleting an entire dimensions, this method will only delete
3395         * one particular split zone given by @a zone of the Region's dimension
3396         * given by @a type. So this method will simply decrement the amount of
3397         * zones by one of the dimension in question. To be able to do that, the
3398         * respective dimension must exist on this Region and it must have at least
3399         * 3 zones. All DimensionRegion objects associated with the zone will be
3400         * deleted.
3401         *
3402         * @param type - identifies the dimension where a zone shall be deleted
3403         * @param zone - index of the dimension split zone that shall be deleted
3404         * @throws gig::Exception if requested zone could not be deleted
3405         */
3406        void Region::DeleteDimensionZone(dimension_t type, int zone) {
3407            dimension_def_t* oldDef = GetDimensionDefinition(type);
3408            if (!oldDef)
3409                throw gig::Exception("Could not delete dimension zone, no such dimension of given type");
3410            if (oldDef->zones <= 2)
3411                throw gig::Exception("Could not delete dimension zone, because it would end up with only one zone.");
3412            if (zone < 0 || zone >= oldDef->zones)
3413                throw gig::Exception("Could not delete dimension zone, requested zone index out of bounds.");
3414    
3415            const int newZoneSize = oldDef->zones - 1;
3416    
3417            // create a temporary Region which just acts as a temporary copy
3418            // container and will be deleted at the end of this function and will
3419            // also not be visible through the API during this process
3420            gig::Region* tempRgn = NULL;
3421            {
3422                // adding these temporary chunks is probably not even necessary
3423                Instrument* instr = static_cast<Instrument*>(GetParent());
3424                RIFF::List* pCkInstrument = instr->pCkInstrument;
3425                RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
3426                if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3427                RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3428                tempRgn = new Region(instr, rgn);
3429            }
3430    
3431            // copy this region's dimensions (with already the dimension split size
3432            // requested by the arguments of this method call) to the temporary
3433            // region, and don't use Region::CopyAssign() here for this task, since
3434            // it would also alter fast lookup helper variables here and there
3435            dimension_def_t newDef;
3436            for (int i = 0; i < Dimensions; ++i) {
3437                dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3438                // is this the dimension requested by the method arguments? ...
3439                if (def.dimension == type) { // ... if yes, decrement zone amount by one
3440                    def.zones = newZoneSize;
3441                    if ((1 << (def.bits - 1)) == def.zones) def.bits--;
3442                    newDef = def;
3443                }
3444                tempRgn->AddDimension(&def);
3445            }
3446    
3447            // find the dimension index in the tempRegion which is the dimension
3448            // type passed to this method (paranoidly expecting different order)
3449            int tempReducedDimensionIndex = -1;
3450            for (int d = 0; d < tempRgn->Dimensions; ++d) {
3451                if (tempRgn->pDimensionDefinitions[d].dimension == type) {
3452                    tempReducedDimensionIndex = d;
3453                    break;
3454                }
3455            }
3456    
3457            // copy dimension regions from this region to the temporary region
3458            for (int iDst = 0; iDst < 256; ++iDst) {
3459                DimensionRegion* dstDimRgn = tempRgn->pDimensionRegions[iDst];
3460                if (!dstDimRgn) continue;
3461                std::map<dimension_t,int> dimCase;
3462                bool isValidZone = true;
3463                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3464                    const int dstBits = tempRgn->pDimensionDefinitions[d].bits;
3465                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3466                        (iDst >> baseBits) & ((1 << dstBits) - 1);
3467                    baseBits += dstBits;
3468                    // there are also DimensionRegion objects of unused zones, skip them
3469                    if (dimCase[tempRgn->pDimensionDefinitions[d].dimension] >= tempRgn->pDimensionDefinitions[d].zones) {
3470                        isValidZone = false;
3471                        break;
3472                    }
3473                }
3474                if (!isValidZone) continue;
3475                // a bit paranoid: cope with the chance that the dimensions would
3476                // have different order in source and destination regions
3477                const bool isLastZone = (dimCase[type] == newZoneSize - 1);
3478                if (dimCase[type] >= zone) dimCase[type]++;
3479                DimensionRegion* srcDimRgn = GetDimensionRegionByBit(dimCase);
3480                dstDimRgn->CopyAssign(srcDimRgn);
3481                // if this is the upper most zone of the dimension passed to this
3482                // method, then correct (raise) its upper limit to 127
3483                if (newDef.split_type == split_type_normal && isLastZone)
3484                    dstDimRgn->DimensionUpperLimits[tempReducedDimensionIndex] = 127;
3485            }
3486    
3487            // now tempRegion's dimensions and DimensionRegions basically reflect
3488            // what we wanted to get for this actual Region here, so we now just
3489            // delete and recreate the dimension in question with the new amount
3490            // zones and then copy back from tempRegion      
3491            DeleteDimension(oldDef);
3492            AddDimension(&newDef);
3493            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3494                DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
3495                if (!srcDimRgn) continue;
3496                std::map<dimension_t,int> dimCase;
3497                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3498                    const int srcBits = tempRgn->pDimensionDefinitions[d].bits;
3499                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3500                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3501                    baseBits += srcBits;
3502                }
3503                // a bit paranoid: cope with the chance that the dimensions would
3504                // have different order in source and destination regions
3505                DimensionRegion* dstDimRgn = GetDimensionRegionByBit(dimCase);
3506                if (!dstDimRgn) continue;
3507                dstDimRgn->CopyAssign(srcDimRgn);
3508            }
3509    
3510            // delete temporary region
3511            delete tempRgn;
3512    
3513            UpdateVelocityTable();
3514        }
3515    
3516        /** @brief Divide split zone of a dimension in two (increment zone amount).
3517         *
3518         * This will increment the amount of zones for the dimension (given by
3519         * @a type) by one. It will do so by dividing the zone (given by @a zone)
3520         * in the middle of its zone range in two. So the two zones resulting from
3521         * the zone being splitted, will be an equivalent copy regarding all their
3522         * articulation informations and sample reference. The two zones will only
3523         * differ in their zone's upper limit
3524         * (DimensionRegion::DimensionUpperLimits).
3525         *
3526         * @param type - identifies the dimension where a zone shall be splitted
3527         * @param zone - index of the dimension split zone that shall be splitted
3528         * @throws gig::Exception if requested zone could not be splitted
3529         */
3530        void Region::SplitDimensionZone(dimension_t type, int zone) {
3531            dimension_def_t* oldDef = GetDimensionDefinition(type);
3532            if (!oldDef)
3533                throw gig::Exception("Could not split dimension zone, no such dimension of given type");
3534            if (zone < 0 || zone >= oldDef->zones)
3535                throw gig::Exception("Could not split dimension zone, requested zone index out of bounds.");
3536    
3537            const int newZoneSize = oldDef->zones + 1;
3538    
3539            // create a temporary Region which just acts as a temporary copy
3540            // container and will be deleted at the end of this function and will
3541            // also not be visible through the API during this process
3542            gig::Region* tempRgn = NULL;
3543            {
3544                // adding these temporary chunks is probably not even necessary
3545                Instrument* instr = static_cast<Instrument*>(GetParent());
3546                RIFF::List* pCkInstrument = instr->pCkInstrument;
3547                RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
3548                if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3549                RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3550                tempRgn = new Region(instr, rgn);
3551            }
3552    
3553            // copy this region's dimensions (with already the dimension split size
3554            // requested by the arguments of this method call) to the temporary
3555            // region, and don't use Region::CopyAssign() here for this task, since
3556            // it would also alter fast lookup helper variables here and there
3557            dimension_def_t newDef;
3558            for (int i = 0; i < Dimensions; ++i) {
3559                dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3560                // is this the dimension requested by the method arguments? ...
3561                if (def.dimension == type) { // ... if yes, increment zone amount by one
3562                    def.zones = newZoneSize;
3563                    if ((1 << oldDef->bits) < newZoneSize) def.bits++;
3564                    newDef = def;
3565                }
3566                tempRgn->AddDimension(&def);
3567            }
3568    
3569            // find the dimension index in the tempRegion which is the dimension
3570            // type passed to this method (paranoidly expecting different order)
3571            int tempIncreasedDimensionIndex = -1;
3572            for (int d = 0; d < tempRgn->Dimensions; ++d) {
3573                if (tempRgn->pDimensionDefinitions[d].dimension == type) {
3574                    tempIncreasedDimensionIndex = d;
3575                    break;
3576                }
3577            }
3578    
3579            // copy dimension regions from this region to the temporary region
3580            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3581                DimensionRegion* srcDimRgn = pDimensionRegions[iSrc];
3582                if (!srcDimRgn) continue;
3583                std::map<dimension_t,int> dimCase;
3584                bool isValidZone = true;
3585                for (int d = 0, baseBits = 0; d < Dimensions; ++d) {
3586                    const int srcBits = pDimensionDefinitions[d].bits;
3587                    dimCase[pDimensionDefinitions[d].dimension] =
3588                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3589                    // there are also DimensionRegion objects for unused zones, skip them
3590                    if (dimCase[pDimensionDefinitions[d].dimension] >= pDimensionDefinitions[d].zones) {
3591                        isValidZone = false;
3592                        break;
3593                    }
3594                    baseBits += srcBits;
3595                }
3596                if (!isValidZone) continue;
3597                // a bit paranoid: cope with the chance that the dimensions would
3598                // have different order in source and destination regions            
3599                if (dimCase[type] > zone) dimCase[type]++;
3600                DimensionRegion* dstDimRgn = tempRgn->GetDimensionRegionByBit(dimCase);
3601                dstDimRgn->CopyAssign(srcDimRgn);
3602                // if this is the requested zone to be splitted, then also copy
3603                // the source DimensionRegion to the newly created target zone
3604                // and set the old zones upper limit lower
3605                if (dimCase[type] == zone) {
3606                    // lower old zones upper limit
3607                    if (newDef.split_type == split_type_normal) {
3608                        const int high =
3609                            dstDimRgn->DimensionUpperLimits[tempIncreasedDimensionIndex];
3610                        int low = 0;
3611                        if (zone > 0) {
3612                            std::map<dimension_t,int> lowerCase = dimCase;
3613                            lowerCase[type]--;
3614                            DimensionRegion* dstDimRgnLow = tempRgn->GetDimensionRegionByBit(lowerCase);
3615                            low = dstDimRgnLow->DimensionUpperLimits[tempIncreasedDimensionIndex];
3616                        }
3617                        dstDimRgn->DimensionUpperLimits[tempIncreasedDimensionIndex] = low + (high - low) / 2;
3618                    }
3619                    // fill the newly created zone of the divided zone as well
3620                    dimCase[type]++;
3621                    dstDimRgn = tempRgn->GetDimensionRegionByBit(dimCase);
3622                    dstDimRgn->CopyAssign(srcDimRgn);
3623                }
3624            }
3625    
3626            // now tempRegion's dimensions and DimensionRegions basically reflect
3627            // what we wanted to get for this actual Region here, so we now just
3628            // delete and recreate the dimension in question with the new amount
3629            // zones and then copy back from tempRegion      
3630            DeleteDimension(oldDef);
3631            AddDimension(&newDef);
3632            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3633                DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
3634                if (!srcDimRgn) continue;
3635                std::map<dimension_t,int> dimCase;
3636                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3637                    const int srcBits = tempRgn->pDimensionDefinitions[d].bits;
3638                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3639                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3640                    baseBits += srcBits;
3641                }
3642                // a bit paranoid: cope with the chance that the dimensions would
3643                // have different order in source and destination regions
3644                DimensionRegion* dstDimRgn = GetDimensionRegionByBit(dimCase);
3645                if (!dstDimRgn) continue;
3646                dstDimRgn->CopyAssign(srcDimRgn);
3647            }
3648    
3649            // delete temporary region
3650            delete tempRgn;
3651    
3652            UpdateVelocityTable();
3653        }
3654    
3655        DimensionRegion* Region::GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase) {
3656            uint8_t bits[8] = {};
3657            for (std::map<dimension_t,int>::const_iterator it = DimCase.begin();
3658                 it != DimCase.end(); ++it)
3659            {
3660                for (int d = 0; d < Dimensions; ++d) {
3661                    if (pDimensionDefinitions[d].dimension == it->first) {
3662                        bits[d] = it->second;
3663                        goto nextDimCaseSlice;
3664                    }
3665                }
3666                assert(false); // do crash ... too harsh maybe ? ignore it instead ?
3667                nextDimCaseSlice:
3668                ; // noop
3669            }
3670            return GetDimensionRegionByBit(bits);
3671        }
3672    
3673        /**
3674         * Searches in the current Region for a dimension of the given dimension
3675         * type and returns the precise configuration of that dimension in this
3676         * Region.
3677         *
3678         * @param type - dimension type of the sought dimension
3679         * @returns dimension definition or NULL if there is no dimension with
3680         *          sought type in this Region.
3681         */
3682        dimension_def_t* Region::GetDimensionDefinition(dimension_t type) {
3683            for (int i = 0; i < Dimensions; ++i)
3684                if (pDimensionDefinitions[i].dimension == type)
3685                    return &pDimensionDefinitions[i];
3686            return NULL;
3687        }
3688    
3689      Region::~Region() {      Region::~Region() {
3690          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
3691              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
# Line 2694  namespace { Line 3743  namespace {
3743              }              }
3744              bitpos += pDimensionDefinitions[i].bits;              bitpos += pDimensionDefinitions[i].bits;
3745          }          }
3746          DimensionRegion* dimreg = pDimensionRegions[dimregidx];          DimensionRegion* dimreg = pDimensionRegions[dimregidx & 255];
3747            if (!dimreg) return NULL;
3748          if (veldim != -1) {          if (veldim != -1) {
3749              // (dimreg is now the dimension region for the lowest velocity)              // (dimreg is now the dimension region for the lowest velocity)
3750              if (dimreg->VelocityTable) // custom defined zone ranges              if (dimreg->VelocityTable) // custom defined zone ranges
3751                  bits = dimreg->VelocityTable[DimValues[veldim]];                  bits = dimreg->VelocityTable[DimValues[veldim] & 127];
3752              else // normal split type              else // normal split type
3753                  bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);                  bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
3754    
3755              dimregidx |= bits << velbitpos;              const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
3756              dimreg = pDimensionRegions[dimregidx];              dimregidx |= (bits & limiter_mask) << velbitpos;
3757                dimreg = pDimensionRegions[dimregidx & 255];
3758          }          }
3759          return dimreg;          return dimreg;
3760      }      }
3761    
3762        int Region::GetDimensionRegionIndexByValue(const uint DimValues[8]) {
3763            uint8_t bits;
3764            int veldim = -1;
3765            int velbitpos;
3766            int bitpos = 0;
3767            int dimregidx = 0;
3768            for (uint i = 0; i < Dimensions; i++) {
3769                if (pDimensionDefinitions[i].dimension == dimension_velocity) {
3770                    // the velocity dimension must be handled after the other dimensions
3771                    veldim = i;
3772                    velbitpos = bitpos;
3773                } else {
3774                    switch (pDimensionDefinitions[i].split_type) {
3775                        case split_type_normal:
3776                            if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
3777                                // gig3: all normal dimensions (not just the velocity dimension) have custom zone ranges
3778                                for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
3779                                    if (DimValues[i] <= pDimensionRegions[bits << bitpos]->DimensionUpperLimits[i]) break;
3780                                }
3781                            } else {
3782                                // gig2: evenly sized zones
3783                                bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
3784                            }
3785                            break;
3786                        case split_type_bit: // the value is already the sought dimension bit number
3787                            const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
3788                            bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
3789                            break;
3790                    }
3791                    dimregidx |= bits << bitpos;
3792                }
3793                bitpos += pDimensionDefinitions[i].bits;
3794            }
3795            dimregidx &= 255;
3796            DimensionRegion* dimreg = pDimensionRegions[dimregidx];
3797            if (!dimreg) return -1;
3798            if (veldim != -1) {
3799                // (dimreg is now the dimension region for the lowest velocity)
3800                if (dimreg->VelocityTable) // custom defined zone ranges
3801                    bits = dimreg->VelocityTable[DimValues[veldim] & 127];
3802                else // normal split type
3803                    bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
3804    
3805                const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
3806                dimregidx |= (bits & limiter_mask) << velbitpos;
3807                dimregidx &= 255;
3808            }
3809            return dimregidx;
3810        }
3811    
3812      /**      /**
3813       * Returns the appropriate DimensionRegion for the given dimension bit       * Returns the appropriate DimensionRegion for the given dimension bit
3814       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>
# Line 2756  namespace { Line 3857  namespace {
3857          }          }
3858          return NULL;          return NULL;
3859      }      }
3860        
3861        /**
3862         * Make a (semi) deep copy of the Region object given by @a orig
3863         * and assign it to this object.
3864         *
3865         * Note that all sample pointers referenced by @a orig are simply copied as
3866         * memory address. Thus the respective samples are shared, not duplicated!
3867         *
3868         * @param orig - original Region object to be copied from
3869         */
3870        void Region::CopyAssign(const Region* orig) {
3871            CopyAssign(orig, NULL);
3872        }
3873        
3874        /**
3875         * Make a (semi) deep copy of the Region object given by @a orig and
3876         * assign it to this object
3877         *
3878         * @param mSamples - crosslink map between the foreign file's samples and
3879         *                   this file's samples
3880         */
3881        void Region::CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples) {
3882            // handle base classes
3883            DLS::Region::CopyAssign(orig);
3884            
3885            if (mSamples && mSamples->count((gig::Sample*)orig->pSample)) {
3886                pSample = mSamples->find((gig::Sample*)orig->pSample)->second;
3887            }
3888            
3889            // handle own member variables
3890            for (int i = Dimensions - 1; i >= 0; --i) {
3891                DeleteDimension(&pDimensionDefinitions[i]);
3892            }
3893            Layers = 0; // just to be sure
3894            for (int i = 0; i < orig->Dimensions; i++) {
3895                // we need to copy the dim definition here, to avoid the compiler
3896                // complaining about const-ness issue
3897                dimension_def_t def = orig->pDimensionDefinitions[i];
3898                AddDimension(&def);
3899            }
3900            for (int i = 0; i < 256; i++) {
3901                if (pDimensionRegions[i] && orig->pDimensionRegions[i]) {
3902                    pDimensionRegions[i]->CopyAssign(
3903                        orig->pDimensionRegions[i],
3904                        mSamples
3905                    );
3906                }
3907            }
3908            Layers = orig->Layers;
3909        }
3910    
3911    
3912    // *************** MidiRule ***************
3913    // *
3914    
3915        MidiRuleCtrlTrigger::MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg) {
3916            _3ewg->SetPos(36);
3917            Triggers = _3ewg->ReadUint8();
3918            _3ewg->SetPos(40);
3919            ControllerNumber = _3ewg->ReadUint8();
3920            _3ewg->SetPos(46);
3921            for (int i = 0 ; i < Triggers ; i++) {
3922                pTriggers[i].TriggerPoint = _3ewg->ReadUint8();
3923                pTriggers[i].Descending = _3ewg->ReadUint8();
3924                pTriggers[i].VelSensitivity = _3ewg->ReadUint8();
3925                pTriggers[i].Key = _3ewg->ReadUint8();
3926                pTriggers[i].NoteOff = _3ewg->ReadUint8();
3927                pTriggers[i].Velocity = _3ewg->ReadUint8();
3928                pTriggers[i].OverridePedal = _3ewg->ReadUint8();
3929                _3ewg->ReadUint8();
3930            }
3931        }
3932    
3933        MidiRuleCtrlTrigger::MidiRuleCtrlTrigger() :
3934            ControllerNumber(0),
3935            Triggers(0) {
3936        }
3937    
3938        void MidiRuleCtrlTrigger::UpdateChunks(uint8_t* pData) const {
3939            pData[32] = 4;
3940            pData[33] = 16;
3941            pData[36] = Triggers;
3942            pData[40] = ControllerNumber;
3943            for (int i = 0 ; i < Triggers ; i++) {
3944                pData[46 + i * 8] = pTriggers[i].TriggerPoint;
3945                pData[47 + i * 8] = pTriggers[i].Descending;
3946                pData[48 + i * 8] = pTriggers[i].VelSensitivity;
3947                pData[49 + i * 8] = pTriggers[i].Key;
3948                pData[50 + i * 8] = pTriggers[i].NoteOff;
3949                pData[51 + i * 8] = pTriggers[i].Velocity;
3950                pData[52 + i * 8] = pTriggers[i].OverridePedal;
3951            }
3952        }
3953    
3954        MidiRuleLegato::MidiRuleLegato(RIFF::Chunk* _3ewg) {
3955            _3ewg->SetPos(36);
3956            LegatoSamples = _3ewg->ReadUint8(); // always 12
3957            _3ewg->SetPos(40);
3958            BypassUseController = _3ewg->ReadUint8();
3959            BypassKey = _3ewg->ReadUint8();
3960            BypassController = _3ewg->ReadUint8();
3961            ThresholdTime = _3ewg->ReadUint16();
3962            _3ewg->ReadInt16();
3963            ReleaseTime = _3ewg->ReadUint16();
3964            _3ewg->ReadInt16();
3965            KeyRange.low = _3ewg->ReadUint8();
3966            KeyRange.high = _3ewg->ReadUint8();
3967            _3ewg->SetPos(64);
3968            ReleaseTriggerKey = _3ewg->ReadUint8();
3969            AltSustain1Key = _3ewg->ReadUint8();
3970            AltSustain2Key = _3ewg->ReadUint8();
3971        }
3972    
3973        MidiRuleLegato::MidiRuleLegato() :
3974            LegatoSamples(12),
3975            BypassUseController(false),
3976            BypassKey(0),
3977            BypassController(1),
3978            ThresholdTime(20),
3979            ReleaseTime(20),
3980            ReleaseTriggerKey(0),
3981            AltSustain1Key(0),
3982            AltSustain2Key(0)
3983        {
3984            KeyRange.low = KeyRange.high = 0;
3985        }
3986    
3987        void MidiRuleLegato::UpdateChunks(uint8_t* pData) const {
3988            pData[32] = 0;
3989            pData[33] = 16;
3990            pData[36] = LegatoSamples;
3991            pData[40] = BypassUseController;
3992            pData[41] = BypassKey;
3993            pData[42] = BypassController;
3994            store16(&pData[43], ThresholdTime);
3995            store16(&pData[47], ReleaseTime);
3996            pData[51] = KeyRange.low;
3997            pData[52] = KeyRange.high;
3998            pData[64] = ReleaseTriggerKey;
3999            pData[65] = AltSustain1Key;
4000            pData[66] = AltSustain2Key;
4001        }
4002    
4003        MidiRuleAlternator::MidiRuleAlternator(RIFF::Chunk* _3ewg) {
4004            _3ewg->SetPos(36);
4005            Articulations = _3ewg->ReadUint8();
4006            int flags = _3ewg->ReadUint8();
4007            Polyphonic = flags & 8;
4008            Chained = flags & 4;
4009            Selector = (flags & 2) ? selector_controller :
4010                (flags & 1) ? selector_key_switch : selector_none;
4011            Patterns = _3ewg->ReadUint8();
4012            _3ewg->ReadUint8(); // chosen row
4013            _3ewg->ReadUint8(); // unknown
4014            _3ewg->ReadUint8(); // unknown
4015            _3ewg->ReadUint8(); // unknown
4016            KeySwitchRange.low = _3ewg->ReadUint8();
4017            KeySwitchRange.high = _3ewg->ReadUint8();
4018            Controller = _3ewg->ReadUint8();
4019            PlayRange.low = _3ewg->ReadUint8();
4020            PlayRange.high = _3ewg->ReadUint8();
4021    
4022            int n = std::min(int(Articulations), 32);
4023            for (int i = 0 ; i < n ; i++) {
4024                _3ewg->ReadString(pArticulations[i], 32);
4025            }
4026            _3ewg->SetPos(1072);
4027            n = std::min(int(Patterns), 32);
4028            for (int i = 0 ; i < n ; i++) {
4029                _3ewg->ReadString(pPatterns[i].Name, 16);
4030                pPatterns[i].Size = _3ewg->ReadUint8();
4031                _3ewg->Read(&pPatterns[i][0], 1, 32);
4032            }
4033        }
4034    
4035        MidiRuleAlternator::MidiRuleAlternator() :
4036            Articulations(0),
4037            Patterns(0),
4038            Selector(selector_none),
4039            Controller(0),
4040            Polyphonic(false),
4041            Chained(false)
4042        {
4043            PlayRange.low = PlayRange.high = 0;
4044            KeySwitchRange.low = KeySwitchRange.high = 0;
4045        }
4046    
4047        void MidiRuleAlternator::UpdateChunks(uint8_t* pData) const {
4048            pData[32] = 3;
4049            pData[33] = 16;
4050            pData[36] = Articulations;
4051            pData[37] = (Polyphonic ? 8 : 0) | (Chained ? 4 : 0) |
4052                (Selector == selector_controller ? 2 :
4053                 (Selector == selector_key_switch ? 1 : 0));
4054            pData[38] = Patterns;
4055    
4056            pData[43] = KeySwitchRange.low;
4057            pData[44] = KeySwitchRange.high;
4058            pData[45] = Controller;
4059            pData[46] = PlayRange.low;
4060            pData[47] = PlayRange.high;
4061    
4062            char* str = reinterpret_cast<char*>(pData);
4063            int pos = 48;
4064            int n = std::min(int(Articulations), 32);
4065            for (int i = 0 ; i < n ; i++, pos += 32) {
4066                strncpy(&str[pos], pArticulations[i].c_str(), 32);
4067            }
4068    
4069            pos = 1072;
4070            n = std::min(int(Patterns), 32);
4071            for (int i = 0 ; i < n ; i++, pos += 49) {
4072                strncpy(&str[pos], pPatterns[i].Name.c_str(), 16);
4073                pData[pos + 16] = pPatterns[i].Size;
4074                memcpy(&pData[pos + 16], &(pPatterns[i][0]), 32);
4075            }
4076        }
4077    
4078    // *************** Script ***************
4079    // *
4080    
4081        Script::Script(ScriptGroup* group, RIFF::Chunk* ckScri) {
4082            pGroup = group;
4083            pChunk = ckScri;
4084            if (ckScri) { // object is loaded from file ...
4085                // read header
4086                uint32_t headerSize = ckScri->ReadUint32();
4087                Compression = (Compression_t) ckScri->ReadUint32();
4088                Encoding    = (Encoding_t) ckScri->ReadUint32();
4089                Language    = (Language_t) ckScri->ReadUint32();
4090                Bypass      = (Language_t) ckScri->ReadUint32() & 1;
4091                crc         = ckScri->ReadUint32();
4092                uint32_t nameSize = ckScri->ReadUint32();
4093                Name.resize(nameSize, ' ');
4094                for (int i = 0; i < nameSize; ++i)
4095                    Name[i] = ckScri->ReadUint8();
4096                // to handle potential future extensions of the header
4097                ckScri->SetPos(headerSize - 6*sizeof(int32_t) + nameSize, RIFF::stream_curpos);
4098                // read actual script data
4099                uint32_t scriptSize = ckScri->GetSize() - ckScri->GetPos();
4100                data.resize(scriptSize);
4101                for (int i = 0; i < scriptSize; ++i)
4102                    data[i] = ckScri->ReadUint8();
4103            } else { // this is a new script object, so just initialize it as such ...
4104                Compression = COMPRESSION_NONE;
4105                Encoding = ENCODING_ASCII;
4106                Language = LANGUAGE_NKSP;
4107                Bypass   = false;
4108                crc      = 0;
4109                Name     = "Unnamed Script";
4110            }
4111        }
4112    
4113        Script::~Script() {
4114        }
4115    
4116        /**
4117         * Returns the current script (i.e. as source code) in text format.
4118         */
4119        String Script::GetScriptAsText() {
4120            String s;
4121            s.resize(data.size(), ' ');
4122            memcpy(&s[0], &data[0], data.size());
4123            return s;
4124        }
4125    
4126        /**
4127         * Replaces the current script with the new script source code text given
4128         * by @a text.
4129         *
4130         * @param text - new script source code
4131         */
4132        void Script::SetScriptAsText(const String& text) {
4133            data.resize(text.size());
4134            memcpy(&data[0], &text[0], text.size());
4135        }
4136    
4137        void Script::UpdateChunks() {
4138            // recalculate CRC32 check sum
4139            __resetCRC(crc);
4140            __calculateCRC(&data[0], data.size(), crc);
4141            __encodeCRC(crc);
4142            // make sure chunk exists and has the required size
4143            const int chunkSize = 7*sizeof(int32_t) + Name.size() + data.size();
4144            if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);
4145            else pChunk->Resize(chunkSize);
4146            // fill the chunk data to be written to disk
4147            uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();
4148            int pos = 0;
4149            store32(&pData[pos], 6*sizeof(int32_t) + Name.size()); // total header size
4150            pos += sizeof(int32_t);
4151            store32(&pData[pos], Compression);
4152            pos += sizeof(int32_t);
4153            store32(&pData[pos], Encoding);
4154            pos += sizeof(int32_t);
4155            store32(&pData[pos], Language);
4156            pos += sizeof(int32_t);
4157            store32(&pData[pos], Bypass ? 1 : 0);
4158            pos += sizeof(int32_t);
4159            store32(&pData[pos], crc);
4160            pos += sizeof(int32_t);
4161            store32(&pData[pos], Name.size());
4162            pos += sizeof(int32_t);
4163            for (int i = 0; i < Name.size(); ++i, ++pos)
4164                pData[pos] = Name[i];
4165            for (int i = 0; i < data.size(); ++i, ++pos)
4166                pData[pos] = data[i];
4167        }
4168    
4169        /**
4170         * Move this script from its current ScriptGroup to another ScriptGroup
4171         * given by @a pGroup.
4172         *
4173         * @param pGroup - script's new group
4174         */
4175        void Script::SetGroup(ScriptGroup* pGroup) {
4176            if (this->pGroup = pGroup) return;
4177            if (pChunk)
4178                pChunk->GetParent()->MoveSubChunk(pChunk, pGroup->pList);
4179            this->pGroup = pGroup;
4180        }
4181    
4182        /**
4183         * Returns the script group this script currently belongs to. Each script
4184         * is a member of exactly one ScriptGroup.
4185         *
4186         * @returns current script group
4187         */
4188        ScriptGroup* Script::GetGroup() const {
4189            return pGroup;
4190        }
4191    
4192        void Script::RemoveAllScriptReferences() {
4193            File* pFile = pGroup->pFile;
4194            for (int i = 0; pFile->GetInstrument(i); ++i) {
4195                Instrument* instr = pFile->GetInstrument(i);
4196                instr->RemoveScript(this);
4197            }
4198        }
4199    
4200    // *************** ScriptGroup ***************
4201    // *
4202    
4203        ScriptGroup::ScriptGroup(File* file, RIFF::List* lstRTIS) {
4204            pFile = file;
4205            pList = lstRTIS;
4206            pScripts = NULL;
4207            if (lstRTIS) {
4208                RIFF::Chunk* ckName = lstRTIS->GetSubChunk(CHUNK_ID_LSNM);
4209                ::LoadString(ckName, Name);
4210            } else {
4211                Name = "Default Group";
4212            }
4213        }
4214    
4215        ScriptGroup::~ScriptGroup() {
4216            if (pScripts) {
4217                std::list<Script*>::iterator iter = pScripts->begin();
4218                std::list<Script*>::iterator end  = pScripts->end();
4219                while (iter != end) {
4220                    delete *iter;
4221                    ++iter;
4222                }
4223                delete pScripts;
4224            }
4225        }
4226    
4227        void ScriptGroup::UpdateChunks() {
4228            if (pScripts) {
4229                if (!pList)
4230                    pList = pFile->pRIFF->GetSubList(LIST_TYPE_3LS)->AddSubList(LIST_TYPE_RTIS);
4231    
4232                // now store the name of this group as <LSNM> chunk as subchunk of the <RTIS> list chunk
4233                ::SaveString(CHUNK_ID_LSNM, NULL, pList, Name, String("Unnamed Group"), true, 64);
4234    
4235                for (std::list<Script*>::iterator it = pScripts->begin();
4236                     it != pScripts->end(); ++it)
4237                {
4238                    (*it)->UpdateChunks();
4239                }
4240            }
4241        }
4242    
4243        /** @brief Get instrument script.
4244         *
4245         * Returns the real-time instrument script with the given index.
4246         *
4247         * @param index - number of the sought script (0..n)
4248         * @returns sought script or NULL if there's no such script
4249         */
4250        Script* ScriptGroup::GetScript(uint index) {
4251            if (!pScripts) LoadScripts();
4252            std::list<Script*>::iterator it = pScripts->begin();
4253            for (uint i = 0; it != pScripts->end(); ++i, ++it)
4254                if (i == index) return *it;
4255            return NULL;
4256        }
4257    
4258        /** @brief Add new instrument script.
4259         *
4260         * Adds a new real-time instrument script to the file. The script is not
4261         * actually used / executed unless it is referenced by an instrument to be
4262         * used. This is similar to samples, which you can add to a file, without
4263         * an instrument necessarily actually using it.
4264         *
4265         * You have to call Save() to make this persistent to the file.
4266         *
4267         * @return new empty script object
4268         */
4269        Script* ScriptGroup::AddScript() {
4270            if (!pScripts) LoadScripts();
4271            Script* pScript = new Script(this, NULL);
4272            pScripts->push_back(pScript);
4273            return pScript;
4274        }
4275    
4276        /** @brief Delete an instrument script.
4277         *
4278         * This will delete the given real-time instrument script. References of
4279         * instruments that are using that script will be removed accordingly.
4280         *
4281         * You have to call Save() to make this persistent to the file.
4282         *
4283         * @param pScript - script to delete
4284         * @throws gig::Exception if given script could not be found
4285         */
4286        void ScriptGroup::DeleteScript(Script* pScript) {
4287            if (!pScripts) LoadScripts();
4288            std::list<Script*>::iterator iter =
4289                find(pScripts->begin(), pScripts->end(), pScript);
4290            if (iter == pScripts->end())
4291                throw gig::Exception("Could not delete script, could not find given script");
4292            pScripts->erase(iter);
4293            pScript->RemoveAllScriptReferences();
4294            if (pScript->pChunk)
4295                pScript->pChunk->GetParent()->DeleteSubChunk(pScript->pChunk);
4296            delete pScript;
4297        }
4298    
4299        void ScriptGroup::LoadScripts() {
4300            if (pScripts) return;
4301            pScripts = new std::list<Script*>;
4302            if (!pList) return;
4303    
4304            for (RIFF::Chunk* ck = pList->GetFirstSubChunk(); ck;
4305                 ck = pList->GetNextSubChunk())
4306            {
4307                if (ck->GetChunkID() == CHUNK_ID_SCRI) {
4308                    pScripts->push_back(new Script(this, ck));
4309                }
4310            }
4311        }
4312    
4313  // *************** Instrument ***************  // *************** Instrument ***************
4314  // *  // *
4315    
4316      Instrument::Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress) : DLS::Instrument((DLS::File*)pFile, insList) {      Instrument::Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress) : DLS::Instrument((DLS::File*)pFile, insList) {
4317          static const DLS::Info::FixedStringLength fixedStringLengths[] = {          static const DLS::Info::string_length_t fixedStringLengths[] = {
4318              { CHUNK_ID_INAM, 64 },              { CHUNK_ID_INAM, 64 },
4319              { CHUNK_ID_ISFT, 12 },              { CHUNK_ID_ISFT, 12 },
4320              { 0, 0 }              { 0, 0 }
4321          };          };
4322          pInfo->FixedStringLengths = fixedStringLengths;          pInfo->SetFixedStringLengths(fixedStringLengths);
4323    
4324          // Initialization          // Initialization
4325          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
# Line 2779  namespace { Line 4330  namespace {
4330          PianoReleaseMode = false;          PianoReleaseMode = false;
4331          DimensionKeyRange.low = 0;          DimensionKeyRange.low = 0;
4332          DimensionKeyRange.high = 0;          DimensionKeyRange.high = 0;
4333            pMidiRules = new MidiRule*[3];
4334            pMidiRules[0] = NULL;
4335            pScriptRefs = NULL;
4336    
4337          // Loading          // Loading
4338          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
# Line 2793  namespace { Line 4347  namespace {
4347                  PianoReleaseMode       = dimkeystart & 0x01;                  PianoReleaseMode       = dimkeystart & 0x01;
4348                  DimensionKeyRange.low  = dimkeystart >> 1;                  DimensionKeyRange.low  = dimkeystart >> 1;
4349                  DimensionKeyRange.high = _3ewg->ReadUint8();                  DimensionKeyRange.high = _3ewg->ReadUint8();
4350    
4351                    if (_3ewg->GetSize() > 32) {
4352                        // read MIDI rules
4353                        int i = 0;
4354                        _3ewg->SetPos(32);
4355                        uint8_t id1 = _3ewg->ReadUint8();
4356                        uint8_t id2 = _3ewg->ReadUint8();
4357    
4358                        if (id2 == 16) {
4359                            if (id1 == 4) {
4360                                pMidiRules[i++] = new MidiRuleCtrlTrigger(_3ewg);
4361                            } else if (id1 == 0) {
4362                                pMidiRules[i++] = new MidiRuleLegato(_3ewg);
4363                            } else if (id1 == 3) {
4364                                pMidiRules[i++] = new MidiRuleAlternator(_3ewg);
4365                            } else {
4366                                pMidiRules[i++] = new MidiRuleUnknown;
4367                            }
4368                        }
4369                        else if (id1 != 0 || id2 != 0) {
4370                            pMidiRules[i++] = new MidiRuleUnknown;
4371                        }
4372                        //TODO: all the other types of rules
4373    
4374                        pMidiRules[i] = NULL;
4375                    }
4376              }              }
4377          }          }
4378    
4379          if (!pRegions) pRegions = new RegionList;          if (pFile->GetAutoLoad()) {
4380          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);              if (!pRegions) pRegions = new RegionList;
4381          if (lrgn) {              RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
4382              RIFF::List* rgn = lrgn->GetFirstSubList();              if (lrgn) {
4383              while (rgn) {                  RIFF::List* rgn = lrgn->GetFirstSubList();
4384                  if (rgn->GetListType() == LIST_TYPE_RGN) {                  while (rgn) {
4385                      __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);                      if (rgn->GetListType() == LIST_TYPE_RGN) {
4386                      pRegions->push_back(new Region(this, rgn));                          __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
4387                            pRegions->push_back(new Region(this, rgn));
4388                        }
4389                        rgn = lrgn->GetNextSubList();
4390                    }
4391                    // Creating Region Key Table for fast lookup
4392                    UpdateRegionKeyTable();
4393                }
4394            }
4395    
4396            // own gig format extensions
4397            RIFF::List* lst3LS = insList->GetSubList(LIST_TYPE_3LS);
4398            if (lst3LS) {
4399                RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4400                if (ckSCSL) {
4401                    int slotCount = ckSCSL->ReadUint32();
4402                    int slotSize  = ckSCSL->ReadUint32();
4403                    int unknownSpace = slotSize - 2*sizeof(uint32_t); // in case of future extensions
4404                    for (int i = 0; i < slotCount; ++i) {
4405                        _ScriptPooolEntry e;
4406                        e.fileOffset = ckSCSL->ReadUint32();
4407                        e.bypass     = ckSCSL->ReadUint32() & 1;
4408                        if (unknownSpace) ckSCSL->SetPos(unknownSpace, RIFF::stream_curpos); // in case of future extensions
4409                        scriptPoolFileOffsets.push_back(e);
4410                  }                  }
                 rgn = lrgn->GetNextSubList();  
4411              }              }
             // Creating Region Key Table for fast lookup  
             UpdateRegionKeyTable();  
4412          }          }
4413    
4414          __notify_progress(pProgress, 1.0f); // notify done          __notify_progress(pProgress, 1.0f); // notify done
# Line 2827  namespace { Line 4427  namespace {
4427      }      }
4428    
4429      Instrument::~Instrument() {      Instrument::~Instrument() {
4430            for (int i = 0 ; pMidiRules[i] ; i++) {
4431                delete pMidiRules[i];
4432            }
4433            delete[] pMidiRules;
4434            if (pScriptRefs) delete pScriptRefs;
4435      }      }
4436    
4437      /**      /**
# Line 2873  namespace { Line 4478  namespace {
4478                                      DimensionKeyRange.low << 1;                                      DimensionKeyRange.low << 1;
4479          pData[10] = dimkeystart;          pData[10] = dimkeystart;
4480          pData[11] = DimensionKeyRange.high;          pData[11] = DimensionKeyRange.high;
4481    
4482            if (pMidiRules[0] == 0 && _3ewg->GetSize() >= 34) {
4483                pData[32] = 0;
4484                pData[33] = 0;
4485            } else {
4486                for (int i = 0 ; pMidiRules[i] ; i++) {
4487                    pMidiRules[i]->UpdateChunks(pData);
4488                }
4489            }
4490    
4491            // own gig format extensions
4492           if (pScriptRefs) {
4493               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4494               if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);
4495               const int totalSize = pScriptRefs->size() * 2*sizeof(uint32_t);
4496               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4497               if (!ckSCSL) ckSCSL = lst3LS->AddSubChunk(CHUNK_ID_SCSL, totalSize);
4498               else ckSCSL->Resize(totalSize);
4499               uint8_t* pData = (uint8_t*) ckSCSL->LoadChunkData();
4500               for (int i = 0, pos = 0; i < pScriptRefs->size(); ++i) {
4501                   int fileOffset =
4502                        (*pScriptRefs)[i].script->pChunk->GetFilePos() -
4503                        (*pScriptRefs)[i].script->pChunk->GetPos() -
4504                        CHUNK_HEADER_SIZE;
4505                   store32(&pData[pos], fileOffset);
4506                   pos += sizeof(uint32_t);
4507                   store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0);
4508                   pos += sizeof(uint32_t);
4509               }
4510           }
4511      }      }
4512    
4513      /**      /**
# Line 2941  namespace { Line 4576  namespace {
4576          UpdateRegionKeyTable();          UpdateRegionKeyTable();
4577      }      }
4578    
4579        /**
4580         * Returns a MIDI rule of the instrument.
4581         *
4582         * The list of MIDI rules, at least in gig v3, always contains at
4583         * most two rules. The second rule can only be the DEF filter
4584         * (which currently isn't supported by libgig).
4585         *
4586         * @param i - MIDI rule number
4587         * @returns   pointer address to MIDI rule number i or NULL if there is none
4588         */
4589        MidiRule* Instrument::GetMidiRule(int i) {
4590            return pMidiRules[i];
4591        }
4592    
4593        /**
4594         * Adds the "controller trigger" MIDI rule to the instrument.
4595         *
4596         * @returns the new MIDI rule
4597         */
4598        MidiRuleCtrlTrigger* Instrument::AddMidiRuleCtrlTrigger() {
4599            delete pMidiRules[0];
4600            MidiRuleCtrlTrigger* r = new MidiRuleCtrlTrigger;
4601            pMidiRules[0] = r;
4602            pMidiRules[1] = 0;
4603            return r;
4604        }
4605    
4606        /**
4607         * Adds the legato MIDI rule to the instrument.
4608         *
4609         * @returns the new MIDI rule
4610         */
4611        MidiRuleLegato* Instrument::AddMidiRuleLegato() {
4612            delete pMidiRules[0];
4613            MidiRuleLegato* r = new MidiRuleLegato;
4614            pMidiRules[0] = r;
4615            pMidiRules[1] = 0;
4616            return r;
4617        }
4618    
4619        /**
4620         * Adds the alternator MIDI rule to the instrument.
4621         *
4622         * @returns the new MIDI rule
4623         */
4624        MidiRuleAlternator* Instrument::AddMidiRuleAlternator() {
4625            delete pMidiRules[0];
4626            MidiRuleAlternator* r = new MidiRuleAlternator;
4627            pMidiRules[0] = r;
4628            pMidiRules[1] = 0;
4629            return r;
4630        }
4631    
4632        /**
4633         * Deletes a MIDI rule from the instrument.
4634         *
4635         * @param i - MIDI rule number
4636         */
4637        void Instrument::DeleteMidiRule(int i) {
4638            delete pMidiRules[i];
4639            pMidiRules[i] = 0;
4640        }
4641    
4642        void Instrument::LoadScripts() {
4643            if (pScriptRefs) return;
4644            pScriptRefs = new std::vector<_ScriptPooolRef>;
4645            if (scriptPoolFileOffsets.empty()) return;
4646            File* pFile = (File*) GetParent();
4647            for (uint k = 0; k < scriptPoolFileOffsets.size(); ++k) {
4648                uint32_t offset = scriptPoolFileOffsets[k].fileOffset;
4649                for (uint i = 0; pFile->GetScriptGroup(i); ++i) {
4650                    ScriptGroup* group = pFile->GetScriptGroup(i);
4651                    for (uint s = 0; group->GetScript(s); ++s) {
4652                        Script* script = group->GetScript(s);
4653                        if (script->pChunk) {
4654                            script->pChunk->SetPos(0);
4655                            if (script->pChunk->GetFilePos() -
4656                                script->pChunk->GetPos() -
4657                                CHUNK_HEADER_SIZE == offset)
4658                            {
4659                                _ScriptPooolRef ref;
4660                                ref.script = script;
4661                                ref.bypass = scriptPoolFileOffsets[k].bypass;
4662                                pScriptRefs->push_back(ref);
4663                                break;
4664                            }
4665                        }
4666                    }
4667                }
4668            }
4669            // we don't need that anymore
4670            scriptPoolFileOffsets.clear();
4671        }
4672    
4673        /** @brief Get instrument script (gig format extension).
4674         *
4675         * Returns the real-time instrument script of instrument script slot
4676         * @a index.
4677         *
4678         * @note This is an own format extension which did not exist i.e. in the
4679         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4680         * gigedit.
4681         *
4682         * @param index - instrument script slot index
4683         * @returns script or NULL if index is out of bounds
4684         */
4685        Script* Instrument::GetScriptOfSlot(uint index) {
4686            LoadScripts();
4687            if (index >= pScriptRefs->size()) return NULL;
4688            return pScriptRefs->at(index).script;
4689        }
4690    
4691        /** @brief Add new instrument script slot (gig format extension).
4692         *
4693         * Add the given real-time instrument script reference to this instrument,
4694         * which shall be executed by the sampler for for this instrument. The
4695         * script will be added to the end of the script list of this instrument.
4696         * The positions of the scripts in the Instrument's Script list are
4697         * relevant, because they define in which order they shall be executed by
4698         * the sampler. For this reason it is also legal to add the same script
4699         * twice to an instrument, for example you might have a script called
4700         * "MyFilter" which performs an event filter task, and you might have
4701         * another script called "MyNoteTrigger" which triggers new notes, then you
4702         * might for example have the following list of scripts on the instrument:
4703         *
4704         * 1. Script "MyFilter"
4705         * 2. Script "MyNoteTrigger"
4706         * 3. Script "MyFilter"
4707         *
4708         * Which would make sense, because the 2nd script launched new events, which
4709         * you might need to filter as well.
4710         *
4711         * There are two ways to disable / "bypass" scripts. You can either disable
4712         * a script locally for the respective script slot on an instrument (i.e. by
4713         * passing @c false to the 2nd argument of this method, or by calling
4714         * SetScriptBypassed()). Or you can disable a script globally for all slots
4715         * and all instruments by setting Script::Bypass.
4716         *
4717         * @note This is an own format extension which did not exist i.e. in the
4718         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4719         * gigedit.
4720         *
4721         * @param pScript - script that shall be executed for this instrument
4722         * @param bypass  - if enabled, the sampler shall skip executing this
4723         *                  script (in the respective list position)
4724         * @see SetScriptBypassed()
4725         */
4726        void Instrument::AddScriptSlot(Script* pScript, bool bypass) {
4727            LoadScripts();
4728            _ScriptPooolRef ref = { pScript, bypass };
4729            pScriptRefs->push_back(ref);
4730        }
4731    
4732        /** @brief Flip two script slots with each other (gig format extension).
4733         *
4734         * Swaps the position of the two given scripts in the Instrument's Script
4735         * list. The positions of the scripts in the Instrument's Script list are
4736         * relevant, because they define in which order they shall be executed by
4737         * the sampler.
4738         *
4739         * @note This is an own format extension which did not exist i.e. in the
4740         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4741         * gigedit.
4742         *
4743         * @param index1 - index of the first script slot to swap
4744         * @param index2 - index of the second script slot to swap
4745         */
4746        void Instrument::SwapScriptSlots(uint index1, uint index2) {
4747            LoadScripts();
4748            if (index1 >= pScriptRefs->size() || index2 >= pScriptRefs->size())
4749                return;
4750            _ScriptPooolRef tmp = (*pScriptRefs)[index1];
4751            (*pScriptRefs)[index1] = (*pScriptRefs)[index2];
4752            (*pScriptRefs)[index2] = tmp;
4753        }
4754    
4755        /** @brief Remove script slot.
4756         *
4757         * Removes the script slot with the given slot index.
4758         *
4759         * @param index - index of script slot to remove
4760         */
4761        void Instrument::RemoveScriptSlot(uint index) {
4762            LoadScripts();
4763            if (index >= pScriptRefs->size()) return;
4764            pScriptRefs->erase( pScriptRefs->begin() + index );
4765        }
4766    
4767        /** @brief Remove reference to given Script (gig format extension).
4768         *
4769         * This will remove all script slots on the instrument which are referencing
4770         * the given script.
4771         *
4772         * @note This is an own format extension which did not exist i.e. in the
4773         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4774         * gigedit.
4775         *
4776         * @param pScript - script reference to remove from this instrument
4777         * @see RemoveScriptSlot()
4778         */
4779        void Instrument::RemoveScript(Script* pScript) {
4780            LoadScripts();
4781            for (int i = pScriptRefs->size() - 1; i >= 0; --i) {
4782                if ((*pScriptRefs)[i].script == pScript) {
4783                    pScriptRefs->erase( pScriptRefs->begin() + i );
4784                }
4785            }
4786        }
4787    
4788        /** @brief Instrument's amount of script slots.
4789         *
4790         * This method returns the amount of script slots this instrument currently
4791         * uses.
4792         *
4793         * A script slot is a reference of a real-time instrument script to be
4794         * executed by the sampler. The scripts will be executed by the sampler in
4795         * sequence of the slots. One (same) script may be referenced multiple
4796         * times in different slots.
4797         *
4798         * @note This is an own format extension which did not exist i.e. in the
4799         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4800         * gigedit.
4801         */
4802        uint Instrument::ScriptSlotCount() const {
4803            return pScriptRefs ? pScriptRefs->size() : scriptPoolFileOffsets.size();
4804        }
4805    
4806        /** @brief Whether script execution shall be skipped.
4807         *
4808         * Defines locally for the Script reference slot in the Instrument's Script
4809         * list, whether the script shall be skipped by the sampler regarding
4810         * execution.
4811         *
4812         * It is also possible to ignore exeuction of the script globally, for all
4813         * slots and for all instruments by setting Script::Bypass.
4814         *
4815         * @note This is an own format extension which did not exist i.e. in the
4816         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4817         * gigedit.
4818         *
4819         * @param index - index of the script slot on this instrument
4820         * @see Script::Bypass
4821         */
4822        bool Instrument::IsScriptSlotBypassed(uint index) {
4823            if (index >= ScriptSlotCount()) return false;
4824            return pScriptRefs ? pScriptRefs->at(index).bypass
4825                               : scriptPoolFileOffsets.at(index).bypass;
4826            
4827        }
4828    
4829        /** @brief Defines whether execution shall be skipped.
4830         *
4831         * You can call this method to define locally whether or whether not the
4832         * given script slot shall be executed by the sampler.
4833         *
4834         * @note This is an own format extension which did not exist i.e. in the
4835         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4836         * gigedit.
4837         *
4838         * @param index - script slot index on this instrument
4839         * @param bBypass - if true, the script slot will be skipped by the sampler
4840         * @see Script::Bypass
4841         */
4842        void Instrument::SetScriptSlotBypassed(uint index, bool bBypass) {
4843            if (index >= ScriptSlotCount()) return;
4844            if (pScriptRefs)
4845                pScriptRefs->at(index).bypass = bBypass;
4846            else
4847                scriptPoolFileOffsets.at(index).bypass = bBypass;
4848        }
4849    
4850        /**
4851         * Make a (semi) deep copy of the Instrument object given by @a orig
4852         * and assign it to this object.
4853         *
4854         * Note that all sample pointers referenced by @a orig are simply copied as
4855         * memory address. Thus the respective samples are shared, not duplicated!
4856         *
4857         * @param orig - original Instrument object to be copied from
4858         */
4859        void Instrument::CopyAssign(const Instrument* orig) {
4860            CopyAssign(orig, NULL);
4861        }
4862            
4863        /**
4864         * Make a (semi) deep copy of the Instrument object given by @a orig
4865         * and assign it to this object.
4866         *
4867         * @param orig - original Instrument object to be copied from
4868         * @param mSamples - crosslink map between the foreign file's samples and
4869         *                   this file's samples
4870         */
4871        void Instrument::CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples) {
4872            // handle base class
4873            // (without copying DLS region stuff)
4874            DLS::Instrument::CopyAssignCore(orig);
4875            
4876            // handle own member variables
4877            Attenuation = orig->Attenuation;
4878            EffectSend = orig->EffectSend;
4879            FineTune = orig->FineTune;
4880            PitchbendRange = orig->PitchbendRange;
4881            PianoReleaseMode = orig->PianoReleaseMode;
4882            DimensionKeyRange = orig->DimensionKeyRange;
4883            scriptPoolFileOffsets = orig->scriptPoolFileOffsets;
4884            pScriptRefs = orig->pScriptRefs;
4885            
4886            // free old midi rules
4887            for (int i = 0 ; pMidiRules[i] ; i++) {
4888                delete pMidiRules[i];
4889            }
4890            //TODO: MIDI rule copying
4891            pMidiRules[0] = NULL;
4892            
4893            // delete all old regions
4894            while (Regions) DeleteRegion(GetFirstRegion());
4895            // create new regions and copy them from original
4896            {
4897                RegionList::const_iterator it = orig->pRegions->begin();
4898                for (int i = 0; i < orig->Regions; ++i, ++it) {
4899                    Region* dstRgn = AddRegion();
4900                    //NOTE: Region does semi-deep copy !
4901                    dstRgn->CopyAssign(
4902                        static_cast<gig::Region*>(*it),
4903                        mSamples
4904                    );
4905                }
4906            }
4907    
4908            UpdateRegionKeyTable();
4909        }
4910    
4911    
4912  // *************** Group ***************  // *************** Group ***************
# Line 3066  namespace { Line 5032  namespace {
5032  // *************** File ***************  // *************** File ***************
5033  // *  // *
5034    
5035      // File version 2.0, 1998-06-28      /// Reflects Gigasampler file format version 2.0 (1998-06-28).
5036      const DLS::version_t File::VERSION_2 = {      const DLS::version_t File::VERSION_2 = {
5037          0, 2, 19980628 & 0xffff, 19980628 >> 16          0, 2, 19980628 & 0xffff, 19980628 >> 16
5038      };      };
5039    
5040      // File version 3.0, 2003-03-31      /// Reflects Gigasampler file format version 3.0 (2003-03-31).
5041      const DLS::version_t File::VERSION_3 = {      const DLS::version_t File::VERSION_3 = {
5042          0, 3, 20030331 & 0xffff, 20030331 >> 16          0, 3, 20030331 & 0xffff, 20030331 >> 16
5043      };      };
5044    
5045      const DLS::Info::FixedStringLength File::FixedStringLengths[] = {      static const DLS::Info::string_length_t _FileFixedStringLengths[] = {
5046          { CHUNK_ID_IARL, 256 },          { CHUNK_ID_IARL, 256 },
5047          { CHUNK_ID_IART, 128 },          { CHUNK_ID_IART, 128 },
5048          { CHUNK_ID_ICMS, 128 },          { CHUNK_ID_ICMS, 128 },
# Line 3098  namespace { Line 5064  namespace {
5064      };      };
5065    
5066      File::File() : DLS::File() {      File::File() : DLS::File() {
5067            bAutoLoad = true;
5068          *pVersion = VERSION_3;          *pVersion = VERSION_3;
5069          pGroups = NULL;          pGroups = NULL;
5070          pInfo->FixedStringLengths = FixedStringLengths;          pScriptGroups = NULL;
5071            pInfo->SetFixedStringLengths(_FileFixedStringLengths);
5072          pInfo->ArchivalLocation = String(256, ' ');          pInfo->ArchivalLocation = String(256, ' ');
5073    
5074          // add some mandatory chunks to get the file chunks in right          // add some mandatory chunks to get the file chunks in right
# Line 3113  namespace { Line 5081  namespace {
5081      }      }
5082    
5083      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
5084            bAutoLoad = true;
5085          pGroups = NULL;          pGroups = NULL;
5086          pInfo->FixedStringLengths = FixedStringLengths;          pScriptGroups = NULL;
5087            pInfo->SetFixedStringLengths(_FileFixedStringLengths);
5088      }      }
5089    
5090      File::~File() {      File::~File() {
# Line 3127  namespace { Line 5097  namespace {
5097              }              }
5098              delete pGroups;              delete pGroups;
5099          }          }
5100            if (pScriptGroups) {
5101                std::list<ScriptGroup*>::iterator iter = pScriptGroups->begin();
5102                std::list<ScriptGroup*>::iterator end  = pScriptGroups->end();
5103                while (iter != end) {
5104                    delete *iter;
5105                    ++iter;
5106                }
5107                delete pScriptGroups;
5108            }
5109      }      }
5110    
5111      Sample* File::GetFirstSample(progress_t* pProgress) {      Sample* File::GetFirstSample(progress_t* pProgress) {
# Line 3141  namespace { Line 5120  namespace {
5120          SamplesIterator++;          SamplesIterator++;
5121          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
5122      }      }
5123        
5124        /**
5125         * Returns Sample object of @a index.
5126         *
5127         * @returns sample object or NULL if index is out of bounds
5128         */
5129        Sample* File::GetSample(uint index) {
5130            if (!pSamples) LoadSamples();
5131            if (!pSamples) return NULL;
5132            DLS::File::SampleList::iterator it = pSamples->begin();
5133            for (int i = 0; i < index; ++i) {
5134                ++it;
5135                if (it == pSamples->end()) return NULL;
5136            }
5137            if (it == pSamples->end()) return NULL;
5138            return static_cast<gig::Sample*>( *it );
5139        }
5140    
5141      /** @brief Add a new sample.      /** @brief Add a new sample.
5142       *       *
# Line 3182  namespace { Line 5178  namespace {
5178          pSamples->erase(iter);          pSamples->erase(iter);
5179          delete pSample;          delete pSample;
5180    
5181            SampleList::iterator tmp = SamplesIterator;
5182          // remove all references to the sample          // remove all references to the sample
5183          for (Instrument* instrument = GetFirstInstrument() ; instrument ;          for (Instrument* instrument = GetFirstInstrument() ; instrument ;
5184               instrument = GetNextInstrument()) {               instrument = GetNextInstrument()) {
# Line 3196  namespace { Line 5193  namespace {
5193                  }                  }
5194              }              }
5195          }          }
5196            SamplesIterator = tmp; // restore iterator
5197      }      }
5198    
5199      void File::LoadSamples() {      void File::LoadSamples() {
# Line 3286  namespace { Line 5284  namespace {
5284              progress_t subprogress;              progress_t subprogress;
5285              __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask              __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
5286              __notify_progress(&subprogress, 0.0f);              __notify_progress(&subprogress, 0.0f);
5287              GetFirstSample(&subprogress); // now force all samples to be loaded              if (GetAutoLoad())
5288                    GetFirstSample(&subprogress); // now force all samples to be loaded
5289              __notify_progress(&subprogress, 1.0f);              __notify_progress(&subprogress, 1.0f);
5290    
5291              // instrument loading subtask              // instrument loading subtask
# Line 3335  namespace { Line 5334  namespace {
5334         pInstruments->push_back(pInstrument);         pInstruments->push_back(pInstrument);
5335         return pInstrument;         return pInstrument;
5336      }      }
5337        
5338        /** @brief Add a duplicate of an existing instrument.
5339         *
5340         * Duplicates the instrument definition given by @a orig and adds it
5341         * to this file. This allows in an instrument editor application to
5342         * easily create variations of an instrument, which will be stored in
5343         * the same .gig file, sharing i.e. the same samples.
5344         *
5345         * Note that all sample pointers referenced by @a orig are simply copied as
5346         * memory address. Thus the respective samples are shared, not duplicated!
5347         *
5348         * You have to call Save() to make this persistent to the file.
5349         *
5350         * @param orig - original instrument to be copied
5351         * @returns duplicated copy of the given instrument
5352         */
5353        Instrument* File::AddDuplicateInstrument(const Instrument* orig) {
5354            Instrument* instr = AddInstrument();
5355            instr->CopyAssign(orig);
5356            return instr;
5357        }
5358        
5359        /** @brief Add content of another existing file.
5360         *
5361         * Duplicates the samples, groups and instruments of the original file
5362         * given by @a pFile and adds them to @c this File. In case @c this File is
5363         * a new one that you haven't saved before, then you have to call
5364         * SetFileName() before calling AddContentOf(), because this method will
5365         * automatically save this file during operation, which is required for
5366         * writing the sample waveform data by disk streaming.
5367         *
5368         * @param pFile - original file whose's content shall be copied from
5369         */
5370        void File::AddContentOf(File* pFile) {
5371            static int iCallCount = -1;
5372            iCallCount++;
5373            std::map<Group*,Group*> mGroups;
5374            std::map<Sample*,Sample*> mSamples;
5375            
5376            // clone sample groups
5377            for (int i = 0; pFile->GetGroup(i); ++i) {
5378                Group* g = AddGroup();
5379                g->Name =
5380                    "COPY" + ToString(iCallCount) + "_" + pFile->GetGroup(i)->Name;
5381                mGroups[pFile->GetGroup(i)] = g;
5382            }
5383            
5384            // clone samples (not waveform data here yet)
5385            for (int i = 0; pFile->GetSample(i); ++i) {
5386                Sample* s = AddSample();
5387                s->CopyAssignMeta(pFile->GetSample(i));
5388                mGroups[pFile->GetSample(i)->GetGroup()]->AddSample(s);
5389                mSamples[pFile->GetSample(i)] = s;
5390            }
5391            
5392            //BUG: For some reason this method only works with this additional
5393            //     Save() call in between here.
5394            //
5395            // Important: The correct one of the 2 Save() methods has to be called
5396            // here, depending on whether the file is completely new or has been
5397            // saved to disk already, otherwise it will result in data corruption.
5398            if (pRIFF->IsNew())
5399                Save(GetFileName());
5400            else
5401                Save();
5402            
5403            // clone instruments
5404            // (passing the crosslink table here for the cloned samples)
5405            for (int i = 0; pFile->GetInstrument(i); ++i) {
5406                Instrument* instr = AddInstrument();
5407                instr->CopyAssign(pFile->GetInstrument(i), &mSamples);
5408            }
5409            
5410            // Mandatory: file needs to be saved to disk at this point, so this
5411            // file has the correct size and data layout for writing the samples'
5412            // waveform data to disk.
5413            Save();
5414            
5415            // clone samples' waveform data
5416            // (using direct read & write disk streaming)
5417            for (int i = 0; pFile->GetSample(i); ++i) {
5418                mSamples[pFile->GetSample(i)]->CopyAssignWave(pFile->GetSample(i));
5419            }
5420        }
5421    
5422      /** @brief Delete an instrument.      /** @brief Delete an instrument.
5423       *       *
# Line 3437  namespace { Line 5520  namespace {
5520          return NULL;          return NULL;
5521      }      }
5522    
5523        /**
5524         * Returns the group with the given group name.
5525         *
5526         * Note: group names don't have to be unique in the gig format! So there
5527         * can be multiple groups with the same name. This method will simply
5528         * return the first group found with the given name.
5529         *
5530         * @param name - name of the sought group
5531         * @returns sought group or NULL if there's no group with that name
5532         */
5533        Group* File::GetGroup(String name) {
5534            if (!pGroups) LoadGroups();
5535            GroupsIterator = pGroups->begin();
5536            for (uint i = 0; GroupsIterator != pGroups->end(); ++GroupsIterator, ++i)
5537                if ((*GroupsIterator)->Name == name) return *GroupsIterator;
5538            return NULL;
5539        }
5540    
5541      Group* File::AddGroup() {      Group* File::AddGroup() {
5542          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
5543          // there must always be at least one group          // there must always be at least one group
# Line 3517  namespace { Line 5618  namespace {
5618          }          }
5619      }      }
5620    
5621        /** @brief Get instrument script group (by index).
5622         *
5623         * Returns the real-time instrument script group with the given index.
5624         *
5625         * @param index - number of the sought group (0..n)
5626         * @returns sought script group or NULL if there's no such group
5627         */
5628        ScriptGroup* File::GetScriptGroup(uint index) {
5629            if (!pScriptGroups) LoadScriptGroups();
5630            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
5631            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
5632                if (i == index) return *it;
5633            return NULL;
5634        }
5635    
5636        /** @brief Get instrument script group (by name).
5637         *
5638         * Returns the first real-time instrument script group found with the given
5639         * group name. Note that group names may not necessarily be unique.
5640         *
5641         * @param name - name of the sought script group
5642         * @returns sought script group or NULL if there's no such group
5643         */
5644        ScriptGroup* File::GetScriptGroup(const String& name) {
5645            if (!pScriptGroups) LoadScriptGroups();
5646            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
5647            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
5648                if ((*it)->Name == name) return *it;
5649            return NULL;
5650        }
5651    
5652        /** @brief Add new instrument script group.
5653         *
5654         * Adds a new, empty real-time instrument script group to the file.
5655         *
5656         * You have to call Save() to make this persistent to the file.
5657         *
5658         * @return new empty script group
5659         */
5660        ScriptGroup* File::AddScriptGroup() {
5661            if (!pScriptGroups) LoadScriptGroups();
5662            ScriptGroup* pScriptGroup = new ScriptGroup(this, NULL);
5663            pScriptGroups->push_back(pScriptGroup);
5664            return pScriptGroup;
5665        }
5666    
5667        /** @brief Delete an instrument script group.
5668         *
5669         * This will delete the given real-time instrument script group and all its
5670         * instrument scripts it contains. References inside instruments that are
5671         * using the deleted scripts will be removed from the respective instruments
5672         * accordingly.
5673         *
5674         * You have to call Save() to make this persistent to the file.
5675         *
5676         * @param pScriptGroup - script group to delete
5677         * @throws gig::Exception if given script group could not be found
5678         */
5679        void File::DeleteScriptGroup(ScriptGroup* pScriptGroup) {
5680            if (!pScriptGroups) LoadScriptGroups();
5681            std::list<ScriptGroup*>::iterator iter =
5682                find(pScriptGroups->begin(), pScriptGroups->end(), pScriptGroup);
5683            if (iter == pScriptGroups->end())
5684                throw gig::Exception("Could not delete script group, could not find given script group");
5685            pScriptGroups->erase(iter);
5686            for (int i = 0; pScriptGroup->GetScript(i); ++i)
5687                pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));
5688            if (pScriptGroup->pList)
5689                pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);
5690            delete pScriptGroup;
5691        }
5692    
5693        void File::LoadScriptGroups() {
5694            if (pScriptGroups) return;
5695            pScriptGroups = new std::list<ScriptGroup*>;
5696            RIFF::List* lstLS = pRIFF->GetSubList(LIST_TYPE_3LS);
5697            if (lstLS) {
5698                for (RIFF::List* lst = lstLS->GetFirstSubList(); lst;
5699                     lst = lstLS->GetNextSubList())
5700                {
5701                    if (lst->GetListType() == LIST_TYPE_RTIS) {
5702                        pScriptGroups->push_back(new ScriptGroup(this, lst));
5703                    }
5704                }
5705            }
5706        }
5707    
5708      /**      /**
5709       * Apply all the gig file's current instruments, samples, groups and settings       * Apply all the gig file's current instruments, samples, groups and settings
5710       * to the respective RIFF chunks. You have to call Save() to make changes       * to the respective RIFF chunks. You have to call Save() to make changes
# Line 3532  namespace { Line 5720  namespace {
5720    
5721          b64BitWavePoolOffsets = pVersion && pVersion->major == 3;          b64BitWavePoolOffsets = pVersion && pVersion->major == 3;
5722    
5723            // update own gig format extension chunks
5724            // (not part of the GigaStudio 4 format)
5725            //
5726            // This must be performed before writing the chunks for instruments,
5727            // because the instruments' script slots will write the file offsets
5728            // of the respective instrument script chunk as reference.
5729            if (pScriptGroups) {
5730                RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);
5731                if (pScriptGroups->empty()) {
5732                    if (lst3LS) pRIFF->DeleteSubChunk(lst3LS);
5733                } else {
5734                    if (!lst3LS) lst3LS = pRIFF->AddSubList(LIST_TYPE_3LS);
5735    
5736                    // Update instrument script (group) chunks.
5737    
5738                    for (std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
5739                         it != pScriptGroups->end(); ++it)
5740                    {
5741                        (*it)->UpdateChunks();
5742                    }
5743                }
5744            }
5745    
5746          // first update base class's chunks          // first update base class's chunks
5747          DLS::File::UpdateChunks();          DLS::File::UpdateChunks();
5748    
# Line 3547  namespace { Line 5758  namespace {
5758    
5759          // update group's chunks          // update group's chunks
5760          if (pGroups) {          if (pGroups) {
5761              std::list<Group*>::iterator iter = pGroups->begin();              // make sure '3gri' and '3gnl' list chunks exist
5762              std::list<Group*>::iterator end  = pGroups->end();              // (before updating the Group chunks)
5763              for (; iter != end; ++iter) {              RIFF::List* _3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
5764                  (*iter)->UpdateChunks();              if (!_3gri) {
5765                    _3gri = pRIFF->AddSubList(LIST_TYPE_3GRI);
5766                    pRIFF->MoveSubChunk(_3gri, pRIFF->GetSubChunk(CHUNK_ID_PTBL));
5767              }              }
5768                RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
5769                if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
5770    
5771              // v3: make sure the file has 128 3gnm chunks              // v3: make sure the file has 128 3gnm chunks
5772                // (before updating the Group chunks)
5773              if (pVersion && pVersion->major == 3) {              if (pVersion && pVersion->major == 3) {
                 RIFF::List* _3gnl = pRIFF->GetSubList(LIST_TYPE_3GRI)->GetSubList(LIST_TYPE_3GNL);  
5774                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
5775                  for (int i = 0 ; i < 128 ; i++) {                  for (int i = 0 ; i < 128 ; i++) {
5776                      if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);                      if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
5777                      if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();                      if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();
5778                  }                  }
5779              }              }
5780    
5781                std::list<Group*>::iterator iter = pGroups->begin();
5782                std::list<Group*>::iterator end  = pGroups->end();
5783                for (; iter != end; ++iter) {
5784                    (*iter)->UpdateChunks();
5785                }
5786          }          }
5787    
5788          // update einf chunk          // update einf chunk
# Line 3693  namespace { Line 5914  namespace {
5914          }          }
5915      }      }
5916    
5917        /**
5918         * Enable / disable automatic loading. By default this properyt is
5919         * enabled and all informations are loaded automatically. However
5920         * loading all Regions, DimensionRegions and especially samples might
5921         * take a long time for large .gig files, and sometimes one might only
5922         * be interested in retrieving very superficial informations like the
5923         * amount of instruments and their names. In this case one might disable
5924         * automatic loading to avoid very slow response times.
5925         *
5926         * @e CAUTION: by disabling this property many pointers (i.e. sample
5927         * references) and informations will have invalid or even undefined
5928         * data! This feature is currently only intended for retrieving very
5929         * superficial informations in a very fast way. Don't use it to retrieve
5930         * details like synthesis informations or even to modify .gig files!
5931         */
5932        void File::SetAutoLoad(bool b) {
5933            bAutoLoad = b;
5934        }
5935    
5936        /**
5937         * Returns whether automatic loading is enabled.
5938         * @see SetAutoLoad()
5939         */
5940        bool File::GetAutoLoad() {
5941            return bAutoLoad;
5942        }
5943    
5944    
5945    
5946  // *************** Exception ***************  // *************** Exception ***************

Legend:
Removed from v.1335  
changed lines
  Added in v.2601

  ViewVC Help
Powered by ViewVC