/[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 1869 by persson, Sun Mar 22 11:13:25 2009 UTC revision 2639 by schoenebeck, Mon Jun 16 13:22:50 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-2009 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 28  Line 28 
28  #include <algorithm>  #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 454  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 514  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 808  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 910  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 1432  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 1580  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 1595  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       * Updates the respective member variable and updates @c SampleAttenuation
# Line 1836  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          store16(&pData[116], eg3depth);          store16(&pData[116], eg3depth);
1982    
1983          // next 2 bytes unknown          // next 2 bytes unknown
# Line 1884  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 1949  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 2060  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 2153  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 2484  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 2630  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 2805  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        /** @brief Change type of an existing dimension.
3656         *
3657         * Alters the dimension type of a dimension already existing on this
3658         * region. If there is currently no dimension on this Region with type
3659         * @a oldType, then this call with throw an Exception. Likewise there are
3660         * cases where the requested dimension type cannot be performed. For example
3661         * if the new dimension type shall be gig::dimension_samplechannel, and the
3662         * current dimension has more than 2 zones. In such cases an Exception is
3663         * thrown as well.
3664         *
3665         * @param oldType - identifies the existing dimension to be changed
3666         * @param newType - to which dimension type it should be changed to
3667         * @throws gig::Exception if requested change cannot be performed
3668         */
3669        void Region::SetDimensionType(dimension_t oldType, dimension_t newType) {
3670            if (oldType == newType) return;
3671            dimension_def_t* def = GetDimensionDefinition(oldType);
3672            if (!def)
3673                throw gig::Exception("No dimension with provided old dimension type exists on this region");
3674            if (newType == dimension_samplechannel && def->zones != 2)
3675                throw gig::Exception("Cannot change to dimension type 'sample channel', because existing dimension does not have 2 zones");
3676            def->split_type = __resolveSplitType(newType);
3677        }
3678    
3679        DimensionRegion* Region::GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase) {
3680            uint8_t bits[8] = {};
3681            for (std::map<dimension_t,int>::const_iterator it = DimCase.begin();
3682                 it != DimCase.end(); ++it)
3683            {
3684                for (int d = 0; d < Dimensions; ++d) {
3685                    if (pDimensionDefinitions[d].dimension == it->first) {
3686                        bits[d] = it->second;
3687                        goto nextDimCaseSlice;
3688                    }
3689                }
3690                assert(false); // do crash ... too harsh maybe ? ignore it instead ?
3691                nextDimCaseSlice:
3692                ; // noop
3693            }
3694            return GetDimensionRegionByBit(bits);
3695        }
3696    
3697        /**
3698         * Searches in the current Region for a dimension of the given dimension
3699         * type and returns the precise configuration of that dimension in this
3700         * Region.
3701         *
3702         * @param type - dimension type of the sought dimension
3703         * @returns dimension definition or NULL if there is no dimension with
3704         *          sought type in this Region.
3705         */
3706        dimension_def_t* Region::GetDimensionDefinition(dimension_t type) {
3707            for (int i = 0; i < Dimensions; ++i)
3708                if (pDimensionDefinitions[i].dimension == type)
3709                    return &pDimensionDefinitions[i];
3710            return NULL;
3711        }
3712    
3713      Region::~Region() {      Region::~Region() {
3714          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
3715              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
# Line 2862  namespace { Line 3767  namespace {
3767              }              }
3768              bitpos += pDimensionDefinitions[i].bits;              bitpos += pDimensionDefinitions[i].bits;
3769          }          }
3770          DimensionRegion* dimreg = pDimensionRegions[dimregidx];          DimensionRegion* dimreg = pDimensionRegions[dimregidx & 255];
3771            if (!dimreg) return NULL;
3772          if (veldim != -1) {          if (veldim != -1) {
3773              // (dimreg is now the dimension region for the lowest velocity)              // (dimreg is now the dimension region for the lowest velocity)
3774              if (dimreg->VelocityTable) // custom defined zone ranges              if (dimreg->VelocityTable) // custom defined zone ranges
3775                  bits = dimreg->VelocityTable[DimValues[veldim]];                  bits = dimreg->VelocityTable[DimValues[veldim] & 127];
3776              else // normal split type              else // normal split type
3777                  bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);                  bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
3778    
3779              dimregidx |= bits << velbitpos;              const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
3780              dimreg = pDimensionRegions[dimregidx];              dimregidx |= (bits & limiter_mask) << velbitpos;
3781                dimreg = pDimensionRegions[dimregidx & 255];
3782          }          }
3783          return dimreg;          return dimreg;
3784      }      }
3785    
3786        int Region::GetDimensionRegionIndexByValue(const uint DimValues[8]) {
3787            uint8_t bits;
3788            int veldim = -1;
3789            int velbitpos;
3790            int bitpos = 0;
3791            int dimregidx = 0;
3792            for (uint i = 0; i < Dimensions; i++) {
3793                if (pDimensionDefinitions[i].dimension == dimension_velocity) {
3794                    // the velocity dimension must be handled after the other dimensions
3795                    veldim = i;
3796                    velbitpos = bitpos;
3797                } else {
3798                    switch (pDimensionDefinitions[i].split_type) {
3799                        case split_type_normal:
3800                            if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
3801                                // gig3: all normal dimensions (not just the velocity dimension) have custom zone ranges
3802                                for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
3803                                    if (DimValues[i] <= pDimensionRegions[bits << bitpos]->DimensionUpperLimits[i]) break;
3804                                }
3805                            } else {
3806                                // gig2: evenly sized zones
3807                                bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
3808                            }
3809                            break;
3810                        case split_type_bit: // the value is already the sought dimension bit number
3811                            const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
3812                            bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
3813                            break;
3814                    }
3815                    dimregidx |= bits << bitpos;
3816                }
3817                bitpos += pDimensionDefinitions[i].bits;
3818            }
3819            dimregidx &= 255;
3820            DimensionRegion* dimreg = pDimensionRegions[dimregidx];
3821            if (!dimreg) return -1;
3822            if (veldim != -1) {
3823                // (dimreg is now the dimension region for the lowest velocity)
3824                if (dimreg->VelocityTable) // custom defined zone ranges
3825                    bits = dimreg->VelocityTable[DimValues[veldim] & 127];
3826                else // normal split type
3827                    bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
3828    
3829                const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
3830                dimregidx |= (bits & limiter_mask) << velbitpos;
3831                dimregidx &= 255;
3832            }
3833            return dimregidx;
3834        }
3835    
3836      /**      /**
3837       * Returns the appropriate DimensionRegion for the given dimension bit       * Returns the appropriate DimensionRegion for the given dimension bit
3838       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>
# Line 2924  namespace { Line 3881  namespace {
3881          }          }
3882          return NULL;          return NULL;
3883      }      }
3884        
3885        /**
3886         * Make a (semi) deep copy of the Region object given by @a orig
3887         * and assign it to this object.
3888         *
3889         * Note that all sample pointers referenced by @a orig are simply copied as
3890         * memory address. Thus the respective samples are shared, not duplicated!
3891         *
3892         * @param orig - original Region object to be copied from
3893         */
3894        void Region::CopyAssign(const Region* orig) {
3895            CopyAssign(orig, NULL);
3896        }
3897        
3898        /**
3899         * Make a (semi) deep copy of the Region object given by @a orig and
3900         * assign it to this object
3901         *
3902         * @param mSamples - crosslink map between the foreign file's samples and
3903         *                   this file's samples
3904         */
3905        void Region::CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples) {
3906            // handle base classes
3907            DLS::Region::CopyAssign(orig);
3908            
3909            if (mSamples && mSamples->count((gig::Sample*)orig->pSample)) {
3910                pSample = mSamples->find((gig::Sample*)orig->pSample)->second;
3911            }
3912            
3913            // handle own member variables
3914            for (int i = Dimensions - 1; i >= 0; --i) {
3915                DeleteDimension(&pDimensionDefinitions[i]);
3916            }
3917            Layers = 0; // just to be sure
3918            for (int i = 0; i < orig->Dimensions; i++) {
3919                // we need to copy the dim definition here, to avoid the compiler
3920                // complaining about const-ness issue
3921                dimension_def_t def = orig->pDimensionDefinitions[i];
3922                AddDimension(&def);
3923            }
3924            for (int i = 0; i < 256; i++) {
3925                if (pDimensionRegions[i] && orig->pDimensionRegions[i]) {
3926                    pDimensionRegions[i]->CopyAssign(
3927                        orig->pDimensionRegions[i],
3928                        mSamples
3929                    );
3930                }
3931            }
3932            Layers = orig->Layers;
3933        }
3934    
3935    
3936  // *************** MidiRule ***************  // *************** MidiRule ***************
3937  // *  // *
3938    
3939  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg) {      MidiRuleCtrlTrigger::MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg) {
3940      _3ewg->SetPos(36);          _3ewg->SetPos(36);
3941      Triggers = _3ewg->ReadUint8();          Triggers = _3ewg->ReadUint8();
3942      _3ewg->SetPos(40);          _3ewg->SetPos(40);
3943      ControllerNumber = _3ewg->ReadUint8();          ControllerNumber = _3ewg->ReadUint8();
3944      _3ewg->SetPos(46);          _3ewg->SetPos(46);
3945      for (int i = 0 ; i < Triggers ; i++) {          for (int i = 0 ; i < Triggers ; i++) {
3946          pTriggers[i].TriggerPoint = _3ewg->ReadUint8();              pTriggers[i].TriggerPoint = _3ewg->ReadUint8();
3947          pTriggers[i].Descending = _3ewg->ReadUint8();              pTriggers[i].Descending = _3ewg->ReadUint8();
3948          pTriggers[i].VelSensitivity = _3ewg->ReadUint8();              pTriggers[i].VelSensitivity = _3ewg->ReadUint8();
3949          pTriggers[i].Key = _3ewg->ReadUint8();              pTriggers[i].Key = _3ewg->ReadUint8();
3950          pTriggers[i].NoteOff = _3ewg->ReadUint8();              pTriggers[i].NoteOff = _3ewg->ReadUint8();
3951          pTriggers[i].Velocity = _3ewg->ReadUint8();              pTriggers[i].Velocity = _3ewg->ReadUint8();
3952          pTriggers[i].OverridePedal = _3ewg->ReadUint8();              pTriggers[i].OverridePedal = _3ewg->ReadUint8();
3953          _3ewg->ReadUint8();              _3ewg->ReadUint8();
3954            }
3955        }
3956    
3957        MidiRuleCtrlTrigger::MidiRuleCtrlTrigger() :
3958            ControllerNumber(0),
3959            Triggers(0) {
3960        }
3961    
3962        void MidiRuleCtrlTrigger::UpdateChunks(uint8_t* pData) const {
3963            pData[32] = 4;
3964            pData[33] = 16;
3965            pData[36] = Triggers;
3966            pData[40] = ControllerNumber;
3967            for (int i = 0 ; i < Triggers ; i++) {
3968                pData[46 + i * 8] = pTriggers[i].TriggerPoint;
3969                pData[47 + i * 8] = pTriggers[i].Descending;
3970                pData[48 + i * 8] = pTriggers[i].VelSensitivity;
3971                pData[49 + i * 8] = pTriggers[i].Key;
3972                pData[50 + i * 8] = pTriggers[i].NoteOff;
3973                pData[51 + i * 8] = pTriggers[i].Velocity;
3974                pData[52 + i * 8] = pTriggers[i].OverridePedal;
3975            }
3976        }
3977    
3978        MidiRuleLegato::MidiRuleLegato(RIFF::Chunk* _3ewg) {
3979            _3ewg->SetPos(36);
3980            LegatoSamples = _3ewg->ReadUint8(); // always 12
3981            _3ewg->SetPos(40);
3982            BypassUseController = _3ewg->ReadUint8();
3983            BypassKey = _3ewg->ReadUint8();
3984            BypassController = _3ewg->ReadUint8();
3985            ThresholdTime = _3ewg->ReadUint16();
3986            _3ewg->ReadInt16();
3987            ReleaseTime = _3ewg->ReadUint16();
3988            _3ewg->ReadInt16();
3989            KeyRange.low = _3ewg->ReadUint8();
3990            KeyRange.high = _3ewg->ReadUint8();
3991            _3ewg->SetPos(64);
3992            ReleaseTriggerKey = _3ewg->ReadUint8();
3993            AltSustain1Key = _3ewg->ReadUint8();
3994            AltSustain2Key = _3ewg->ReadUint8();
3995        }
3996    
3997        MidiRuleLegato::MidiRuleLegato() :
3998            LegatoSamples(12),
3999            BypassUseController(false),
4000            BypassKey(0),
4001            BypassController(1),
4002            ThresholdTime(20),
4003            ReleaseTime(20),
4004            ReleaseTriggerKey(0),
4005            AltSustain1Key(0),
4006            AltSustain2Key(0)
4007        {
4008            KeyRange.low = KeyRange.high = 0;
4009        }
4010    
4011        void MidiRuleLegato::UpdateChunks(uint8_t* pData) const {
4012            pData[32] = 0;
4013            pData[33] = 16;
4014            pData[36] = LegatoSamples;
4015            pData[40] = BypassUseController;
4016            pData[41] = BypassKey;
4017            pData[42] = BypassController;
4018            store16(&pData[43], ThresholdTime);
4019            store16(&pData[47], ReleaseTime);
4020            pData[51] = KeyRange.low;
4021            pData[52] = KeyRange.high;
4022            pData[64] = ReleaseTriggerKey;
4023            pData[65] = AltSustain1Key;
4024            pData[66] = AltSustain2Key;
4025        }
4026    
4027        MidiRuleAlternator::MidiRuleAlternator(RIFF::Chunk* _3ewg) {
4028            _3ewg->SetPos(36);
4029            Articulations = _3ewg->ReadUint8();
4030            int flags = _3ewg->ReadUint8();
4031            Polyphonic = flags & 8;
4032            Chained = flags & 4;
4033            Selector = (flags & 2) ? selector_controller :
4034                (flags & 1) ? selector_key_switch : selector_none;
4035            Patterns = _3ewg->ReadUint8();
4036            _3ewg->ReadUint8(); // chosen row
4037            _3ewg->ReadUint8(); // unknown
4038            _3ewg->ReadUint8(); // unknown
4039            _3ewg->ReadUint8(); // unknown
4040            KeySwitchRange.low = _3ewg->ReadUint8();
4041            KeySwitchRange.high = _3ewg->ReadUint8();
4042            Controller = _3ewg->ReadUint8();
4043            PlayRange.low = _3ewg->ReadUint8();
4044            PlayRange.high = _3ewg->ReadUint8();
4045    
4046            int n = std::min(int(Articulations), 32);
4047            for (int i = 0 ; i < n ; i++) {
4048                _3ewg->ReadString(pArticulations[i], 32);
4049            }
4050            _3ewg->SetPos(1072);
4051            n = std::min(int(Patterns), 32);
4052            for (int i = 0 ; i < n ; i++) {
4053                _3ewg->ReadString(pPatterns[i].Name, 16);
4054                pPatterns[i].Size = _3ewg->ReadUint8();
4055                _3ewg->Read(&pPatterns[i][0], 1, 32);
4056            }
4057        }
4058    
4059        MidiRuleAlternator::MidiRuleAlternator() :
4060            Articulations(0),
4061            Patterns(0),
4062            Selector(selector_none),
4063            Controller(0),
4064            Polyphonic(false),
4065            Chained(false)
4066        {
4067            PlayRange.low = PlayRange.high = 0;
4068            KeySwitchRange.low = KeySwitchRange.high = 0;
4069        }
4070    
4071        void MidiRuleAlternator::UpdateChunks(uint8_t* pData) const {
4072            pData[32] = 3;
4073            pData[33] = 16;
4074            pData[36] = Articulations;
4075            pData[37] = (Polyphonic ? 8 : 0) | (Chained ? 4 : 0) |
4076                (Selector == selector_controller ? 2 :
4077                 (Selector == selector_key_switch ? 1 : 0));
4078            pData[38] = Patterns;
4079    
4080            pData[43] = KeySwitchRange.low;
4081            pData[44] = KeySwitchRange.high;
4082            pData[45] = Controller;
4083            pData[46] = PlayRange.low;
4084            pData[47] = PlayRange.high;
4085    
4086            char* str = reinterpret_cast<char*>(pData);
4087            int pos = 48;
4088            int n = std::min(int(Articulations), 32);
4089            for (int i = 0 ; i < n ; i++, pos += 32) {
4090                strncpy(&str[pos], pArticulations[i].c_str(), 32);
4091            }
4092    
4093            pos = 1072;
4094            n = std::min(int(Patterns), 32);
4095            for (int i = 0 ; i < n ; i++, pos += 49) {
4096                strncpy(&str[pos], pPatterns[i].Name.c_str(), 16);
4097                pData[pos + 16] = pPatterns[i].Size;
4098                memcpy(&pData[pos + 16], &(pPatterns[i][0]), 32);
4099            }
4100        }
4101    
4102    // *************** Script ***************
4103    // *
4104    
4105        Script::Script(ScriptGroup* group, RIFF::Chunk* ckScri) {
4106            pGroup = group;
4107            pChunk = ckScri;
4108            if (ckScri) { // object is loaded from file ...
4109                // read header
4110                uint32_t headerSize = ckScri->ReadUint32();
4111                Compression = (Compression_t) ckScri->ReadUint32();
4112                Encoding    = (Encoding_t) ckScri->ReadUint32();
4113                Language    = (Language_t) ckScri->ReadUint32();
4114                Bypass      = (Language_t) ckScri->ReadUint32() & 1;
4115                crc         = ckScri->ReadUint32();
4116                uint32_t nameSize = ckScri->ReadUint32();
4117                Name.resize(nameSize, ' ');
4118                for (int i = 0; i < nameSize; ++i)
4119                    Name[i] = ckScri->ReadUint8();
4120                // to handle potential future extensions of the header
4121                ckScri->SetPos(sizeof(int32_t) + headerSize);
4122                // read actual script data
4123                uint32_t scriptSize = ckScri->GetSize() - ckScri->GetPos();
4124                data.resize(scriptSize);
4125                for (int i = 0; i < scriptSize; ++i)
4126                    data[i] = ckScri->ReadUint8();
4127            } else { // this is a new script object, so just initialize it as such ...
4128                Compression = COMPRESSION_NONE;
4129                Encoding = ENCODING_ASCII;
4130                Language = LANGUAGE_NKSP;
4131                Bypass   = false;
4132                crc      = 0;
4133                Name     = "Unnamed Script";
4134            }
4135        }
4136    
4137        Script::~Script() {
4138        }
4139    
4140        /**
4141         * Returns the current script (i.e. as source code) in text format.
4142         */
4143        String Script::GetScriptAsText() {
4144            String s;
4145            s.resize(data.size(), ' ');
4146            memcpy(&s[0], &data[0], data.size());
4147            return s;
4148        }
4149    
4150        /**
4151         * Replaces the current script with the new script source code text given
4152         * by @a text.
4153         *
4154         * @param text - new script source code
4155         */
4156        void Script::SetScriptAsText(const String& text) {
4157            data.resize(text.size());
4158            memcpy(&data[0], &text[0], text.size());
4159        }
4160    
4161        void Script::UpdateChunks() {
4162            // recalculate CRC32 check sum
4163            __resetCRC(crc);
4164            __calculateCRC(&data[0], data.size(), crc);
4165            __encodeCRC(crc);
4166            // make sure chunk exists and has the required size
4167            const int chunkSize = 7*sizeof(int32_t) + Name.size() + data.size();
4168            if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);
4169            else pChunk->Resize(chunkSize);
4170            // fill the chunk data to be written to disk
4171            uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();
4172            int pos = 0;
4173            store32(&pData[pos], 6*sizeof(int32_t) + Name.size()); // total header size
4174            pos += sizeof(int32_t);
4175            store32(&pData[pos], Compression);
4176            pos += sizeof(int32_t);
4177            store32(&pData[pos], Encoding);
4178            pos += sizeof(int32_t);
4179            store32(&pData[pos], Language);
4180            pos += sizeof(int32_t);
4181            store32(&pData[pos], Bypass ? 1 : 0);
4182            pos += sizeof(int32_t);
4183            store32(&pData[pos], crc);
4184            pos += sizeof(int32_t);
4185            store32(&pData[pos], Name.size());
4186            pos += sizeof(int32_t);
4187            for (int i = 0; i < Name.size(); ++i, ++pos)
4188                pData[pos] = Name[i];
4189            for (int i = 0; i < data.size(); ++i, ++pos)
4190                pData[pos] = data[i];
4191      }      }
 }  
4192    
4193        /**
4194         * Move this script from its current ScriptGroup to another ScriptGroup
4195         * given by @a pGroup.
4196         *
4197         * @param pGroup - script's new group
4198         */
4199        void Script::SetGroup(ScriptGroup* pGroup) {
4200            if (this->pGroup = pGroup) return;
4201            if (pChunk)
4202                pChunk->GetParent()->MoveSubChunk(pChunk, pGroup->pList);
4203            this->pGroup = pGroup;
4204        }
4205    
4206        /**
4207         * Returns the script group this script currently belongs to. Each script
4208         * is a member of exactly one ScriptGroup.
4209         *
4210         * @returns current script group
4211         */
4212        ScriptGroup* Script::GetGroup() const {
4213            return pGroup;
4214        }
4215    
4216        void Script::RemoveAllScriptReferences() {
4217            File* pFile = pGroup->pFile;
4218            for (int i = 0; pFile->GetInstrument(i); ++i) {
4219                Instrument* instr = pFile->GetInstrument(i);
4220                instr->RemoveScript(this);
4221            }
4222        }
4223    
4224    // *************** ScriptGroup ***************
4225    // *
4226    
4227        ScriptGroup::ScriptGroup(File* file, RIFF::List* lstRTIS) {
4228            pFile = file;
4229            pList = lstRTIS;
4230            pScripts = NULL;
4231            if (lstRTIS) {
4232                RIFF::Chunk* ckName = lstRTIS->GetSubChunk(CHUNK_ID_LSNM);
4233                ::LoadString(ckName, Name);
4234            } else {
4235                Name = "Default Group";
4236            }
4237        }
4238    
4239        ScriptGroup::~ScriptGroup() {
4240            if (pScripts) {
4241                std::list<Script*>::iterator iter = pScripts->begin();
4242                std::list<Script*>::iterator end  = pScripts->end();
4243                while (iter != end) {
4244                    delete *iter;
4245                    ++iter;
4246                }
4247                delete pScripts;
4248            }
4249        }
4250    
4251        void ScriptGroup::UpdateChunks() {
4252            if (pScripts) {
4253                if (!pList)
4254                    pList = pFile->pRIFF->GetSubList(LIST_TYPE_3LS)->AddSubList(LIST_TYPE_RTIS);
4255    
4256                // now store the name of this group as <LSNM> chunk as subchunk of the <RTIS> list chunk
4257                ::SaveString(CHUNK_ID_LSNM, NULL, pList, Name, String("Unnamed Group"), true, 64);
4258    
4259                for (std::list<Script*>::iterator it = pScripts->begin();
4260                     it != pScripts->end(); ++it)
4261                {
4262                    (*it)->UpdateChunks();
4263                }
4264            }
4265        }
4266    
4267        /** @brief Get instrument script.
4268         *
4269         * Returns the real-time instrument script with the given index.
4270         *
4271         * @param index - number of the sought script (0..n)
4272         * @returns sought script or NULL if there's no such script
4273         */
4274        Script* ScriptGroup::GetScript(uint index) {
4275            if (!pScripts) LoadScripts();
4276            std::list<Script*>::iterator it = pScripts->begin();
4277            for (uint i = 0; it != pScripts->end(); ++i, ++it)
4278                if (i == index) return *it;
4279            return NULL;
4280        }
4281    
4282        /** @brief Add new instrument script.
4283         *
4284         * Adds a new real-time instrument script to the file. The script is not
4285         * actually used / executed unless it is referenced by an instrument to be
4286         * used. This is similar to samples, which you can add to a file, without
4287         * an instrument necessarily actually using it.
4288         *
4289         * You have to call Save() to make this persistent to the file.
4290         *
4291         * @return new empty script object
4292         */
4293        Script* ScriptGroup::AddScript() {
4294            if (!pScripts) LoadScripts();
4295            Script* pScript = new Script(this, NULL);
4296            pScripts->push_back(pScript);
4297            return pScript;
4298        }
4299    
4300        /** @brief Delete an instrument script.
4301         *
4302         * This will delete the given real-time instrument script. References of
4303         * instruments that are using that script will be removed accordingly.
4304         *
4305         * You have to call Save() to make this persistent to the file.
4306         *
4307         * @param pScript - script to delete
4308         * @throws gig::Exception if given script could not be found
4309         */
4310        void ScriptGroup::DeleteScript(Script* pScript) {
4311            if (!pScripts) LoadScripts();
4312            std::list<Script*>::iterator iter =
4313                find(pScripts->begin(), pScripts->end(), pScript);
4314            if (iter == pScripts->end())
4315                throw gig::Exception("Could not delete script, could not find given script");
4316            pScripts->erase(iter);
4317            pScript->RemoveAllScriptReferences();
4318            if (pScript->pChunk)
4319                pScript->pChunk->GetParent()->DeleteSubChunk(pScript->pChunk);
4320            delete pScript;
4321        }
4322    
4323        void ScriptGroup::LoadScripts() {
4324            if (pScripts) return;
4325            pScripts = new std::list<Script*>;
4326            if (!pList) return;
4327    
4328            for (RIFF::Chunk* ck = pList->GetFirstSubChunk(); ck;
4329                 ck = pList->GetNextSubChunk())
4330            {
4331                if (ck->GetChunkID() == CHUNK_ID_SCRI) {
4332                    pScripts->push_back(new Script(this, ck));
4333                }
4334            }
4335        }
4336    
4337  // *************** Instrument ***************  // *************** Instrument ***************
4338  // *  // *
# Line 2970  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4356  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4356          DimensionKeyRange.high = 0;          DimensionKeyRange.high = 0;
4357          pMidiRules = new MidiRule*[3];          pMidiRules = new MidiRule*[3];
4358          pMidiRules[0] = NULL;          pMidiRules[0] = NULL;
4359            pScriptRefs = NULL;
4360    
4361          // Loading          // Loading
4362          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
# Line 2992  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4379  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4379                      uint8_t id1 = _3ewg->ReadUint8();                      uint8_t id1 = _3ewg->ReadUint8();
4380                      uint8_t id2 = _3ewg->ReadUint8();                      uint8_t id2 = _3ewg->ReadUint8();
4381    
4382                      if (id1 == 4 && id2 == 16) {                      if (id2 == 16) {
4383                          pMidiRules[i++] = new MidiRuleCtrlTrigger(_3ewg);                          if (id1 == 4) {
4384                                pMidiRules[i++] = new MidiRuleCtrlTrigger(_3ewg);
4385                            } else if (id1 == 0) {
4386                                pMidiRules[i++] = new MidiRuleLegato(_3ewg);
4387                            } else if (id1 == 3) {
4388                                pMidiRules[i++] = new MidiRuleAlternator(_3ewg);
4389                            } else {
4390                                pMidiRules[i++] = new MidiRuleUnknown;
4391                            }
4392                        }
4393                        else if (id1 != 0 || id2 != 0) {
4394                            pMidiRules[i++] = new MidiRuleUnknown;
4395                      }                      }
4396                      //TODO: all the other types of rules                      //TODO: all the other types of rules
4397    
# Line 3019  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4417  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4417              }              }
4418          }          }
4419    
4420            // own gig format extensions
4421            RIFF::List* lst3LS = insList->GetSubList(LIST_TYPE_3LS);
4422            if (lst3LS) {
4423                RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4424                if (ckSCSL) {
4425                    int headerSize = ckSCSL->ReadUint32();
4426                    int slotCount  = ckSCSL->ReadUint32();
4427                    if (slotCount) {
4428                        int slotSize  = ckSCSL->ReadUint32();
4429                        ckSCSL->SetPos(headerSize); // in case of future header extensions
4430                        int unknownSpace = slotSize - 2*sizeof(uint32_t); // in case of future slot extensions
4431                        for (int i = 0; i < slotCount; ++i) {
4432                            _ScriptPooolEntry e;
4433                            e.fileOffset = ckSCSL->ReadUint32();
4434                            e.bypass     = ckSCSL->ReadUint32() & 1;
4435                            if (unknownSpace) ckSCSL->SetPos(unknownSpace, RIFF::stream_curpos); // in case of future extensions
4436                            scriptPoolFileOffsets.push_back(e);
4437                        }
4438                    }
4439                }
4440            }
4441    
4442          __notify_progress(pProgress, 1.0f); // notify done          __notify_progress(pProgress, 1.0f); // notify done
4443      }      }
4444    
# Line 3035  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4455  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4455      }      }
4456    
4457      Instrument::~Instrument() {      Instrument::~Instrument() {
4458            for (int i = 0 ; pMidiRules[i] ; i++) {
4459                delete pMidiRules[i];
4460            }
4461          delete[] pMidiRules;          delete[] pMidiRules;
4462            if (pScriptRefs) delete pScriptRefs;
4463      }      }
4464    
4465      /**      /**
# Line 3082  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4506  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4506                                      DimensionKeyRange.low << 1;                                      DimensionKeyRange.low << 1;
4507          pData[10] = dimkeystart;          pData[10] = dimkeystart;
4508          pData[11] = DimensionKeyRange.high;          pData[11] = DimensionKeyRange.high;
4509    
4510            if (pMidiRules[0] == 0 && _3ewg->GetSize() >= 34) {
4511                pData[32] = 0;
4512                pData[33] = 0;
4513            } else {
4514                for (int i = 0 ; pMidiRules[i] ; i++) {
4515                    pMidiRules[i]->UpdateChunks(pData);
4516                }
4517            }
4518    
4519            // own gig format extensions
4520           if (pScriptRefs) {
4521               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4522               if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);
4523               const int slotCount = pScriptRefs->size();
4524               const int headerSize = 3 * sizeof(uint32_t);
4525               const int slotSize  = 2 * sizeof(uint32_t);
4526               const int totalChunkSize = headerSize + slotCount * slotSize;
4527               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4528               if (!ckSCSL) ckSCSL = lst3LS->AddSubChunk(CHUNK_ID_SCSL, totalChunkSize);
4529               else ckSCSL->Resize(totalChunkSize);
4530               uint8_t* pData = (uint8_t*) ckSCSL->LoadChunkData();
4531               int pos = 0;
4532               store32(&pData[pos], headerSize);
4533               pos += sizeof(uint32_t);
4534               store32(&pData[pos], slotCount);
4535               pos += sizeof(uint32_t);
4536               store32(&pData[pos], slotSize);
4537               pos += sizeof(uint32_t);
4538               for (int i = 0; i < slotCount; ++i) {
4539                   // arbitrary value, the actual file offset will be updated in
4540                   // UpdateScriptFileOffsets() after the file has been resized
4541                   int bogusFileOffset = 0;
4542                   store32(&pData[pos], bogusFileOffset);
4543                   pos += sizeof(uint32_t);
4544                   store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0);
4545                   pos += sizeof(uint32_t);
4546               }
4547           }
4548        }
4549    
4550        void Instrument::UpdateScriptFileOffsets() {
4551           // own gig format extensions
4552           if (pScriptRefs) {
4553               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4554               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4555               const int slotCount = pScriptRefs->size();
4556               const int headerSize = 3 * sizeof(uint32_t);
4557               ckSCSL->SetPos(headerSize);
4558               for (int i = 0; i < slotCount; ++i) {
4559                   uint32_t fileOffset =
4560                        (*pScriptRefs)[i].script->pChunk->GetFilePos() -
4561                        (*pScriptRefs)[i].script->pChunk->GetPos() -
4562                        CHUNK_HEADER_SIZE;
4563                   ckSCSL->WriteUint32(&fileOffset);
4564                   // jump over flags entry (containing the bypass flag)
4565                   ckSCSL->SetPos(sizeof(uint32_t), RIFF::stream_curpos);
4566               }
4567           }        
4568      }      }
4569    
4570      /**      /**
# Line 3164  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 4647  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
4647          return pMidiRules[i];          return pMidiRules[i];
4648      }      }
4649    
4650        /**
4651         * Adds the "controller trigger" MIDI rule to the instrument.
4652         *
4653         * @returns the new MIDI rule
4654         */
4655        MidiRuleCtrlTrigger* Instrument::AddMidiRuleCtrlTrigger() {
4656            delete pMidiRules[0];
4657            MidiRuleCtrlTrigger* r = new MidiRuleCtrlTrigger;
4658            pMidiRules[0] = r;
4659            pMidiRules[1] = 0;
4660            return r;
4661        }
4662    
4663        /**
4664         * Adds the legato MIDI rule to the instrument.
4665         *
4666         * @returns the new MIDI rule
4667         */
4668        MidiRuleLegato* Instrument::AddMidiRuleLegato() {
4669            delete pMidiRules[0];
4670            MidiRuleLegato* r = new MidiRuleLegato;
4671            pMidiRules[0] = r;
4672            pMidiRules[1] = 0;
4673            return r;
4674        }
4675    
4676        /**
4677         * Adds the alternator MIDI rule to the instrument.
4678         *
4679         * @returns the new MIDI rule
4680         */
4681        MidiRuleAlternator* Instrument::AddMidiRuleAlternator() {
4682            delete pMidiRules[0];
4683            MidiRuleAlternator* r = new MidiRuleAlternator;
4684            pMidiRules[0] = r;
4685            pMidiRules[1] = 0;
4686            return r;
4687        }
4688    
4689        /**
4690         * Deletes a MIDI rule from the instrument.
4691         *
4692         * @param i - MIDI rule number
4693         */
4694        void Instrument::DeleteMidiRule(int i) {
4695            delete pMidiRules[i];
4696            pMidiRules[i] = 0;
4697        }
4698    
4699        void Instrument::LoadScripts() {
4700            if (pScriptRefs) return;
4701            pScriptRefs = new std::vector<_ScriptPooolRef>;
4702            if (scriptPoolFileOffsets.empty()) return;
4703            File* pFile = (File*) GetParent();
4704            for (uint k = 0; k < scriptPoolFileOffsets.size(); ++k) {
4705                uint32_t soughtOffset = scriptPoolFileOffsets[k].fileOffset;
4706                for (uint i = 0; pFile->GetScriptGroup(i); ++i) {
4707                    ScriptGroup* group = pFile->GetScriptGroup(i);
4708                    for (uint s = 0; group->GetScript(s); ++s) {
4709                        Script* script = group->GetScript(s);
4710                        if (script->pChunk) {
4711                            uint32_t offset = script->pChunk->GetFilePos() -
4712                                              script->pChunk->GetPos() -
4713                                              CHUNK_HEADER_SIZE;
4714                            if (offset == soughtOffset)
4715                            {
4716                                _ScriptPooolRef ref;
4717                                ref.script = script;
4718                                ref.bypass = scriptPoolFileOffsets[k].bypass;
4719                                pScriptRefs->push_back(ref);
4720                                break;
4721                            }
4722                        }
4723                    }
4724                }
4725            }
4726            // we don't need that anymore
4727            scriptPoolFileOffsets.clear();
4728        }
4729    
4730        /** @brief Get instrument script (gig format extension).
4731         *
4732         * Returns the real-time instrument script of instrument script slot
4733         * @a index.
4734         *
4735         * @note This is an own format extension which did not exist i.e. in the
4736         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4737         * gigedit.
4738         *
4739         * @param index - instrument script slot index
4740         * @returns script or NULL if index is out of bounds
4741         */
4742        Script* Instrument::GetScriptOfSlot(uint index) {
4743            LoadScripts();
4744            if (index >= pScriptRefs->size()) return NULL;
4745            return pScriptRefs->at(index).script;
4746        }
4747    
4748        /** @brief Add new instrument script slot (gig format extension).
4749         *
4750         * Add the given real-time instrument script reference to this instrument,
4751         * which shall be executed by the sampler for for this instrument. The
4752         * script will be added to the end of the script list of this instrument.
4753         * The positions of the scripts in the Instrument's Script list are
4754         * relevant, because they define in which order they shall be executed by
4755         * the sampler. For this reason it is also legal to add the same script
4756         * twice to an instrument, for example you might have a script called
4757         * "MyFilter" which performs an event filter task, and you might have
4758         * another script called "MyNoteTrigger" which triggers new notes, then you
4759         * might for example have the following list of scripts on the instrument:
4760         *
4761         * 1. Script "MyFilter"
4762         * 2. Script "MyNoteTrigger"
4763         * 3. Script "MyFilter"
4764         *
4765         * Which would make sense, because the 2nd script launched new events, which
4766         * you might need to filter as well.
4767         *
4768         * There are two ways to disable / "bypass" scripts. You can either disable
4769         * a script locally for the respective script slot on an instrument (i.e. by
4770         * passing @c false to the 2nd argument of this method, or by calling
4771         * SetScriptBypassed()). Or you can disable a script globally for all slots
4772         * and all instruments by setting Script::Bypass.
4773         *
4774         * @note This is an own format extension which did not exist i.e. in the
4775         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4776         * gigedit.
4777         *
4778         * @param pScript - script that shall be executed for this instrument
4779         * @param bypass  - if enabled, the sampler shall skip executing this
4780         *                  script (in the respective list position)
4781         * @see SetScriptBypassed()
4782         */
4783        void Instrument::AddScriptSlot(Script* pScript, bool bypass) {
4784            LoadScripts();
4785            _ScriptPooolRef ref = { pScript, bypass };
4786            pScriptRefs->push_back(ref);
4787        }
4788    
4789        /** @brief Flip two script slots with each other (gig format extension).
4790         *
4791         * Swaps the position of the two given scripts in the Instrument's Script
4792         * list. The positions of the scripts in the Instrument's Script list are
4793         * relevant, because they define in which order they shall be executed by
4794         * the sampler.
4795         *
4796         * @note This is an own format extension which did not exist i.e. in the
4797         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4798         * gigedit.
4799         *
4800         * @param index1 - index of the first script slot to swap
4801         * @param index2 - index of the second script slot to swap
4802         */
4803        void Instrument::SwapScriptSlots(uint index1, uint index2) {
4804            LoadScripts();
4805            if (index1 >= pScriptRefs->size() || index2 >= pScriptRefs->size())
4806                return;
4807            _ScriptPooolRef tmp = (*pScriptRefs)[index1];
4808            (*pScriptRefs)[index1] = (*pScriptRefs)[index2];
4809            (*pScriptRefs)[index2] = tmp;
4810        }
4811    
4812        /** @brief Remove script slot.
4813         *
4814         * Removes the script slot with the given slot index.
4815         *
4816         * @param index - index of script slot to remove
4817         */
4818        void Instrument::RemoveScriptSlot(uint index) {
4819            LoadScripts();
4820            if (index >= pScriptRefs->size()) return;
4821            pScriptRefs->erase( pScriptRefs->begin() + index );
4822        }
4823    
4824        /** @brief Remove reference to given Script (gig format extension).
4825         *
4826         * This will remove all script slots on the instrument which are referencing
4827         * the given script.
4828         *
4829         * @note This is an own format extension which did not exist i.e. in the
4830         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4831         * gigedit.
4832         *
4833         * @param pScript - script reference to remove from this instrument
4834         * @see RemoveScriptSlot()
4835         */
4836        void Instrument::RemoveScript(Script* pScript) {
4837            LoadScripts();
4838            for (int i = pScriptRefs->size() - 1; i >= 0; --i) {
4839                if ((*pScriptRefs)[i].script == pScript) {
4840                    pScriptRefs->erase( pScriptRefs->begin() + i );
4841                }
4842            }
4843        }
4844    
4845        /** @brief Instrument's amount of script slots.
4846         *
4847         * This method returns the amount of script slots this instrument currently
4848         * uses.
4849         *
4850         * A script slot is a reference of a real-time instrument script to be
4851         * executed by the sampler. The scripts will be executed by the sampler in
4852         * sequence of the slots. One (same) script may be referenced multiple
4853         * times in different slots.
4854         *
4855         * @note This is an own format extension which did not exist i.e. in the
4856         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4857         * gigedit.
4858         */
4859        uint Instrument::ScriptSlotCount() const {
4860            return pScriptRefs ? pScriptRefs->size() : scriptPoolFileOffsets.size();
4861        }
4862    
4863        /** @brief Whether script execution shall be skipped.
4864         *
4865         * Defines locally for the Script reference slot in the Instrument's Script
4866         * list, whether the script shall be skipped by the sampler regarding
4867         * execution.
4868         *
4869         * It is also possible to ignore exeuction of the script globally, for all
4870         * slots and for all instruments by setting Script::Bypass.
4871         *
4872         * @note This is an own format extension which did not exist i.e. in the
4873         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4874         * gigedit.
4875         *
4876         * @param index - index of the script slot on this instrument
4877         * @see Script::Bypass
4878         */
4879        bool Instrument::IsScriptSlotBypassed(uint index) {
4880            if (index >= ScriptSlotCount()) return false;
4881            return pScriptRefs ? pScriptRefs->at(index).bypass
4882                               : scriptPoolFileOffsets.at(index).bypass;
4883            
4884        }
4885    
4886        /** @brief Defines whether execution shall be skipped.
4887         *
4888         * You can call this method to define locally whether or whether not the
4889         * given script slot shall be executed by the sampler.
4890         *
4891         * @note This is an own format extension which did not exist i.e. in the
4892         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4893         * gigedit.
4894         *
4895         * @param index - script slot index on this instrument
4896         * @param bBypass - if true, the script slot will be skipped by the sampler
4897         * @see Script::Bypass
4898         */
4899        void Instrument::SetScriptSlotBypassed(uint index, bool bBypass) {
4900            if (index >= ScriptSlotCount()) return;
4901            if (pScriptRefs)
4902                pScriptRefs->at(index).bypass = bBypass;
4903            else
4904                scriptPoolFileOffsets.at(index).bypass = bBypass;
4905        }
4906    
4907        /**
4908         * Make a (semi) deep copy of the Instrument object given by @a orig
4909         * and assign it to this object.
4910         *
4911         * Note that all sample pointers referenced by @a orig are simply copied as
4912         * memory address. Thus the respective samples are shared, not duplicated!
4913         *
4914         * @param orig - original Instrument object to be copied from
4915         */
4916        void Instrument::CopyAssign(const Instrument* orig) {
4917            CopyAssign(orig, NULL);
4918        }
4919            
4920        /**
4921         * Make a (semi) deep copy of the Instrument object given by @a orig
4922         * and assign it to this object.
4923         *
4924         * @param orig - original Instrument object to be copied from
4925         * @param mSamples - crosslink map between the foreign file's samples and
4926         *                   this file's samples
4927         */
4928        void Instrument::CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples) {
4929            // handle base class
4930            // (without copying DLS region stuff)
4931            DLS::Instrument::CopyAssignCore(orig);
4932            
4933            // handle own member variables
4934            Attenuation = orig->Attenuation;
4935            EffectSend = orig->EffectSend;
4936            FineTune = orig->FineTune;
4937            PitchbendRange = orig->PitchbendRange;
4938            PianoReleaseMode = orig->PianoReleaseMode;
4939            DimensionKeyRange = orig->DimensionKeyRange;
4940            scriptPoolFileOffsets = orig->scriptPoolFileOffsets;
4941            pScriptRefs = orig->pScriptRefs;
4942            
4943            // free old midi rules
4944            for (int i = 0 ; pMidiRules[i] ; i++) {
4945                delete pMidiRules[i];
4946            }
4947            //TODO: MIDI rule copying
4948            pMidiRules[0] = NULL;
4949            
4950            // delete all old regions
4951            while (Regions) DeleteRegion(GetFirstRegion());
4952            // create new regions and copy them from original
4953            {
4954                RegionList::const_iterator it = orig->pRegions->begin();
4955                for (int i = 0; i < orig->Regions; ++i, ++it) {
4956                    Region* dstRgn = AddRegion();
4957                    //NOTE: Region does semi-deep copy !
4958                    dstRgn->CopyAssign(
4959                        static_cast<gig::Region*>(*it),
4960                        mSamples
4961                    );
4962                }
4963            }
4964    
4965            UpdateRegionKeyTable();
4966        }
4967    
4968    
4969  // *************** Group ***************  // *************** Group ***************
4970  // *  // *
# Line 3323  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5124  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5124          bAutoLoad = true;          bAutoLoad = true;
5125          *pVersion = VERSION_3;          *pVersion = VERSION_3;
5126          pGroups = NULL;          pGroups = NULL;
5127            pScriptGroups = NULL;
5128          pInfo->SetFixedStringLengths(_FileFixedStringLengths);          pInfo->SetFixedStringLengths(_FileFixedStringLengths);
5129          pInfo->ArchivalLocation = String(256, ' ');          pInfo->ArchivalLocation = String(256, ' ');
5130    
# Line 3338  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5140  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5140      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
5141          bAutoLoad = true;          bAutoLoad = true;
5142          pGroups = NULL;          pGroups = NULL;
5143            pScriptGroups = NULL;
5144          pInfo->SetFixedStringLengths(_FileFixedStringLengths);          pInfo->SetFixedStringLengths(_FileFixedStringLengths);
5145      }      }
5146    
# Line 3351  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5154  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5154              }              }
5155              delete pGroups;              delete pGroups;
5156          }          }
5157            if (pScriptGroups) {
5158                std::list<ScriptGroup*>::iterator iter = pScriptGroups->begin();
5159                std::list<ScriptGroup*>::iterator end  = pScriptGroups->end();
5160                while (iter != end) {
5161                    delete *iter;
5162                    ++iter;
5163                }
5164                delete pScriptGroups;
5165            }
5166      }      }
5167    
5168      Sample* File::GetFirstSample(progress_t* pProgress) {      Sample* File::GetFirstSample(progress_t* pProgress) {
# Line 3365  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5177  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5177          SamplesIterator++;          SamplesIterator++;
5178          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
5179      }      }
5180        
5181        /**
5182         * Returns Sample object of @a index.
5183         *
5184         * @returns sample object or NULL if index is out of bounds
5185         */
5186        Sample* File::GetSample(uint index) {
5187            if (!pSamples) LoadSamples();
5188            if (!pSamples) return NULL;
5189            DLS::File::SampleList::iterator it = pSamples->begin();
5190            for (int i = 0; i < index; ++i) {
5191                ++it;
5192                if (it == pSamples->end()) return NULL;
5193            }
5194            if (it == pSamples->end()) return NULL;
5195            return static_cast<gig::Sample*>( *it );
5196        }
5197    
5198      /** @brief Add a new sample.      /** @brief Add a new sample.
5199       *       *
# Line 3562  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5391  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5391         pInstruments->push_back(pInstrument);         pInstruments->push_back(pInstrument);
5392         return pInstrument;         return pInstrument;
5393      }      }
5394        
5395        /** @brief Add a duplicate of an existing instrument.
5396         *
5397         * Duplicates the instrument definition given by @a orig and adds it
5398         * to this file. This allows in an instrument editor application to
5399         * easily create variations of an instrument, which will be stored in
5400         * the same .gig file, sharing i.e. the same samples.
5401         *
5402         * Note that all sample pointers referenced by @a orig are simply copied as
5403         * memory address. Thus the respective samples are shared, not duplicated!
5404         *
5405         * You have to call Save() to make this persistent to the file.
5406         *
5407         * @param orig - original instrument to be copied
5408         * @returns duplicated copy of the given instrument
5409         */
5410        Instrument* File::AddDuplicateInstrument(const Instrument* orig) {
5411            Instrument* instr = AddInstrument();
5412            instr->CopyAssign(orig);
5413            return instr;
5414        }
5415        
5416        /** @brief Add content of another existing file.
5417         *
5418         * Duplicates the samples, groups and instruments of the original file
5419         * given by @a pFile and adds them to @c this File. In case @c this File is
5420         * a new one that you haven't saved before, then you have to call
5421         * SetFileName() before calling AddContentOf(), because this method will
5422         * automatically save this file during operation, which is required for
5423         * writing the sample waveform data by disk streaming.
5424         *
5425         * @param pFile - original file whose's content shall be copied from
5426         */
5427        void File::AddContentOf(File* pFile) {
5428            static int iCallCount = -1;
5429            iCallCount++;
5430            std::map<Group*,Group*> mGroups;
5431            std::map<Sample*,Sample*> mSamples;
5432            
5433            // clone sample groups
5434            for (int i = 0; pFile->GetGroup(i); ++i) {
5435                Group* g = AddGroup();
5436                g->Name =
5437                    "COPY" + ToString(iCallCount) + "_" + pFile->GetGroup(i)->Name;
5438                mGroups[pFile->GetGroup(i)] = g;
5439            }
5440            
5441            // clone samples (not waveform data here yet)
5442            for (int i = 0; pFile->GetSample(i); ++i) {
5443                Sample* s = AddSample();
5444                s->CopyAssignMeta(pFile->GetSample(i));
5445                mGroups[pFile->GetSample(i)->GetGroup()]->AddSample(s);
5446                mSamples[pFile->GetSample(i)] = s;
5447            }
5448            
5449            //BUG: For some reason this method only works with this additional
5450            //     Save() call in between here.
5451            //
5452            // Important: The correct one of the 2 Save() methods has to be called
5453            // here, depending on whether the file is completely new or has been
5454            // saved to disk already, otherwise it will result in data corruption.
5455            if (pRIFF->IsNew())
5456                Save(GetFileName());
5457            else
5458                Save();
5459            
5460            // clone instruments
5461            // (passing the crosslink table here for the cloned samples)
5462            for (int i = 0; pFile->GetInstrument(i); ++i) {
5463                Instrument* instr = AddInstrument();
5464                instr->CopyAssign(pFile->GetInstrument(i), &mSamples);
5465            }
5466            
5467            // Mandatory: file needs to be saved to disk at this point, so this
5468            // file has the correct size and data layout for writing the samples'
5469            // waveform data to disk.
5470            Save();
5471            
5472            // clone samples' waveform data
5473            // (using direct read & write disk streaming)
5474            for (int i = 0; pFile->GetSample(i); ++i) {
5475                mSamples[pFile->GetSample(i)]->CopyAssignWave(pFile->GetSample(i));
5476            }
5477        }
5478    
5479      /** @brief Delete an instrument.      /** @brief Delete an instrument.
5480       *       *
# Line 3664  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5577  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5577          return NULL;          return NULL;
5578      }      }
5579    
5580        /**
5581         * Returns the group with the given group name.
5582         *
5583         * Note: group names don't have to be unique in the gig format! So there
5584         * can be multiple groups with the same name. This method will simply
5585         * return the first group found with the given name.
5586         *
5587         * @param name - name of the sought group
5588         * @returns sought group or NULL if there's no group with that name
5589         */
5590        Group* File::GetGroup(String name) {
5591            if (!pGroups) LoadGroups();
5592            GroupsIterator = pGroups->begin();
5593            for (uint i = 0; GroupsIterator != pGroups->end(); ++GroupsIterator, ++i)
5594                if ((*GroupsIterator)->Name == name) return *GroupsIterator;
5595            return NULL;
5596        }
5597    
5598      Group* File::AddGroup() {      Group* File::AddGroup() {
5599          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
5600          // there must always be at least one group          // there must always be at least one group
# Line 3744  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5675  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5675          }          }
5676      }      }
5677    
5678        /** @brief Get instrument script group (by index).
5679         *
5680         * Returns the real-time instrument script group with the given index.
5681         *
5682         * @param index - number of the sought group (0..n)
5683         * @returns sought script group or NULL if there's no such group
5684         */
5685        ScriptGroup* File::GetScriptGroup(uint index) {
5686            if (!pScriptGroups) LoadScriptGroups();
5687            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
5688            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
5689                if (i == index) return *it;
5690            return NULL;
5691        }
5692    
5693        /** @brief Get instrument script group (by name).
5694         *
5695         * Returns the first real-time instrument script group found with the given
5696         * group name. Note that group names may not necessarily be unique.
5697         *
5698         * @param name - name of the sought script group
5699         * @returns sought script group or NULL if there's no such group
5700         */
5701        ScriptGroup* File::GetScriptGroup(const String& name) {
5702            if (!pScriptGroups) LoadScriptGroups();
5703            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
5704            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
5705                if ((*it)->Name == name) return *it;
5706            return NULL;
5707        }
5708    
5709        /** @brief Add new instrument script group.
5710         *
5711         * Adds a new, empty real-time instrument script group to the file.
5712         *
5713         * You have to call Save() to make this persistent to the file.
5714         *
5715         * @return new empty script group
5716         */
5717        ScriptGroup* File::AddScriptGroup() {
5718            if (!pScriptGroups) LoadScriptGroups();
5719            ScriptGroup* pScriptGroup = new ScriptGroup(this, NULL);
5720            pScriptGroups->push_back(pScriptGroup);
5721            return pScriptGroup;
5722        }
5723    
5724        /** @brief Delete an instrument script group.
5725         *
5726         * This will delete the given real-time instrument script group and all its
5727         * instrument scripts it contains. References inside instruments that are
5728         * using the deleted scripts will be removed from the respective instruments
5729         * accordingly.
5730         *
5731         * You have to call Save() to make this persistent to the file.
5732         *
5733         * @param pScriptGroup - script group to delete
5734         * @throws gig::Exception if given script group could not be found
5735         */
5736        void File::DeleteScriptGroup(ScriptGroup* pScriptGroup) {
5737            if (!pScriptGroups) LoadScriptGroups();
5738            std::list<ScriptGroup*>::iterator iter =
5739                find(pScriptGroups->begin(), pScriptGroups->end(), pScriptGroup);
5740            if (iter == pScriptGroups->end())
5741                throw gig::Exception("Could not delete script group, could not find given script group");
5742            pScriptGroups->erase(iter);
5743            for (int i = 0; pScriptGroup->GetScript(i); ++i)
5744                pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));
5745            if (pScriptGroup->pList)
5746                pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);
5747            delete pScriptGroup;
5748        }
5749    
5750        void File::LoadScriptGroups() {
5751            if (pScriptGroups) return;
5752            pScriptGroups = new std::list<ScriptGroup*>;
5753            RIFF::List* lstLS = pRIFF->GetSubList(LIST_TYPE_3LS);
5754            if (lstLS) {
5755                for (RIFF::List* lst = lstLS->GetFirstSubList(); lst;
5756                     lst = lstLS->GetNextSubList())
5757                {
5758                    if (lst->GetListType() == LIST_TYPE_RTIS) {
5759                        pScriptGroups->push_back(new ScriptGroup(this, lst));
5760                    }
5761                }
5762            }
5763        }
5764    
5765      /**      /**
5766       * Apply all the gig file's current instruments, samples, groups and settings       * Apply all the gig file's current instruments, samples, groups and settings
5767       * 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 3759  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5777  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5777    
5778          b64BitWavePoolOffsets = pVersion && pVersion->major == 3;          b64BitWavePoolOffsets = pVersion && pVersion->major == 3;
5779    
5780            // update own gig format extension chunks
5781            // (not part of the GigaStudio 4 format)
5782            //
5783            // This must be performed before writing the chunks for instruments,
5784            // because the instruments' script slots will write the file offsets
5785            // of the respective instrument script chunk as reference.
5786            if (pScriptGroups) {
5787                RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);
5788                if (pScriptGroups->empty()) {
5789                    if (lst3LS) pRIFF->DeleteSubChunk(lst3LS);
5790                } else {
5791                    if (!lst3LS) lst3LS = pRIFF->AddSubList(LIST_TYPE_3LS);
5792    
5793                    // Update instrument script (group) chunks.
5794    
5795                    for (std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
5796                         it != pScriptGroups->end(); ++it)
5797                    {
5798                        (*it)->UpdateChunks();
5799                    }
5800                }
5801            }
5802    
5803          // first update base class's chunks          // first update base class's chunks
5804          DLS::File::UpdateChunks();          DLS::File::UpdateChunks();
5805    
# Line 3774  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5815  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5815    
5816          // update group's chunks          // update group's chunks
5817          if (pGroups) {          if (pGroups) {
5818              std::list<Group*>::iterator iter = pGroups->begin();              // make sure '3gri' and '3gnl' list chunks exist
5819              std::list<Group*>::iterator end  = pGroups->end();              // (before updating the Group chunks)
5820              for (; iter != end; ++iter) {              RIFF::List* _3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
5821                  (*iter)->UpdateChunks();              if (!_3gri) {
5822                    _3gri = pRIFF->AddSubList(LIST_TYPE_3GRI);
5823                    pRIFF->MoveSubChunk(_3gri, pRIFF->GetSubChunk(CHUNK_ID_PTBL));
5824              }              }
5825                RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
5826                if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
5827    
5828              // v3: make sure the file has 128 3gnm chunks              // v3: make sure the file has 128 3gnm chunks
5829                // (before updating the Group chunks)
5830              if (pVersion && pVersion->major == 3) {              if (pVersion && pVersion->major == 3) {
                 RIFF::List* _3gnl = pRIFF->GetSubList(LIST_TYPE_3GRI)->GetSubList(LIST_TYPE_3GNL);  
5831                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
5832                  for (int i = 0 ; i < 128 ; i++) {                  for (int i = 0 ; i < 128 ; i++) {
5833                      if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);                      if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
5834                      if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();                      if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();
5835                  }                  }
5836              }              }
5837    
5838                std::list<Group*>::iterator iter = pGroups->begin();
5839                std::list<Group*>::iterator end  = pGroups->end();
5840                for (; iter != end; ++iter) {
5841                    (*iter)->UpdateChunks();
5842                }
5843          }          }
5844    
5845          // update einf chunk          // update einf chunk
# Line 3919  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger Line 5970  MidiRuleCtrlTrigger::MidiRuleCtrlTrigger
5970              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
5971          }          }
5972      }      }
5973        
5974        void File::UpdateFileOffsets() {
5975            DLS::File::UpdateFileOffsets();
5976    
5977            for (Instrument* instrument = GetFirstInstrument(); instrument;
5978                 instrument = GetNextInstrument())
5979            {
5980                instrument->UpdateScriptFileOffsets();
5981            }
5982        }
5983    
5984      /**      /**
5985       * Enable / disable automatic loading. By default this properyt is       * Enable / disable automatic loading. By default this properyt is

Legend:
Removed from v.1869  
changed lines
  Added in v.2639

  ViewVC Help
Powered by ViewVC